Package software.amazon.awscdk.services.apigatewayv2

Interface CfnDomainName.DomainNameConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainName.DomainNameConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDomainName

@Stability(Stable)
public static interface CfnDomainName.DomainNameConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The DomainNameConfiguration property type specifies the configuration for an API's domain name.

DomainNameConfiguration is a property of the AWS::ApiGatewayV2::DomainName resource.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigatewayv2.*;
 DomainNameConfigurationProperty domainNameConfigurationProperty = DomainNameConfigurationProperty.builder()
         .certificateArn("certificateArn")
         .certificateName("certificateName")
         .endpointType("endpointType")
         .ownershipVerificationCertificateArn("ownershipVerificationCertificateArn")
         .securityPolicy("securityPolicy")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomainName.DomainNameConfigurationProperty.Builder	A builder for CfnDomainName.DomainNameConfigurationProperty
static final class	CfnDomainName.DomainNameConfigurationProperty.Jsii$Proxy	An implementation for CfnDomainName.DomainNameConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDomainName.DomainNameConfigurationProperty.Builder	builder()
default String	getCertificateArn()	An AWS -managed certificate that will be used by the edge-optimized endpoint for this domain name.
default String	getCertificateName()	The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
default String	getEndpointType()	The endpoint type.
default String	getOwnershipVerificationCertificateArn()	The Amazon resource name (ARN) for the public certificate issued by AWS Certificate Manager .
default String	getSecurityPolicy()	The Transport Layer Security (TLS) version of the security policy for this domain name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCertificateArn

@Stability(Stable)
@Nullable
default String getCertificateArn()

An AWS -managed certificate that will be used by the edge-optimized endpoint for this domain name.

AWS Certificate Manager is the only supported source.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-certificatearn

getCertificateName

@Stability(Stable)
@Nullable
default String getCertificateName()

The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-certificatename

getEndpointType

@Stability(Stable)
@Nullable
default String getEndpointType()

The endpoint type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-endpointtype

getOwnershipVerificationCertificateArn

@Stability(Stable)
@Nullable
default String getOwnershipVerificationCertificateArn()

The Amazon resource name (ARN) for the public certificate issued by AWS Certificate Manager .

This ARN is used to validate custom domain ownership. It's required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-ownershipverificationcertificatearn

getSecurityPolicy

@Stability(Stable)
@Nullable
default String getSecurityPolicy()

The Transport Layer Security (TLS) version of the security policy for this domain name.

The valid values are TLS_1_0 and TLS_1_2 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-securitypolicy

builder

@Stability(Stable)
static CfnDomainName.DomainNameConfigurationProperty.Builder builder()

Returns:

a CfnDomainName.DomainNameConfigurationProperty.Builder of CfnDomainName.DomainNameConfigurationProperty