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

Class CfnBasePathMappingV2PropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnBasePathMappingV2PropsMixin>

Enclosing class:

CfnBasePathMappingV2PropsMixin

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

A fluent builder for CfnBasePathMappingV2PropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnBasePathMappingV2PropsMixin.Builder	basePath(String basePath)	The base path name that callers of the private API must provide as part of the URL after the domain name.
CfnBasePathMappingV2PropsMixin	build()
static CfnBasePathMappingV2PropsMixin.Builder	create()
static CfnBasePathMappingV2PropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnBasePathMappingV2PropsMixin.Builder	domainNameArn(String domainNameArn)	The ARN of the domain name for the BasePathMappingV2 resource to be described.
CfnBasePathMappingV2PropsMixin.Builder	restApiId(String restApiId)	The private API's identifier.
CfnBasePathMappingV2PropsMixin.Builder	stage(String stage)	Represents a unique identifier for a version of a deployed private RestApi that is callable by users.

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 CfnBasePathMappingV2PropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnBasePathMappingV2PropsMixin.Builder.

create

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

Returns:

a new instance of CfnBasePathMappingV2PropsMixin.Builder.

basePath

@Stability(Stable)
public CfnBasePathMappingV2PropsMixin.Builder basePath(String basePath)

The base path name that callers of the private API must provide as part of the URL after the domain name.

Parameters:

basePath - The base path name that callers of the private API must provide as part of the URL after the domain name. This parameter is required.

Returns:

this

See Also:

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

domainNameArn

@Stability(Stable)
public CfnBasePathMappingV2PropsMixin.Builder domainNameArn(String domainNameArn)

The ARN of the domain name for the BasePathMappingV2 resource to be described.

Parameters:

domainNameArn - The ARN of the domain name for the BasePathMappingV2 resource to be described. This parameter is required.

Returns:

this

See Also:

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

restApiId

@Stability(Stable)
public CfnBasePathMappingV2PropsMixin.Builder restApiId(String restApiId)

The private API's identifier.

This identifier is unique across all of your APIs in API Gateway.

Parameters:

restApiId - The private API's identifier. This parameter is required.

Returns:

this

See Also:

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

stage

@Stability(Stable)
public CfnBasePathMappingV2PropsMixin.Builder stage(String stage)

Represents a unique identifier for a version of a deployed private RestApi that is callable by users.

The Stage must depend on the RestApi 's stage. To create a dependency, add a DependsOn attribute to the BasePathMappingV2 resource.

Parameters:

stage - Represents a unique identifier for a version of a deployed private RestApi that is callable by users. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnBasePathMappingV2PropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnBasePathMappingV2PropsMixin.