CfnDomainNameProps

class aws_cdk.aws_apigateway.CfnDomainNameProps(*, certificate_arn=None, domain_name=None, endpoint_configuration=None, mutual_tls_authentication=None, ownership_verification_certificate_arn=None, regional_certificate_arn=None, security_policy=None, tags=None)

Bases: object

Properties for defining a CfnDomainName.

Parameters:

certificate_arn (Optional[str]) – The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
domain_name (Optional[str]) – The custom domain name as an API host name, for example, my-api.example.com .
endpoint_configuration (Union[IResolvable, EndpointConfigurationProperty, Dict[str, Any], None]) – The endpoint configuration of this DomainName showing the endpoint types of the domain name.
mutual_tls_authentication (Union[IResolvable, MutualTlsAuthenticationProperty, Dict[str, Any], None]) – The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
ownership_verification_certificate_arn (Optional[str]) – The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.
regional_certificate_arn (Optional[str]) – The reference to an AWS -managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
security_policy (Optional[str]) – The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2 .
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The collection of tags. Each tag element is associated with a given resource.

Link:

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

cfn_domain_name_props = apigateway.CfnDomainNameProps(
    certificate_arn="certificateArn",
    domain_name="domainName",
    endpoint_configuration=apigateway.CfnDomainName.EndpointConfigurationProperty(
        types=["types"]
    ),
    mutual_tls_authentication=apigateway.CfnDomainName.MutualTlsAuthenticationProperty(
        truststore_uri="truststoreUri",
        truststore_version="truststoreVersion"
    ),
    ownership_verification_certificate_arn="ownershipVerificationCertificateArn",
    regional_certificate_arn="regionalCertificateArn",
    security_policy="securityPolicy",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

certificate_arn

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

AWS Certificate Manager is the only supported source.

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

domain_name

The custom domain name as an API host name, for example, my-api.example.com .

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

endpoint_configuration

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

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

mutual_tls_authentication

The mutual TLS authentication configuration for a custom domain name.

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.