Interface CfnDomainName.DomainNameConfigurationProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnDomainName.DomainNameConfigurationProperty extends
The DomainNameConfiguration property type specifies the configuration for a an API's domain name.

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


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 DomainNameConfigurationProperty domainNameConfigurationProperty = DomainNameConfigurationProperty.builder()
  • 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.

    • 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.
    • getEndpointType

      @Stability(Stable) @Nullable default String getEndpointType()
      The endpoint type.
    • 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.

    • 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 .

    • builder

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