CfnUserPoolRegionalConfigurationAttachmentPropsMixin

class aws_cdk.cfn_property_mixins.aws_cognito.CfnUserPoolRegionalConfigurationAttachmentPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::Cognito::UserPoolRegionalConfigurationAttachment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolregionalconfigurationattachment.html

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:

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 x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

CustomEmailSenderProperty

class CfnUserPoolRegionalConfigurationAttachmentPropsMixin.CustomEmailSenderProperty(*, lambda_arn=None, lambda_version=None)

Bases: object

Parameters:
  • lambda_arn (Optional[str])

  • lambda_version (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-customemailsender.html

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

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-customemailsender.html#cfn-cognito-userpoolregionalconfigurationattachment-customemailsender-lambdaarn

Type:

see

lambda_version

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-customemailsender.html#cfn-cognito-userpoolregionalconfigurationattachment-customemailsender-lambdaversion

Type:

see

CustomSMSSenderProperty

class CfnUserPoolRegionalConfigurationAttachmentPropsMixin.CustomSMSSenderProperty(*, lambda_arn=None, lambda_version=None)

Bases: object

Parameters:
  • lambda_arn (Optional[str])

  • lambda_version (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-customsmssender.html

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

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-customsmssender.html#cfn-cognito-userpoolregionalconfigurationattachment-customsmssender-lambdaarn

Type:

see

lambda_version

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-customsmssender.html#cfn-cognito-userpoolregionalconfigurationattachment-customsmssender-lambdaversion

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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-emailconfiguration.html

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

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-emailconfiguration.html#cfn-cognito-userpoolregionalconfigurationattachment-emailconfiguration-configurationset

Type:

see

email_sending_account

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-emailconfiguration.html#cfn-cognito-userpoolregionalconfigurationattachment-emailconfiguration-emailsendingaccount

Type:

see

from_

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-emailconfiguration.html#cfn-cognito-userpoolregionalconfigurationattachment-emailconfiguration-from

Type:

see

reply_to_email_address

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-emailconfiguration.html#cfn-cognito-userpoolregionalconfigurationattachment-emailconfiguration-replytoemailaddress

Type:

see

source_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-emailconfiguration.html#cfn-cognito-userpoolregionalconfigurationattachment-emailconfiguration-sourcearn

Type:

see

InboundFederationProperty

class CfnUserPoolRegionalConfigurationAttachmentPropsMixin.InboundFederationProperty(*, lambda_arn=None, lambda_version=None)

Bases: object

Parameters:
  • lambda_arn (Optional[str])

  • lambda_version (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-inboundfederation.html

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

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-inboundfederation.html#cfn-cognito-userpoolregionalconfigurationattachment-inboundfederation-lambdaarn

Type:

see

lambda_version

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-inboundfederation.html#cfn-cognito-userpoolregionalconfigurationattachment-inboundfederation-lambdaversion

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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-lambdaconfig.html

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

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-lambdaconfig.html#cfn-cognito-userpoolregionalconfigurationattachment-lambdaconfig-createauthchallenge

Type:

see

custom_email_sender

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-lambdaconfig.html#cfn-cognito-userpoolregionalconfigurationattachment-lambdaconfig-customemailsender

Type:

see

custom_message

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-lambdaconfig.html#cfn-cognito-userpoolregionalconfigurationattachment-lambdaconfig-custommessage

Type:

see

custom_sms_sender

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-lambdaconfig.html#cfn-cognito-userpoolregionalconfigurationattachment-lambdaconfig-customsmssender

Type:

see

define_auth_challenge

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-lambdaconfig.html#cfn-cognito-userpoolregionalconfigurationattachment-lambdaconfig-defineauthchallenge

Type:

see

inbound_federation

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-lambdaconfig.html#cfn-cognito-userpoolregionalconfigurationattachment-lambdaconfig-inboundfederation

Type:

see

kms_key_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-lambdaconfig.html#cfn-cognito-userpoolregionalconfigurationattachment-lambdaconfig-kmskeyid

Type:

see

post_authentication

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-lambdaconfig.html#cfn-cognito-userpoolregionalconfigurationattachment-lambdaconfig-postauthentication

Type:

see

post_confirmation

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-lambdaconfig.html#cfn-cognito-userpoolregionalconfigurationattachment-lambdaconfig-postconfirmation

Type:

see

pre_authentication

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-lambdaconfig.html#cfn-cognito-userpoolregionalconfigurationattachment-lambdaconfig-preauthentication

Type:

see

pre_sign_up

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-lambdaconfig.html#cfn-cognito-userpoolregionalconfigurationattachment-lambdaconfig-presignup

Type:

see

pre_token_generation

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-lambdaconfig.html#cfn-cognito-userpoolregionalconfigurationattachment-lambdaconfig-pretokengeneration

Type:

see

pre_token_generation_config

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-lambdaconfig.html#cfn-cognito-userpoolregionalconfigurationattachment-lambdaconfig-pretokengenerationconfig

Type:

see

user_migration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-lambdaconfig.html#cfn-cognito-userpoolregionalconfigurationattachment-lambdaconfig-usermigration

Type:

see

verify_auth_challenge_response

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-lambdaconfig.html#cfn-cognito-userpoolregionalconfigurationattachment-lambdaconfig-verifyauthchallengeresponse

Type:

see

PreTokenGenerationConfigProperty

class CfnUserPoolRegionalConfigurationAttachmentPropsMixin.PreTokenGenerationConfigProperty(*, lambda_arn=None, lambda_version=None)

Bases: object

Parameters:
  • lambda_arn (Optional[str])

  • lambda_version (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-pretokengenerationconfig.html

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

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-pretokengenerationconfig.html#cfn-cognito-userpoolregionalconfigurationattachment-pretokengenerationconfig-lambdaarn

Type:

see

lambda_version

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-pretokengenerationconfig.html#cfn-cognito-userpoolregionalconfigurationattachment-pretokengenerationconfig-lambdaversion

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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-smsconfiguration.html

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

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-smsconfiguration.html#cfn-cognito-userpoolregionalconfigurationattachment-smsconfiguration-externalid

Type:

see

sns_caller_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-smsconfiguration.html#cfn-cognito-userpoolregionalconfigurationattachment-smsconfiguration-snscallerarn

Type:

see

sns_region

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolregionalconfigurationattachment-smsconfiguration.html#cfn-cognito-userpoolregionalconfigurationattachment-smsconfiguration-snsregion

Type:

see