Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Class CfnDomainNameV2PropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnDomainNameV2PropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDomainNameV2PropsMixin>

Enclosing class:

CfnDomainNameV2PropsMixin

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

A fluent builder for CfnDomainNameV2PropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnDomainNameV2PropsMixin	build()
CfnDomainNameV2PropsMixin.Builder	certificateArn(String certificateArn)	The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name.
static CfnDomainNameV2PropsMixin.Builder	create()
static CfnDomainNameV2PropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnDomainNameV2PropsMixin.Builder	domainName(String domainName)	Represents a custom domain name as a user-friendly host name of an API (RestApi).
CfnDomainNameV2PropsMixin.Builder	endpointAccessMode(String endpointAccessMode)	The endpoint access mode for your DomainName.
CfnDomainNameV2PropsMixin.Builder	endpointConfiguration(CfnDomainNameV2PropsMixin.EndpointConfigurationProperty 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.
CfnDomainNameV2PropsMixin.Builder	endpointConfiguration(IResolvable 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.
CfnDomainNameV2PropsMixin.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.
CfnDomainNameV2PropsMixin.Builder	routingMode(String routingMode)	The routing mode for this domain name.
CfnDomainNameV2PropsMixin.Builder	securityPolicy(String securityPolicy)	The Transport Layer Security (TLS) version + cipher suite for this DomainName.
CfnDomainNameV2PropsMixin.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 CfnDomainNameV2PropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnDomainNameV2PropsMixin.Builder.

create

@Stability(Stable)
public static CfnDomainNameV2PropsMixin.Builder create()

Returns:

a new instance of CfnDomainNameV2PropsMixin.Builder.

certificateArn

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

endpointAccessMode

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

The endpoint access mode for your DomainName.

Parameters:

endpointAccessMode - The endpoint access mode for your 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-endpointaccessmode

endpointConfiguration

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

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. 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 CfnDomainNameV2PropsMixin.Builder endpointConfiguration(CfnDomainNameV2PropsMixin.EndpointConfigurationProperty 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.

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. 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 CfnDomainNameV2PropsMixin.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

routingMode

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

Default: - "BASE_PATH_MAPPING_ONLY"

Parameters:

routingMode - The routing mode 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-routingmode

securityPolicy

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

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

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 CfnDomainNameV2PropsMixin.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 CfnDomainNameV2PropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnDomainNameV2PropsMixin.