DomainConfiguration

The configuration required to generate AWS::ApiGateway::DomainNameAccessAssociation resource.

AWS SAM generates an AWS::ApiGateway::DomainNameAccessAssociation resource when this property is set. For information about generated AWS CloudFormation resources, see Generated AWS CloudFormation resources for AWS SAM.

Type: DomainAccessAssociation

Required: No

AWS CloudFormation compatibility: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent.

A list of the basepaths to configure with the Amazon API Gateway domain name.

Type: List

Required: No

Default: /

AWS CloudFormation compatibility: This property is similar to the BasePath property of an AWS::ApiGateway::BasePathMapping resource. AWS SAM creates multiple AWS::ApiGateway::BasePathMapping resources, one per BasePath specified in this property.

The Amazon Resource Name (ARN) of an AWS managed certificate this domain name's endpoint. AWS Certificate Manager is the only supported source.

Type: String

Required: Yes

AWS CloudFormation compatibility: This property is similar to the CertificateArn property of an AWS::ApiGateway::DomainName resource. If EndpointConfiguration is set to REGIONAL (the default value), CertificateArn maps to RegionalCertificateArn in AWS::ApiGateway::DomainName. If the EndpointConfiguration is set to EDGE, CertificateArn maps to CertificateArn in AWS::ApiGateway::DomainName. If EndpointConfiguration is set to PRIVATE, this property is passed to the AWS::ApiGateway::DomainNameV2 resource.

Additional notes: For an EDGE endpoint, you must create the certificate in the us-east-1 AWS Region.

The custom domain name for your API Gateway API. Uppercase letters are not supported.

AWS SAM generates an AWS::ApiGateway::DomainName resource when this property is set. For information about this scenario, see DomainName property is specified. For information about generated AWS CloudFormation resources, see Generated AWS CloudFormation resources for AWS SAM.

Type: String

Required: Yes

AWS CloudFormation compatibility: This property is passed directly to the DomainName property of an AWS::ApiGateway::DomainName resource, or to AWS::ApiGateway::DomainNameV2 when EndpointConfiguration is set to PRIVATE.

Defines the type of API Gateway endpoint to map to the custom domain. The value of this property determines how the CertificateArn property is mapped in AWS CloudFormation.

Valid values: EDGE, REGIONAL, or PRIVATE

Type: String

Required: No

Default: REGIONAL

AWS CloudFormation compatibility: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent.

The mutual Transport Layer Security (TLS) authentication configuration for a custom domain name.

Type: MutualTlsAuthentication

Required: No

AWS CloudFormation compatibility: This property is passed directly to the MutualTlsAuthentication property of an AWS::ApiGateway::DomainName resource.

Indicates whether non-alphanumeric characters are allowed in basepaths defined by the BasePath property. When set to True, non-alphanumeric characters are removed from basepaths.

Use NormalizeBasePath with the BasePath property.

Type: Boolean

Required: No

Default: True

AWS CloudFormation compatibility: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent.

The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Required only when you configure mutual TLS and you specify an ACM imported or private CA certificate ARN for the CertificateArn.

Type: String

Required: No

AWS CloudFormation compatibility: This property is passed directly to the OwnershipVerificationCertificateArn property of an AWS::ApiGateway::DomainName resource.

The IAM policy to attach to the API Gateway domain name. Only applicable when EndpointConfiguration is set to PRIVATE.

Type: Json

Required: No

AWS CloudFormation compatibility: This property is passed directly to the Policy property of an AWS::ApiGateway::DomainNameV2 resource when EndpointConfiguration is set to PRIVATE. For examples of valid policy documents, see AWS::ApiGateway::DomainNameV2.

Defines an Amazon Route 53 configuration.

Type: Route53Configuration

Required: No

AWS CloudFormation compatibility: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent.

The TLS version plus cipher suite for this domain name.

Type: String

Required: No

AWS CloudFormation compatibility: This property is passed directly to the SecurityPolicy property of an AWS::ApiGateway::DomainName resource, or to AWS::ApiGateway::DomainNameV2 when EndpointConfiguration is set to PRIVATE. For PRIVATE endpoints, only TLS_1_2 is supported.