CfnDomainNameV2PropsMixin

class aws_cdk.mixins_preview.aws_apigateway.mixins.CfnDomainNameV2PropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::ApiGateway::DomainNameV2 resource specifies a custom domain name for your private APIs in API Gateway.

You can use a private custom domain name to provide a URL for your private API that’s more intuitive and easier to recall.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html
CloudformationResource:: AWS::ApiGateway::DomainNameV2
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_apigateway import mixins as apigateway_mixins

# policy: Any

cfn_domain_name_v2_props_mixin = apigateway_mixins.CfnDomainNameV2PropsMixin(apigateway_mixins.CfnDomainNameV2MixinProps(
    certificate_arn="certificateArn",
    domain_name="domainName",
    endpoint_access_mode="endpointAccessMode",
    endpoint_configuration=apigateway_mixins.CfnDomainNameV2PropsMixin.EndpointConfigurationProperty(
        ip_address_type="ipAddressType",
        types=["types"]
    ),
    policy=policy,
    routing_mode="routingMode",
    security_policy="securityPolicy",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ApiGateway::DomainNameV2.

Parameters:

props (Union[CfnDomainNameV2MixinProps, 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 = ['certificateArn', 'domainName', 'endpointAccessMode', 'endpointConfiguration', 'policy', 'routingMode', 'securityPolicy', '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

EndpointConfigurationProperty

class CfnDomainNameV2PropsMixin.EndpointConfigurationProperty(*, ip_address_type=None, types=None)

Bases: object

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.

Parameters:

ip_address_type (Optional[str]) – The IP address types that can invoke an API (RestApi) or a DomainName. Use ipv4 to allow only IPv4 addresses to invoke an API or DomainName, or use dualstack to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the PRIVATE endpoint type, only dualstack is supported.
types (Optional[Sequence[str]]) – A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE" . For a regional API and its custom domain name, the endpoint type is REGIONAL . For a private API, the endpoint type is PRIVATE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainnamev2-endpointconfiguration.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_apigateway import mixins as apigateway_mixins

endpoint_configuration_property = apigateway_mixins.CfnDomainNameV2PropsMixin.EndpointConfigurationProperty(
    ip_address_type="ipAddressType",
    types=["types"]
)

Attributes

ip_address_type

The IP address types that can invoke an API (RestApi) or a DomainName.

Use ipv4 to allow only IPv4 addresses to invoke an API or DomainName, or use dualstack to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the PRIVATE endpoint type, only dualstack is supported.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainnamev2-endpointconfiguration.html#cfn-apigateway-domainnamev2-endpointconfiguration-ipaddresstype

types

A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).

For an edge-optimized API and its custom domain name, the endpoint type is "EDGE" . For a regional API and its custom domain name, the endpoint type is REGIONAL . For a private API, the endpoint type is PRIVATE .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainnamev2-endpointconfiguration.html#cfn-apigateway-domainnamev2-endpointconfiguration-types