CfnDomainPropsMixin

class aws_cdk.mixins_preview.aws_lightsail.mixins.CfnDomainPropsMixin(props, *, strategy=None)

Bases: Mixin

Describes a domain where you are storing recordsets.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-domain.html
CloudformationResource:: AWS::Lightsail::Domain
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

from aws_cdk import CfnTag
# 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_lightsail import mixins as lightsail_mixins

cfn_domain_props_mixin = lightsail_mixins.CfnDomainPropsMixin(lightsail_mixins.CfnDomainMixinProps(
    domain_entries=[lightsail_mixins.CfnDomainPropsMixin.DomainEntryProperty(
        id="id",
        is_alias=False,
        name="name",
        target="target",
        type="type"
    )],
    domain_name="domainName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Lightsail::Domain.

Parameters:

props (Union[CfnDomainMixinProps, 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 = ['domainEntries', 'domainName', '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

DomainEntryProperty

class CfnDomainPropsMixin.DomainEntryProperty(*, id=None, is_alias=None, name=None, target=None, type=None)

Bases: object

Describes a domain recordset entry.

Parameters:

id (Optional[str]) – The ID of the domain recordset entry.
is_alias (Union[bool, IResolvable, None]) – When true , specifies whether the domain entry is an alias used by the Lightsail load balancer, Lightsail container service, Lightsail content delivery network (CDN) distribution, or another AWS resource. You can include an alias (A type) record in your request, which points to the DNS name of a load balancer, container service, CDN distribution, or other AWS resource and routes traffic to that resource.
name (Optional[str]) – The name of the domain.
target (Optional[str]) – The target IP address ( 192.0.2.0 ), or AWS name server ( ns-111.awsdns-22.com. ). For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com . For Lightsail distributions, the value looks like exampled1182ne.cloudfront.net . For Lightsail container services, the value looks like container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com . Be sure to also set isAlias to true when setting up an A record for a Lightsail load balancer, distribution, or container service.
type (Optional[str]) – The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT). The following domain entry types can be used: - A - AAAA - CNAME - MX - NS - SOA - SRV - TXT

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-domain-domainentry.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_lightsail import mixins as lightsail_mixins

domain_entry_property = lightsail_mixins.CfnDomainPropsMixin.DomainEntryProperty(
    id="id",
    is_alias=False,
    name="name",
    target="target",
    type="type"
)

Attributes

id

The ID of the domain recordset entry.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-domain-domainentry.html#cfn-lightsail-domain-domainentry-id

is_alias

When true , specifies whether the domain entry is an alias used by the Lightsail load balancer, Lightsail container service, Lightsail content delivery network (CDN) distribution, or another AWS resource.

You can include an alias (A type) record in your request, which points to the DNS name of a load balancer, container service, CDN distribution, or other AWS resource and routes traffic to that resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-domain-domainentry.html#cfn-lightsail-domain-domainentry-isalias

name

The name of the domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-domain-domainentry.html#cfn-lightsail-domain-domainentry-name

target

The target IP address ( 192.0.2.0 ), or AWS name server ( ns-111.awsdns-22.com. ).

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com . For Lightsail distributions, the value looks like exampled1182ne.cloudfront.net . For Lightsail container services, the value looks like container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com . Be sure to also set isAlias to true when setting up an A record for a Lightsail load balancer, distribution, or container service.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-domain-domainentry.html#cfn-lightsail-domain-domainentry-target

type

The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The following domain entry types can be used:

A
AAAA
CNAME
MX
NS
SOA
SRV
TXT

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-domain-domainentry.html#cfn-lightsail-domain-domainentry-type

LocationProperty

class CfnDomainPropsMixin.LocationProperty(*, availability_zone=None, region_name=None)

Bases: object

The AWS Region and Availability Zone where the domain was created (read-only).

Parameters:

availability_zone (Optional[str]) – The Availability Zone.
region_name (Optional[str]) – The AWS Region name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-domain-location.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_lightsail import mixins as lightsail_mixins

location_property = lightsail_mixins.CfnDomainPropsMixin.LocationProperty(
    availability_zone="availabilityZone",
    region_name="regionName"
)

Attributes

availability_zone

The Availability Zone.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-domain-location.html#cfn-lightsail-domain-location-availabilityzone

region_name

The AWS Region name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-domain-location.html#cfn-lightsail-domain-location-regionname