Package 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(Stable) public static final class CfnBasePathMapping.Builder extends Object implements software.amazon.jsii.Builder<CfnBasePathMapping>
A fluent builder for CfnBasePathMapping.

  • Method Details

    • create

      @Stability(Stable) public static CfnBasePathMapping.Builder create(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(Stable) public CfnBasePathMapping.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

    • basePath

      @Stability(Stable) public CfnBasePathMapping.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

    • id

      @Stability(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(Stable) public CfnBasePathMapping.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

    • stage

      @Stability(Stable) public CfnBasePathMapping.Builder stage(String stage)
      The name of the associated stage.

      Parameters:
      stage - The name of the associated stage. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnBasePathMapping build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnBasePathMapping>
      Returns:
      a newly built instance of CfnBasePathMapping.