CfnUserPoolRegionalConfigurationAttachmentPropsMixin
- class aws_cdk.cfn_property_mixins.aws_cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin(props, *, strategy=None)
Bases:
MixinResource Type definition for AWS::Cognito::UserPoolRegionalConfigurationAttachment.
- See:
- CloudformationResource:
AWS::Cognito::UserPoolRegionalConfigurationAttachment
- Mixin:
true
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_cognito as cognito import aws_cdk as cdk # merge_strategy: cdk.IMergeStrategy cfn_user_pool_regional_configuration_attachment_props_mixin = cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin(cognito.CfnUserPoolRegionalConfigurationAttachmentMixinProps( email_configuration=cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin.EmailConfigurationProperty( configuration_set="configurationSet", email_sending_account="emailSendingAccount", from="from", reply_to_email_address="replyToEmailAddress", source_arn="sourceArn" ), lambda_config=cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin.LambdaConfigProperty( create_auth_challenge="createAuthChallenge", custom_email_sender=cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin.CustomEmailSenderProperty( lambda_arn="lambdaArn", lambda_version="lambdaVersion" ), custom_message="customMessage", custom_sms_sender=cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin.CustomSMSSenderProperty( lambda_arn="lambdaArn", lambda_version="lambdaVersion" ), define_auth_challenge="defineAuthChallenge", inbound_federation=cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin.InboundFederationProperty( lambda_arn="lambdaArn", lambda_version="lambdaVersion" ), kms_key_id="kmsKeyId", post_authentication="postAuthentication", post_confirmation="postConfirmation", pre_authentication="preAuthentication", pre_sign_up="preSignUp", pre_token_generation="preTokenGeneration", pre_token_generation_config=cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin.PreTokenGenerationConfigProperty( lambda_arn="lambdaArn", lambda_version="lambdaVersion" ), user_migration="userMigration", verify_auth_challenge_response="verifyAuthChallengeResponse" ), sms_configuration=cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin.SmsConfigurationProperty( external_id="externalId", sns_caller_arn="snsCallerArn", sns_region="snsRegion" ), status="status", user_pool_id="userPoolId", user_pool_tags={ "user_pool_tags_key": "userPoolTags" } ), strategy=merge_strategy )
Create a mixin to apply properties to
AWS::Cognito::UserPoolRegionalConfigurationAttachment.- Parameters:
props (
Union[CfnUserPoolRegionalConfigurationAttachmentMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
None
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['emailConfiguration', 'lambdaConfig', 'smsConfiguration', 'status', 'userPoolId', 'userPoolTags']
Static Methods
- classmethod is_mixin(x)
Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.
CustomEmailSenderProperty
- class CfnUserPoolRegionalConfigurationAttachmentPropsMixin.CustomEmailSenderProperty(*, lambda_arn=None, lambda_version=None)
Bases:
object- Parameters:
lambda_arn (
Optional[str])lambda_version (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_cognito as cognito custom_email_sender_property = cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin.CustomEmailSenderProperty( lambda_arn="lambdaArn", lambda_version="lambdaVersion" )
Attributes
- lambda_arn
-
- Type:
see
CustomSMSSenderProperty
- class CfnUserPoolRegionalConfigurationAttachmentPropsMixin.CustomSMSSenderProperty(*, lambda_arn=None, lambda_version=None)
Bases:
object- Parameters:
lambda_arn (
Optional[str])lambda_version (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_cognito as cognito custom_sms_sender_property = cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin.CustomSMSSenderProperty( lambda_arn="lambdaArn", lambda_version="lambdaVersion" )
Attributes
- lambda_arn
-
- Type:
see
EmailConfigurationProperty
- class CfnUserPoolRegionalConfigurationAttachmentPropsMixin.EmailConfigurationProperty(*, configuration_set=None, email_sending_account=None, from_=None, reply_to_email_address=None, source_arn=None)
Bases:
object- Parameters:
configuration_set (
Optional[str])email_sending_account (
Optional[str])from
reply_to_email_address (
Optional[str])source_arn (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_cognito as cognito email_configuration_property = cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin.EmailConfigurationProperty( configuration_set="configurationSet", email_sending_account="emailSendingAccount", from="from", reply_to_email_address="replyToEmailAddress", source_arn="sourceArn" )
Attributes
- configuration_set
-
- Type:
see
- email_sending_account
-
- Type:
see
- from_
-
- Type:
see
- reply_to_email_address
-
- Type:
see
InboundFederationProperty
- class CfnUserPoolRegionalConfigurationAttachmentPropsMixin.InboundFederationProperty(*, lambda_arn=None, lambda_version=None)
Bases:
object- Parameters:
lambda_arn (
Optional[str])lambda_version (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_cognito as cognito inbound_federation_property = cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin.InboundFederationProperty( lambda_arn="lambdaArn", lambda_version="lambdaVersion" )
Attributes
- lambda_arn
-
- Type:
see
LambdaConfigProperty
- class CfnUserPoolRegionalConfigurationAttachmentPropsMixin.LambdaConfigProperty(*, create_auth_challenge=None, custom_email_sender=None, custom_message=None, custom_sms_sender=None, define_auth_challenge=None, inbound_federation=None, kms_key_id=None, post_authentication=None, post_confirmation=None, pre_authentication=None, pre_sign_up=None, pre_token_generation=None, pre_token_generation_config=None, user_migration=None, verify_auth_challenge_response=None)
Bases:
object- Parameters:
create_auth_challenge (
Optional[str])custom_email_sender (
Union[IResolvable,CustomEmailSenderProperty,Dict[str,Any],None])custom_message (
Optional[str])custom_sms_sender (
Union[IResolvable,CustomSMSSenderProperty,Dict[str,Any],None])define_auth_challenge (
Optional[str])inbound_federation (
Union[IResolvable,InboundFederationProperty,Dict[str,Any],None])kms_key_id (
Optional[str])post_authentication (
Optional[str])post_confirmation (
Optional[str])pre_authentication (
Optional[str])pre_sign_up (
Optional[str])pre_token_generation (
Optional[str])pre_token_generation_config (
Union[IResolvable,PreTokenGenerationConfigProperty,Dict[str,Any],None])user_migration (
Optional[str])verify_auth_challenge_response (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_cognito as cognito lambda_config_property = cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin.LambdaConfigProperty( create_auth_challenge="createAuthChallenge", custom_email_sender=cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin.CustomEmailSenderProperty( lambda_arn="lambdaArn", lambda_version="lambdaVersion" ), custom_message="customMessage", custom_sms_sender=cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin.CustomSMSSenderProperty( lambda_arn="lambdaArn", lambda_version="lambdaVersion" ), define_auth_challenge="defineAuthChallenge", inbound_federation=cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin.InboundFederationProperty( lambda_arn="lambdaArn", lambda_version="lambdaVersion" ), kms_key_id="kmsKeyId", post_authentication="postAuthentication", post_confirmation="postConfirmation", pre_authentication="preAuthentication", pre_sign_up="preSignUp", pre_token_generation="preTokenGeneration", pre_token_generation_config=cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin.PreTokenGenerationConfigProperty( lambda_arn="lambdaArn", lambda_version="lambdaVersion" ), user_migration="userMigration", verify_auth_challenge_response="verifyAuthChallengeResponse" )
Attributes
- create_auth_challenge
-
- Type:
see
- custom_email_sender
-
- Type:
see
- custom_message
-
- Type:
see
- custom_sms_sender
-
- Type:
see
- define_auth_challenge
-
- Type:
see
- inbound_federation
-
- Type:
see
- kms_key_id
-
- Type:
see
- post_authentication
-
- Type:
see
- post_confirmation
-
- Type:
see
- pre_authentication
-
- Type:
see
- pre_sign_up
-
- Type:
see
- pre_token_generation
-
- Type:
see
- pre_token_generation_config
-
- Type:
see
- user_migration
-
- Type:
see
PreTokenGenerationConfigProperty
- class CfnUserPoolRegionalConfigurationAttachmentPropsMixin.PreTokenGenerationConfigProperty(*, lambda_arn=None, lambda_version=None)
Bases:
object- Parameters:
lambda_arn (
Optional[str])lambda_version (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_cognito as cognito pre_token_generation_config_property = cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin.PreTokenGenerationConfigProperty( lambda_arn="lambdaArn", lambda_version="lambdaVersion" )
Attributes
- lambda_arn
-
- Type:
see
SmsConfigurationProperty
- class CfnUserPoolRegionalConfigurationAttachmentPropsMixin.SmsConfigurationProperty(*, external_id=None, sns_caller_arn=None, sns_region=None)
Bases:
object- Parameters:
external_id (
Optional[str])sns_caller_arn (
Optional[str])sns_region (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_cognito as cognito sms_configuration_property = cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin.SmsConfigurationProperty( external_id="externalId", sns_caller_arn="snsCallerArn", sns_region="snsRegion" )
Attributes
- external_id
-
- Type:
see
- sns_caller_arn
-
- Type:
see