CfnUserPoolDomainPropsMixin

class aws_cdk.mixins_preview.aws_cognito.mixins.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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_cognito import mixins as cognito_mixins

cfn_user_pool_domain_props_mixin = cognito_mixins.CfnUserPoolDomainPropsMixin(cognito_mixins.CfnUserPoolDomainMixinProps(
    custom_domain_config=cognito_mixins.CfnUserPoolDomainPropsMixin.CustomDomainConfigTypeProperty(
        certificate_arn="certificateArn"
    ),
    domain="domain",
    managed_login_version=123,
    user_pool_id="userPoolId"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnUserPoolDomainMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['customDomainConfig', 'domain', 'managedLoginVersion', 'userPoolId']

Static Methods

classmethod is_mixin(x)

(experimental) 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.
Stability:: experimental

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.mixins_preview.aws_cognito import mixins as cognito_mixins

custom_domain_config_type_property = cognito_mixins.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