CfnServicePropsMixin

class aws_cdk.mixins_preview.aws_vpclattice.mixins.CfnServicePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a service.

A service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC).

For more information, see Services in the Amazon VPC Lattice User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html

CloudformationResource:

AWS::VpcLattice::Service

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_vpclattice import mixins as vpclattice_mixins

cfn_service_props_mixin = vpclattice_mixins.CfnServicePropsMixin(vpclattice_mixins.CfnServiceMixinProps(
    auth_type="authType",
    certificate_arn="certificateArn",
    custom_domain_name="customDomainName",
    dns_entry=vpclattice_mixins.CfnServicePropsMixin.DnsEntryProperty(
        domain_name="domainName",
        hosted_zone_id="hostedZoneId"
    ),
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::VpcLattice::Service.

Parameters:
  • props (Union[CfnServiceMixinProps, 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 = ['authType', 'certificateArn', 'customDomainName', 'dnsEntry', 'name', '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

DnsEntryProperty

class CfnServicePropsMixin.DnsEntryProperty(*, domain_name=None, hosted_zone_id=None)

Bases: object

Describes the DNS information of a service.

Parameters:
  • domain_name (Optional[str]) – The domain name of the service.

  • hosted_zone_id (Optional[str]) – The ID of the hosted zone.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-service-dnsentry.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_vpclattice import mixins as vpclattice_mixins

dns_entry_property = vpclattice_mixins.CfnServicePropsMixin.DnsEntryProperty(
    domain_name="domainName",
    hosted_zone_id="hostedZoneId"
)

Attributes

domain_name

The domain name of the service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-service-dnsentry.html#cfn-vpclattice-service-dnsentry-domainname

hosted_zone_id

The ID of the hosted zone.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-service-dnsentry.html#cfn-vpclattice-service-dnsentry-hostedzoneid