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

Class CfnBasePathMappingPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnBasePathMappingPropsMixin>

Enclosing class:

CfnBasePathMappingPropsMixin

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

A fluent builder for CfnBasePathMappingPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnBasePathMappingPropsMixin.Builder	basePath(String basePath)	The base path name that callers of the API must provide as part of the URL after the domain name.
CfnBasePathMappingPropsMixin	build()
static CfnBasePathMappingPropsMixin.Builder	create()
static CfnBasePathMappingPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnBasePathMappingPropsMixin.Builder	domainName(String domainName)	The domain name of the BasePathMapping resource to be described.
CfnBasePathMappingPropsMixin.Builder	domainName(IDomainNameRef domainName)	The domain name of the BasePathMapping resource to be described.
CfnBasePathMappingPropsMixin.Builder	id(String id)
CfnBasePathMappingPropsMixin.Builder	restApiId(String restApiId)	The string identifier of the associated RestApi.
CfnBasePathMappingPropsMixin.Builder	restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnBasePathMappingPropsMixin.Builder	stage(String stage)	The name of the associated stage.
CfnBasePathMappingPropsMixin.Builder	stage(IStageRef stage)	The name of the associated stage.

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

Parameters:

options - Mixin options.

Returns:

a new instance of CfnBasePathMappingPropsMixin.Builder.

create

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

Returns:

a new instance of CfnBasePathMappingPropsMixin.Builder.

basePath

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

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

Parameters:

basePath - The base path name that callers of the 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-basepathmapping.html#cfn-apigateway-basepathmapping-basepath

domainName

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

The domain name of the BasePathMapping resource to be described.

Parameters:

domainName - The domain name of the BasePathMapping resource to be described. This parameter is required.

Returns:

this

See Also:

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

domainName

@Stability(Stable)
public CfnBasePathMappingPropsMixin.Builder domainName(IDomainNameRef domainName)

The domain name of the BasePathMapping resource to be described.

Parameters:

domainName - The domain name of the BasePathMapping resource to be described. This parameter is required.

Returns:

this

See Also:

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

id

@Stability(Stable)
public CfnBasePathMappingPropsMixin.Builder id(String id)

Parameters:

id - This parameter is required.

Returns:

this

See Also:

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

restApiId

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

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi. This parameter is required.

Returns:

this

See Also:

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

restApiId

@Stability(Stable)
public CfnBasePathMappingPropsMixin.Builder restApiId(IRestApiRef restApiId)

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi. This parameter is required.

Returns:

this

See Also:

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

stage

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

The name of the associated stage.

Parameters:

stage - The name of the associated stage. This parameter is required.

Returns:

this

See Also:

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

stage

@Stability(Stable)
public CfnBasePathMappingPropsMixin.Builder stage(IStageRef stage)

The name of the associated stage.

Parameters:

stage - The name of the associated stage. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnBasePathMappingPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnBasePathMappingPropsMixin.