Skip to content

Latest commit

 

History

History
2742 lines (1690 loc) · 130 KB

bigtableAppProfile.typescript.md

File metadata and controls

2742 lines (1690 loc) · 130 KB

bigtableAppProfile Submodule

Constructs

BigtableAppProfile

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

Initializers

import { bigtableAppProfile } from '@cdktf/provider-google'

new bigtableAppProfile.BigtableAppProfile(scope: Construct, id: string, config: BigtableAppProfileConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config BigtableAppProfileConfig 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".
putDataBoostIsolationReadOnly No description.
putSingleClusterRouting No description.
putStandardIsolation No description.
putTimeouts No description.
resetDataBoostIsolationReadOnly No description.
resetDescription No description.
resetId No description.
resetIgnoreWarnings No description.
resetInstance No description.
resetMultiClusterRoutingClusterIds No description.
resetMultiClusterRoutingUseAny No description.
resetProject No description.
resetRowAffinity No description.
resetSingleClusterRouting No description.
resetStandardIsolation No description.
resetTimeouts No description.

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


resetOverrideLogicalId
public resetOverrideLogicalId(): void

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

toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget
public addMoveTarget(moveTarget: string): void

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
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktf.TerraformProvider

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

moveFromId
public moveFromId(id: string): void

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
public moveTo(moveTarget: string, index?: string | number): void

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: string | number

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


moveToId
public moveToId(id: string): void

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


putDataBoostIsolationReadOnly
public putDataBoostIsolationReadOnly(value: BigtableAppProfileDataBoostIsolationReadOnly): void
valueRequired

putSingleClusterRouting
public putSingleClusterRouting(value: BigtableAppProfileSingleClusterRouting): void
valueRequired

putStandardIsolation
public putStandardIsolation(value: BigtableAppProfileStandardIsolation): void
valueRequired

putTimeouts
public putTimeouts(value: BigtableAppProfileTimeouts): void
valueRequired

resetDataBoostIsolationReadOnly
public resetDataBoostIsolationReadOnly(): void
resetDescription
public resetDescription(): void
resetId
public resetId(): void
resetIgnoreWarnings
public resetIgnoreWarnings(): void
resetInstance
public resetInstance(): void
resetMultiClusterRoutingClusterIds
public resetMultiClusterRoutingClusterIds(): void
resetMultiClusterRoutingUseAny
public resetMultiClusterRoutingUseAny(): void
resetProject
public resetProject(): void
resetRowAffinity
public resetRowAffinity(): void
resetSingleClusterRouting
public resetSingleClusterRouting(): void
resetStandardIsolation
public resetStandardIsolation(): void
resetTimeouts
public resetTimeouts(): void

Static Functions

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

isConstruct
import { bigtableAppProfile } from '@cdktf/provider-google'

bigtableAppProfile.BigtableAppProfile.isConstruct(x: any)

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: any

Any object.


isTerraformElement
import { bigtableAppProfile } from '@cdktf/provider-google'

bigtableAppProfile.BigtableAppProfile.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { bigtableAppProfile } from '@cdktf/provider-google'

bigtableAppProfile.BigtableAppProfile.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { bigtableAppProfile } from '@cdktf/provider-google'

bigtableAppProfile.BigtableAppProfile.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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


importFromIdRequired
  • Type: string

The id of the existing BigtableAppProfile that should be imported.

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


providerOptional
  • Type: cdktf.TerraformProvider

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


Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
dataBoostIsolationReadOnly BigtableAppProfileDataBoostIsolationReadOnlyOutputReference No description.
name string No description.
singleClusterRouting BigtableAppProfileSingleClusterRoutingOutputReference No description.
standardIsolation BigtableAppProfileStandardIsolationOutputReference No description.
timeouts BigtableAppProfileTimeoutsOutputReference No description.
appProfileIdInput string No description.
dataBoostIsolationReadOnlyInput BigtableAppProfileDataBoostIsolationReadOnly No description.
descriptionInput string No description.
idInput string No description.
ignoreWarningsInput boolean | cdktf.IResolvable No description.
instanceInput string No description.
multiClusterRoutingClusterIdsInput string[] No description.
multiClusterRoutingUseAnyInput boolean | cdktf.IResolvable No description.
projectInput string No description.
rowAffinityInput boolean | cdktf.IResolvable No description.
singleClusterRoutingInput BigtableAppProfileSingleClusterRouting No description.
standardIsolationInput BigtableAppProfileStandardIsolation No description.
timeoutsInput cdktf.IResolvable | BigtableAppProfileTimeouts No description.
appProfileId string No description.
description string No description.
id string No description.
ignoreWarnings boolean | cdktf.IResolvable No description.
instance string No description.
multiClusterRoutingClusterIds string[] No description.
multiClusterRoutingUseAny boolean | cdktf.IResolvable No description.
project string No description.
rowAffinity boolean | cdktf.IResolvable No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

terraformMetaArgumentsRequired
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

dataBoostIsolationReadOnlyRequired
public readonly dataBoostIsolationReadOnly: BigtableAppProfileDataBoostIsolationReadOnlyOutputReference;

nameRequired
public readonly name: string;
  • Type: string

singleClusterRoutingRequired
public readonly singleClusterRouting: BigtableAppProfileSingleClusterRoutingOutputReference;

standardIsolationRequired
public readonly standardIsolation: BigtableAppProfileStandardIsolationOutputReference;

timeoutsRequired
public readonly timeouts: BigtableAppProfileTimeoutsOutputReference;

appProfileIdInputOptional
public readonly appProfileIdInput: string;
  • Type: string

dataBoostIsolationReadOnlyInputOptional
public readonly dataBoostIsolationReadOnlyInput: BigtableAppProfileDataBoostIsolationReadOnly;

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

idInputOptional
public readonly idInput: string;
  • Type: string

ignoreWarningsInputOptional
public readonly ignoreWarningsInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

instanceInputOptional
public readonly instanceInput: string;
  • Type: string

multiClusterRoutingClusterIdsInputOptional
public readonly multiClusterRoutingClusterIdsInput: string[];
  • Type: string[]

multiClusterRoutingUseAnyInputOptional
public readonly multiClusterRoutingUseAnyInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

projectInputOptional
public readonly projectInput: string;
  • Type: string

rowAffinityInputOptional
public readonly rowAffinityInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

singleClusterRoutingInputOptional
public readonly singleClusterRoutingInput: BigtableAppProfileSingleClusterRouting;

standardIsolationInputOptional
public readonly standardIsolationInput: BigtableAppProfileStandardIsolation;

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | BigtableAppProfileTimeouts;

appProfileIdRequired
public readonly appProfileId: string;
  • Type: string

descriptionRequired
public readonly description: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

ignoreWarningsRequired
public readonly ignoreWarnings: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

instanceRequired
public readonly instance: string;
  • Type: string

multiClusterRoutingClusterIdsRequired
public readonly multiClusterRoutingClusterIds: string[];
  • Type: string[]

multiClusterRoutingUseAnyRequired
public readonly multiClusterRoutingUseAny: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

projectRequired
public readonly project: string;
  • Type: string

rowAffinityRequired
public readonly rowAffinity: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

BigtableAppProfileConfig

Initializer

import { bigtableAppProfile } from '@cdktf/provider-google'

const bigtableAppProfileConfig: bigtableAppProfile.BigtableAppProfileConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
appProfileId string The unique name of the app profile in the form '[a-zA-Z0-9][-.a-zA-Z0-9]*'.
dataBoostIsolationReadOnly BigtableAppProfileDataBoostIsolationReadOnly data_boost_isolation_read_only block.
description string Long form description of the use case for this app profile.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#id BigtableAppProfile#id}.
ignoreWarnings boolean | cdktf.IResolvable If true, ignore safety checks when deleting/updating the app profile.
instance string The name of the instance to create the app profile within.
multiClusterRoutingClusterIds string[] The set of clusters to route to.
multiClusterRoutingUseAny boolean | cdktf.IResolvable If true, read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays.
project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#project BigtableAppProfile#project}.
rowAffinity boolean | cdktf.IResolvable Must be used with multi-cluster routing.
singleClusterRouting BigtableAppProfileSingleClusterRouting single_cluster_routing block.
standardIsolation BigtableAppProfileStandardIsolation standard_isolation block.
timeouts BigtableAppProfileTimeouts timeouts block.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

appProfileIdRequired
public readonly appProfileId: string;
  • Type: string

The unique name of the app profile in the form '[a-zA-Z0-9][-.a-zA-Z0-9]*'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#app_profile_id BigtableAppProfile#app_profile_id}


dataBoostIsolationReadOnlyOptional
public readonly dataBoostIsolationReadOnly: BigtableAppProfileDataBoostIsolationReadOnly;

data_boost_isolation_read_only block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#data_boost_isolation_read_only BigtableAppProfile#data_boost_isolation_read_only}


descriptionOptional
public readonly description: string;
  • Type: string

Long form description of the use case for this app profile.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#description BigtableAppProfile#description}


idOptional
public readonly id: string;
  • Type: string

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


ignoreWarningsOptional
public readonly ignoreWarnings: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

If true, ignore safety checks when deleting/updating the app profile.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#ignore_warnings BigtableAppProfile#ignore_warnings}


instanceOptional
public readonly instance: string;
  • Type: string

The name of the instance to create the app profile within.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#instance BigtableAppProfile#instance}


multiClusterRoutingClusterIdsOptional
public readonly multiClusterRoutingClusterIds: string[];
  • Type: string[]

The set of clusters to route to.

The order is ignored; clusters will be tried in order of distance. If left empty, all clusters are eligible.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#multi_cluster_routing_cluster_ids BigtableAppProfile#multi_cluster_routing_cluster_ids}


multiClusterRoutingUseAnyOptional
public readonly multiClusterRoutingUseAny: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

If true, read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays.

Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#multi_cluster_routing_use_any BigtableAppProfile#multi_cluster_routing_use_any}


projectOptional
public readonly project: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#project BigtableAppProfile#project}.


rowAffinityOptional
public readonly rowAffinity: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Must be used with multi-cluster routing.

If true, then this app profile will use row affinity sticky routing. With row affinity, Bigtable will route single row key requests based on the row key, rather than randomly. Instead, each row key will be assigned to a cluster by Cloud Bigtable, and will stick to that cluster. Choosing this option improves read-your-writes consistency for most requests under most circumstances, without sacrificing availability. Consistency is not guaranteed, as requests may still fail over between clusters in the event of errors or latency.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#row_affinity BigtableAppProfile#row_affinity}


singleClusterRoutingOptional
public readonly singleClusterRouting: BigtableAppProfileSingleClusterRouting;

single_cluster_routing block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#single_cluster_routing BigtableAppProfile#single_cluster_routing}


standardIsolationOptional
public readonly standardIsolation: BigtableAppProfileStandardIsolation;

standard_isolation block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#standard_isolation BigtableAppProfile#standard_isolation}


timeoutsOptional
public readonly timeouts: BigtableAppProfileTimeouts;

timeouts block.

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


BigtableAppProfileDataBoostIsolationReadOnly

Initializer

import { bigtableAppProfile } from '@cdktf/provider-google'

const bigtableAppProfileDataBoostIsolationReadOnly: bigtableAppProfile.BigtableAppProfileDataBoostIsolationReadOnly = { ... }

Properties

Name Type Description
computeBillingOwner string The Compute Billing Owner for this Data Boost App Profile. Possible values: ["HOST_PAYS"].

computeBillingOwnerRequired
public readonly computeBillingOwner: string;
  • Type: string

The Compute Billing Owner for this Data Boost App Profile. Possible values: ["HOST_PAYS"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#compute_billing_owner BigtableAppProfile#compute_billing_owner}


BigtableAppProfileSingleClusterRouting

Initializer

import { bigtableAppProfile } from '@cdktf/provider-google'

const bigtableAppProfileSingleClusterRouting: bigtableAppProfile.BigtableAppProfileSingleClusterRouting = { ... }

Properties

Name Type Description
clusterId string The cluster to which read/write requests should be routed.
allowTransactionalWrites boolean | cdktf.IResolvable If true, CheckAndMutateRow and ReadModifyWriteRow requests are allowed by this app profile.

clusterIdRequired
public readonly clusterId: string;
  • Type: string

The cluster to which read/write requests should be routed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#cluster_id BigtableAppProfile#cluster_id}


allowTransactionalWritesOptional
public readonly allowTransactionalWrites: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

If true, CheckAndMutateRow and ReadModifyWriteRow requests are allowed by this app profile.

It is unsafe to send these requests to the same table/row/column in multiple clusters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#allow_transactional_writes BigtableAppProfile#allow_transactional_writes}


BigtableAppProfileStandardIsolation

Initializer

import { bigtableAppProfile } from '@cdktf/provider-google'

const bigtableAppProfileStandardIsolation: bigtableAppProfile.BigtableAppProfileStandardIsolation = { ... }

Properties

Name Type Description
priority string The priority of requests sent using this app profile. Possible values: ["PRIORITY_LOW", "PRIORITY_MEDIUM", "PRIORITY_HIGH"].

priorityRequired
public readonly priority: string;
  • Type: string

The priority of requests sent using this app profile. Possible values: ["PRIORITY_LOW", "PRIORITY_MEDIUM", "PRIORITY_HIGH"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#priority BigtableAppProfile#priority}


BigtableAppProfileTimeouts

Initializer

import { bigtableAppProfile } from '@cdktf/provider-google'

const bigtableAppProfileTimeouts: bigtableAppProfile.BigtableAppProfileTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#create BigtableAppProfile#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#delete BigtableAppProfile#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#update BigtableAppProfile#update}.

createOptional
public readonly create: string;
  • Type: string

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


deleteOptional
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/bigtable_app_profile#delete BigtableAppProfile#delete}.


updateOptional
public readonly update: string;
  • Type: string

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


Classes

BigtableAppProfileDataBoostIsolationReadOnlyOutputReference

Initializers

import { bigtableAppProfile } from '@cdktf/provider-google'

new bigtableAppProfile.BigtableAppProfileDataBoostIsolationReadOnlyOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: 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.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

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.
computeBillingOwnerInput string No description.
computeBillingOwner string No description.
internalValue BigtableAppProfileDataBoostIsolationReadOnly No description.

creationStackRequired
public readonly creationStack: string[];
  • 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 readonly fqn: string;
  • Type: string

computeBillingOwnerInputOptional
public readonly computeBillingOwnerInput: string;
  • Type: string

computeBillingOwnerRequired
public readonly computeBillingOwner: string;
  • Type: string

internalValueOptional
public readonly internalValue: BigtableAppProfileDataBoostIsolationReadOnly;

BigtableAppProfileSingleClusterRoutingOutputReference

Initializers

import { bigtableAppProfile } from '@cdktf/provider-google'

new bigtableAppProfile.BigtableAppProfileSingleClusterRoutingOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: 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.
resetAllowTransactionalWrites No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetAllowTransactionalWrites
public resetAllowTransactionalWrites(): void

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.
allowTransactionalWritesInput boolean | cdktf.IResolvable No description.
clusterIdInput string No description.
allowTransactionalWrites boolean | cdktf.IResolvable No description.
clusterId string No description.
internalValue BigtableAppProfileSingleClusterRouting No description.

creationStackRequired
public readonly creationStack: string[];
  • 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 readonly fqn: string;
  • Type: string

allowTransactionalWritesInputOptional
public readonly allowTransactionalWritesInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

clusterIdInputOptional
public readonly clusterIdInput: string;
  • Type: string

allowTransactionalWritesRequired
public readonly allowTransactionalWrites: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

clusterIdRequired
public readonly clusterId: string;
  • Type: string

internalValueOptional
public readonly internalValue: BigtableAppProfileSingleClusterRouting;

BigtableAppProfileStandardIsolationOutputReference

Initializers

import { bigtableAppProfile } from '@cdktf/provider-google'

new bigtableAppProfile.BigtableAppProfileStandardIsolationOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: 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.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

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.
priorityInput string No description.
priority string No description.
internalValue BigtableAppProfileStandardIsolation No description.

creationStackRequired
public readonly creationStack: string[];
  • 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 readonly fqn: string;
  • Type: string

priorityInputOptional
public readonly priorityInput: string;
  • Type: string

priorityRequired
public readonly priority: string;
  • Type: string

internalValueOptional
public readonly internalValue: BigtableAppProfileStandardIsolation;

BigtableAppProfileTimeoutsOutputReference

Initializers

import { bigtableAppProfile } from '@cdktf/provider-google'

new bigtableAppProfile.BigtableAppProfileTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: 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.
resetDelete No description.
resetUpdate No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

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

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.
deleteInput string No description.
updateInput string No description.
create string No description.
delete string No description.
update string No description.
internalValue cdktf.IResolvable | BigtableAppProfileTimeouts No description.

creationStackRequired
public readonly creationStack: string[];
  • 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 readonly fqn: string;
  • Type: string

createInputOptional
public readonly createInput: string;
  • Type: string

deleteInputOptional
public readonly deleteInput: string;
  • Type: string

updateInputOptional
public readonly updateInput: string;
  • Type: string

createRequired
public readonly create: string;
  • Type: string

deleteRequired
public readonly delete: string;
  • Type: string

updateRequired
public readonly update: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | BigtableAppProfileTimeouts;