UserPoolIdentityProviderAmazonProps

class aws_cdk.aws_cognito.UserPoolIdentityProviderAmazonProps(*, user_pool, attribute_mapping=None, client_id, client_secret, scopes=None)

Bases: aws_cdk.aws_cognito.UserPoolIdentityProviderProps

Properties to initialize UserPoolAmazonIdentityProvider.

Parameters
  • user_pool (IUserPool) – The user pool to which this construct provides identities.

  • attribute_mapping (Union[AttributeMapping, Dict[str, Any], None]) – Mapping attributes from the identity provider to standard and custom attributes of the user pool. Default: - no attribute mapping

  • client_id (str) – The client id recognized by ‘Login with Amazon’ APIs.

  • client_secret (str) – The client secret to be accompanied with clientId for ‘Login with Amazon’ APIs to authenticate the client.

  • scopes (Optional[Sequence[str]]) – The types of user profile data to obtain for the Amazon profile. Default: [ profile ]

ExampleMetadata

infused

Example:

pool = cognito.UserPool(self, "Pool")
provider = cognito.UserPoolIdentityProviderAmazon(self, "Amazon",
    user_pool=pool,
    client_id="amzn-client-id",
    client_secret="amzn-client-secret"
)

client = pool.add_client("app-client",
    # ...
    supported_identity_providers=[cognito.UserPoolClientIdentityProvider.AMAZON
    ]
)

client.node.add_dependency(provider)

Attributes

attribute_mapping

Mapping attributes from the identity provider to standard and custom attributes of the user pool.

Default
  • no attribute mapping

Return type

Optional[AttributeMapping]

client_id

The client id recognized by ‘Login with Amazon’ APIs.

See

https://developer.amazon.com/docs/login-with-amazon/security-profile.html#client-identifier

Return type

str

client_secret

The client secret to be accompanied with clientId for ‘Login with Amazon’ APIs to authenticate the client.

See

https://developer.amazon.com/docs/login-with-amazon/security-profile.html#client-identifier

Return type

str

scopes

The types of user profile data to obtain for the Amazon profile.

Default

[ profile ]

See

https://developer.amazon.com/docs/login-with-amazon/customer-profile.html

Return type

Optional[List[str]]

user_pool

The user pool to which this construct provides identities.

Return type

IUserPool