Package software.amazon.awscdk.services.apigateway

Class CfnBasePathMappingV2Props.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnBasePathMappingV2Props.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnBasePathMappingV2Props>

Enclosing interface:

CfnBasePathMappingV2Props

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

A builder for CfnBasePathMappingV2Props

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnBasePathMappingV2Props.Builder	basePath(String basePath)	Sets the value of CfnBasePathMappingV2Props.getBasePath()
CfnBasePathMappingV2Props	build()	Builds the configured instance.
CfnBasePathMappingV2Props.Builder	domainNameArn(String domainNameArn)	Sets the value of CfnBasePathMappingV2Props.getDomainNameArn()
CfnBasePathMappingV2Props.Builder	restApiId(String restApiId)	Sets the value of CfnBasePathMappingV2Props.getRestApiId()
CfnBasePathMappingV2Props.Builder	stage(String stage)	Sets the value of CfnBasePathMappingV2Props.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

domainNameArn

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

Sets the value of CfnBasePathMappingV2Props.getDomainNameArn()

Parameters:

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

Returns:

this

restApiId

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

Sets the value of CfnBasePathMappingV2Props.getRestApiId()

Parameters:

restApiId - The private API's identifier. This parameter is required. This identifier is unique across all of your APIs in API Gateway.

Returns:

this

basePath

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

Sets the value of CfnBasePathMappingV2Props.getBasePath()

Parameters:

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

Returns:

this

stage

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

Sets the value of CfnBasePathMappingV2Props.getStage()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public CfnBasePathMappingV2Props build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnBasePathMappingV2Props

Throws:

NullPointerException - if any required attribute was not provided