software.amazon.awscdk.services.apigateway

Class CfnBasePathMapping.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnBasePathMapping.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnBasePathMapping>

Enclosing class:

CfnBasePathMapping

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

A fluent builder for CfnBasePathMapping.

Method Summary

Modifier and Type	Method and Description
CfnBasePathMapping.Builder	basePath(String basePath) The base path name that callers of the API must provide in the URL after the domain name.
CfnBasePathMapping	build()
static CfnBasePathMapping.Builder	create(software.constructs.Construct scope, String id)
CfnBasePathMapping.Builder	domainName(String domainName) The `DomainName` of an [AWS::ApiGateway::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) resource.
CfnBasePathMapping.Builder	id(String id) `AWS::ApiGateway::BasePathMapping.Id`.
CfnBasePathMapping.Builder	restApiId(String restApiId) The ID of the API.
CfnBasePathMapping.Builder	stage(String stage) The name of the API's stage.

Methods inherited from class java.lang.Object

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

Method Detail

create

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

Parameters:

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

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnBasePathMapping.Builder.

domainName

@Stability(value=Stable)
public CfnBasePathMapping.Builder domainName(String domainName)

The `DomainName` of an [AWS::ApiGateway::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) resource.

Parameters:

domainName - The `DomainName` of an [AWS::ApiGateway::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) resource. This parameter is required.

Returns:

this

basePath

@Stability(value=Stable)
public CfnBasePathMapping.Builder basePath(String basePath)

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

Parameters:

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

Returns:

this

id

@Stability(value=Stable)
public CfnBasePathMapping.Builder id(String id)

`AWS::ApiGateway::BasePathMapping.Id`.

Parameters:

id - `AWS::ApiGateway::BasePathMapping.Id`. This parameter is required.

Returns:

this

restApiId

@Stability(value=Stable)
public CfnBasePathMapping.Builder restApiId(String restApiId)

The ID of the API.

Parameters:

restApiId - The ID of the API. This parameter is required.

Returns:

this

stage

@Stability(value=Stable)
public CfnBasePathMapping.Builder stage(String stage)

The name of the API's stage.

Parameters:

stage - The name of the API's stage. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnBasePathMapping build()

Specified by:

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