Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy google_bigtable_gc_policy}.
import com.hashicorp.cdktf.providers.google.bigtable_gc_policy.BigtableGcPolicy;
BigtableGcPolicy.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>)
.columnFamily(java.lang.String)
.instanceName(java.lang.String)
.table(java.lang.String)
// .deletionPolicy(java.lang.String)
// .gcRules(java.lang.String)
// .id(java.lang.String)
// .ignoreWarnings(java.lang.Boolean)
// .ignoreWarnings(IResolvable)
// .maxAge(BigtableGcPolicyMaxAge)
// .maxVersion(IResolvable)
// .maxVersion(java.util.List<BigtableGcPolicyMaxVersion>)
// .mode(java.lang.String)
// .project(java.lang.String)
// .timeouts(BigtableGcPolicyTimeouts)
.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. |
columnFamily |
java.lang.String |
The name of the column family. |
instanceName |
java.lang.String |
The name of the Bigtable instance. |
table |
java.lang.String |
The name of the table. |
deletionPolicy |
java.lang.String |
The deletion policy for the GC policy. |
gcRules |
java.lang.String |
Serialized JSON string for garbage collection policy. Conflicts with "mode", "max_age" and "max_version". |
id |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#id BigtableGcPolicy#id}. |
ignoreWarnings |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
Allows ignoring warnings when updating the GC policy. |
maxAge |
BigtableGcPolicyMaxAge |
max_age block. |
maxVersion |
com.hashicorp.cdktf.IResolvable OR java.util.List<BigtableGcPolicyMaxVersion> |
max_version block. |
mode |
java.lang.String |
NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources. |
project |
java.lang.String |
The ID of the project in which the resource belongs. |
timeouts |
BigtableGcPolicyTimeouts |
timeouts block. |
- Type: software.constructs.Construct
The scope in which to define this construct.
- Type: java.lang.String
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
- Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
- Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
- Type: com.hashicorp.cdktf.ITerraformIterator
- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
- Type: com.hashicorp.cdktf.TerraformProvider
- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
- Type: java.lang.String
The name of the column family.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#column_family BigtableGcPolicy#column_family}
- Type: java.lang.String
The name of the Bigtable instance.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#instance_name BigtableGcPolicy#instance_name}
- Type: java.lang.String
The name of the table.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#table BigtableGcPolicy#table}
- Type: java.lang.String
The deletion policy for the GC policy.
Setting ABANDON allows the resource to be abandoned rather than deleted. This is useful for GC policy as it cannot be deleted in a replicated instance. Possible values are: "ABANDON".
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#deletion_policy BigtableGcPolicy#deletion_policy}
- Type: java.lang.String
Serialized JSON string for garbage collection policy. Conflicts with "mode", "max_age" and "max_version".
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#gc_rules BigtableGcPolicy#gc_rules}
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#id BigtableGcPolicy#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.
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
Allows ignoring warnings when updating the GC policy.
This can be used to increase the gc policy on replicated clusters. Doing this may make clusters be inconsistent for a longer period of time, before using this make sure you understand the risks listed at https://cloud.google.com/bigtable/docs/garbage-collection#increasing
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#ignore_warnings BigtableGcPolicy#ignore_warnings}
- Type: BigtableGcPolicyMaxAge
max_age block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#max_age BigtableGcPolicy#max_age}
- Type: com.hashicorp.cdktf.IResolvable OR java.util.List<BigtableGcPolicyMaxVersion>
max_version block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#max_version BigtableGcPolicy#max_version}
- Type: java.lang.String
NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources.
This field may be deprecated in the future. If multiple policies are set, you should choose between UNION OR INTERSECTION.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#mode BigtableGcPolicy#mode}
- Type: java.lang.String
The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#project BigtableGcPolicy#project}
- Type: BigtableGcPolicyTimeouts
timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#timeouts BigtableGcPolicy#timeouts}
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". |
putMaxAge |
No description. |
putMaxVersion |
No description. |
putTimeouts |
No description. |
resetDeletionPolicy |
No description. |
resetGcRules |
No description. |
resetId |
No description. |
resetIgnoreWarnings |
No description. |
resetMaxAge |
No description. |
resetMaxVersion |
No description. |
resetMode |
No description. |
resetProject |
No description. |
resetTimeouts |
No description. |
public java.lang.String toString()
Returns a string representation of this construct.
public void addOverride(java.lang.String path, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
public void overrideLogicalId(java.lang.String newLogicalId)
Overrides the auto-generated logical ID with a specific ID.
- Type: java.lang.String
The new logical ID to use for this stack element.
public void resetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
public java.lang.Object toHclTerraform()
public java.lang.Object toMetadata()
public java.lang.Object toTerraform()
Adds this resource to the terraform JSON output.
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.
- Type: java.lang.String
The string move target that will correspond to this resource.
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
- Type: java.lang.String
- Type: com.hashicorp.cdktf.TerraformProvider
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
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.
- Type: java.lang.String
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
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.
- Type: java.lang.String
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- 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.
public void moveToId(java.lang.String id)
Moves this resource to the resource corresponding to "id".
- Type: java.lang.String
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public void putMaxAge(BigtableGcPolicyMaxAge value)
- Type: BigtableGcPolicyMaxAge
public void putMaxVersion(IResolvable OR java.util.List<BigtableGcPolicyMaxVersion> value)
- Type: com.hashicorp.cdktf.IResolvable OR java.util.List<BigtableGcPolicyMaxVersion>
public void putTimeouts(BigtableGcPolicyTimeouts value)
- Type: BigtableGcPolicyTimeouts
public void resetDeletionPolicy()
public void resetGcRules()
public void resetId()
public void resetIgnoreWarnings()
public void resetMaxAge()
public void resetMaxVersion()
public void resetMode()
public void resetProject()
public void resetTimeouts()
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a BigtableGcPolicy resource upon running "cdktf plan ". |
import com.hashicorp.cdktf.providers.google.bigtable_gc_policy.BigtableGcPolicy;
BigtableGcPolicy.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.
- Type: java.lang.Object
Any object.
import com.hashicorp.cdktf.providers.google.bigtable_gc_policy.BigtableGcPolicy;
BigtableGcPolicy.isTerraformElement(java.lang.Object x)
- Type: java.lang.Object
import com.hashicorp.cdktf.providers.google.bigtable_gc_policy.BigtableGcPolicy;
BigtableGcPolicy.isTerraformResource(java.lang.Object x)
- Type: java.lang.Object
import com.hashicorp.cdktf.providers.google.bigtable_gc_policy.BigtableGcPolicy;
BigtableGcPolicy.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),BigtableGcPolicy.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)
Generates CDKTF code for importing a BigtableGcPolicy resource upon running "cdktf plan ".
- Type: software.constructs.Construct
The scope in which to define this construct.
- Type: java.lang.String
The construct id used in the generated config for the BigtableGcPolicy to import.
- Type: java.lang.String
The id of the existing BigtableGcPolicy that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#import import section} in the documentation of this resource for the id to use
- Type: com.hashicorp.cdktf.TerraformProvider
? Optional instance of the provider where the BigtableGcPolicy to import is found.
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. |
maxAge |
BigtableGcPolicyMaxAgeOutputReference |
No description. |
maxVersion |
BigtableGcPolicyMaxVersionList |
No description. |
timeouts |
BigtableGcPolicyTimeoutsOutputReference |
No description. |
columnFamilyInput |
java.lang.String |
No description. |
deletionPolicyInput |
java.lang.String |
No description. |
gcRulesInput |
java.lang.String |
No description. |
idInput |
java.lang.String |
No description. |
ignoreWarningsInput |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
instanceNameInput |
java.lang.String |
No description. |
maxAgeInput |
BigtableGcPolicyMaxAge |
No description. |
maxVersionInput |
com.hashicorp.cdktf.IResolvable OR java.util.List<BigtableGcPolicyMaxVersion> |
No description. |
modeInput |
java.lang.String |
No description. |
projectInput |
java.lang.String |
No description. |
tableInput |
java.lang.String |
No description. |
timeoutsInput |
com.hashicorp.cdktf.IResolvable OR BigtableGcPolicyTimeouts |
No description. |
columnFamily |
java.lang.String |
No description. |
deletionPolicy |
java.lang.String |
No description. |
gcRules |
java.lang.String |
No description. |
id |
java.lang.String |
No description. |
ignoreWarnings |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
instanceName |
java.lang.String |
No description. |
mode |
java.lang.String |
No description. |
project |
java.lang.String |
No description. |
table |
java.lang.String |
No description. |
public Node getNode();
- Type: software.constructs.Node
The tree node.
public TerraformStack getCdktfStack();
- Type: com.hashicorp.cdktf.TerraformStack
public java.lang.String getFqn();
- Type: java.lang.String
public java.lang.String getFriendlyUniqueId();
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
- Type: java.util.Map<java.lang.String, java.lang.Object>
public java.lang.String getTerraformResourceType();
- Type: java.lang.String
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
- Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
public java.lang.Object getConnection();
- Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
public java.lang.Object getCount();
- Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
public java.util.List<java.lang.String> getDependsOn();
- Type: java.util.List<java.lang.String>
public ITerraformIterator getForEach();
- Type: com.hashicorp.cdktf.ITerraformIterator
public TerraformResourceLifecycle getLifecycle();
- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
public TerraformProvider getProvider();
- Type: com.hashicorp.cdktf.TerraformProvider
public java.lang.Object getProvisioners();
- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
public BigtableGcPolicyMaxAgeOutputReference getMaxAge();
public BigtableGcPolicyMaxVersionList getMaxVersion();
public BigtableGcPolicyTimeoutsOutputReference getTimeouts();
public java.lang.String getColumnFamilyInput();
- Type: java.lang.String
public java.lang.String getDeletionPolicyInput();
- Type: java.lang.String
public java.lang.String getGcRulesInput();
- Type: java.lang.String
public java.lang.String getIdInput();
- Type: java.lang.String
public java.lang.Object getIgnoreWarningsInput();
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.lang.String getInstanceNameInput();
- Type: java.lang.String
public BigtableGcPolicyMaxAge getMaxAgeInput();
- Type: BigtableGcPolicyMaxAge
public java.lang.Object getMaxVersionInput();
- Type: com.hashicorp.cdktf.IResolvable OR java.util.List<BigtableGcPolicyMaxVersion>
public java.lang.String getModeInput();
- Type: java.lang.String
public java.lang.String getProjectInput();
- Type: java.lang.String
public java.lang.String getTableInput();
- Type: java.lang.String
public java.lang.Object getTimeoutsInput();
- Type: com.hashicorp.cdktf.IResolvable OR BigtableGcPolicyTimeouts
public java.lang.String getColumnFamily();
- Type: java.lang.String
public java.lang.String getDeletionPolicy();
- Type: java.lang.String
public java.lang.String getGcRules();
- Type: java.lang.String
public java.lang.String getId();
- Type: java.lang.String
public java.lang.Object getIgnoreWarnings();
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.lang.String getInstanceName();
- Type: java.lang.String
public java.lang.String getMode();
- Type: java.lang.String
public java.lang.String getProject();
- Type: java.lang.String
public java.lang.String getTable();
- Type: java.lang.String
Name | Type | Description |
---|---|---|
tfResourceType |
java.lang.String |
No description. |
public java.lang.String getTfResourceType();
- Type: java.lang.String
import com.hashicorp.cdktf.providers.google.bigtable_gc_policy.BigtableGcPolicyConfig;
BigtableGcPolicyConfig.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>)
.columnFamily(java.lang.String)
.instanceName(java.lang.String)
.table(java.lang.String)
// .deletionPolicy(java.lang.String)
// .gcRules(java.lang.String)
// .id(java.lang.String)
// .ignoreWarnings(java.lang.Boolean)
// .ignoreWarnings(IResolvable)
// .maxAge(BigtableGcPolicyMaxAge)
// .maxVersion(IResolvable)
// .maxVersion(java.util.List<BigtableGcPolicyMaxVersion>)
// .mode(java.lang.String)
// .project(java.lang.String)
// .timeouts(BigtableGcPolicyTimeouts)
.build();
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. |
columnFamily |
java.lang.String |
The name of the column family. |
instanceName |
java.lang.String |
The name of the Bigtable instance. |
table |
java.lang.String |
The name of the table. |
deletionPolicy |
java.lang.String |
The deletion policy for the GC policy. |
gcRules |
java.lang.String |
Serialized JSON string for garbage collection policy. Conflicts with "mode", "max_age" and "max_version". |
id |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#id BigtableGcPolicy#id}. |
ignoreWarnings |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
Allows ignoring warnings when updating the GC policy. |
maxAge |
BigtableGcPolicyMaxAge |
max_age block. |
maxVersion |
com.hashicorp.cdktf.IResolvable OR java.util.List<BigtableGcPolicyMaxVersion> |
max_version block. |
mode |
java.lang.String |
NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources. |
project |
java.lang.String |
The ID of the project in which the resource belongs. |
timeouts |
BigtableGcPolicyTimeouts |
timeouts block. |
public java.lang.Object getConnection();
- Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
public java.lang.Object getCount();
- Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
public java.util.List<ITerraformDependable> getDependsOn();
- Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
public ITerraformIterator getForEach();
- Type: com.hashicorp.cdktf.ITerraformIterator
public TerraformResourceLifecycle getLifecycle();
- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
public TerraformProvider getProvider();
- Type: com.hashicorp.cdktf.TerraformProvider
public java.lang.Object getProvisioners();
- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
public java.lang.String getColumnFamily();
- Type: java.lang.String
The name of the column family.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#column_family BigtableGcPolicy#column_family}
public java.lang.String getInstanceName();
- Type: java.lang.String
The name of the Bigtable instance.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#instance_name BigtableGcPolicy#instance_name}
public java.lang.String getTable();
- Type: java.lang.String
The name of the table.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#table BigtableGcPolicy#table}
public java.lang.String getDeletionPolicy();
- Type: java.lang.String
The deletion policy for the GC policy.
Setting ABANDON allows the resource to be abandoned rather than deleted. This is useful for GC policy as it cannot be deleted in a replicated instance. Possible values are: "ABANDON".
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#deletion_policy BigtableGcPolicy#deletion_policy}
public java.lang.String getGcRules();
- Type: java.lang.String
Serialized JSON string for garbage collection policy. Conflicts with "mode", "max_age" and "max_version".
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#gc_rules BigtableGcPolicy#gc_rules}
public java.lang.String getId();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#id BigtableGcPolicy#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.
public java.lang.Object getIgnoreWarnings();
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
Allows ignoring warnings when updating the GC policy.
This can be used to increase the gc policy on replicated clusters. Doing this may make clusters be inconsistent for a longer period of time, before using this make sure you understand the risks listed at https://cloud.google.com/bigtable/docs/garbage-collection#increasing
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#ignore_warnings BigtableGcPolicy#ignore_warnings}
public BigtableGcPolicyMaxAge getMaxAge();
- Type: BigtableGcPolicyMaxAge
max_age block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#max_age BigtableGcPolicy#max_age}
public java.lang.Object getMaxVersion();
- Type: com.hashicorp.cdktf.IResolvable OR java.util.List<BigtableGcPolicyMaxVersion>
max_version block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#max_version BigtableGcPolicy#max_version}
public java.lang.String getMode();
- Type: java.lang.String
NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources.
This field may be deprecated in the future. If multiple policies are set, you should choose between UNION OR INTERSECTION.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#mode BigtableGcPolicy#mode}
public java.lang.String getProject();
- Type: java.lang.String
The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#project BigtableGcPolicy#project}
public BigtableGcPolicyTimeouts getTimeouts();
- Type: BigtableGcPolicyTimeouts
timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#timeouts BigtableGcPolicy#timeouts}
import com.hashicorp.cdktf.providers.google.bigtable_gc_policy.BigtableGcPolicyMaxAge;
BigtableGcPolicyMaxAge.builder()
// .days(java.lang.Number)
// .duration(java.lang.String)
.build();
Name | Type | Description |
---|---|---|
days |
java.lang.Number |
Number of days before applying GC policy. |
duration |
java.lang.String |
Duration before applying GC policy. |
public java.lang.Number getDays();
- Type: java.lang.Number
Number of days before applying GC policy.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#days BigtableGcPolicy#days}
public java.lang.String getDuration();
- Type: java.lang.String
Duration before applying GC policy.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#duration BigtableGcPolicy#duration}
import com.hashicorp.cdktf.providers.google.bigtable_gc_policy.BigtableGcPolicyMaxVersion;
BigtableGcPolicyMaxVersion.builder()
.number(java.lang.Number)
.build();
Name | Type | Description |
---|---|---|
number |
java.lang.Number |
Number of version before applying the GC policy. |
public java.lang.Number getNumber();
- Type: java.lang.Number
Number of version before applying the GC policy.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#number BigtableGcPolicy#number}
import com.hashicorp.cdktf.providers.google.bigtable_gc_policy.BigtableGcPolicyTimeouts;
BigtableGcPolicyTimeouts.builder()
// .create(java.lang.String)
// .delete(java.lang.String)
.build();
Name | Type | Description |
---|---|---|
create |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#create BigtableGcPolicy#create}. |
delete |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#delete BigtableGcPolicy#delete}. |
public java.lang.String getCreate();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#create BigtableGcPolicy#create}.
public java.lang.String getDelete();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/bigtable_gc_policy#delete BigtableGcPolicy#delete}.
import com.hashicorp.cdktf.providers.google.bigtable_gc_policy.BigtableGcPolicyMaxAgeOutputReference;
new BigtableGcPolicyMaxAgeOutputReference(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. |
- Type: com.hashicorp.cdktf.IInterpolatingParent
The parent resource.
- Type: java.lang.String
The attribute on the parent resource this class is referencing.
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. |
resetDays |
No description. |
resetDuration |
No description. |
public java.lang.String computeFqn()
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable interpolationForAttribute(java.lang.String property)
- Type: java.lang.String
public java.lang.Object resolve(IResolveContext _context)
Produce the Token's value at resolution time.
- Type: com.hashicorp.cdktf.IResolveContext
public java.lang.String toString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
public void resetDays()
public void resetDuration()
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. |
daysInput |
java.lang.Number |
No description. |
durationInput |
java.lang.String |
No description. |
days |
java.lang.Number |
No description. |
duration |
java.lang.String |
No description. |
internalValue |
BigtableGcPolicyMaxAge |
No description. |
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.
public java.lang.String getFqn();
- Type: java.lang.String
public java.lang.Number getDaysInput();
- Type: java.lang.Number
public java.lang.String getDurationInput();
- Type: java.lang.String
public java.lang.Number getDays();
- Type: java.lang.Number
public java.lang.String getDuration();
- Type: java.lang.String
public BigtableGcPolicyMaxAge getInternalValue();
- Type: BigtableGcPolicyMaxAge
import com.hashicorp.cdktf.providers.google.bigtable_gc_policy.BigtableGcPolicyMaxVersionList;
new BigtableGcPolicyMaxVersionList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet);
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. |
wrapsSet |
java.lang.Boolean |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: com.hashicorp.cdktf.IInterpolatingParent
The parent resource.
- Type: java.lang.String
The attribute on the parent resource this class is referencing.
- Type: java.lang.Boolean
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
Name | Description |
---|---|
allWithMapKey |
Creating an iterator for this complex list. |
computeFqn |
No description. |
resolve |
Produce the Token's value at resolution time. |
toString |
Return a string representation of this resolvable object. |
get |
No description. |
public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName)
Creating an iterator for this complex list.
The list will be converted into a map with the mapKeyAttributeName as the key.
- Type: java.lang.String
public java.lang.String computeFqn()
public java.lang.Object resolve(IResolveContext _context)
Produce the Token's value at resolution time.
- Type: com.hashicorp.cdktf.IResolveContext
public java.lang.String toString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
public BigtableGcPolicyMaxVersionOutputReference get(java.lang.Number index)
- Type: java.lang.Number
the index of the item to return.
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. |
internalValue |
com.hashicorp.cdktf.IResolvable OR java.util.List<BigtableGcPolicyMaxVersion> |
No description. |
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.
public java.lang.String getFqn();
- Type: java.lang.String
public java.lang.Object getInternalValue();
- Type: com.hashicorp.cdktf.IResolvable OR java.util.List<BigtableGcPolicyMaxVersion>
import com.hashicorp.cdktf.providers.google.bigtable_gc_policy.BigtableGcPolicyMaxVersionOutputReference;
new BigtableGcPolicyMaxVersionOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet);
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. |
complexObjectIndex |
java.lang.Number |
the index of this item in the list. |
complexObjectIsFromSet |
java.lang.Boolean |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: com.hashicorp.cdktf.IInterpolatingParent
The parent resource.
- Type: java.lang.String
The attribute on the parent resource this class is referencing.
- Type: java.lang.Number
the index of this item in the list.
- Type: java.lang.Boolean
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
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. |
public java.lang.String computeFqn()
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable interpolationForAttribute(java.lang.String property)
- Type: java.lang.String
public java.lang.Object resolve(IResolveContext _context)
Produce the Token's value at resolution time.
- Type: com.hashicorp.cdktf.IResolveContext
public java.lang.String toString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
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. |
numberInput |
java.lang.Number |
No description. |
number |
java.lang.Number |
No description. |
internalValue |
com.hashicorp.cdktf.IResolvable OR BigtableGcPolicyMaxVersion |
No description. |
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.
public java.lang.String getFqn();
- Type: java.lang.String
public java.lang.Number getNumberInput();
- Type: java.lang.Number
public java.lang.Number getNumber();
- Type: java.lang.Number
public java.lang.Object getInternalValue();
- Type: com.hashicorp.cdktf.IResolvable OR BigtableGcPolicyMaxVersion
import com.hashicorp.cdktf.providers.google.bigtable_gc_policy.BigtableGcPolicyTimeoutsOutputReference;
new BigtableGcPolicyTimeoutsOutputReference(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. |
- Type: com.hashicorp.cdktf.IInterpolatingParent
The parent resource.
- Type: java.lang.String
The attribute on the parent resource this class is referencing.
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. |
public java.lang.String computeFqn()
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable interpolationForAttribute(java.lang.String property)
- Type: java.lang.String
public java.lang.Object resolve(IResolveContext _context)
Produce the Token's value at resolution time.
- Type: com.hashicorp.cdktf.IResolveContext
public java.lang.String toString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
public void resetCreate()
public void resetDelete()
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. |
create |
java.lang.String |
No description. |
delete |
java.lang.String |
No description. |
internalValue |
com.hashicorp.cdktf.IResolvable OR BigtableGcPolicyTimeouts |
No description. |
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.
public java.lang.String getFqn();
- Type: java.lang.String
public java.lang.String getCreateInput();
- Type: java.lang.String
public java.lang.String getDeleteInput();
- Type: java.lang.String
public java.lang.String getCreate();
- Type: java.lang.String
public java.lang.String getDelete();
- Type: java.lang.String
public java.lang.Object getInternalValue();
- Type: com.hashicorp.cdktf.IResolvable OR BigtableGcPolicyTimeouts