Package software.amazon.awscdk.services.apigateway

Class CfnDomainNameV2.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnDomainNameV2.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDomainNameV2>

Enclosing class:

CfnDomainNameV2

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

A fluent builder for CfnDomainNameV2.

Method Summary

Modifier and Type	Method	Description
CfnDomainNameV2	build()
CfnDomainNameV2.Builder	certificateArn(String certificateArn)	The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name.
static CfnDomainNameV2.Builder	create(software.constructs.Construct scope, String id)
CfnDomainNameV2.Builder	domainName(String domainName)	Represents a custom domain name as a user-friendly host name of an API (RestApi).
CfnDomainNameV2.Builder	endpointConfiguration(IResolvable endpointConfiguration)	The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
CfnDomainNameV2.Builder	endpointConfiguration(CfnDomainNameV2.EndpointConfigurationProperty endpointConfiguration)	The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
CfnDomainNameV2.Builder	policy(Object policy)	A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration.
CfnDomainNameV2.Builder	securityPolicy(String securityPolicy)	The Transport Layer Security (TLS) version + cipher suite for this DomainName.
CfnDomainNameV2.Builder	tags(List<? extends CfnTag> tags)	The collection of tags.

Methods inherited from class java.lang.Object

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

Method Details

create

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

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnDomainNameV2.Builder.

certificateArn

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

Parameters:

certificateArn - The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-certificatearn

domainName

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-domainname

endpointConfiguration

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

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.

Parameters:

endpointConfiguration - The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-endpointconfiguration

endpointConfiguration

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

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.

Parameters:

endpointConfiguration - The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-endpointconfiguration

policy

@Stability(Stable)
public CfnDomainNameV2.Builder policy(Object 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 .

Parameters:

policy - A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-policy

securityPolicy

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

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

Only TLS_1_2 is supported.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-securitypolicy

tags

@Stability(Stable)
public CfnDomainNameV2.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-tags

build

@Stability(Stable)
public CfnDomainNameV2 build()

Specified by:

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

Returns:

a newly built instance of CfnDomainNameV2.