Class: Aws::VerifiedPermissions::Types::CognitoUserPoolConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-verifiedpermissions/types.rb

Overview

The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.

This data type part of a [Configuration] structure that is used as a parameter to [CreateIdentitySource].

Example:‘“CognitoUserPoolConfiguration”:[“a1b2c3d4e5f6g7h8i9j0kalbmc”],“groupConfiguration”: {“groupEntityType”: “MyCorp::Group”}`

[1]: docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_Configuration.html [2]: docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html

See Also:

Constant Summary collapse

SENSITIVE = 
[:client_ids]

Instance Attribute Summary collapse

Instance Attribute Details

#client_ids ⇒ Array<String>

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

Example: ‘“ClientIds”: [“&ExampleCogClientId;”]`

Returns:

  • (Array<String>) 


696
697
698
699
700
701
702
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 696

class CognitoUserPoolConfiguration < Struct.new(
  :user_pool_arn,
  :client_ids,
  :group_configuration)
  SENSITIVE = [:client_ids]
  include Aws::Structure
end

#group_configuration ⇒ Types::CognitoGroupConfiguration

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

Returns:



696
697
698
699
700
701
702
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 696

class CognitoUserPoolConfiguration < Struct.new(
  :user_pool_arn,
  :client_ids,
  :group_configuration)
  SENSITIVE = [:client_ids]
  include Aws::Structure
end

#user_pool_arn ⇒ String

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

Example: ‘“UserPoolArn”: “arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5”`

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (String) 


696
697
698
699
700
701
702
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 696

class CognitoUserPoolConfiguration < Struct.new(
  :user_pool_arn,
  :client_ids,
  :group_configuration)
  SENSITIVE = [:client_ids]
  include Aws::Structure
end