Skip to content

Latest commit

 

History

History
1085 lines (678 loc) · 51.8 KB

apiGatewayBasePathMapping.java.md

File metadata and controls

1085 lines (678 loc) · 51.8 KB

apiGatewayBasePathMapping Submodule

Constructs

ApiGatewayBasePathMapping

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_base_path_mapping aws_api_gateway_base_path_mapping}.

Initializers

import com.hashicorp.cdktf.providers.aws.api_gateway_base_path_mapping.ApiGatewayBasePathMapping;

ApiGatewayBasePathMapping.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .apiId(java.lang.String)
    .domainName(java.lang.String)
//  .basePath(java.lang.String)
//  .id(java.lang.String)
//  .stageName(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
apiId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_base_path_mapping#api_id ApiGatewayBasePathMapping#api_id}.
domainName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_base_path_mapping#domain_name ApiGatewayBasePathMapping#domain_name}.
basePath java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_base_path_mapping#base_path ApiGatewayBasePathMapping#base_path}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_base_path_mapping#id ApiGatewayBasePathMapping#id}.
stageName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_base_path_mapping#stage_name ApiGatewayBasePathMapping#stage_name}.

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope


connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

apiIdRequired
  • Type: java.lang.String

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


domainNameRequired
  • Type: java.lang.String

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


basePathOptional
  • Type: java.lang.String

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


idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/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.


stageNameOptional
  • Type: java.lang.String

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


Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
resetBasePath No description.
resetId No description.
resetStageName No description.

toString
public java.lang.String toString()

Returns a string representation of this construct.

addOverride
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String

valueRequired
  • Type: java.lang.Object

overrideLogicalId
public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.


resetOverrideLogicalId
public void resetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform
public java.lang.Object toHclTerraform()
toMetadata
public java.lang.Object toMetadata()
toTerraform
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget
public void addMoveTarget(java.lang.String moveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.


getAnyMapAttribute
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanAttribute
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanMapAttribute
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getListAttribute
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberAttribute
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberListAttribute
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberMapAttribute
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringAttribute
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringMapAttribute
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

hasResourceMove
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

moveFromId
public void moveFromId(java.lang.String id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: java.lang.String

Full id of resource being moved from, e.g. "aws_s3_bucket.example".


moveTo
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.


indexOptional
  • Type: java.lang.String OR java.lang.Number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.


moveToId
public void moveToId(java.lang.String id)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: java.lang.String

Full id of resource to move to, e.g. "aws_s3_bucket.example".


resetBasePath
public void resetBasePath()
resetId
public void resetId()
resetStageName
public void resetStageName()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a ApiGatewayBasePathMapping resource upon running "cdktf plan ".

isConstruct
import com.hashicorp.cdktf.providers.aws.api_gateway_base_path_mapping.ApiGatewayBasePathMapping;

ApiGatewayBasePathMapping.isConstruct(java.lang.Object x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: java.lang.Object

Any object.


isTerraformElement
import com.hashicorp.cdktf.providers.aws.api_gateway_base_path_mapping.ApiGatewayBasePathMapping;

ApiGatewayBasePathMapping.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object

isTerraformResource
import com.hashicorp.cdktf.providers.aws.api_gateway_base_path_mapping.ApiGatewayBasePathMapping;

ApiGatewayBasePathMapping.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object

generateConfigForImport
import com.hashicorp.cdktf.providers.aws.api_gateway_base_path_mapping.ApiGatewayBasePathMapping;

ApiGatewayBasePathMapping.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ApiGatewayBasePathMapping.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

Generates CDKTF code for importing a ApiGatewayBasePathMapping resource upon running "cdktf plan ".

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: java.lang.String

The construct id used in the generated config for the ApiGatewayBasePathMapping to import.


importFromIdRequired
  • Type: java.lang.String

The id of the existing ApiGatewayBasePathMapping that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_base_path_mapping#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

? Optional instance of the provider where the ApiGatewayBasePathMapping to import is found.


Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
apiIdInput java.lang.String No description.
basePathInput java.lang.String No description.
domainNameInput java.lang.String No description.
idInput java.lang.String No description.
stageNameInput java.lang.String No description.
apiId java.lang.String No description.
basePath java.lang.String No description.
domainName java.lang.String No description.
id java.lang.String No description.
stageName java.lang.String No description.

nodeRequired
public Node getNode();
  • Type: software.constructs.Node

The tree node.


cdktfStackRequired
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack

fqnRequired
public java.lang.String getFqn();
  • Type: java.lang.String

friendlyUniqueIdRequired
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String

terraformMetaArgumentsRequired
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>

terraformResourceTypeRequired
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String

terraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

apiIdInputOptional
public java.lang.String getApiIdInput();
  • Type: java.lang.String

basePathInputOptional
public java.lang.String getBasePathInput();
  • Type: java.lang.String

domainNameInputOptional
public java.lang.String getDomainNameInput();
  • Type: java.lang.String

idInputOptional
public java.lang.String getIdInput();
  • Type: java.lang.String

stageNameInputOptional
public java.lang.String getStageNameInput();
  • Type: java.lang.String

apiIdRequired
public java.lang.String getApiId();
  • Type: java.lang.String

basePathRequired
public java.lang.String getBasePath();
  • Type: java.lang.String

domainNameRequired
public java.lang.String getDomainName();
  • Type: java.lang.String

idRequired
public java.lang.String getId();
  • Type: java.lang.String

stageNameRequired
public java.lang.String getStageName();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.

tfResourceTypeRequired
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

ApiGatewayBasePathMappingConfig

Initializer

import com.hashicorp.cdktf.providers.aws.api_gateway_base_path_mapping.ApiGatewayBasePathMappingConfig;

ApiGatewayBasePathMappingConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .apiId(java.lang.String)
    .domainName(java.lang.String)
//  .basePath(java.lang.String)
//  .id(java.lang.String)
//  .stageName(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
apiId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_base_path_mapping#api_id ApiGatewayBasePathMapping#api_id}.
domainName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_base_path_mapping#domain_name ApiGatewayBasePathMapping#domain_name}.
basePath java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_base_path_mapping#base_path ApiGatewayBasePathMapping#base_path}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_base_path_mapping#id ApiGatewayBasePathMapping#id}.
stageName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_base_path_mapping#stage_name ApiGatewayBasePathMapping#stage_name}.

connectionOptional
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

apiIdRequired
public java.lang.String getApiId();
  • Type: java.lang.String

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


domainNameRequired
public java.lang.String getDomainName();
  • Type: java.lang.String

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


basePathOptional
public java.lang.String getBasePath();
  • Type: java.lang.String

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


idOptional
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/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.


stageNameOptional
public java.lang.String getStageName();
  • Type: java.lang.String

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