Package software.amazon.awscdk.services.apigateway

Interface CfnDomainNameProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDomainNameProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.804Z") @Stability(Stable) public interface CfnDomainNameProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnDomainName.

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.apigateway.*;
 CfnDomainNameProps cfnDomainNameProps = CfnDomainNameProps.builder()
         .certificateArn("certificateArn")
         .domainName("domainName")
         .endpointConfiguration(EndpointConfigurationProperty.builder()
                 .types(List.of("types"))
                 .build())
         .mutualTlsAuthentication(MutualTlsAuthenticationProperty.builder()
                 .truststoreUri("truststoreUri")
                 .truststoreVersion("truststoreVersion")
                 .build())
         .ownershipVerificationCertificateArn("ownershipVerificationCertificateArn")
         .regionalCertificateArn("regionalCertificateArn")
         .securityPolicy("securityPolicy")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Method Details

    • getCertificateArn

      @Stability(Stable) @Nullable default String getCertificateArn()
      The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name.

      AWS Certificate Manager is the only supported source.

    • getDomainName

      @Stability(Stable) @Nullable default String getDomainName()
      The custom domain name as an API host name, for example, my-api.example.com .

    • getEndpointConfiguration

      @Stability(Stable) @Nullable default Object getEndpointConfiguration()
      The endpoint configuration of this DomainName showing the endpoint types of the domain name.

    • getMutualTlsAuthentication

      @Stability(Stable) @Nullable default Object getMutualTlsAuthentication()
      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.

    • getOwnershipVerificationCertificateArn

      @Stability(Stable) @Nullable default String getOwnershipVerificationCertificateArn()
      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.

    • getRegionalCertificateArn

      @Stability(Stable) @Nullable default String getRegionalCertificateArn()
      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.

    • getSecurityPolicy

      @Stability(Stable) @Nullable default String getSecurityPolicy()
      The Transport Layer Security (TLS) version + cipher suite for this DomainName.

      The valid values are TLS_1_0 and TLS_1_2 .

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      The collection of tags.

      Each tag element is associated with a given resource.

    • builder

      @Stability(Stable) static CfnDomainNameProps.Builder builder()
      Returns:
      a CfnDomainNameProps.Builder of CfnDomainNameProps