CfnDomainNameProps

class aws_cdk.aws_apigatewayv2.CfnDomainNameProps(*, domain_name, domain_name_configurations=None, mutual_tls_authentication=None, tags=None)

Bases: object

Properties for defining a CfnDomainName.

Parameters
  • domain_name (str) – The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.

  • domain_name_configurations (Union[IResolvable, Sequence[Union[IResolvable, DomainNameConfigurationProperty, Dict[str, Any]]], None]) – The domain name configurations.

  • mutual_tls_authentication (Union[IResolvable, MutualTlsAuthenticationProperty, Dict[str, Any], None]) – The mutual TLS authentication configuration for a custom domain name.

  • tags (Optional[Any]) – The collection of tags associated with a domain name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigatewayv2 as apigatewayv2

# tags: Any

cfn_domain_name_props = apigatewayv2.CfnDomainNameProps(
    domain_name="domainName",

    # the properties below are optional
    domain_name_configurations=[apigatewayv2.CfnDomainName.DomainNameConfigurationProperty(
        certificate_arn="certificateArn",
        certificate_name="certificateName",
        endpoint_type="endpointType",
        ownership_verification_certificate_arn="ownershipVerificationCertificateArn",
        security_policy="securityPolicy"
    )],
    mutual_tls_authentication=apigatewayv2.CfnDomainName.MutualTlsAuthenticationProperty(
        truststore_uri="truststoreUri",
        truststore_version="truststoreVersion"
    ),
    tags=tags
)

Attributes

domain_name

The custom domain name for your API in Amazon API Gateway.

Uppercase letters are not supported.

Link

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

Return type

str

domain_name_configurations

The domain name configurations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainnameconfigurations

Return type

Union[IResolvable, List[Union[IResolvable, DomainNameConfigurationProperty]], None]

mutual_tls_authentication

The mutual TLS authentication configuration for a custom domain name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-mutualtlsauthentication

Return type

Union[IResolvable, MutualTlsAuthenticationProperty, None]

tags

The collection of tags associated with a domain name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-tags

Return type

Any