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 for use by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source. For requirements and additional information about setting up certificates, see Get Certificates Ready in AWS Certificate Manager in the API Gateway Developer Guide .

  • domain_name (Optional[str]) – The custom domain name for your API. Uppercase letters are not supported.

  • endpoint_configuration (Union[IResolvable, EndpointConfigurationProperty, None]) – A list of the endpoint types of the domain name.

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

  • 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 for use by the regional endpoint for the domain name. AWS Certificate Manager is the only supported source.

  • security_policy (Optional[str]) – The Transport Layer Security (TLS) version + cipher suite for this domain name. Valid values include TLS_1_0 and TLS_1_2 .

  • tags (Optional[Sequence[CfnTag]]) – An array of arbitrary tags (key-value pairs) to associate with the domain name.

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 for use by the edge-optimized endpoint for this domain name.

AWS Certificate Manager is the only supported source. For requirements and additional information about setting up certificates, see Get Certificates Ready in AWS Certificate Manager in the API Gateway Developer Guide .

Link

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

Return type

Optional[str]

domain_name

The custom domain name for your API.

Uppercase letters are not supported.

Link

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

Return type

Optional[str]

endpoint_configuration

A list of 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

Return type

Union[IResolvable, EndpointConfigurationProperty, 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-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication

Return type

Union[IResolvable, MutualTlsAuthenticationProperty, None]

ownership_verification_certificate_arn

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.

Link

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

Return type

Optional[str]

regional_certificate_arn

The reference to an AWS -managed certificate for use by the regional endpoint for the 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-regionalcertificatearn

Return type

Optional[str]

security_policy

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

Valid values include TLS_1_0 and TLS_1_2 .

Link

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

Return type

Optional[str]

tags

An array of arbitrary tags (key-value pairs) to associate with the domain name.

Link

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

Return type

Optional[List[CfnTag]]