Skip to content

Latest commit

 

History

History
2034 lines (1279 loc) · 99 KB

apiGatewayRestApi.java.md

File metadata and controls

2034 lines (1279 loc) · 99 KB

apiGatewayRestApi Submodule

Constructs

ApiGatewayRestApi

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

Initializers

import com.hashicorp.cdktf.providers.aws.api_gateway_rest_api.ApiGatewayRestApi;

ApiGatewayRestApi.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>)
    .name(java.lang.String)
//  .apiKeySource(java.lang.String)
//  .binaryMediaTypes(java.util.List<java.lang.String>)
//  .body(java.lang.String)
//  .description(java.lang.String)
//  .disableExecuteApiEndpoint(java.lang.Boolean)
//  .disableExecuteApiEndpoint(IResolvable)
//  .endpointConfiguration(ApiGatewayRestApiEndpointConfiguration)
//  .failOnWarnings(java.lang.Boolean)
//  .failOnWarnings(IResolvable)
//  .id(java.lang.String)
//  .minimumCompressionSize(java.lang.String)
//  .parameters(java.util.Map<java.lang.String, java.lang.String>)
//  .policy(java.lang.String)
//  .putRestApiMode(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, 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.
name java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#name ApiGatewayRestApi#name}.
apiKeySource java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#api_key_source ApiGatewayRestApi#api_key_source}.
binaryMediaTypes java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#binary_media_types ApiGatewayRestApi#binary_media_types}.
body java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#body ApiGatewayRestApi#body}.
description java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#description ApiGatewayRestApi#description}.
disableExecuteApiEndpoint java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#disable_execute_api_endpoint ApiGatewayRestApi#disable_execute_api_endpoint}.
endpointConfiguration ApiGatewayRestApiEndpointConfiguration endpoint_configuration block.
failOnWarnings java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#fail_on_warnings ApiGatewayRestApi#fail_on_warnings}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#id ApiGatewayRestApi#id}.
minimumCompressionSize java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#minimum_compression_size ApiGatewayRestApi#minimum_compression_size}.
parameters java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#parameters ApiGatewayRestApi#parameters}.
policy java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#policy ApiGatewayRestApi#policy}.
putRestApiMode java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#put_rest_api_mode ApiGatewayRestApi#put_rest_api_mode}.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#tags ApiGatewayRestApi#tags}.
tagsAll java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#tags_all ApiGatewayRestApi#tags_all}.

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>

nameRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#name ApiGatewayRestApi#name}.


apiKeySourceOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#api_key_source ApiGatewayRestApi#api_key_source}.


binaryMediaTypesOptional
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#binary_media_types ApiGatewayRestApi#binary_media_types}.


bodyOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#body ApiGatewayRestApi#body}.


descriptionOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#description ApiGatewayRestApi#description}.


disableExecuteApiEndpointOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#disable_execute_api_endpoint ApiGatewayRestApi#disable_execute_api_endpoint}.


endpointConfigurationOptional

endpoint_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#endpoint_configuration ApiGatewayRestApi#endpoint_configuration}


failOnWarningsOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#fail_on_warnings ApiGatewayRestApi#fail_on_warnings}.


idOptional
  • Type: java.lang.String

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


minimumCompressionSizeOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#minimum_compression_size ApiGatewayRestApi#minimum_compression_size}.


parametersOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#parameters ApiGatewayRestApi#parameters}.


policyOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#policy ApiGatewayRestApi#policy}.


putRestApiModeOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#put_rest_api_mode ApiGatewayRestApi#put_rest_api_mode}.


tagsOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#tags ApiGatewayRestApi#tags}.


tagsAllOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#tags_all ApiGatewayRestApi#tags_all}.


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".
putEndpointConfiguration No description.
resetApiKeySource No description.
resetBinaryMediaTypes No description.
resetBody No description.
resetDescription No description.
resetDisableExecuteApiEndpoint No description.
resetEndpointConfiguration No description.
resetFailOnWarnings No description.
resetId No description.
resetMinimumCompressionSize No description.
resetParameters No description.
resetPolicy No description.
resetPutRestApiMode No description.
resetTags No description.
resetTagsAll 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".


putEndpointConfiguration
public void putEndpointConfiguration(ApiGatewayRestApiEndpointConfiguration value)
valueRequired

resetApiKeySource
public void resetApiKeySource()
resetBinaryMediaTypes
public void resetBinaryMediaTypes()
resetBody
public void resetBody()
resetDescription
public void resetDescription()
resetDisableExecuteApiEndpoint
public void resetDisableExecuteApiEndpoint()
resetEndpointConfiguration
public void resetEndpointConfiguration()
resetFailOnWarnings
public void resetFailOnWarnings()
resetId
public void resetId()
resetMinimumCompressionSize
public void resetMinimumCompressionSize()
resetParameters
public void resetParameters()
resetPolicy
public void resetPolicy()
resetPutRestApiMode
public void resetPutRestApiMode()
resetTags
public void resetTags()
resetTagsAll
public void resetTagsAll()

Static Functions

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

isConstruct
import com.hashicorp.cdktf.providers.aws.api_gateway_rest_api.ApiGatewayRestApi;

ApiGatewayRestApi.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_rest_api.ApiGatewayRestApi;

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

isTerraformResource
import com.hashicorp.cdktf.providers.aws.api_gateway_rest_api.ApiGatewayRestApi;

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

generateConfigForImport
import com.hashicorp.cdktf.providers.aws.api_gateway_rest_api.ApiGatewayRestApi;

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

Generates CDKTF code for importing a ApiGatewayRestApi 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 ApiGatewayRestApi to import.


importFromIdRequired
  • Type: java.lang.String

The id of the existing ApiGatewayRestApi that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#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 ApiGatewayRestApi 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.
arn java.lang.String No description.
createdDate java.lang.String No description.
endpointConfiguration ApiGatewayRestApiEndpointConfigurationOutputReference No description.
executionArn java.lang.String No description.
rootResourceId java.lang.String No description.
apiKeySourceInput java.lang.String No description.
binaryMediaTypesInput java.util.List<java.lang.String> No description.
bodyInput java.lang.String No description.
descriptionInput java.lang.String No description.
disableExecuteApiEndpointInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
endpointConfigurationInput ApiGatewayRestApiEndpointConfiguration No description.
failOnWarningsInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
idInput java.lang.String No description.
minimumCompressionSizeInput java.lang.String No description.
nameInput java.lang.String No description.
parametersInput java.util.Map<java.lang.String, java.lang.String> No description.
policyInput java.lang.String No description.
putRestApiModeInput java.lang.String No description.
tagsAllInput java.util.Map<java.lang.String, java.lang.String> No description.
tagsInput java.util.Map<java.lang.String, java.lang.String> No description.
apiKeySource java.lang.String No description.
binaryMediaTypes java.util.List<java.lang.String> No description.
body java.lang.String No description.
description java.lang.String No description.
disableExecuteApiEndpoint java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
failOnWarnings java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
id java.lang.String No description.
minimumCompressionSize java.lang.String No description.
name java.lang.String No description.
parameters java.util.Map<java.lang.String, java.lang.String> No description.
policy java.lang.String No description.
putRestApiMode java.lang.String No description.
tags java.util.Map<java.lang.String, java.lang.String> No description.
tagsAll java.util.Map<java.lang.String, 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>

arnRequired
public java.lang.String getArn();
  • Type: java.lang.String

createdDateRequired
public java.lang.String getCreatedDate();
  • Type: java.lang.String

endpointConfigurationRequired
public ApiGatewayRestApiEndpointConfigurationOutputReference getEndpointConfiguration();

executionArnRequired
public java.lang.String getExecutionArn();
  • Type: java.lang.String

rootResourceIdRequired
public java.lang.String getRootResourceId();
  • Type: java.lang.String

apiKeySourceInputOptional
public java.lang.String getApiKeySourceInput();
  • Type: java.lang.String

binaryMediaTypesInputOptional
public java.util.List<java.lang.String> getBinaryMediaTypesInput();
  • Type: java.util.List<java.lang.String>

bodyInputOptional
public java.lang.String getBodyInput();
  • Type: java.lang.String

descriptionInputOptional
public java.lang.String getDescriptionInput();
  • Type: java.lang.String

disableExecuteApiEndpointInputOptional
public java.lang.Object getDisableExecuteApiEndpointInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

endpointConfigurationInputOptional
public ApiGatewayRestApiEndpointConfiguration getEndpointConfigurationInput();

failOnWarningsInputOptional
public java.lang.Object getFailOnWarningsInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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

minimumCompressionSizeInputOptional
public java.lang.String getMinimumCompressionSizeInput();
  • Type: java.lang.String

nameInputOptional
public java.lang.String getNameInput();
  • Type: java.lang.String

parametersInputOptional
public java.util.Map<java.lang.String, java.lang.String> getParametersInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>

policyInputOptional
public java.lang.String getPolicyInput();
  • Type: java.lang.String

putRestApiModeInputOptional
public java.lang.String getPutRestApiModeInput();
  • Type: java.lang.String

tagsAllInputOptional
public java.util.Map<java.lang.String, java.lang.String> getTagsAllInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>

tagsInputOptional
public java.util.Map<java.lang.String, java.lang.String> getTagsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>

apiKeySourceRequired
public java.lang.String getApiKeySource();
  • Type: java.lang.String

binaryMediaTypesRequired
public java.util.List<java.lang.String> getBinaryMediaTypes();
  • Type: java.util.List<java.lang.String>

bodyRequired
public java.lang.String getBody();
  • Type: java.lang.String

descriptionRequired
public java.lang.String getDescription();
  • Type: java.lang.String

disableExecuteApiEndpointRequired
public java.lang.Object getDisableExecuteApiEndpoint();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

failOnWarningsRequired
public java.lang.Object getFailOnWarnings();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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

minimumCompressionSizeRequired
public java.lang.String getMinimumCompressionSize();
  • Type: java.lang.String

nameRequired
public java.lang.String getName();
  • Type: java.lang.String

parametersRequired
public java.util.Map<java.lang.String, java.lang.String> getParameters();
  • Type: java.util.Map<java.lang.String, java.lang.String>

policyRequired
public java.lang.String getPolicy();
  • Type: java.lang.String

putRestApiModeRequired
public java.lang.String getPutRestApiMode();
  • Type: java.lang.String

tagsRequired
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>

tagsAllRequired
public java.util.Map<java.lang.String, java.lang.String> getTagsAll();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Constants

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

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

Structs

ApiGatewayRestApiConfig

Initializer

import com.hashicorp.cdktf.providers.aws.api_gateway_rest_api.ApiGatewayRestApiConfig;

ApiGatewayRestApiConfig.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>)
    .name(java.lang.String)
//  .apiKeySource(java.lang.String)
//  .binaryMediaTypes(java.util.List<java.lang.String>)
//  .body(java.lang.String)
//  .description(java.lang.String)
//  .disableExecuteApiEndpoint(java.lang.Boolean)
//  .disableExecuteApiEndpoint(IResolvable)
//  .endpointConfiguration(ApiGatewayRestApiEndpointConfiguration)
//  .failOnWarnings(java.lang.Boolean)
//  .failOnWarnings(IResolvable)
//  .id(java.lang.String)
//  .minimumCompressionSize(java.lang.String)
//  .parameters(java.util.Map<java.lang.String, java.lang.String>)
//  .policy(java.lang.String)
//  .putRestApiMode(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, 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.
name java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#name ApiGatewayRestApi#name}.
apiKeySource java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#api_key_source ApiGatewayRestApi#api_key_source}.
binaryMediaTypes java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#binary_media_types ApiGatewayRestApi#binary_media_types}.
body java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#body ApiGatewayRestApi#body}.
description java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#description ApiGatewayRestApi#description}.
disableExecuteApiEndpoint java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#disable_execute_api_endpoint ApiGatewayRestApi#disable_execute_api_endpoint}.
endpointConfiguration ApiGatewayRestApiEndpointConfiguration endpoint_configuration block.
failOnWarnings java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#fail_on_warnings ApiGatewayRestApi#fail_on_warnings}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#id ApiGatewayRestApi#id}.
minimumCompressionSize java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#minimum_compression_size ApiGatewayRestApi#minimum_compression_size}.
parameters java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#parameters ApiGatewayRestApi#parameters}.
policy java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#policy ApiGatewayRestApi#policy}.
putRestApiMode java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#put_rest_api_mode ApiGatewayRestApi#put_rest_api_mode}.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#tags ApiGatewayRestApi#tags}.
tagsAll java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#tags_all ApiGatewayRestApi#tags_all}.

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>

nameRequired
public java.lang.String getName();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#name ApiGatewayRestApi#name}.


apiKeySourceOptional
public java.lang.String getApiKeySource();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#api_key_source ApiGatewayRestApi#api_key_source}.


binaryMediaTypesOptional
public java.util.List<java.lang.String> getBinaryMediaTypes();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#binary_media_types ApiGatewayRestApi#binary_media_types}.


bodyOptional
public java.lang.String getBody();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#body ApiGatewayRestApi#body}.


descriptionOptional
public java.lang.String getDescription();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#description ApiGatewayRestApi#description}.


disableExecuteApiEndpointOptional
public java.lang.Object getDisableExecuteApiEndpoint();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#disable_execute_api_endpoint ApiGatewayRestApi#disable_execute_api_endpoint}.


endpointConfigurationOptional
public ApiGatewayRestApiEndpointConfiguration getEndpointConfiguration();

endpoint_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#endpoint_configuration ApiGatewayRestApi#endpoint_configuration}


failOnWarningsOptional
public java.lang.Object getFailOnWarnings();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#fail_on_warnings ApiGatewayRestApi#fail_on_warnings}.


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_rest_api#id ApiGatewayRestApi#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.


minimumCompressionSizeOptional
public java.lang.String getMinimumCompressionSize();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#minimum_compression_size ApiGatewayRestApi#minimum_compression_size}.


parametersOptional
public java.util.Map<java.lang.String, java.lang.String> getParameters();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#parameters ApiGatewayRestApi#parameters}.


policyOptional
public java.lang.String getPolicy();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#policy ApiGatewayRestApi#policy}.


putRestApiModeOptional
public java.lang.String getPutRestApiMode();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#put_rest_api_mode ApiGatewayRestApi#put_rest_api_mode}.


tagsOptional
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#tags ApiGatewayRestApi#tags}.


tagsAllOptional
public java.util.Map<java.lang.String, java.lang.String> getTagsAll();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#tags_all ApiGatewayRestApi#tags_all}.


ApiGatewayRestApiEndpointConfiguration

Initializer

import com.hashicorp.cdktf.providers.aws.api_gateway_rest_api.ApiGatewayRestApiEndpointConfiguration;

ApiGatewayRestApiEndpointConfiguration.builder()
    .types(java.util.List<java.lang.String>)
//  .vpcEndpointIds(java.util.List<java.lang.String>)
    .build();

Properties

Name Type Description
types java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#types ApiGatewayRestApi#types}.
vpcEndpointIds java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#vpc_endpoint_ids ApiGatewayRestApi#vpc_endpoint_ids}.

typesRequired
public java.util.List<java.lang.String> getTypes();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#types ApiGatewayRestApi#types}.


vpcEndpointIdsOptional
public java.util.List<java.lang.String> getVpcEndpointIds();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/resources/api_gateway_rest_api#vpc_endpoint_ids ApiGatewayRestApi#vpc_endpoint_ids}.


Classes

ApiGatewayRestApiEndpointConfigurationOutputReference

Initializers

import com.hashicorp.cdktf.providers.aws.api_gateway_rest_api.ApiGatewayRestApiEndpointConfigurationOutputReference;

new ApiGatewayRestApiEndpointConfigurationOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.


Methods

Name Description
computeFqn No description.
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.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetVpcEndpointIds No description.

computeFqn
public java.lang.String computeFqn()
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

interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String

resolve
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext

toString
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetVpcEndpointIds
public void resetVpcEndpointIds()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
typesInput java.util.List<java.lang.String> No description.
vpcEndpointIdsInput java.util.List<java.lang.String> No description.
types java.util.List<java.lang.String> No description.
vpcEndpointIds java.util.List<java.lang.String> No description.
internalValue ApiGatewayRestApiEndpointConfiguration No description.

creationStackRequired
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


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

typesInputOptional
public java.util.List<java.lang.String> getTypesInput();
  • Type: java.util.List<java.lang.String>

vpcEndpointIdsInputOptional
public java.util.List<java.lang.String> getVpcEndpointIdsInput();
  • Type: java.util.List<java.lang.String>

typesRequired
public java.util.List<java.lang.String> getTypes();
  • Type: java.util.List<java.lang.String>

vpcEndpointIdsRequired
public java.util.List<java.lang.String> getVpcEndpointIds();
  • Type: java.util.List<java.lang.String>

internalValueOptional
public ApiGatewayRestApiEndpointConfiguration getInternalValue();