CfnDistributionTenantPropsMixin

class aws_cdk.mixins_preview.aws_cloudfront.mixins.CfnDistributionTenantPropsMixin(props, *, strategy=None)

Bases: Mixin

The distribution tenant.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html
CloudformationResource:: AWS::CloudFront::DistributionTenant
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_cloudfront import mixins as cloudfront_mixins

cfn_distribution_tenant_props_mixin = cloudfront_mixins.CfnDistributionTenantPropsMixin(cloudfront_mixins.CfnDistributionTenantMixinProps(
    connection_group_id="connectionGroupId",
    customizations=cloudfront_mixins.CfnDistributionTenantPropsMixin.CustomizationsProperty(
        certificate=cloudfront_mixins.CfnDistributionTenantPropsMixin.CertificateProperty(
            arn="arn"
        ),
        geo_restrictions=cloudfront_mixins.CfnDistributionTenantPropsMixin.GeoRestrictionCustomizationProperty(
            locations=["locations"],
            restriction_type="restrictionType"
        ),
        web_acl=cloudfront_mixins.CfnDistributionTenantPropsMixin.WebAclCustomizationProperty(
            action="action",
            arn="arn"
        )
    ),
    distribution_id="distributionId",
    domains=["domains"],
    enabled=False,
    managed_certificate_request=cloudfront_mixins.CfnDistributionTenantPropsMixin.ManagedCertificateRequestProperty(
        certificate_transparency_logging_preference="certificateTransparencyLoggingPreference",
        primary_domain_name="primaryDomainName",
        validation_token_host="validationTokenHost"
    ),
    name="name",
    parameters=[cloudfront_mixins.CfnDistributionTenantPropsMixin.ParameterProperty(
        name="name",
        value="value"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::CloudFront::DistributionTenant.

Parameters:

props (Union[CfnDistributionTenantMixinProps, 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 = ['connectionGroupId', 'customizations', 'distributionId', 'domains', 'enabled', 'managedCertificateRequest', 'name', 'parameters', 'tags']

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

CertificateProperty

class CfnDistributionTenantPropsMixin.CertificateProperty(*, arn=None)

Bases: object

The Certificate Manager (ACM) certificate associated with your distribution.

Parameters:: arn (Optional[str]) – The Amazon Resource Name (ARN) of the ACM certificate.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-certificate.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_cloudfront import mixins as cloudfront_mixins

certificate_property = cloudfront_mixins.CfnDistributionTenantPropsMixin.CertificateProperty(
    arn="arn"
)

Attributes

arn

The Amazon Resource Name (ARN) of the ACM certificate.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-certificate.html#cfn-cloudfront-distributiontenant-certificate-arn

CustomizationsProperty

class CfnDistributionTenantPropsMixin.CustomizationsProperty(*, certificate=None, geo_restrictions=None, web_acl=None)

Bases: object

Customizations for the distribution tenant.

For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and AWS WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.

Parameters:

certificate (Union[IResolvable, CertificateProperty, Dict[str, Any], None]) – The Certificate Manager (ACM) certificate.
geo_restrictions (Union[IResolvable, GeoRestrictionCustomizationProperty, Dict[str, Any], None]) – The geographic restrictions.
web_acl (Union[IResolvable, WebAclCustomizationProperty, Dict[str, Any], None]) – The AWS WAF web ACL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-customizations.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_cloudfront import mixins as cloudfront_mixins

customizations_property = cloudfront_mixins.CfnDistributionTenantPropsMixin.CustomizationsProperty(
    certificate=cloudfront_mixins.CfnDistributionTenantPropsMixin.CertificateProperty(
        arn="arn"
    ),
    geo_restrictions=cloudfront_mixins.CfnDistributionTenantPropsMixin.GeoRestrictionCustomizationProperty(
        locations=["locations"],
        restriction_type="restrictionType"
    ),
    web_acl=cloudfront_mixins.CfnDistributionTenantPropsMixin.WebAclCustomizationProperty(
        action="action",
        arn="arn"
    )
)

Attributes

certificate

The Certificate Manager (ACM) certificate.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-customizations.html#cfn-cloudfront-distributiontenant-customizations-certificate

geo_restrictions

The geographic restrictions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-customizations.html#cfn-cloudfront-distributiontenant-customizations-georestrictions

web_acl

The AWS WAF web ACL.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-customizations.html#cfn-cloudfront-distributiontenant-customizations-webacl

DomainResultProperty

class CfnDistributionTenantPropsMixin.DomainResultProperty(*, domain=None, status=None)

Bases: object

The details about the domain result.

Parameters:

domain (Optional[str]) – The specified domain.
status (Optional[str]) – Whether the domain is active or inactive.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-domainresult.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_cloudfront import mixins as cloudfront_mixins

domain_result_property = cloudfront_mixins.CfnDistributionTenantPropsMixin.DomainResultProperty(
    domain="domain",
    status="status"
)

Attributes

domain

The specified domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-domainresult.html#cfn-cloudfront-distributiontenant-domainresult-domain

status

Whether the domain is active or inactive.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-domainresult.html#cfn-cloudfront-distributiontenant-domainresult-status

GeoRestrictionCustomizationProperty

class CfnDistributionTenantPropsMixin.GeoRestrictionCustomizationProperty(*, locations=None, restriction_type=None)

Bases: object

The customizations that you specified for the distribution tenant for geographic restrictions.

Parameters:

locations (Optional[Sequence[str]]) – The locations for geographic restrictions.
restriction_type (Optional[str]) – The method that you want to use to restrict distribution of your content by country:. - none : No geographic restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist : The Location elements specify the countries in which you don’t want CloudFront to distribute your content. - whitelist : The Location elements specify the countries in which you want CloudFront to distribute your content.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-georestrictioncustomization.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_cloudfront import mixins as cloudfront_mixins

geo_restriction_customization_property = cloudfront_mixins.CfnDistributionTenantPropsMixin.GeoRestrictionCustomizationProperty(
    locations=["locations"],
    restriction_type="restrictionType"
)

Attributes

locations

The locations for geographic restrictions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-georestrictioncustomization.html#cfn-cloudfront-distributiontenant-georestrictioncustomization-locations

restriction_type

.

none : No geographic restriction is enabled, meaning access to content is not restricted by client geo location.
blacklist : The Location elements specify the countries in which you don’t want CloudFront to distribute your content.
whitelist : The Location elements specify the countries in which you want CloudFront to distribute your content.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-georestrictioncustomization.html#cfn-cloudfront-distributiontenant-georestrictioncustomization-restrictiontype
Type:: The method that you want to use to restrict distribution of your content by country

ManagedCertificateRequestProperty

class CfnDistributionTenantPropsMixin.ManagedCertificateRequestProperty(*, certificate_transparency_logging_preference=None, primary_domain_name=None, validation_token_host=None)

Bases: object

An object that represents the request for the Amazon CloudFront managed ACM certificate.

Parameters:

certificate_transparency_logging_preference (Optional[str]) – You can opt out of certificate transparency logging by specifying the disabled option. Opt in by specifying enabled . For more information, see Certificate Transparency Logging in the Certificate Manager User Guide .
primary_domain_name (Optional[str]) – The primary domain name associated with the CloudFront managed ACM certificate.
validation_token_host (Optional[str]) – Specify how the HTTP validation token will be served when requesting the CloudFront managed ACM certificate. - For cloudfront , CloudFront will automatically serve the validation token. Choose this mode if you can point the domain’s DNS to CloudFront immediately. - For self-hosted , you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-managedcertificaterequest.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_cloudfront import mixins as cloudfront_mixins

managed_certificate_request_property = cloudfront_mixins.CfnDistributionTenantPropsMixin.ManagedCertificateRequestProperty(
    certificate_transparency_logging_preference="certificateTransparencyLoggingPreference",
    primary_domain_name="primaryDomainName",
    validation_token_host="validationTokenHost"
)

Attributes

certificate_transparency_logging_preference

You can opt out of certificate transparency logging by specifying the disabled option.

Opt in by specifying enabled . For more information, see Certificate Transparency Logging in the Certificate Manager User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-managedcertificaterequest.html#cfn-cloudfront-distributiontenant-managedcertificaterequest-certificatetransparencyloggingpreference

primary_domain_name

The primary domain name associated with the CloudFront managed ACM certificate.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-managedcertificaterequest.html#cfn-cloudfront-distributiontenant-managedcertificaterequest-primarydomainname

validation_token_host

Specify how the HTTP validation token will be served when requesting the CloudFront managed ACM certificate.

For cloudfront , CloudFront will automatically serve the validation token. Choose this mode if you can point the domain’s DNS to CloudFront immediately.
For self-hosted , you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-managedcertificaterequest.html#cfn-cloudfront-distributiontenant-managedcertificaterequest-validationtokenhost

ParameterProperty

class CfnDistributionTenantPropsMixin.ParameterProperty(*, name=None, value=None)

Bases: object

A list of parameter values to add to the resource.

A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

Parameters:

name (Optional[str]) – The parameter name.
value (Optional[str]) – The parameter value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-parameter.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_cloudfront import mixins as cloudfront_mixins

parameter_property = cloudfront_mixins.CfnDistributionTenantPropsMixin.ParameterProperty(
    name="name",
    value="value"
)

Attributes

name

The parameter name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-parameter.html#cfn-cloudfront-distributiontenant-parameter-name

value

The parameter value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-parameter.html#cfn-cloudfront-distributiontenant-parameter-value

WebAclCustomizationProperty

class CfnDistributionTenantPropsMixin.WebAclCustomizationProperty(*, action=None, arn=None)

Bases: object

The AWS WAF web ACL customization specified for the distribution tenant.

Parameters:

action (Optional[str]) – The action for the AWS WAF web ACL customization. You can specify override to specify a separate AWS WAF web ACL for the distribution tenant. If you specify disable , the distribution tenant won’t have AWS WAF web ACL protections and won’t inherit from the multi-tenant distribution.
arn (Optional[str]) – The Amazon Resource Name (ARN) of the AWS WAF web ACL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-webaclcustomization.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_cloudfront import mixins as cloudfront_mixins

web_acl_customization_property = cloudfront_mixins.CfnDistributionTenantPropsMixin.WebAclCustomizationProperty(
    action="action",
    arn="arn"
)

Attributes

action

The action for the AWS WAF web ACL customization.

You can specify override to specify a separate AWS WAF web ACL for the distribution tenant. If you specify disable , the distribution tenant won’t have AWS WAF web ACL protections and won’t inherit from the multi-tenant distribution.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-webaclcustomization.html#cfn-cloudfront-distributiontenant-webaclcustomization-action

arn

The Amazon Resource Name (ARN) of the AWS WAF web ACL.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distributiontenant-webaclcustomization.html#cfn-cloudfront-distributiontenant-webaclcustomization-arn