CfnUserPoolDomainPropsMixin

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

Bases: Mixin

The AWS::Cognito::UserPoolDomain resource creates a new domain for a user pool.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html
CloudformationResource:: AWS::Cognito::UserPoolDomain
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_domain_props_mixin = cognito.CfnUserPoolDomainPropsMixin(cognito.CfnUserPoolDomainMixinProps(
    custom_domain_config=cognito.CfnUserPoolDomainPropsMixin.CustomDomainConfigTypeProperty(
        certificate_arn="certificateArn"
    ),
    domain="domain",
    managed_login_version=123,
    routing=cognito.CfnUserPoolDomainPropsMixin.RoutingTypeProperty(
        failover=cognito.CfnUserPoolDomainPropsMixin.FailoverTypeProperty(
            primary_route53_health_check_id="primaryRoute53HealthCheckId",
            secondary_region="secondaryRegion"
        )
    ),
    user_pool_id="userPoolId"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::Cognito::UserPoolDomain.

Parameters:

props (Union[CfnUserPoolDomainMixinProps, 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 = ['customDomainConfig', 'domain', 'managedLoginVersion', 'routing', 'userPoolId']

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.

CustomDomainConfigTypeProperty

class CfnUserPoolDomainPropsMixin.CustomDomainConfigTypeProperty(*, certificate_arn=None)

Bases: object

The configuration for a hosted UI custom domain.

Parameters:: certificate_arn (Optional[str]) – The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooldomain-customdomainconfigtype.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_domain_config_type_property = cognito.CfnUserPoolDomainPropsMixin.CustomDomainConfigTypeProperty(
    certificate_arn="certificateArn"
)

Attributes

certificate_arn

The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate.

You use this certificate for the subdomain of your custom domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooldomain-customdomainconfigtype.html#cfn-cognito-userpooldomain-customdomainconfigtype-certificatearn

FailoverTypeProperty

class CfnUserPoolDomainPropsMixin.FailoverTypeProperty(*, primary_route53_health_check_id=None, secondary_region=None)

Bases: object

Parameters:

primary_route53_health_check_id (Optional[str])
secondary_region (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooldomain-failovertype.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

failover_type_property = cognito.CfnUserPoolDomainPropsMixin.FailoverTypeProperty(
    primary_route53_health_check_id="primaryRoute53HealthCheckId",
    secondary_region="secondaryRegion"
)

Attributes

primary_route53_health_check_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooldomain-failovertype.html#cfn-cognito-userpooldomain-failovertype-primaryroute53healthcheckid

Type:: see

secondary_region

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooldomain-failovertype.html#cfn-cognito-userpooldomain-failovertype-secondaryregion

Type:: see

RoutingTypeProperty

class CfnUserPoolDomainPropsMixin.RoutingTypeProperty(*, failover=None)

Bases: object

Parameters:: failover (Union[IResolvable, FailoverTypeProperty, Dict[str, Any], None])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooldomain-routingtype.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

routing_type_property = cognito.CfnUserPoolDomainPropsMixin.RoutingTypeProperty(
    failover=cognito.CfnUserPoolDomainPropsMixin.FailoverTypeProperty(
        primary_route53_health_check_id="primaryRoute53HealthCheckId",
        secondary_region="secondaryRegion"
    )
)

Attributes

failover

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooldomain-routingtype.html#cfn-cognito-userpooldomain-routingtype-failover

Type:: see