CfnDomainNameV2Props

class aws_cdk.aws_apigateway.CfnDomainNameV2Props(*, certificate_arn=None, domain_name=None, endpoint_configuration=None, policy=None, security_policy=None, tags=None)

Bases: object

Properties for defining a CfnDomainNameV2.

Parameters:

certificate_arn (Optional[str]) – The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name. AWS Certificate Manager is the only supported source.
domain_name (Optional[str]) – Represents a custom domain name as a user-friendly host name of an API (RestApi).
endpoint_configuration (Union[IResolvable, EndpointConfigurationProperty, Dict[str, Any], None]) – The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
policy (Any) – A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. You can use Fn::ToJsonString to enter your policy . For more information, see Fn::ToJsonString .
security_policy (Optional[str]) – The Transport Layer Security (TLS) version + cipher suite for this DomainName. Only TLS_1_2 is supported.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The collection of tags. Each tag element is associated with a given resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.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 import aws_apigateway as apigateway

# policy: Any

cfn_domain_name_v2_props = apigateway.CfnDomainNameV2Props(
    certificate_arn="certificateArn",
    domain_name="domainName",
    endpoint_configuration=apigateway.CfnDomainNameV2.EndpointConfigurationProperty(
        types=["types"]
    ),
    policy=policy,
    security_policy="securityPolicy",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

certificate_arn

The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name.

AWS Certificate Manager is the only supported source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-certificatearn

domain_name

Represents a custom domain name as a user-friendly host name of an API (RestApi).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-domainname

endpoint_configuration

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.

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

policy

A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration.

You can use Fn::ToJsonString to enter your policy . For more information, see Fn::ToJsonString .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-policy

security_policy

The Transport Layer Security (TLS) version + cipher suite for this DomainName.

Only TLS_1_2 is supported.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-securitypolicy

tags

The collection of tags.

Each tag element is associated with a given resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-tags