Skip to content

Latest commit

 

History

History
2489 lines (1539 loc) · 104 KB

bigtableTable.csharp.md

File metadata and controls

2489 lines (1539 loc) · 104 KB

bigtableTable Submodule

Constructs

BigtableTable

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table google_bigtable_table}.

Initializers 

using HashiCorp.Cdktf.Providers.Google;

new BigtableTable(Construct Scope, string Id, BigtableTableConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config BigtableTableConfig No description.
ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

ConfigRequired

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".
PutAutomatedBackupPolicy No description.
PutColumnFamily No description.
PutTimeouts No description.
ResetAutomatedBackupPolicy No description.
ResetChangeStreamRetention No description.
ResetColumnFamily No description.
ResetDeletionProtection No description.
ResetId No description.
ResetProject No description.
ResetSplitKeys No description.
ResetTimeouts No description.
ToString 
private string ToString()

Returns a string representation of this construct.

AddOverride 
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string
ValueRequired
  • Type: object
OverrideLogicalId 
private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
private void ResetOverrideLogicalId()

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

ToHclTerraform 
private object ToHclTerraform()
ToMetadata 
private object ToMetadata()
ToTerraform 
private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget 
private void AddMoveTarget(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: string

The string move target that will correspond to this resource.

GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
HasResourceMove 
private object HasResourceMove()
ImportFrom 
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string
ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
MoveFromId 
private void MoveFromId(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: string

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

MoveTo 
private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTargetRequired
  • Type: string

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

IndexOptional
  • Type: object

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

MoveToId 
private void MoveToId(string Id)

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

IdRequired
  • Type: string

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

PutAutomatedBackupPolicy 
private void PutAutomatedBackupPolicy(BigtableTableAutomatedBackupPolicy Value)
ValueRequired
PutColumnFamily 
private void PutColumnFamily(object Value)
ValueRequired
  • Type: object
PutTimeouts 
private void PutTimeouts(BigtableTableTimeouts Value)
ValueRequired
ResetAutomatedBackupPolicy 
private void ResetAutomatedBackupPolicy()
ResetChangeStreamRetention 
private void ResetChangeStreamRetention()
ResetColumnFamily 
private void ResetColumnFamily()
ResetDeletionProtection 
private void ResetDeletionProtection()
ResetId 
private void ResetId()
ResetProject 
private void ResetProject()
ResetSplitKeys 
private void ResetSplitKeys()
ResetTimeouts 
private 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 BigtableTable resource upon running "cdktf plan ".
IsConstruct 
using HashiCorp.Cdktf.Providers.Google;

BigtableTable.IsConstruct(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: object

Any object.

IsTerraformElement 
using HashiCorp.Cdktf.Providers.Google;

BigtableTable.IsTerraformElement(object X);
XRequired
  • Type: object
IsTerraformResource 
using HashiCorp.Cdktf.Providers.Google;

BigtableTable.IsTerraformResource(object X);
XRequired
  • Type: object
GenerateConfigForImport 
using HashiCorp.Cdktf.Providers.Google;

BigtableTable.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

ImportToIdRequired
  • Type: string

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

ImportFromIdRequired
  • Type: string

The id of the existing BigtableTable that should be imported.

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

ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

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

Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
TerraformMetaArguments System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
Connection object No description.
Count object No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
AutomatedBackupPolicy BigtableTableAutomatedBackupPolicyOutputReference No description.
ColumnFamily BigtableTableColumnFamilyList No description.
Timeouts BigtableTableTimeoutsOutputReference No description.
AutomatedBackupPolicyInput BigtableTableAutomatedBackupPolicy No description.
ChangeStreamRetentionInput string No description.
ColumnFamilyInput object No description.
DeletionProtectionInput string No description.
IdInput string No description.
InstanceNameInput string No description.
NameInput string No description.
ProjectInput string No description.
SplitKeysInput string[] No description.
TimeoutsInput object No description.
ChangeStreamRetention string No description.
DeletionProtection string No description.
Id string No description.
InstanceName string No description.
Name string No description.
Project string No description.
SplitKeys string[] No description.
NodeRequired 
public Node Node { get; }
  • Type: Constructs.Node

The tree node.

CdktfStackRequired 
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack
FqnRequired 
public string Fqn { get; }
  • Type: string
FriendlyUniqueIdRequired 
public string FriendlyUniqueId { get; }
  • Type: string
TerraformMetaArgumentsRequired 
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>
TerraformResourceTypeRequired 
public string TerraformResourceType { get; }
  • Type: string
TerraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
ConnectionOptional 
public object Connection { get; }
  • Type: object
CountOptional 
public object Count { get; }
  • Type: object
DependsOnOptional 
public string[] DependsOn { get; }
  • Type: string[]
ForEachOptional 
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider
ProvisionersOptional 
public object[] Provisioners { get; }
  • Type: object[]
AutomatedBackupPolicyRequired 
public BigtableTableAutomatedBackupPolicyOutputReference AutomatedBackupPolicy { get; }
ColumnFamilyRequired 
public BigtableTableColumnFamilyList ColumnFamily { get; }
TimeoutsRequired 
public BigtableTableTimeoutsOutputReference Timeouts { get; }
AutomatedBackupPolicyInputOptional 
public BigtableTableAutomatedBackupPolicy AutomatedBackupPolicyInput { get; }
ChangeStreamRetentionInputOptional 
public string ChangeStreamRetentionInput { get; }
  • Type: string
ColumnFamilyInputOptional 
public object ColumnFamilyInput { get; }
  • Type: object
DeletionProtectionInputOptional 
public string DeletionProtectionInput { get; }
  • Type: string
IdInputOptional 
public string IdInput { get; }
  • Type: string
InstanceNameInputOptional 
public string InstanceNameInput { get; }
  • Type: string
NameInputOptional 
public string NameInput { get; }
  • Type: string
ProjectInputOptional 
public string ProjectInput { get; }
  • Type: string
SplitKeysInputOptional 
public string[] SplitKeysInput { get; }
  • Type: string[]
TimeoutsInputOptional 
public object TimeoutsInput { get; }
  • Type: object
ChangeStreamRetentionRequired 
public string ChangeStreamRetention { get; }
  • Type: string
DeletionProtectionRequired 
public string DeletionProtection { get; }
  • Type: string
IdRequired 
public string Id { get; }
  • Type: string
InstanceNameRequired 
public string InstanceName { get; }
  • Type: string
NameRequired 
public string Name { get; }
  • Type: string
ProjectRequired 
public string Project { get; }
  • Type: string
SplitKeysRequired 
public string[] SplitKeys { get; }
  • Type: string[]

Constants

Name Type Description
TfResourceType string No description.
TfResourceTypeRequired 
public string TfResourceType { get; }
  • Type: string

Structs

BigtableTableAutomatedBackupPolicy

Initializer 

using HashiCorp.Cdktf.Providers.Google;

new BigtableTableAutomatedBackupPolicy {
    string Frequency = null,
    string RetentionPeriod = null
};

Properties

Name Type Description
Frequency string How frequently automated backups should occur.
RetentionPeriod string How long the automated backups should be retained.
FrequencyOptional 
public string Frequency { get; set; }
  • Type: string

How frequently automated backups should occur.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#frequency BigtableTable#frequency}

RetentionPeriodOptional 
public string RetentionPeriod { get; set; }
  • Type: string

How long the automated backups should be retained.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#retention_period BigtableTable#retention_period}

BigtableTableColumnFamily

Initializer 

using HashiCorp.Cdktf.Providers.Google;

new BigtableTableColumnFamily {
    string Family,
    string Type = null
};

Properties

Name Type Description
Family string The name of the column family.
Type string The type of the column family.
FamilyRequired 
public string Family { get; set; }
  • Type: string

The name of the column family.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#family BigtableTable#family}

TypeOptional 
public string Type { get; set; }
  • Type: string

The type of the column family.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#type BigtableTable#type}

BigtableTableConfig

Initializer 

using HashiCorp.Cdktf.Providers.Google;

new BigtableTableConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string InstanceName,
    string Name,
    BigtableTableAutomatedBackupPolicy AutomatedBackupPolicy = null,
    string ChangeStreamRetention = null,
    object ColumnFamily = null,
    string DeletionProtection = null,
    string Id = null,
    string Project = null,
    string[] SplitKeys = null,
    BigtableTableTimeouts Timeouts = null
};

Properties

Name Type Description
Connection object No description.
Count object No description.
DependsOn HashiCorp.Cdktf.ITerraformDependable[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
InstanceName string The name of the Bigtable instance.
Name string The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.
AutomatedBackupPolicy BigtableTableAutomatedBackupPolicy automated_backup_policy block.
ChangeStreamRetention string Duration to retain change stream data for the table.
ColumnFamily object column_family block.
DeletionProtection string A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, currently deletion protection will be set to UNPROTECTED as it is the API default value.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#id BigtableTable#id}.
Project string The ID of the project in which the resource belongs.
SplitKeys string[] A list of predefined keys to split the table on.
Timeouts BigtableTableTimeouts timeouts block.
ConnectionOptional 
public object Connection { get; set; }
  • Type: object
CountOptional 
public object Count { get; set; }
  • Type: object
DependsOnOptional 
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]
ForEachOptional 
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider
ProvisionersOptional 
public object[] Provisioners { get; set; }
  • Type: object[]
InstanceNameRequired 
public string InstanceName { get; set; }
  • Type: string

The name of the Bigtable instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#instance_name BigtableTable#instance_name}

NameRequired 
public string Name { get; set; }
  • Type: string

The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#name BigtableTable#name}

AutomatedBackupPolicyOptional 
public BigtableTableAutomatedBackupPolicy AutomatedBackupPolicy { get; set; }

automated_backup_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#automated_backup_policy BigtableTable#automated_backup_policy}

ChangeStreamRetentionOptional 
public string ChangeStreamRetention { get; set; }
  • Type: string

Duration to retain change stream data for the table.

Set to 0 to disable. Must be between 1 and 7 days.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#change_stream_retention BigtableTable#change_stream_retention}

ColumnFamilyOptional 
public object ColumnFamily { get; set; }
  • Type: object

column_family block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#column_family BigtableTable#column_family}

DeletionProtectionOptional 
public string DeletionProtection { get; set; }
  • Type: string

A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, currently deletion protection will be set to UNPROTECTED as it is the API default value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#deletion_protection BigtableTable#deletion_protection}

IdOptional 
public string Id { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#id BigtableTable#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.

ProjectOptional 
public string Project { get; set; }
  • Type: 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.17.0/docs/resources/bigtable_table#project BigtableTable#project}

SplitKeysOptional 
public string[] SplitKeys { get; set; }
  • Type: string[]

A list of predefined keys to split the table on.

!> Warning: Modifying the split_keys of an existing table will cause Terraform to delete/recreate the entire google_bigtable_table resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#split_keys BigtableTable#split_keys}

TimeoutsOptional 
public BigtableTableTimeouts Timeouts { get; set; }

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#timeouts BigtableTable#timeouts}

BigtableTableTimeouts

Initializer 

using HashiCorp.Cdktf.Providers.Google;

new BigtableTableTimeouts {
    string Create = null,
    string Update = null
};

Properties

Name Type Description
Create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#create BigtableTable#create}.
Update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#update BigtableTable#update}.
CreateOptional 
public string Create { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#create BigtableTable#create}.

UpdateOptional 
public string Update { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_table#update BigtableTable#update}.

Classes

BigtableTableAutomatedBackupPolicyOutputReference

Initializers 

using HashiCorp.Cdktf.Providers.Google;

new BigtableTableAutomatedBackupPolicyOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

TerraformAttributeRequired
  • Type: 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.
ResetFrequency No description.
ResetRetentionPeriod No description.
ComputeFqn 
private string ComputeFqn()
GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string
Resolve 
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext
ToString 
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetFrequency 
private void ResetFrequency()
ResetRetentionPeriod 
private void ResetRetentionPeriod()

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
FrequencyInput string No description.
RetentionPeriodInput string No description.
Frequency string No description.
RetentionPeriod string No description.
InternalValue BigtableTableAutomatedBackupPolicy No description.
CreationStackRequired 
public string[] CreationStack { get; }
  • Type: 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 string Fqn { get; }
  • Type: string
FrequencyInputOptional 
public string FrequencyInput { get; }
  • Type: string
RetentionPeriodInputOptional 
public string RetentionPeriodInput { get; }
  • Type: string
FrequencyRequired 
public string Frequency { get; }
  • Type: string
RetentionPeriodRequired 
public string RetentionPeriod { get; }
  • Type: string
InternalValueOptional 
public BigtableTableAutomatedBackupPolicy InternalValue { get; }

BigtableTableColumnFamilyList

Initializers 

using HashiCorp.Cdktf.Providers.Google;

new BigtableTableColumnFamilyList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
WrapsSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

WrapsSetRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

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.
AllWithMapKey 
private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

MapKeyAttributeNameRequired
  • Type: string
ComputeFqn 
private string ComputeFqn()
Resolve 
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext
ToString 
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get 
private BigtableTableColumnFamilyOutputReference Get(double Index)
IndexRequired
  • Type: double

the index of the item to return.

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
InternalValue object No description.
CreationStackRequired 
public string[] CreationStack { get; }
  • Type: 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 string Fqn { get; }
  • Type: string
InternalValueOptional 
public object InternalValue { get; }
  • Type: object

BigtableTableColumnFamilyOutputReference

Initializers 

using HashiCorp.Cdktf.Providers.Google;

new BigtableTableColumnFamilyOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
ComplexObjectIndex double the index of this item in the list.
ComplexObjectIsFromSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

ComplexObjectIndexRequired
  • Type: double

the index of this item in the list.

ComplexObjectIsFromSetRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

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.
ResetType No description.
ComputeFqn 
private string ComputeFqn()
GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string
Resolve 
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext
ToString 
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetType 
private void ResetType()

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
FamilyInput string No description.
TypeInput string No description.
Family string No description.
Type string No description.
InternalValue object No description.
CreationStackRequired 
public string[] CreationStack { get; }
  • Type: 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 string Fqn { get; }
  • Type: string
FamilyInputOptional 
public string FamilyInput { get; }
  • Type: string
TypeInputOptional 
public string TypeInput { get; }
  • Type: string
FamilyRequired 
public string Family { get; }
  • Type: string
TypeRequired 
public string Type { get; }
  • Type: string
InternalValueOptional 
public object InternalValue { get; }
  • Type: object

BigtableTableTimeoutsOutputReference

Initializers 

using HashiCorp.Cdktf.Providers.Google;

new BigtableTableTimeoutsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

TerraformAttributeRequired
  • Type: 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.
ResetUpdate No description.
ComputeFqn 
private string ComputeFqn()
GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string
Resolve 
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext
ToString 
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetCreate 
private void ResetCreate()
ResetUpdate 
private void ResetUpdate()

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
CreateInput string No description.
UpdateInput string No description.
Create string No description.
Update string No description.
InternalValue object No description.
CreationStackRequired 
public string[] CreationStack { get; }
  • Type: 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 string Fqn { get; }
  • Type: string
CreateInputOptional 
public string CreateInput { get; }
  • Type: string
UpdateInputOptional 
public string UpdateInput { get; }
  • Type: string
CreateRequired 
public string Create { get; }
  • Type: string
UpdateRequired 
public string Update { get; }
  • Type: string
InternalValueOptional 
public object InternalValue { get; }
  • Type: object