Skip to content
This repository was archived by the owner on Dec 10, 2025. It is now read-only.

Latest commit

 

History

History
2149 lines (1349 loc) · 105 KB

File metadata and controls

2149 lines (1349 loc) · 105 KB

cloudformationStack Submodule

Constructs

CloudformationStack

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack aws_cloudformation_stack}.

Initializers

import com.hashicorp.cdktf.providers.aws.cloudformation_stack.CloudformationStack;

CloudformationStack.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .name(java.lang.String)
//  .capabilities(java.util.List<java.lang.String>)
//  .disableRollback(java.lang.Boolean|IResolvable)
//  .iamRoleArn(java.lang.String)
//  .id(java.lang.String)
//  .notificationArns(java.util.List<java.lang.String>)
//  .onFailure(java.lang.String)
//  .parameters(java.util.Map<java.lang.String, java.lang.String>)
//  .policyBody(java.lang.String)
//  .policyUrl(java.lang.String)
//  .region(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
//  .templateBody(java.lang.String)
//  .templateUrl(java.lang.String)
//  .timeoutInMinutes(java.lang.Number)
//  .timeouts(CloudformationStackTimeouts)
    .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|com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number|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|com.hashicorp.cdktf.LocalExecProvisioner|com.hashicorp.cdktf.RemoteExecProvisioner> No description.
name java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#name CloudformationStack#name}.
capabilities java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#capabilities CloudformationStack#capabilities}.
disableRollback java.lang.Boolean|com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#disable_rollback CloudformationStack#disable_rollback}.
iamRoleArn java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#iam_role_arn CloudformationStack#iam_role_arn}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#id CloudformationStack#id}.
notificationArns java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#notification_arns CloudformationStack#notification_arns}.
onFailure java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#on_failure CloudformationStack#on_failure}.
parameters java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#parameters CloudformationStack#parameters}.
policyBody java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#policy_body CloudformationStack#policy_body}.
policyUrl java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#policy_url CloudformationStack#policy_url}.
region java.lang.String Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#tags CloudformationStack#tags}.
tagsAll java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#tags_all CloudformationStack#tags_all}.
templateBody java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#template_body CloudformationStack#template_body}.
templateUrl java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#template_url CloudformationStack#template_url}.
timeoutInMinutes java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#timeout_in_minutes CloudformationStack#timeout_in_minutes}.
timeouts CloudformationStackTimeouts timeouts block.

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|com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
  • Type: java.lang.Number|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|com.hashicorp.cdktf.LocalExecProvisioner|com.hashicorp.cdktf.RemoteExecProvisioner>

nameRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#name CloudformationStack#name}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#capabilities CloudformationStack#capabilities}.


disableRollbackOptional
  • Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#disable_rollback CloudformationStack#disable_rollback}.


iamRoleArnOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#iam_role_arn CloudformationStack#iam_role_arn}.


idOptional
  • Type: java.lang.String

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


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#notification_arns CloudformationStack#notification_arns}.


onFailureOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#on_failure CloudformationStack#on_failure}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#parameters CloudformationStack#parameters}.


policyBodyOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#policy_body CloudformationStack#policy_body}.


policyUrlOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#policy_url CloudformationStack#policy_url}.


regionOptional
  • Type: java.lang.String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#region CloudformationStack#region}


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#tags CloudformationStack#tags}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#tags_all CloudformationStack#tags_all}.


templateBodyOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#template_body CloudformationStack#template_body}.


templateUrlOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#template_url CloudformationStack#template_url}.


timeoutInMinutesOptional
  • Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#timeout_in_minutes CloudformationStack#timeout_in_minutes}.


timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#timeouts CloudformationStack#timeouts}


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".
putTimeouts No description.
resetCapabilities No description.
resetDisableRollback No description.
resetIamRoleArn No description.
resetId No description.
resetNotificationArns No description.
resetOnFailure No description.
resetParameters No description.
resetPolicyBody No description.
resetPolicyUrl No description.
resetRegion No description.
resetTags No description.
resetTagsAll No description.
resetTemplateBody No description.
resetTemplateUrl No description.
resetTimeoutInMinutes No description.
resetTimeouts 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|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|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|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".


putTimeouts
public void putTimeouts(CloudformationStackTimeouts value)
valueRequired

resetCapabilities
public void resetCapabilities()
resetDisableRollback
public void resetDisableRollback()
resetIamRoleArn
public void resetIamRoleArn()
resetId
public void resetId()
resetNotificationArns
public void resetNotificationArns()
resetOnFailure
public void resetOnFailure()
resetParameters
public void resetParameters()
resetPolicyBody
public void resetPolicyBody()
resetPolicyUrl
public void resetPolicyUrl()
resetRegion
public void resetRegion()
resetTags
public void resetTags()
resetTagsAll
public void resetTagsAll()
resetTemplateBody
public void resetTemplateBody()
resetTemplateUrl
public void resetTemplateUrl()
resetTimeoutInMinutes
public void resetTimeoutInMinutes()
resetTimeouts
public void resetTimeouts()

Static Functions

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

isConstruct
import com.hashicorp.cdktf.providers.aws.cloudformation_stack.CloudformationStack;

CloudformationStack.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.cloudformation_stack.CloudformationStack;

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

isTerraformResource
import com.hashicorp.cdktf.providers.aws.cloudformation_stack.CloudformationStack;

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

generateConfigForImport
import com.hashicorp.cdktf.providers.aws.cloudformation_stack.CloudformationStack;

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

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


importFromIdRequired
  • Type: java.lang.String

The id of the existing CloudformationStack that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#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 CloudformationStack 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|com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number|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|com.hashicorp.cdktf.LocalExecProvisioner|com.hashicorp.cdktf.RemoteExecProvisioner> No description.
outputs com.hashicorp.cdktf.StringMap No description.
timeouts CloudformationStackTimeoutsOutputReference No description.
capabilitiesInput java.util.List<java.lang.String> No description.
disableRollbackInput java.lang.Boolean|com.hashicorp.cdktf.IResolvable No description.
iamRoleArnInput java.lang.String No description.
idInput java.lang.String No description.
nameInput java.lang.String No description.
notificationArnsInput java.util.List<java.lang.String> No description.
onFailureInput java.lang.String No description.
parametersInput java.util.Map<java.lang.String, java.lang.String> No description.
policyBodyInput java.lang.String No description.
policyUrlInput java.lang.String No description.
regionInput 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.
templateBodyInput java.lang.String No description.
templateUrlInput java.lang.String No description.
timeoutInMinutesInput java.lang.Number No description.
timeoutsInput com.hashicorp.cdktf.IResolvable|CloudformationStackTimeouts No description.
capabilities java.util.List<java.lang.String> No description.
disableRollback java.lang.Boolean|com.hashicorp.cdktf.IResolvable No description.
iamRoleArn java.lang.String No description.
id java.lang.String No description.
name java.lang.String No description.
notificationArns java.util.List<java.lang.String> No description.
onFailure java.lang.String No description.
parameters java.util.Map<java.lang.String, java.lang.String> No description.
policyBody java.lang.String No description.
policyUrl java.lang.String No description.
region 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.
templateBody java.lang.String No description.
templateUrl java.lang.String No description.
timeoutInMinutes java.lang.Number 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 SSHProvisionerConnection|WinrmProvisionerConnection getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection|com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Number|TerraformCount getCount();
  • Type: java.lang.Number|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.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner|com.hashicorp.cdktf.LocalExecProvisioner|com.hashicorp.cdktf.RemoteExecProvisioner>

outputsRequired
public StringMap getOutputs();
  • Type: com.hashicorp.cdktf.StringMap

timeoutsRequired
public CloudformationStackTimeoutsOutputReference getTimeouts();

capabilitiesInputOptional
public java.util.List<java.lang.String> getCapabilitiesInput();
  • Type: java.util.List<java.lang.String>

disableRollbackInputOptional
public java.lang.Boolean|IResolvable getDisableRollbackInput();
  • Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable

iamRoleArnInputOptional
public java.lang.String getIamRoleArnInput();
  • Type: java.lang.String

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

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

notificationArnsInputOptional
public java.util.List<java.lang.String> getNotificationArnsInput();
  • Type: java.util.List<java.lang.String>

onFailureInputOptional
public java.lang.String getOnFailureInput();
  • 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>

policyBodyInputOptional
public java.lang.String getPolicyBodyInput();
  • Type: java.lang.String

policyUrlInputOptional
public java.lang.String getPolicyUrlInput();
  • Type: java.lang.String

regionInputOptional
public java.lang.String getRegionInput();
  • 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>

templateBodyInputOptional
public java.lang.String getTemplateBodyInput();
  • Type: java.lang.String

templateUrlInputOptional
public java.lang.String getTemplateUrlInput();
  • Type: java.lang.String

timeoutInMinutesInputOptional
public java.lang.Number getTimeoutInMinutesInput();
  • Type: java.lang.Number

timeoutsInputOptional
public IResolvable|CloudformationStackTimeouts getTimeoutsInput();

capabilitiesRequired
public java.util.List<java.lang.String> getCapabilities();
  • Type: java.util.List<java.lang.String>

disableRollbackRequired
public java.lang.Boolean|IResolvable getDisableRollback();
  • Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable

iamRoleArnRequired
public java.lang.String getIamRoleArn();
  • Type: java.lang.String

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

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

notificationArnsRequired
public java.util.List<java.lang.String> getNotificationArns();
  • Type: java.util.List<java.lang.String>

onFailureRequired
public java.lang.String getOnFailure();
  • 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>

policyBodyRequired
public java.lang.String getPolicyBody();
  • Type: java.lang.String

policyUrlRequired
public java.lang.String getPolicyUrl();
  • Type: java.lang.String

regionRequired
public java.lang.String getRegion();
  • 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>

templateBodyRequired
public java.lang.String getTemplateBody();
  • Type: java.lang.String

templateUrlRequired
public java.lang.String getTemplateUrl();
  • Type: java.lang.String

timeoutInMinutesRequired
public java.lang.Number getTimeoutInMinutes();
  • Type: java.lang.Number

Constants

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

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

Structs

CloudformationStackConfig

Initializer

import com.hashicorp.cdktf.providers.aws.cloudformation_stack.CloudformationStackConfig;

CloudformationStackConfig.builder()
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .name(java.lang.String)
//  .capabilities(java.util.List<java.lang.String>)
//  .disableRollback(java.lang.Boolean|IResolvable)
//  .iamRoleArn(java.lang.String)
//  .id(java.lang.String)
//  .notificationArns(java.util.List<java.lang.String>)
//  .onFailure(java.lang.String)
//  .parameters(java.util.Map<java.lang.String, java.lang.String>)
//  .policyBody(java.lang.String)
//  .policyUrl(java.lang.String)
//  .region(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
//  .templateBody(java.lang.String)
//  .templateUrl(java.lang.String)
//  .timeoutInMinutes(java.lang.Number)
//  .timeouts(CloudformationStackTimeouts)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection|com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number|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|com.hashicorp.cdktf.LocalExecProvisioner|com.hashicorp.cdktf.RemoteExecProvisioner> No description.
name java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#name CloudformationStack#name}.
capabilities java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#capabilities CloudformationStack#capabilities}.
disableRollback java.lang.Boolean|com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#disable_rollback CloudformationStack#disable_rollback}.
iamRoleArn java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#iam_role_arn CloudformationStack#iam_role_arn}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#id CloudformationStack#id}.
notificationArns java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#notification_arns CloudformationStack#notification_arns}.
onFailure java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#on_failure CloudformationStack#on_failure}.
parameters java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#parameters CloudformationStack#parameters}.
policyBody java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#policy_body CloudformationStack#policy_body}.
policyUrl java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#policy_url CloudformationStack#policy_url}.
region java.lang.String Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#tags CloudformationStack#tags}.
tagsAll java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#tags_all CloudformationStack#tags_all}.
templateBody java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#template_body CloudformationStack#template_body}.
templateUrl java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#template_url CloudformationStack#template_url}.
timeoutInMinutes java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#timeout_in_minutes CloudformationStack#timeout_in_minutes}.
timeouts CloudformationStackTimeouts timeouts block.

connectionOptional
public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection|com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Number|TerraformCount getCount();
  • Type: java.lang.Number|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.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner|com.hashicorp.cdktf.LocalExecProvisioner|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/6.25.0/docs/resources/cloudformation_stack#name CloudformationStack#name}.


capabilitiesOptional
public java.util.List<java.lang.String> getCapabilities();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#capabilities CloudformationStack#capabilities}.


disableRollbackOptional
public java.lang.Boolean|IResolvable getDisableRollback();
  • Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#disable_rollback CloudformationStack#disable_rollback}.


iamRoleArnOptional
public java.lang.String getIamRoleArn();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#iam_role_arn CloudformationStack#iam_role_arn}.


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

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


notificationArnsOptional
public java.util.List<java.lang.String> getNotificationArns();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#notification_arns CloudformationStack#notification_arns}.


onFailureOptional
public java.lang.String getOnFailure();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#on_failure CloudformationStack#on_failure}.


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/6.25.0/docs/resources/cloudformation_stack#parameters CloudformationStack#parameters}.


policyBodyOptional
public java.lang.String getPolicyBody();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#policy_body CloudformationStack#policy_body}.


policyUrlOptional
public java.lang.String getPolicyUrl();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#policy_url CloudformationStack#policy_url}.


regionOptional
public java.lang.String getRegion();
  • Type: java.lang.String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#region CloudformationStack#region}


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/6.25.0/docs/resources/cloudformation_stack#tags CloudformationStack#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/6.25.0/docs/resources/cloudformation_stack#tags_all CloudformationStack#tags_all}.


templateBodyOptional
public java.lang.String getTemplateBody();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#template_body CloudformationStack#template_body}.


templateUrlOptional
public java.lang.String getTemplateUrl();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#template_url CloudformationStack#template_url}.


timeoutInMinutesOptional
public java.lang.Number getTimeoutInMinutes();
  • Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#timeout_in_minutes CloudformationStack#timeout_in_minutes}.


timeoutsOptional
public CloudformationStackTimeouts getTimeouts();

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#timeouts CloudformationStack#timeouts}


CloudformationStackTimeouts

Initializer

import com.hashicorp.cdktf.providers.aws.cloudformation_stack.CloudformationStackTimeouts;

CloudformationStackTimeouts.builder()
//  .create(java.lang.String)
//  .delete(java.lang.String)
//  .update(java.lang.String)
    .build();

Properties

Name Type Description
create java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#create CloudformationStack#create}.
delete java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#delete CloudformationStack#delete}.
update java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#update CloudformationStack#update}.

createOptional
public java.lang.String getCreate();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#create CloudformationStack#create}.


deleteOptional
public java.lang.String getDelete();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#delete CloudformationStack#delete}.


updateOptional
public java.lang.String getUpdate();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/cloudformation_stack#update CloudformationStack#update}.


Classes

CloudformationStackTimeoutsOutputReference

Initializers

import com.hashicorp.cdktf.providers.aws.cloudformation_stack.CloudformationStackTimeoutsOutputReference;

new CloudformationStackTimeoutsOutputReference(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.
resetCreate No description.
resetDelete No description.
resetUpdate 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.

resetCreate
public void resetCreate()
resetDelete
public void resetDelete()
resetUpdate
public void resetUpdate()

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.
createInput java.lang.String No description.
deleteInput java.lang.String No description.
updateInput java.lang.String No description.
create java.lang.String No description.
delete java.lang.String No description.
update java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable|CloudformationStackTimeouts 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

createInputOptional
public java.lang.String getCreateInput();
  • Type: java.lang.String

deleteInputOptional
public java.lang.String getDeleteInput();
  • Type: java.lang.String

updateInputOptional
public java.lang.String getUpdateInput();
  • Type: java.lang.String

createRequired
public java.lang.String getCreate();
  • Type: java.lang.String

deleteRequired
public java.lang.String getDelete();
  • Type: java.lang.String

updateRequired
public java.lang.String getUpdate();
  • Type: java.lang.String

internalValueOptional
public IResolvable|CloudformationStackTimeouts getInternalValue();