Package software.amazon.awscdk.services.apigateway

Class BasePathMappingProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.BasePathMappingProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BasePathMappingProps>

Enclosing interface:

BasePathMappingProps

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

A builder for BasePathMappingProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BasePathMappingProps.Builder	basePath(String basePath)	Sets the value of BasePathMappingOptions.getBasePath()
BasePathMappingProps	build()	Builds the configured instance.
BasePathMappingProps.Builder	domainName(IDomainName domainName)	Sets the value of BasePathMappingProps.getDomainName()
BasePathMappingProps.Builder	restApi(IRestApi restApi)	Sets the value of BasePathMappingProps.getRestApi()
BasePathMappingProps.Builder	stage(Stage stage)	Sets the value of BasePathMappingOptions.getStage()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

domainName

@Stability(Stable)
public BasePathMappingProps.Builder domainName(IDomainName domainName)

Sets the value of BasePathMappingProps.getDomainName()

Parameters:

domainName - The DomainName to associate with this base path mapping. This parameter is required.

Returns:

this

restApi

@Stability(Stable)
public BasePathMappingProps.Builder restApi(IRestApi restApi)

Sets the value of BasePathMappingProps.getRestApi()

Parameters:

restApi - The RestApi resource to target. This parameter is required.

Returns:

this

basePath

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

Sets the value of BasePathMappingOptions.getBasePath()

Parameters:

basePath - The base path name that callers of the API must provide in the URL after the domain name (e.g. example.com/base-path). If you specify this property, it can't be an empty string.

Returns:

this

stage

@Stability(Stable)
public BasePathMappingProps.Builder stage(Stage stage)

Sets the value of BasePathMappingOptions.getStage()

Parameters:

stage - The Deployment stage of API [disable-awslint:ref-via-interface].

Returns:

this

build

@Stability(Stable)
public BasePathMappingProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of BasePathMappingProps

Throws:

NullPointerException - if any required attribute was not provided