Class: AWSCDK::Verifiedpermissions::CfnIdentitySource::CognitoUserPoolConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
verifiedpermissions/cfn_identity_source.rb

Overview

A structure that contains configuration information used when creating or updating an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_pool_arn:, client_ids: nil, group_configuration: nil) ⇒ CognitoUserPoolConfigurationProperty

Returns a new instance of CognitoUserPoolConfigurationProperty.

Parameters:



606
607
608
609
610
611
612
613
 
# File 'verifiedpermissions/cfn_identity_source.rb', line 606

def initialize(user_pool_arn:, client_ids: nil, group_configuration: nil)
  @user_pool_arn = user_pool_arn
  Jsii::Type.check_type(@user_pool_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userPoolArn")
  @client_ids = client_ids
  Jsii::Type.check_type(@client_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "clientIds") unless @client_ids.nil?
  @group_configuration = group_configuration.is_a?(Hash) ? ::AWSCDK::Verifiedpermissions::CfnIdentitySource::CognitoGroupConfigurationProperty.new(**group_configuration.transform_keys(&:to_sym)) : group_configuration
  Jsii::Type.check_type(@group_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c192ZXJpZmllZHBlcm1pc3Npb25zLkNmbklkZW50aXR5U291cmNlLkNvZ25pdG9Hcm91cENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "groupConfiguration") unless @group_configuration.nil?
end

Instance Attribute Details

#client_ids ⇒ Array<String>? (readonly)

The unique application client IDs that are associated with the specified Amazon Cognito user pool.

Example: "ClientIds": ["&ExampleCogClientId;"]

Returns:

  • (Array<String>, nil)

See Also:



626
627
628
 
# File 'verifiedpermissions/cfn_identity_source.rb', line 626

def client_ids
  @client_ids
end

#group_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.

Returns:

See Also:



631
632
633
 
# File 'verifiedpermissions/cfn_identity_source.rb', line 631

def group_configuration
  @group_configuration
end

#user_pool_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.

Returns:

  • (String)

See Also:



619
620
621
 
# File 'verifiedpermissions/cfn_identity_source.rb', line 619

def user_pool_arn
  @user_pool_arn
end

Class Method Details

.jsii_properties ⇒ Object 



633
634
635
636
637
638
639
 
# File 'verifiedpermissions/cfn_identity_source.rb', line 633

def self.jsii_properties
  {
    :user_pool_arn => "userPoolArn",
    :client_ids => "clientIds",
    :group_configuration => "groupConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



641
642
643
644
645
646
647
648
649
 
# File 'verifiedpermissions/cfn_identity_source.rb', line 641

def to_jsii
  result = {}
  result.merge!({
    "userPoolArn" => @user_pool_arn,
    "clientIds" => @client_ids,
    "groupConfiguration" => @group_configuration,
  })
  result.compact
end