Class: AWSCDK::Cognito::CfnUserPoolUserToGroupAttachmentProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cognito/cfn_user_pool_user_to_group_attachment_props.rb

Overview

Properties for defining a CfnUserPoolUserToGroupAttachment.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(group_name:, username:, user_pool_id:) ⇒ CfnUserPoolUserToGroupAttachmentProps

Returns a new instance of CfnUserPoolUserToGroupAttachmentProps.

Parameters:



12
13
14
15
16
17
18
19
 
# File 'cognito/cfn_user_pool_user_to_group_attachment_props.rb', line 12

def initialize(group_name:, username:, user_pool_id:)
  @group_name = group_name
  Jsii::Type.check_type(@group_name, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb2duaXRvLklVc2VyUG9vbEdyb3VwUmVmIn1dfX0=")), "groupName")
  @username = username
  Jsii::Type.check_type(@username, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb2duaXRvLklVc2VyUG9vbFVzZXJSZWYifV19fQ==")), "username")
  @user_pool_id = user_pool_id
  Jsii::Type.check_type(@user_pool_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb2duaXRvLklVc2VyUG9vbFJlZiJ9XX19")), "userPoolId")
end

Instance Attribute Details

#group_name ⇒ String, AWSCDK::Interfaces::AWSCognito::IUserPoolGroupRef (readonly)

The name of the group that you want to add your user to.

Returns:

See Also:



25
26
27
 
# File 'cognito/cfn_user_pool_user_to_group_attachment_props.rb', line 25

def group_name
  @group_name
end

#user_pool_id ⇒ String, AWSCDK::Interfaces::AWSCognito::IUserPoolRef (readonly)

The ID of the user pool that contains the group that you want to add the user to.

Returns:

See Also:



35
36
37
 
# File 'cognito/cfn_user_pool_user_to_group_attachment_props.rb', line 35

def user_pool_id
  @user_pool_id
end

#username ⇒ String, AWSCDK::Interfaces::AWSCognito::IUserPoolUserRef (readonly)

The user's username.

Returns:

See Also:



30
31
32
 
# File 'cognito/cfn_user_pool_user_to_group_attachment_props.rb', line 30

def username
  @username
end

Class Method Details

.jsii_properties ⇒ Object 



37
38
39
40
41
42
43
 
# File 'cognito/cfn_user_pool_user_to_group_attachment_props.rb', line 37

def self.jsii_properties
  {
    :group_name => "groupName",
    :username => "username",
    :user_pool_id => "userPoolId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



45
46
47
48
49
50
51
52
53
 
# File 'cognito/cfn_user_pool_user_to_group_attachment_props.rb', line 45

def to_jsii
  result = {}
  result.merge!({
    "groupName" => @group_name,
    "username" => @username,
    "userPoolId" => @user_pool_id,
  })
  result.compact
end