Package com.hashicorp.cdktf.providers.aws.api_gateway_base_path_mapping

Class ApiGatewayBasePathMapping

  • All Implemented Interfaces:
    com.hashicorp.cdktf.IInterpolatingParent, com.hashicorp.cdktf.ITerraformAddressable, com.hashicorp.cdktf.ITerraformDependable, com.hashicorp.cdktf.ITerraformResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
    @Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-30T04:56:50.181Z")
@Stability(Stable)
public class ApiGatewayBasePathMapping
extends com.hashicorp.cdktf.TerraformResource
    Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/api_gateway_base_path_mapping aws_api_gateway_base_path_mapping}.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ApiGatewayBasePathMapping.Builder
      A fluent builder for ApiGatewayBasePathMapping.

      • Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

        software.amazon.jsii.JsiiObject.InitializationMode

      • Nested classes/interfaces inherited from interface software.constructs.IConstruct

        software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

      • Nested classes/interfaces inherited from interface com.hashicorp.cdktf.IInterpolatingParent

        com.hashicorp.cdktf.IInterpolatingParent.Jsii$Default, com.hashicorp.cdktf.IInterpolatingParent.Jsii$Proxy

      • Nested classes/interfaces inherited from interface com.hashicorp.cdktf.ITerraformDependable

        com.hashicorp.cdktf.ITerraformDependable.Jsii$Default, com.hashicorp.cdktf.ITerraformDependable.Jsii$Proxy

      • Nested classes/interfaces inherited from interface com.hashicorp.cdktf.ITerraformResource

        com.hashicorp.cdktf.ITerraformResource.Jsii$Default, com.hashicorp.cdktf.ITerraformResource.Jsii$Proxy

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getApiId()  
      String getApiIdInput()  
      String getBasePath()  
      String getBasePathInput()  
      String getDomainName()  
      String getDomainNameInput()  
      String getId()  
      String getIdInput()  
      String getStageName()  
      String getStageNameInput()  
      void resetBasePath()  
      void resetId()  
      void resetStageName()  
      void setApiId​(String value)  
      void setBasePath​(String value)  
      void setDomainName​(String value)  
      void setId​(String value)  
      void setStageName​(String value)  
      protected Map<String,​Object> synthesizeAttributes()  

      • Methods inherited from class com.hashicorp.cdktf.TerraformResource

        getAnyMapAttribute, getBooleanAttribute, getBooleanMapAttribute, getConnection, getCount, getDependsOn, getForEach, getLifecycle, getListAttribute, getNumberAttribute, getNumberListAttribute, getNumberMapAttribute, getProvider, getProvisioners, getStringAttribute, getStringMapAttribute, getTerraformGeneratorMetadata, getTerraformMetaArguments, getTerraformResourceType, interpolationForAttribute, isTerraformResource, setConnection, setConnection, setCount, setCount, setDependsOn, setForEach, setLifecycle, setProvider, setProvisioners, toMetadata, toTerraform

      • Methods inherited from class com.hashicorp.cdktf.TerraformElement

        addOverride, getCdktfStack, getConstructNodeMetadata, getFqn, getFriendlyUniqueId, getRawOverrides, isTerraformElement, overrideLogicalId, resetOverrideLogicalId

      • Methods inherited from class software.constructs.Construct

        getNode, isConstruct, toString

      • Methods inherited from class software.amazon.jsii.JsiiObject

        jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

      • Methods inherited from interface com.hashicorp.cdktf.ITerraformAddressable

        getFqn

      • Methods inherited from interface com.hashicorp.cdktf.ITerraformResource

        getFqn, getFriendlyUniqueId

      • Methods inherited from interface software.amazon.jsii.JsiiSerializable

        $jsii$toJson

    • Field Detail

      • TF_RESOURCE_TYPE

        @Stability(Stable)
public static final String TF_RESOURCE_TYPE

    • Constructor Detail

      • ApiGatewayBasePathMapping

        protected ApiGatewayBasePathMapping​(software.amazon.jsii.JsiiObjectRef objRef)

      • ApiGatewayBasePathMapping

        protected ApiGatewayBasePathMapping​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • ApiGatewayBasePathMapping

        @Stability(Stable)
public ApiGatewayBasePathMapping​(@NotNull
                                 software.constructs.Construct scope,
                                 @NotNull
                                 String id,
                                 @NotNull
                                 ApiGatewayBasePathMappingConfig config)
        Create a new {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/api_gateway_base_path_mapping aws_api_gateway_base_path_mapping} Resource.

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        config - This parameter is required.

    • Method Detail

      • resetBasePath

        @Stability(Stable)
public void resetBasePath()

      • resetId

        @Stability(Stable)
public void resetId()

      • resetStageName

        @Stability(Stable)
public void resetStageName()

      • synthesizeAttributes

        @Stability(Stable)
@NotNull
protected Map<String,​Object> synthesizeAttributes()
        Overrides:
        synthesizeAttributes in class com.hashicorp.cdktf.TerraformResource

      • getApiIdInput

        @Stability(Stable)
@Nullable
public String getApiIdInput()

      • getBasePathInput

        @Stability(Stable)
@Nullable
public String getBasePathInput()

      • getDomainNameInput

        @Stability(Stable)
@Nullable
public String getDomainNameInput()

      • getIdInput

        @Stability(Stable)
@Nullable
public String getIdInput()

      • getStageNameInput

        @Stability(Stable)
@Nullable
public String getStageNameInput()

      • getApiId

        @Stability(Stable)
@NotNull
public String getApiId()

      • setApiId

        @Stability(Stable)
public void setApiId​(@NotNull
                     String value)

      • getBasePath

        @Stability(Stable)
@NotNull
public String getBasePath()

      • setBasePath

        @Stability(Stable)
public void setBasePath​(@NotNull
                        String value)

      • getDomainName

        @Stability(Stable)
@NotNull
public String getDomainName()

      • setDomainName

        @Stability(Stable)
public void setDomainName​(@NotNull
                          String value)

      • getId

        @Stability(Stable)
@NotNull
public String getId()

      • setId

        @Stability(Stable)
public void setId​(@NotNull
                  String value)

      • getStageName

        @Stability(Stable)
@NotNull
public String getStageName()

      • setStageName

        @Stability(Stable)
public void setStageName​(@NotNull
                         String value)