Package software.amazon.awscdk.services.apigateway

Class CfnDomainNameV2Props.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnDomainNameV2Props.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDomainNameV2Props>

Enclosing interface:

CfnDomainNameV2Props

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

A builder for CfnDomainNameV2Props

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDomainNameV2Props	build()	Builds the configured instance.
CfnDomainNameV2Props.Builder	certificateArn(String certificateArn)	Sets the value of CfnDomainNameV2Props.getCertificateArn()
CfnDomainNameV2Props.Builder	domainName(String domainName)	Sets the value of CfnDomainNameV2Props.getDomainName()
CfnDomainNameV2Props.Builder	endpointAccessMode(String endpointAccessMode)	Sets the value of CfnDomainNameV2Props.getEndpointAccessMode()
CfnDomainNameV2Props.Builder	endpointConfiguration(IResolvable endpointConfiguration)	Sets the value of CfnDomainNameV2Props.getEndpointConfiguration()
CfnDomainNameV2Props.Builder	endpointConfiguration(CfnDomainNameV2.EndpointConfigurationProperty endpointConfiguration)	Sets the value of CfnDomainNameV2Props.getEndpointConfiguration()
CfnDomainNameV2Props.Builder	policy(Object policy)	Sets the value of CfnDomainNameV2Props.getPolicy()
CfnDomainNameV2Props.Builder	routingMode(String routingMode)	Sets the value of CfnDomainNameV2Props.getRoutingMode()
CfnDomainNameV2Props.Builder	securityPolicy(String securityPolicy)	Sets the value of CfnDomainNameV2Props.getSecurityPolicy()
CfnDomainNameV2Props.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnDomainNameV2Props.getTags()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

certificateArn

@Stability(Stable)
public CfnDomainNameV2Props.Builder certificateArn(String certificateArn)

Sets the value of CfnDomainNameV2Props.getCertificateArn()

Parameters:

certificateArn - The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name. AWS Certificate Manager is the only supported source.

Returns:

this

domainName

@Stability(Stable)
public CfnDomainNameV2Props.Builder domainName(String domainName)

Sets the value of CfnDomainNameV2Props.getDomainName()

Parameters:

domainName - Represents a custom domain name as a user-friendly host name of an API (RestApi).

Returns:

this

endpointAccessMode

@Stability(Stable)
public CfnDomainNameV2Props.Builder endpointAccessMode(String endpointAccessMode)

Sets the value of CfnDomainNameV2Props.getEndpointAccessMode()

Parameters:

endpointAccessMode - The endpoint access mode for your DomainName.

Returns:

this

endpointConfiguration

@Stability(Stable)
public CfnDomainNameV2Props.Builder endpointConfiguration(IResolvable endpointConfiguration)

Sets the value of CfnDomainNameV2Props.getEndpointConfiguration()

Parameters:

endpointConfiguration - The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.

Returns:

this

endpointConfiguration

@Stability(Stable)
public CfnDomainNameV2Props.Builder endpointConfiguration(CfnDomainNameV2.EndpointConfigurationProperty endpointConfiguration)

Sets the value of CfnDomainNameV2Props.getEndpointConfiguration()

Parameters:

endpointConfiguration - The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.

Returns:

this

policy

@Stability(Stable)
public CfnDomainNameV2Props.Builder policy(Object policy)

Sets the value of CfnDomainNameV2Props.getPolicy()

Parameters:

policy - A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. You can use Fn::ToJsonString to enter your policy . For more information, see Fn::ToJsonString .

Returns:

this

routingMode

@Stability(Stable)
public CfnDomainNameV2Props.Builder routingMode(String routingMode)

Sets the value of CfnDomainNameV2Props.getRoutingMode()

Parameters:

routingMode - The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your private APIs.

Returns:

this

securityPolicy

@Stability(Stable)
public CfnDomainNameV2Props.Builder securityPolicy(String securityPolicy)

Sets the value of CfnDomainNameV2Props.getSecurityPolicy()

Parameters:

securityPolicy - The Transport Layer Security (TLS) version + cipher suite for this DomainName.

Returns:

this

tags

@Stability(Stable)
public CfnDomainNameV2Props.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnDomainNameV2Props.getTags()

Parameters:

tags - The collection of tags. Each tag element is associated with a given resource.

Returns:

this

build

@Stability(Stable)
public CfnDomainNameV2Props build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDomainNameV2Props

Throws:

NullPointerException - if any required attribute was not provided