DomainNameArgs

data class DomainNameArgs(val certificateArn: Output<String>? = null, val domainName: Output<String>? = null, val endpointConfiguration: Output<DomainNameEndpointConfigurationArgs>? = null, val mutualTlsAuthentication: Output<DomainNameMutualTlsAuthenticationArgs>? = null, val ownershipVerificationCertificateArn: Output<String>? = null, val regionalCertificateArn: Output<String>? = null, val routingMode: Output<DomainNameRoutingMode>? = null, val securityPolicy: Output<String>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<DomainNameArgs>

The `AWS::ApiGateway::DomainName` resource specifies a custom domain name for your API in API Gateway. You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide.

Example Usage

Example

No Java example available.

Example

No Java example available.

Constructors

Link copied to clipboard
constructor(certificateArn: Output<String>? = null, domainName: Output<String>? = null, endpointConfiguration: Output<DomainNameEndpointConfigurationArgs>? = null, mutualTlsAuthentication: Output<DomainNameMutualTlsAuthenticationArgs>? = null, ownershipVerificationCertificateArn: Output<String>? = null, regionalCertificateArn: Output<String>? = null, routingMode: Output<DomainNameRoutingMode>? = null, securityPolicy: Output<String>? = null, tags: Output<List<TagArgs>>? = null)

Properties

Link copied to clipboard
val certificateArn: Output<String>? = null

The reference to an AWS -managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. AWS Certificate Manager is the only supported source.

Link copied to clipboard
val domainName: Output<String>? = null

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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 copied to clipboard
val regionalCertificateArn: Output<String>? = null

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.

Link copied to clipboard
val routingMode: Output<DomainNameRoutingMode>? = null
Link copied to clipboard
val securityPolicy: Output<String>? = null

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2 .

Link copied to clipboard
val tags: Output<List<TagArgs>>? = null

The collection of tags. Each tag element is associated with a given resource.

Functions

Link copied to clipboard
open override fun toJava(): DomainNameArgs