UserPoolIdentityProviderAmazon

class aws_cdk.aws_cognito.UserPoolIdentityProviderAmazon(scope, id, *, client_id, client_secret, scopes=None, user_pool, attribute_mapping=None)

Bases: aws_cdk.core.Resource

Represents a identity provider that integrates with ‘Login with Amazon’.

Resource

AWS::Cognito::UserPoolIdentityProvider

Parameters

  • scope (Construct) –

  • id (str) –

  • 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 ]

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

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

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DELETE), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters

policy (RemovalPolicy) –

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type

ResourceEnvironment

node

The construct tree node associated with this construct.

Return type

ConstructNode

provider_name

The primary identifier of this identity provider.

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool