Package software.amazon.awscdk.services.apigateway

Class CfnDomainName.Builder

java.lang.Object
software.amazon.awscdk.services.apigateway.CfnDomainName.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDomainName>
Enclosing class:
CfnDomainName
@Stability(Stable) public static final class CfnDomainName.Builder extends Object implements software.amazon.jsii.Builder<CfnDomainName>
A fluent builder for CfnDomainName.

  • Method Details

    • create

      @Stability(Stable) public static CfnDomainName.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnDomainName.Builder.

    • certificateArn

      @Stability(Stable) public CfnDomainName.Builder certificateArn(String certificateArn)
      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.

      Parameters:
      certificateArn - The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name. This parameter is required.
      Returns:
      this

    • domainName

      @Stability(Stable) public CfnDomainName.Builder domainName(String domainName)
      The custom domain name as an API host name, for example, my-api.example.com .

      Parameters:
      domainName - The custom domain name as an API host name, for example, my-api.example.com . This parameter is required.
      Returns:
      this

    • endpointConfiguration

      @Stability(Stable) public CfnDomainName.Builder endpointConfiguration(IResolvable endpointConfiguration)
      The endpoint configuration of this DomainName showing the endpoint types of the domain name.

      Parameters:
      endpointConfiguration - The endpoint configuration of this DomainName showing the endpoint types of the domain name. This parameter is required.
      Returns:
      this

    • endpointConfiguration

      @Stability(Stable) public CfnDomainName.Builder endpointConfiguration(CfnDomainName.EndpointConfigurationProperty endpointConfiguration)
      The endpoint configuration of this DomainName showing the endpoint types of the domain name.

      Parameters:
      endpointConfiguration - The endpoint configuration of this DomainName showing the endpoint types of the domain name. This parameter is required.
      Returns:
      this

    • mutualTlsAuthentication

      @Stability(Stable) public CfnDomainName.Builder mutualTlsAuthentication(IResolvable mutualTlsAuthentication)
      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.

      Parameters:
      mutualTlsAuthentication - The mutual TLS authentication configuration for a custom domain name. This parameter is required.
      Returns:
      this

    • mutualTlsAuthentication

      @Stability(Stable) public CfnDomainName.Builder mutualTlsAuthentication(CfnDomainName.MutualTlsAuthenticationProperty mutualTlsAuthentication)
      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.

      Parameters:
      mutualTlsAuthentication - The mutual TLS authentication configuration for a custom domain name. This parameter is required.
      Returns:
      this

    • ownershipVerificationCertificateArn

      @Stability(Stable) public CfnDomainName.Builder ownershipVerificationCertificateArn(String ownershipVerificationCertificateArn)
      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.

      Parameters:
      ownershipVerificationCertificateArn - The ARN of the public certificate issued by ACM to validate ownership of your custom domain. This parameter is required.
      Returns:
      this

    • regionalCertificateArn

      @Stability(Stable) public CfnDomainName.Builder regionalCertificateArn(String regionalCertificateArn)
      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.

      Parameters:
      regionalCertificateArn - The reference to an AWS -managed certificate that will be used for validating the regional domain name. This parameter is required.
      Returns:
      this

    • securityPolicy

      @Stability(Stable) public CfnDomainName.Builder securityPolicy(String securityPolicy)
      The Transport Layer Security (TLS) version + cipher suite for this DomainName.

      The valid values are TLS_1_0 and TLS_1_2 .

      Parameters:
      securityPolicy - The Transport Layer Security (TLS) version + cipher suite for this DomainName. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnDomainName.Builder tags(List<? extends CfnTag> tags)
      The collection of tags.

      Each tag element is associated with a given resource.

      Parameters:
      tags - The collection of tags. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnDomainName build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDomainName>
      Returns:
      a newly built instance of CfnDomainName.