Package software.amazon.awscdk.services.apigateway

Class CfnBasePathMapping

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.apigateway.CfnBasePathMapping
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.754Z") @Stability(Stable) public class CfnBasePathMapping extends CfnResource implements IInspectable
A CloudFormation AWS::ApiGateway::BasePathMapping.

The AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your API must use in the invocation URL.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 CfnBasePathMapping cfnBasePathMapping = CfnBasePathMapping.Builder.create(this, "MyCfnBasePathMapping")
         .domainName("domainName")
         // the properties below are optional
         .basePath("basePath")
         .id("id")
         .restApiId("restApiId")
         .stage("stage")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnBasePathMapping

      protected CfnBasePathMapping(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnBasePathMapping

      protected CfnBasePathMapping(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnBasePathMapping

      @Stability(Stable) public CfnBasePathMapping(@NotNull Construct scope, @NotNull String id, @NotNull CfnBasePathMappingProps props)
      Create a new AWS::ApiGateway::BasePathMapping.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDomainName

      @Stability(Stable) @NotNull public String getDomainName()
      The domain name of the BasePathMapping resource to be described.

    • setDomainName

      @Stability(Stable) public void setDomainName(@NotNull String value)
      The domain name of the BasePathMapping resource to be described.

    • getBasePath

      @Stability(Stable) @Nullable public String getBasePath()
      The base path name that callers of the API must provide as part of the URL after the domain name.

    • setBasePath

      @Stability(Stable) public void setBasePath(@Nullable String value)
      The base path name that callers of the API must provide as part of the URL after the domain name.

    • getId

      @Stability(Stable) @Nullable public String getId()
      AWS::ApiGateway::BasePathMapping.Id.

    • setId

      @Stability(Stable) public void setId(@Nullable String value)
      AWS::ApiGateway::BasePathMapping.Id.

    • getRestApiId

      @Stability(Stable) @Nullable public String getRestApiId()
      The string identifier of the associated RestApi.

    • setRestApiId

      @Stability(Stable) public void setRestApiId(@Nullable String value)
      The string identifier of the associated RestApi.

    • getStage

      @Stability(Stable) @Nullable public String getStage()
      The name of the associated stage.

    • setStage

      @Stability(Stable) public void setStage(@Nullable String value)
      The name of the associated stage.