UserPoolIdentityProviderApple¶
-
class
aws_cdk.aws_cognito.
UserPoolIdentityProviderApple
(scope, id, *, client_id, key_id, private_key, team_id, scopes=None, user_pool, attribute_mapping=None)¶ Bases:
aws_cdk.core.Resource
Represents a identity provider that integrates with ‘Apple’.
- Resource
AWS::Cognito::UserPoolIdentityProvider
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_cognito as cognito # provider_attribute: cognito.ProviderAttribute # user_pool: cognito.UserPool user_pool_identity_provider_apple = cognito.UserPoolIdentityProviderApple(self, "MyUserPoolIdentityProviderApple", client_id="clientId", key_id="keyId", private_key="privateKey", team_id="teamId", user_pool=user_pool, # the properties below are optional attribute_mapping=cognito.AttributeMapping( address=provider_attribute, birthdate=provider_attribute, custom={ "custom_key": provider_attribute }, email=provider_attribute, family_name=provider_attribute, fullname=provider_attribute, gender=provider_attribute, given_name=provider_attribute, last_update_time=provider_attribute, locale=provider_attribute, middle_name=provider_attribute, nickname=provider_attribute, phone_number=provider_attribute, preferred_username=provider_attribute, profile_page=provider_attribute, profile_picture=provider_attribute, timezone=provider_attribute, website=provider_attribute ), scopes=["scopes"] )
- Parameters
scope (
Construct
) –id (
str
) –client_id (
str
) – The client id recognized by Apple APIs.key_id (
str
) – The keyId (of the same key, which content has to be later supplied asprivateKey
) for Apple APIs to authenticate the client.private_key (
str
) – The privateKey content for Apple APIs to authenticate the client.team_id (
str
) – The teamId for Apple APIs to authenticate the client.scopes (
Optional
[Sequence
[str
]]) – The list of apple permissions to obtain for getting access to the apple profile. Default: [ name ]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.DESTROY
), 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
-
node
¶ The construct tree node associated with this construct.
- Return type
-
provider_name
¶ The primary identifier of this identity provider.
- Return type
str
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