`apiGatewayStage` Submodule

Constructs

ApiGatewayStage

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage aws_api_gateway_stage}.

Initializers

import com.hashicorp.cdktf.providers.aws.api_gateway_stage.ApiGatewayStage;

ApiGatewayStage.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>)
    .deploymentId(java.lang.String)
    .restApiId(java.lang.String)
    .stageName(java.lang.String)
//  .accessLogSettings(ApiGatewayStageAccessLogSettings)
//  .cacheClusterEnabled(java.lang.Boolean)
//  .cacheClusterEnabled(IResolvable)
//  .cacheClusterSize(java.lang.String)
//  .canarySettings(ApiGatewayStageCanarySettings)
//  .clientCertificateId(java.lang.String)
//  .description(java.lang.String)
//  .documentationVersion(java.lang.String)
//  .id(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
//  .variables(java.util.Map<java.lang.String, java.lang.String>)
//  .xrayTracingEnabled(java.lang.Boolean)
//  .xrayTracingEnabled(IResolvable)
    .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.
`deploymentId`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#deployment_id ApiGatewayStage#deployment_id}.
`restApiId`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#rest_api_id ApiGatewayStage#rest_api_id}.
`stageName`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#stage_name ApiGatewayStage#stage_name}.
`accessLogSettings`	`ApiGatewayStageAccessLogSettings`	access_log_settings block.
`cacheClusterEnabled`	`java.lang.Boolean OR com.hashicorp.cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#cache_cluster_enabled ApiGatewayStage#cache_cluster_enabled}.
`cacheClusterSize`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#cache_cluster_size ApiGatewayStage#cache_cluster_size}.
`canarySettings`	`ApiGatewayStageCanarySettings`	canary_settings block.
`clientCertificateId`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#client_certificate_id ApiGatewayStage#client_certificate_id}.
`description`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#description ApiGatewayStage#description}.
`documentationVersion`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#documentation_version ApiGatewayStage#documentation_version}.
`id`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#id ApiGatewayStage#id}.
`tags`	`java.util.Map<java.lang.String, java.lang.String>`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#tags ApiGatewayStage#tags}.
`tagsAll`	`java.util.Map<java.lang.String, java.lang.String>`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#tags_all ApiGatewayStage#tags_all}.
`variables`	`java.util.Map<java.lang.String, java.lang.String>`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#variables ApiGatewayStage#variables}.
`xrayTracingEnabled`	`java.lang.Boolean OR com.hashicorp.cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#xray_tracing_enabled ApiGatewayStage#xray_tracing_enabled}.

`scope`^Required

Type: software.constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

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

`count`^Optional

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

`dependsOn`^Optional

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

`forEach`^Optional

Type: com.hashicorp.cdktf.ITerraformIterator

`lifecycle`^Optional

Type: com.hashicorp.cdktf.TerraformResourceLifecycle

`provider`^Optional

Type: com.hashicorp.cdktf.TerraformProvider

`provisioners`^Optional

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

`deploymentId`^Required

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#deployment_id ApiGatewayStage#deployment_id}.

`restApiId`^Required

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#rest_api_id ApiGatewayStage#rest_api_id}.

`stageName`^Required

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#stage_name ApiGatewayStage#stage_name}.

`accessLogSettings`^Optional

Type: ApiGatewayStageAccessLogSettings

access_log_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#access_log_settings ApiGatewayStage#access_log_settings}

`cacheClusterEnabled`^Optional

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#cache_cluster_enabled ApiGatewayStage#cache_cluster_enabled}.

`cacheClusterSize`^Optional

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#cache_cluster_size ApiGatewayStage#cache_cluster_size}.

`canarySettings`^Optional

Type: ApiGatewayStageCanarySettings

canary_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#canary_settings ApiGatewayStage#canary_settings}

`clientCertificateId`^Optional

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#client_certificate_id ApiGatewayStage#client_certificate_id}.

`description`^Optional

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#description ApiGatewayStage#description}.

`documentationVersion`^Optional

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#documentation_version ApiGatewayStage#documentation_version}.

`id`^Optional

Type: java.lang.String

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

`tags`^Optional

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#tags ApiGatewayStage#tags}.

`tagsAll`^Optional

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#tags_all ApiGatewayStage#tags_all}.

`variables`^Optional

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#variables ApiGatewayStage#variables}.

`xrayTracingEnabled`^Optional

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#xray_tracing_enabled ApiGatewayStage#xray_tracing_enabled}.

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".
`putAccessLogSettings`	No description.
`putCanarySettings`	No description.
`resetAccessLogSettings`	No description.
`resetCacheClusterEnabled`	No description.
`resetCacheClusterSize`	No description.
`resetCanarySettings`	No description.
`resetClientCertificateId`	No description.
`resetDescription`	No description.
`resetDocumentationVersion`	No description.
`resetId`	No description.
`resetTags`	No description.
`resetTagsAll`	No description.
`resetVariables`	No description.
`resetXrayTracingEnabled`	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)

`path`^Required

Type: java.lang.String

`value`^Required

Type: java.lang.Object

`overrideLogicalId`

public void overrideLogicalId(java.lang.String newLogicalId)

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

`newLogicalId`^Required

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.

`moveTarget`^Required

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)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanAttribute`

public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanMapAttribute`

public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getListAttribute`

public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberAttribute`

public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberListAttribute`

public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberMapAttribute`

public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringAttribute`

public java.lang.String getStringAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringMapAttribute`

public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

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)

`id`^Required

Type: java.lang.String

`provider`^Optional

Type: com.hashicorp.cdktf.TerraformProvider

`interpolationForAttribute`

public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

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.

`id`^Required

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.

`moveTarget`^Required

Type: java.lang.String

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

`index`^Optional

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".

`id`^Required

Type: java.lang.String

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

`putAccessLogSettings`

public void putAccessLogSettings(ApiGatewayStageAccessLogSettings value)

`value`^Required

Type: ApiGatewayStageAccessLogSettings

`putCanarySettings`

public void putCanarySettings(ApiGatewayStageCanarySettings value)

`value`^Required

Type: ApiGatewayStageCanarySettings

`resetAccessLogSettings`

public void resetAccessLogSettings()

`resetCacheClusterEnabled`

public void resetCacheClusterEnabled()

`resetCacheClusterSize`

public void resetCacheClusterSize()

`resetCanarySettings`

public void resetCanarySettings()

`resetClientCertificateId`

public void resetClientCertificateId()

`resetDescription`

public void resetDescription()

`resetDocumentationVersion`

public void resetDocumentationVersion()

`resetId`

public void resetId()

`resetTags`

public void resetTags()

`resetTagsAll`

public void resetTagsAll()

`resetVariables`

public void resetVariables()

`resetXrayTracingEnabled`

public void resetXrayTracingEnabled()

Static Functions

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

`isConstruct`

import com.hashicorp.cdktf.providers.aws.api_gateway_stage.ApiGatewayStage;

ApiGatewayStage.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.

`x`^Required

Type: java.lang.Object

Any object.

`isTerraformElement`

import com.hashicorp.cdktf.providers.aws.api_gateway_stage.ApiGatewayStage;

ApiGatewayStage.isTerraformElement(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`isTerraformResource`

import com.hashicorp.cdktf.providers.aws.api_gateway_stage.ApiGatewayStage;

ApiGatewayStage.isTerraformResource(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`generateConfigForImport`

import com.hashicorp.cdktf.providers.aws.api_gateway_stage.ApiGatewayStage;

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

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

`scope`^Required

Type: software.constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: java.lang.String

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

`importFromId`^Required

Type: java.lang.String

The id of the existing ApiGatewayStage that should be imported.

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

`provider`^Optional

Type: com.hashicorp.cdktf.TerraformProvider

? Optional instance of the provider where the ApiGatewayStage 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.
`accessLogSettings`	`ApiGatewayStageAccessLogSettingsOutputReference`	No description.
`arn`	`java.lang.String`	No description.
`canarySettings`	`ApiGatewayStageCanarySettingsOutputReference`	No description.
`executionArn`	`java.lang.String`	No description.
`invokeUrl`	`java.lang.String`	No description.
`webAclArn`	`java.lang.String`	No description.
`accessLogSettingsInput`	`ApiGatewayStageAccessLogSettings`	No description.
`cacheClusterEnabledInput`	`java.lang.Boolean OR com.hashicorp.cdktf.IResolvable`	No description.
`cacheClusterSizeInput`	`java.lang.String`	No description.
`canarySettingsInput`	`ApiGatewayStageCanarySettings`	No description.
`clientCertificateIdInput`	`java.lang.String`	No description.
`deploymentIdInput`	`java.lang.String`	No description.
`descriptionInput`	`java.lang.String`	No description.
`documentationVersionInput`	`java.lang.String`	No description.
`idInput`	`java.lang.String`	No description.
`restApiIdInput`	`java.lang.String`	No description.
`stageNameInput`	`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.
`variablesInput`	`java.util.Map<java.lang.String, java.lang.String>`	No description.
`xrayTracingEnabledInput`	`java.lang.Boolean OR com.hashicorp.cdktf.IResolvable`	No description.
`cacheClusterEnabled`	`java.lang.Boolean OR com.hashicorp.cdktf.IResolvable`	No description.
`cacheClusterSize`	`java.lang.String`	No description.
`clientCertificateId`	`java.lang.String`	No description.
`deploymentId`	`java.lang.String`	No description.
`description`	`java.lang.String`	No description.
`documentationVersion`	`java.lang.String`	No description.
`id`	`java.lang.String`	No description.
`restApiId`	`java.lang.String`	No description.
`stageName`	`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.
`variables`	`java.util.Map<java.lang.String, java.lang.String>`	No description.
`xrayTracingEnabled`	`java.lang.Boolean OR com.hashicorp.cdktf.IResolvable`	No description.

`node`^Required

public Node getNode();

Type: software.constructs.Node

The tree node.

`cdktfStack`^Required

public TerraformStack getCdktfStack();

Type: com.hashicorp.cdktf.TerraformStack

`fqn`^Required

public java.lang.String getFqn();

Type: java.lang.String

`friendlyUniqueId`^Required

public java.lang.String getFriendlyUniqueId();

Type: java.lang.String

`terraformMetaArguments`^Required

public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();

Type: java.util.Map<java.lang.String, java.lang.Object>

`terraformResourceType`^Required

public java.lang.String getTerraformResourceType();

Type: java.lang.String

`terraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();

Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public java.lang.Object getConnection();

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

`count`^Optional

public java.lang.Object getCount();

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

`dependsOn`^Optional

public java.util.List<java.lang.String> getDependsOn();

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

`forEach`^Optional

public ITerraformIterator getForEach();

Type: com.hashicorp.cdktf.ITerraformIterator

`lifecycle`^Optional

public TerraformResourceLifecycle getLifecycle();

Type: com.hashicorp.cdktf.TerraformResourceLifecycle

`provider`^Optional

public TerraformProvider getProvider();

Type: com.hashicorp.cdktf.TerraformProvider

`provisioners`^Optional

public java.lang.Object getProvisioners();

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

`accessLogSettings`^Required

public ApiGatewayStageAccessLogSettingsOutputReference getAccessLogSettings();

Type: ApiGatewayStageAccessLogSettingsOutputReference

`arn`^Required

public java.lang.String getArn();

Type: java.lang.String

`canarySettings`^Required

public ApiGatewayStageCanarySettingsOutputReference getCanarySettings();

Type: ApiGatewayStageCanarySettingsOutputReference

`executionArn`^Required

public java.lang.String getExecutionArn();

Type: java.lang.String

`invokeUrl`^Required

public java.lang.String getInvokeUrl();

Type: java.lang.String

`webAclArn`^Required

public java.lang.String getWebAclArn();

Type: java.lang.String

`accessLogSettingsInput`^Optional

public ApiGatewayStageAccessLogSettings getAccessLogSettingsInput();

Type: ApiGatewayStageAccessLogSettings

`cacheClusterEnabledInput`^Optional

public java.lang.Object getCacheClusterEnabledInput();

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

`cacheClusterSizeInput`^Optional

public java.lang.String getCacheClusterSizeInput();

Type: java.lang.String

`canarySettingsInput`^Optional

public ApiGatewayStageCanarySettings getCanarySettingsInput();

Type: ApiGatewayStageCanarySettings

`clientCertificateIdInput`^Optional

public java.lang.String getClientCertificateIdInput();

Type: java.lang.String

`deploymentIdInput`^Optional

public java.lang.String getDeploymentIdInput();

Type: java.lang.String

`descriptionInput`^Optional

public java.lang.String getDescriptionInput();

Type: java.lang.String

`documentationVersionInput`^Optional

public java.lang.String getDocumentationVersionInput();

Type: java.lang.String

`idInput`^Optional

public java.lang.String getIdInput();

Type: java.lang.String

`restApiIdInput`^Optional

public java.lang.String getRestApiIdInput();

Type: java.lang.String

`stageNameInput`^Optional

public java.lang.String getStageNameInput();

Type: java.lang.String

`tagsAllInput`^Optional

public java.util.Map<java.lang.String, java.lang.String> getTagsAllInput();

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

`tagsInput`^Optional

public java.util.Map<java.lang.String, java.lang.String> getTagsInput();

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

`variablesInput`^Optional

public java.util.Map<java.lang.String, java.lang.String> getVariablesInput();

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

`xrayTracingEnabledInput`^Optional

public java.lang.Object getXrayTracingEnabledInput();

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

`cacheClusterEnabled`^Required

public java.lang.Object getCacheClusterEnabled();

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

`cacheClusterSize`^Required

public java.lang.String getCacheClusterSize();

Type: java.lang.String

`clientCertificateId`^Required

public java.lang.String getClientCertificateId();

Type: java.lang.String

`deploymentId`^Required

public java.lang.String getDeploymentId();

Type: java.lang.String

`description`^Required

public java.lang.String getDescription();

Type: java.lang.String

`documentationVersion`^Required

public java.lang.String getDocumentationVersion();

Type: java.lang.String

`id`^Required

public java.lang.String getId();

Type: java.lang.String

`restApiId`^Required

public java.lang.String getRestApiId();

Type: java.lang.String

`stageName`^Required

public java.lang.String getStageName();

Type: java.lang.String

`tags`^Required

public java.util.Map<java.lang.String, java.lang.String> getTags();

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

`tagsAll`^Required

public java.util.Map<java.lang.String, java.lang.String> getTagsAll();

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

`variables`^Required

public java.util.Map<java.lang.String, java.lang.String> getVariables();

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

`xrayTracingEnabled`^Required

public java.lang.Object getXrayTracingEnabled();

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

Constants

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

`tfResourceType`^Required

public java.lang.String getTfResourceType();

Type: java.lang.String

Structs

ApiGatewayStageAccessLogSettings

Initializer

import com.hashicorp.cdktf.providers.aws.api_gateway_stage.ApiGatewayStageAccessLogSettings;

ApiGatewayStageAccessLogSettings.builder()
    .destinationArn(java.lang.String)
    .format(java.lang.String)
    .build();

Properties

Name	Type	Description
`destinationArn`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#destination_arn ApiGatewayStage#destination_arn}.
`format`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#format ApiGatewayStage#format}.

`destinationArn`^Required

public java.lang.String getDestinationArn();

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#destination_arn ApiGatewayStage#destination_arn}.

`format`^Required

public java.lang.String getFormat();

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#format ApiGatewayStage#format}.

ApiGatewayStageCanarySettings

Initializer

import com.hashicorp.cdktf.providers.aws.api_gateway_stage.ApiGatewayStageCanarySettings;

ApiGatewayStageCanarySettings.builder()
    .deploymentId(java.lang.String)
//  .percentTraffic(java.lang.Number)
//  .stageVariableOverrides(java.util.Map<java.lang.String, java.lang.String>)
//  .useStageCache(java.lang.Boolean)
//  .useStageCache(IResolvable)
    .build();

Properties

Name	Type	Description
`deploymentId`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#deployment_id ApiGatewayStage#deployment_id}.
`percentTraffic`	`java.lang.Number`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#percent_traffic ApiGatewayStage#percent_traffic}.
`stageVariableOverrides`	`java.util.Map<java.lang.String, java.lang.String>`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#stage_variable_overrides ApiGatewayStage#stage_variable_overrides}.
`useStageCache`	`java.lang.Boolean OR com.hashicorp.cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#use_stage_cache ApiGatewayStage#use_stage_cache}.

`deploymentId`^Required

public java.lang.String getDeploymentId();

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#deployment_id ApiGatewayStage#deployment_id}.

`percentTraffic`^Optional

public java.lang.Number getPercentTraffic();

Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#percent_traffic ApiGatewayStage#percent_traffic}.

`stageVariableOverrides`^Optional

public java.util.Map<java.lang.String, java.lang.String> getStageVariableOverrides();

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#stage_variable_overrides ApiGatewayStage#stage_variable_overrides}.

`useStageCache`^Optional

public java.lang.Object getUseStageCache();

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#use_stage_cache ApiGatewayStage#use_stage_cache}.

ApiGatewayStageConfig

Initializer

import com.hashicorp.cdktf.providers.aws.api_gateway_stage.ApiGatewayStageConfig;

ApiGatewayStageConfig.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>)
    .deploymentId(java.lang.String)
    .restApiId(java.lang.String)
    .stageName(java.lang.String)
//  .accessLogSettings(ApiGatewayStageAccessLogSettings)
//  .cacheClusterEnabled(java.lang.Boolean)
//  .cacheClusterEnabled(IResolvable)
//  .cacheClusterSize(java.lang.String)
//  .canarySettings(ApiGatewayStageCanarySettings)
//  .clientCertificateId(java.lang.String)
//  .description(java.lang.String)
//  .documentationVersion(java.lang.String)
//  .id(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
//  .variables(java.util.Map<java.lang.String, java.lang.String>)
//  .xrayTracingEnabled(java.lang.Boolean)
//  .xrayTracingEnabled(IResolvable)
    .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.
`deploymentId`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#deployment_id ApiGatewayStage#deployment_id}.
`restApiId`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#rest_api_id ApiGatewayStage#rest_api_id}.
`stageName`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#stage_name ApiGatewayStage#stage_name}.
`accessLogSettings`	`ApiGatewayStageAccessLogSettings`	access_log_settings block.
`cacheClusterEnabled`	`java.lang.Boolean OR com.hashicorp.cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#cache_cluster_enabled ApiGatewayStage#cache_cluster_enabled}.
`cacheClusterSize`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#cache_cluster_size ApiGatewayStage#cache_cluster_size}.
`canarySettings`	`ApiGatewayStageCanarySettings`	canary_settings block.
`clientCertificateId`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#client_certificate_id ApiGatewayStage#client_certificate_id}.
`description`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#description ApiGatewayStage#description}.
`documentationVersion`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#documentation_version ApiGatewayStage#documentation_version}.
`id`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#id ApiGatewayStage#id}.
`tags`	`java.util.Map<java.lang.String, java.lang.String>`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#tags ApiGatewayStage#tags}.
`tagsAll`	`java.util.Map<java.lang.String, java.lang.String>`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#tags_all ApiGatewayStage#tags_all}.
`variables`	`java.util.Map<java.lang.String, java.lang.String>`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#variables ApiGatewayStage#variables}.
`xrayTracingEnabled`	`java.lang.Boolean OR com.hashicorp.cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#xray_tracing_enabled ApiGatewayStage#xray_tracing_enabled}.

`connection`^Optional

public java.lang.Object getConnection();

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

`count`^Optional

public java.lang.Object getCount();

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

`dependsOn`^Optional

public java.util.List<ITerraformDependable> getDependsOn();

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

`forEach`^Optional

public ITerraformIterator getForEach();

Type: com.hashicorp.cdktf.ITerraformIterator

`lifecycle`^Optional

public TerraformResourceLifecycle getLifecycle();

Type: com.hashicorp.cdktf.TerraformResourceLifecycle

`provider`^Optional

public TerraformProvider getProvider();

Type: com.hashicorp.cdktf.TerraformProvider

`provisioners`^Optional

public java.lang.Object getProvisioners();

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

`deploymentId`^Required

public java.lang.String getDeploymentId();

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#deployment_id ApiGatewayStage#deployment_id}.

`restApiId`^Required

public java.lang.String getRestApiId();

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#rest_api_id ApiGatewayStage#rest_api_id}.

`stageName`^Required

public java.lang.String getStageName();

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#stage_name ApiGatewayStage#stage_name}.

`accessLogSettings`^Optional

public ApiGatewayStageAccessLogSettings getAccessLogSettings();

Type: ApiGatewayStageAccessLogSettings

access_log_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#access_log_settings ApiGatewayStage#access_log_settings}

`cacheClusterEnabled`^Optional

public java.lang.Object getCacheClusterEnabled();

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#cache_cluster_enabled ApiGatewayStage#cache_cluster_enabled}.

`cacheClusterSize`^Optional

public java.lang.String getCacheClusterSize();

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#cache_cluster_size ApiGatewayStage#cache_cluster_size}.

`canarySettings`^Optional

public ApiGatewayStageCanarySettings getCanarySettings();

Type: ApiGatewayStageCanarySettings

canary_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#canary_settings ApiGatewayStage#canary_settings}

`clientCertificateId`^Optional

public java.lang.String getClientCertificateId();

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#client_certificate_id ApiGatewayStage#client_certificate_id}.

`description`^Optional

public java.lang.String getDescription();

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#description ApiGatewayStage#description}.

`documentationVersion`^Optional

public java.lang.String getDocumentationVersion();

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#documentation_version ApiGatewayStage#documentation_version}.

`id`^Optional

public java.lang.String getId();

Type: java.lang.String

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

`tags`^Optional

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.89.0/docs/resources/api_gateway_stage#tags ApiGatewayStage#tags}.

`tagsAll`^Optional

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.89.0/docs/resources/api_gateway_stage#tags_all ApiGatewayStage#tags_all}.

`variables`^Optional

public java.util.Map<java.lang.String, java.lang.String> getVariables();

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#variables ApiGatewayStage#variables}.

`xrayTracingEnabled`^Optional

public java.lang.Object getXrayTracingEnabled();

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/api_gateway_stage#xray_tracing_enabled ApiGatewayStage#xray_tracing_enabled}.

Classes

ApiGatewayStageAccessLogSettingsOutputReference

Initializers

import com.hashicorp.cdktf.providers.aws.api_gateway_stage.ApiGatewayStageAccessLogSettingsOutputReference;

new ApiGatewayStageAccessLogSettingsOutputReference(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.

`terraformResource`^Required

Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

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.

`computeFqn`

public java.lang.String computeFqn()

`getAnyMapAttribute`

public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanAttribute`

public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanMapAttribute`

public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getListAttribute`

public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberAttribute`

public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberListAttribute`

public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberMapAttribute`

public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringAttribute`

public java.lang.String getStringAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringMapAttribute`

public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`interpolationForAttribute`

public IResolvable interpolationForAttribute(java.lang.String property)

`property`^Required

Type: java.lang.String

`resolve`

public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

`_context`^Required

Type: com.hashicorp.cdktf.IResolveContext

`toString`

public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

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.
`destinationArnInput`	`java.lang.String`	No description.
`formatInput`	`java.lang.String`	No description.
`destinationArn`	`java.lang.String`	No description.
`format`	`java.lang.String`	No description.
`internalValue`	`ApiGatewayStageAccessLogSettings`	No description.

`creationStack`^Required

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.

`fqn`^Required

public java.lang.String getFqn();

Type: java.lang.String

`destinationArnInput`^Optional

public java.lang.String getDestinationArnInput();

Type: java.lang.String

`formatInput`^Optional

public java.lang.String getFormatInput();

Type: java.lang.String

`destinationArn`^Required

public java.lang.String getDestinationArn();

Type: java.lang.String

`format`^Required

public java.lang.String getFormat();

Type: java.lang.String

`internalValue`^Optional

public ApiGatewayStageAccessLogSettings getInternalValue();

Type: ApiGatewayStageAccessLogSettings

ApiGatewayStageCanarySettingsOutputReference

Initializers

import com.hashicorp.cdktf.providers.aws.api_gateway_stage.ApiGatewayStageCanarySettingsOutputReference;

new ApiGatewayStageCanarySettingsOutputReference(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.

`terraformResource`^Required

Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

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.
`resetPercentTraffic`	No description.
`resetStageVariableOverrides`	No description.
`resetUseStageCache`	No description.

`computeFqn`

public java.lang.String computeFqn()

`getAnyMapAttribute`

public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanAttribute`

public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanMapAttribute`

public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getListAttribute`

public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberAttribute`

public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberListAttribute`

public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberMapAttribute`

public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringAttribute`

public java.lang.String getStringAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringMapAttribute`

public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`interpolationForAttribute`

public IResolvable interpolationForAttribute(java.lang.String property)

`property`^Required

Type: java.lang.String

`resolve`

public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

`_context`^Required

Type: com.hashicorp.cdktf.IResolveContext

`toString`

public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetPercentTraffic`

public void resetPercentTraffic()

`resetStageVariableOverrides`

public void resetStageVariableOverrides()

`resetUseStageCache`

public void resetUseStageCache()

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.
`deploymentIdInput`	`java.lang.String`	No description.
`percentTrafficInput`	`java.lang.Number`	No description.
`stageVariableOverridesInput`	`java.util.Map<java.lang.String, java.lang.String>`	No description.
`useStageCacheInput`	`java.lang.Boolean OR com.hashicorp.cdktf.IResolvable`	No description.
`deploymentId`	`java.lang.String`	No description.
`percentTraffic`	`java.lang.Number`	No description.
`stageVariableOverrides`	`java.util.Map<java.lang.String, java.lang.String>`	No description.
`useStageCache`	`java.lang.Boolean OR com.hashicorp.cdktf.IResolvable`	No description.
`internalValue`	`ApiGatewayStageCanarySettings`	No description.

`creationStack`^Required

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.

`fqn`^Required

public java.lang.String getFqn();

Type: java.lang.String

`deploymentIdInput`^Optional

public java.lang.String getDeploymentIdInput();

Type: java.lang.String

`percentTrafficInput`^Optional

public java.lang.Number getPercentTrafficInput();

Type: java.lang.Number

`stageVariableOverridesInput`^Optional

public java.util.Map<java.lang.String, java.lang.String> getStageVariableOverridesInput();

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

`useStageCacheInput`^Optional

public java.lang.Object getUseStageCacheInput();

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

`deploymentId`^Required

public java.lang.String getDeploymentId();

Type: java.lang.String

`percentTraffic`^Required

public java.lang.Number getPercentTraffic();

Type: java.lang.Number

`stageVariableOverrides`^Required

public java.util.Map<java.lang.String, java.lang.String> getStageVariableOverrides();

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

`useStageCache`^Required

public java.lang.Object getUseStageCache();

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

`internalValue`^Optional

public ApiGatewayStageCanarySettings getInternalValue();

Type: ApiGatewayStageCanarySettings

Files

apiGatewayStage.java.md

Latest commit

History

apiGatewayStage.java.md

File metadata and controls

apiGatewayStage Submodule

Constructs