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

Interface ApiGatewayBasePathMappingConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

All Known Implementing Classes:

ApiGatewayBasePathMappingConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-30T04:56:50.183Z")
@Stability(Stable)
public interface ApiGatewayBasePathMappingConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ApiGatewayBasePathMappingConfig.Builder	A builder for ApiGatewayBasePathMappingConfig
static class	ApiGatewayBasePathMappingConfig.Jsii$Proxy	An implementation for ApiGatewayBasePathMappingConfig

Method Summary

Modifier and Type	Method	Description
static ApiGatewayBasePathMappingConfig.Builder	builder()
String	getApiId()	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/api_gateway_base_path_mapping#api_id ApiGatewayBasePathMapping#api_id}.
default String	getBasePath()	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/api_gateway_base_path_mapping#base_path ApiGatewayBasePathMapping#base_path}.
String	getDomainName()	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/api_gateway_base_path_mapping#domain_name ApiGatewayBasePathMapping#domain_name}.
default String	getId()	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/api_gateway_base_path_mapping#id ApiGatewayBasePathMapping#id}.
default String	getStageName()	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/api_gateway_base_path_mapping#stage_name ApiGatewayBasePathMapping#stage_name}.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface com.hashicorp.cdktf.TerraformMetaArguments

getConnection, getCount, getDependsOn, getForEach, getLifecycle, getProvider, getProvisioners

Method Detail

getApiId

@Stability(Stable)
@NotNull
String getApiId()

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/api_gateway_base_path_mapping#api_id ApiGatewayBasePathMapping#api_id}.

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/api_gateway_base_path_mapping#domain_name ApiGatewayBasePathMapping#domain_name}.

getBasePath

@Stability(Stable)
@Nullable
default String getBasePath()

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/api_gateway_base_path_mapping#base_path ApiGatewayBasePathMapping#base_path}.

getId

@Stability(Stable)
@Nullable
default String getId()

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/api_gateway_base_path_mapping#id ApiGatewayBasePathMapping#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

getStageName

@Stability(Stable)
@Nullable
default String getStageName()

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/api_gateway_base_path_mapping#stage_name ApiGatewayBasePathMapping#stage_name}.

builder

@Stability(Stable)
static ApiGatewayBasePathMappingConfig.Builder builder()

Returns:

a ApiGatewayBasePathMappingConfig.Builder of ApiGatewayBasePathMappingConfig