Package software.amazon.awscdk.services.apigateway

Class DomainNameProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • mapping

      @Stability(Stable) public DomainNameProps.Builder mapping(IRestApi mapping)
      Sets the value of DomainNameProps.getMapping()
      Parameters:
      mapping - If specified, all requests to this domain will be mapped to the production deployment of this API. If you wish to map this domain to multiple APIs with different base paths, use addBasePathMapping or addApiMapping.
      Returns:
      this

    • certificate

      @Stability(Stable) public DomainNameProps.Builder certificate(ICertificateRef certificate)
      Sets the value of DomainNameOptions.getCertificate()
      Parameters:
      certificate - The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name. This parameter is required. For "EDGE" domain names, the certificate needs to be in the US East (N. Virginia) region.
      Returns:
      this

    • domainName

      @Stability(Stable) public DomainNameProps.Builder domainName(String domainName)
      Sets the value of DomainNameOptions.getDomainName()
      Parameters:
      domainName - The custom domain name for your API. This parameter is required. Uppercase letters are not supported.
      Returns:
      this

    • basePath

      @Stability(Stable) public DomainNameProps.Builder basePath(String basePath)
      Sets the value of DomainNameOptions.getBasePath()
      Parameters:
      basePath - The base path name that callers of the API must provide in the URL after the domain name (e.g. example.com/base-path). If you specify this property, it can't be an empty string.
      Returns:
      this

    • endpointAccessMode

      @Stability(Stable) public DomainNameProps.Builder endpointAccessMode(EndpointAccessMode endpointAccessMode)
      Sets the value of DomainNameOptions.getEndpointAccessMode()
      Parameters:
      endpointAccessMode - The endpoint access mode for this domain name. When using enhanced security policies (those starting with SecurityPolicy_), you must specify this property. STRICT is recommended for production workloads, but BASIC may be needed during migration or for certain application architectures.
      Returns:
      this

    • endpointType

      @Stability(Stable) public DomainNameProps.Builder endpointType(EndpointType endpointType)
      Sets the value of DomainNameOptions.getEndpointType()
      Parameters:
      endpointType - The type of endpoint for this DomainName.
      Returns:
      this

    • mtls

      @Stability(Stable) public DomainNameProps.Builder mtls(MTLSConfig mtls)
      Sets the value of DomainNameOptions.getMtls()
      Parameters:
      mtls - The mutual TLS authentication configuration for a custom domain name.
      Returns:
      this

    • securityPolicy

      @Stability(Stable) public DomainNameProps.Builder securityPolicy(SecurityPolicy securityPolicy)
      Sets the value of DomainNameOptions.getSecurityPolicy()
      Parameters:
      securityPolicy - The Transport Layer Security (TLS) version + cipher suite for this domain name.
      Returns:
      this

    • build

      @Stability(Stable) public DomainNameProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<DomainNameProps>
      Returns:
      a new instance of DomainNameProps
      Throws:
      NullPointerException - if any required attribute was not provided