software.amazon.awscdk.services.apigateway

Class CfnBasePathMappingProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnBasePathMappingProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnBasePathMappingProps>

Enclosing interface:

CfnBasePathMappingProps

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

A builder for CfnBasePathMappingProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnBasePathMappingProps.Builder	basePath(String basePath) Sets the value of CfnBasePathMappingProps.getBasePath()
CfnBasePathMappingProps	build() Builds the configured instance.
CfnBasePathMappingProps.Builder	domainName(String domainName) Sets the value of CfnBasePathMappingProps.getDomainName()
CfnBasePathMappingProps.Builder	id(String id) Sets the value of CfnBasePathMappingProps.getId()
CfnBasePathMappingProps.Builder	restApiId(String restApiId) Sets the value of CfnBasePathMappingProps.getRestApiId()
CfnBasePathMappingProps.Builder	stage(String stage) Sets the value of CfnBasePathMappingProps.getStage()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

domainName

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

Sets the value of CfnBasePathMappingProps.getDomainName()

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 CfnBasePathMappingProps.Builder basePath(String basePath)

Sets the value of CfnBasePathMappingProps.getBasePath()

Parameters:

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

Returns:

this

id

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

Sets the value of CfnBasePathMappingProps.getId()

Parameters:

id - `AWS::ApiGateway::BasePathMapping.Id`.

Returns:

this

restApiId

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

Sets the value of CfnBasePathMappingProps.getRestApiId()

Parameters:

restApiId - The ID of the API.

Returns:

this

stage

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

Sets the value of CfnBasePathMappingProps.getStage()

Parameters:

stage - The name of the API's stage.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnBasePathMappingProps

Throws:

NullPointerException - if any required attribute was not provided