DomainNameV2Args

data class DomainNameV2Args(val certificateArn: Output<String>? = null, val domainName: Output<String>? = null, val endpointConfiguration: Output<DomainNameV2EndpointConfigurationArgs>? = null, val policy: Output<Any>? = null, val routingMode: Output<DomainNameV2RoutingMode>? = null, val securityPolicy: Output<String>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<DomainNameV2Args>

Resource Type definition for AWS::ApiGateway::DomainNameV2.

Constructors

Link copied to clipboard
constructor(certificateArn: Output<String>? = null, domainName: Output<String>? = null, endpointConfiguration: Output<DomainNameV2EndpointConfigurationArgs>? = null, policy: Output<Any>? = null, routingMode: Output<DomainNameV2RoutingMode>? = 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 the private endpoint for this domain name. AWS Certificate Manager is the only supported source.

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

Represents a custom domain name as a user-friendly host name of an API (RestApi).

Link copied to clipboard

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.

Link copied to clipboard
val policy: Output<Any>? = null

A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. You can use Fn::ToJsonString to enter your policy . For more information, see Fn::ToJsonString . Search the CloudFormation User Guide for AWS::ApiGateway::DomainNameV2 for more information about the expected schema for this property.

Link copied to clipboard

The valid routing modes are BASE_PATH_MAPPING_ONLY, ROUTING_RULE_THEN_BASE_PATH_MAPPING and ROUTING_RULE_ONLY. All other inputs are invalid.

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

The Transport Layer Security (TLS) version + cipher suite for this DomainName. Only TLS_1_2 is supported.

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(): DomainNameV2Args