software.amazon.awscdk.services.apigateway

Class DomainName.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.DomainName.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DomainName>

Enclosing class:

DomainName

@Stability(value=Stable)
public static final class DomainName.Builder
extends Object
implements software.amazon.jsii.Builder<DomainName>

A fluent builder for DomainName.

Method Summary

Modifier and Type	Method and Description
DomainName.Builder	basePath(String basePath) The base path name that callers of the API must provide in the URL after the domain name (e.g.
DomainName	build()
DomainName.Builder	certificate(ICertificate certificate) The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name.
static DomainName.Builder	create(software.constructs.Construct scope, String id)
DomainName.Builder	domainName(String domainName) The custom domain name for your API.
DomainName.Builder	endpointType(EndpointType endpointType) The type of endpoint for this DomainName.
DomainName.Builder	mapping(IRestApi mapping) If specified, all requests to this domain will be mapped to the production deployment of this API.
DomainName.Builder	mtls(MTLSConfig mtls) The mutual TLS authentication configuration for a custom domain name.
DomainName.Builder	securityPolicy(SecurityPolicy securityPolicy) The Transport Layer Security (TLS) version + cipher suite for this domain name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static DomainName.Builder create(software.constructs.Construct scope,
                                                                 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of DomainName.Builder.

certificate

@Stability(value=Stable)
public DomainName.Builder certificate(ICertificate certificate)

The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name.

For "EDGE" domain names, the certificate needs to be in the US East (N. Virginia) region.

Parameters:

certificate - The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name. This parameter is required.

Returns:

this

domainName

@Stability(value=Stable)
public DomainName.Builder domainName(String domainName)

The custom domain name for your API.

Uppercase letters are not supported.

Parameters:

domainName - The custom domain name for your API. This parameter is required.

Returns:

this

basePath

@Stability(value=Stable)
public DomainName.Builder basePath(String 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.

Default: - map requests from the domain root (e.g. `example.com`). If this is undefined, no additional mappings will be allowed on this domain name.

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. This parameter is required.

Returns:

this

endpointType

@Stability(value=Stable)
public DomainName.Builder endpointType(EndpointType endpointType)

The type of endpoint for this DomainName.

Default: REGIONAL

Parameters:

endpointType - The type of endpoint for this DomainName. This parameter is required.

Returns:

this

mtls

@Stability(value=Stable)
public DomainName.Builder mtls(MTLSConfig mtls)

The mutual TLS authentication configuration for a custom domain name.

Default: - mTLS is not configured.

Parameters:

mtls - The mutual TLS authentication configuration for a custom domain name. This parameter is required.

Returns:

this

securityPolicy

@Stability(value=Stable)
public DomainName.Builder securityPolicy(SecurityPolicy securityPolicy)

The Transport Layer Security (TLS) version + cipher suite for this domain name.

Default: SecurityPolicy.TLS_1_0

Parameters:

securityPolicy - The Transport Layer Security (TLS) version + cipher suite for this domain name. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html

mapping

@Stability(value=Stable)
public DomainName.Builder mapping(IRestApi 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, don't specify this option and use addBasePathMapping.

Default: - you will have to call `addBasePathMapping` to map this domain to API endpoints.

Parameters:

mapping - If specified, all requests to this domain will be mapped to the production deployment of this API. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public DomainName build()

Specified by:

build in interface software.amazon.jsii.Builder<DomainName>