Skip to content

Latest commit

 

History

History
3432 lines (2187 loc) · 156 KB

spannerInstance.python.md

File metadata and controls

3432 lines (2187 loc) · 156 KB
Raw

spannerInstance Submodule

Constructs

SpannerInstance

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance google_spanner_instance}.

Initializers 

from cdktf_cdktf_provider_google import spanner_instance

spannerInstance.SpannerInstance(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  config: str,
  display_name: str,
  autoscaling_config: SpannerInstanceAutoscalingConfig = None,
  edition: str = None,
  force_destroy: typing.Union[bool, IResolvable] = None,
  id: str = None,
  labels: typing.Mapping[str] = None,
  name: str = None,
  num_nodes: typing.Union[int, float] = None,
  processing_units: typing.Union[int, float] = None,
  project: str = None,
  timeouts: SpannerInstanceTimeouts = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
config str The name of the instance's configuration (similar but not quite the same as a region) which defines the geographic placement and replication of your databases in this instance.
display_name str The descriptive name for this instance as it appears in UIs.
autoscaling_config SpannerInstanceAutoscalingConfig autoscaling_config block.
edition str The edition selected for this instance.
force_destroy typing.Union[bool, cdktf.IResolvable] When deleting a spanner instance, this boolean option will delete all backups of this instance.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#id SpannerInstance#id}.
labels typing.Mapping[str] An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
name str A unique identifier for the instance, which cannot be changed after the instance is created.
num_nodes typing.Union[int, float] The number of nodes allocated to this instance. Exactly one of either node_count or processing_units must be present in terraform.
processing_units typing.Union[int, float] The number of processing units allocated to this instance. Exactly one of processing_units or node_count must be present in terraform.
project str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#project SpannerInstance#project}.
timeouts SpannerInstanceTimeouts timeouts block.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
configRequired
  • Type: str

The name of the instance's configuration (similar but not quite the same as a region) which defines the geographic placement and replication of your databases in this instance.

It determines where your data is stored. Values are typically of the form 'regional-europe-west1' , 'us-central' etc. In order to obtain a valid list please consult the Configuration section of the docs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#config SpannerInstance#config}

display_nameRequired
  • Type: str

The descriptive name for this instance as it appears in UIs.

Must be unique per project and between 4 and 30 characters in length.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#display_name SpannerInstance#display_name}

autoscaling_configOptional

autoscaling_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#autoscaling_config SpannerInstance#autoscaling_config}

editionOptional
  • Type: str

The edition selected for this instance.

Different editions provide different capabilities at different price points. Possible values: ["EDITION_UNSPECIFIED", "STANDARD", "ENTERPRISE", "ENTERPRISE_PLUS"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#edition SpannerInstance#edition}

force_destroyOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

When deleting a spanner instance, this boolean option will delete all backups of this instance.

This must be set to true if you created a backup manually in the console.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#force_destroy SpannerInstance#force_destroy}

idOptional
  • Type: str

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

labelsOptional
  • Type: typing.Mapping[str]

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#labels SpannerInstance#labels}

nameOptional
  • Type: str

A unique identifier for the instance, which cannot be changed after the instance is created.

The name must be between 6 and 30 characters in length. If not provided, a random string starting with 'tf-' will be selected.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#name SpannerInstance#name}

num_nodesOptional
  • Type: typing.Union[int, float]

The number of nodes allocated to this instance. Exactly one of either node_count or processing_units must be present in terraform.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#num_nodes SpannerInstance#num_nodes}

processing_unitsOptional
  • Type: typing.Union[int, float]

The number of processing units allocated to this instance. Exactly one of processing_units or node_count must be present in terraform.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#processing_units SpannerInstance#processing_units}

projectOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#project SpannerInstance#project}.

timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#timeouts SpannerInstance#timeouts}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_autoscaling_config No description.
put_timeouts No description.
reset_autoscaling_config No description.
reset_edition No description.
reset_force_destroy No description.
reset_id No description.
reset_labels No description.
reset_name No description.
reset_num_nodes No description.
reset_processing_units No description.
reset_project No description.
reset_timeouts No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

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

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

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

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

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

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

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

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

move_to_id 
def move_to_id(
  id: str
) -> None

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

idRequired
  • Type: str

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

put_autoscaling_config 
def put_autoscaling_config(
  autoscaling_limits: SpannerInstanceAutoscalingConfigAutoscalingLimits = None,
  autoscaling_targets: SpannerInstanceAutoscalingConfigAutoscalingTargets = None
) -> None
autoscaling_limitsOptional

autoscaling_limits block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#autoscaling_limits SpannerInstance#autoscaling_limits}

autoscaling_targetsOptional

autoscaling_targets block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#autoscaling_targets SpannerInstance#autoscaling_targets}

put_timeouts 
def put_timeouts(
  create: str = None,
  delete: str = None,
  update: str = None
) -> None
createOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#create SpannerInstance#create}.

deleteOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#delete SpannerInstance#delete}.

updateOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#update SpannerInstance#update}.

reset_autoscaling_config 
def reset_autoscaling_config() -> None
reset_edition 
def reset_edition() -> None
reset_force_destroy 
def reset_force_destroy() -> None
reset_id 
def reset_id() -> None
reset_labels 
def reset_labels() -> None
reset_name 
def reset_name() -> None
reset_num_nodes 
def reset_num_nodes() -> None
reset_processing_units 
def reset_processing_units() -> None
reset_project 
def reset_project() -> None
reset_timeouts 
def reset_timeouts() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a SpannerInstance resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_google import spanner_instance

spannerInstance.SpannerInstance.is_construct(
  x: typing.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: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_google import spanner_instance

spannerInstance.SpannerInstance.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_google import spanner_instance

spannerInstance.SpannerInstance.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_google import spanner_instance

spannerInstance.SpannerInstance.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

The id of the existing SpannerInstance that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#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 SpannerInstance to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
autoscaling_config SpannerInstanceAutoscalingConfigOutputReference No description.
effective_labels cdktf.StringMap No description.
state str No description.
terraform_labels cdktf.StringMap No description.
timeouts SpannerInstanceTimeoutsOutputReference No description.
autoscaling_config_input SpannerInstanceAutoscalingConfig No description.
config_input str No description.
display_name_input str No description.
edition_input str No description.
force_destroy_input typing.Union[bool, cdktf.IResolvable] No description.
id_input str No description.
labels_input typing.Mapping[str] No description.
name_input str No description.
num_nodes_input typing.Union[int, float] No description.
processing_units_input typing.Union[int, float] No description.
project_input str No description.
timeouts_input typing.Union[cdktf.IResolvable, SpannerInstanceTimeouts] No description.
config str No description.
display_name str No description.
edition str No description.
force_destroy typing.Union[bool, cdktf.IResolvable] No description.
id str No description.
labels typing.Mapping[str] No description.
name str No description.
num_nodes typing.Union[int, float] No description.
processing_units typing.Union[int, float] No description.
project str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
autoscaling_configRequired 
autoscaling_config: SpannerInstanceAutoscalingConfigOutputReference
effective_labelsRequired 
effective_labels: StringMap
  • Type: cdktf.StringMap
stateRequired 
state: str
  • Type: str
terraform_labelsRequired 
terraform_labels: StringMap
  • Type: cdktf.StringMap
timeoutsRequired 
timeouts: SpannerInstanceTimeoutsOutputReference
autoscaling_config_inputOptional 
autoscaling_config_input: SpannerInstanceAutoscalingConfig
config_inputOptional 
config_input: str
  • Type: str
display_name_inputOptional 
display_name_input: str
  • Type: str
edition_inputOptional 
edition_input: str
  • Type: str
force_destroy_inputOptional 
force_destroy_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
id_inputOptional 
id_input: str
  • Type: str
labels_inputOptional 
labels_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
name_inputOptional 
name_input: str
  • Type: str
num_nodes_inputOptional 
num_nodes_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
processing_units_inputOptional 
processing_units_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
project_inputOptional 
project_input: str
  • Type: str
timeouts_inputOptional 
timeouts_input: typing.Union[IResolvable, SpannerInstanceTimeouts]
configRequired 
config: str
  • Type: str
display_nameRequired 
display_name: str
  • Type: str
editionRequired 
edition: str
  • Type: str
force_destroyRequired 
force_destroy: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
idRequired 
id: str
  • Type: str
labelsRequired 
labels: typing.Mapping[str]
  • Type: typing.Mapping[str]
nameRequired 
name: str
  • Type: str
num_nodesRequired 
num_nodes: typing.Union[int, float]
  • Type: typing.Union[int, float]
processing_unitsRequired 
processing_units: typing.Union[int, float]
  • Type: typing.Union[int, float]
projectRequired 
project: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

SpannerInstanceAutoscalingConfig

Initializer 

from cdktf_cdktf_provider_google import spanner_instance

spannerInstance.SpannerInstanceAutoscalingConfig(
  autoscaling_limits: SpannerInstanceAutoscalingConfigAutoscalingLimits = None,
  autoscaling_targets: SpannerInstanceAutoscalingConfigAutoscalingTargets = None
)

Properties

Name Type Description
autoscaling_limits SpannerInstanceAutoscalingConfigAutoscalingLimits autoscaling_limits block.
autoscaling_targets SpannerInstanceAutoscalingConfigAutoscalingTargets autoscaling_targets block.
autoscaling_limitsOptional 
autoscaling_limits: SpannerInstanceAutoscalingConfigAutoscalingLimits

autoscaling_limits block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#autoscaling_limits SpannerInstance#autoscaling_limits}

autoscaling_targetsOptional 
autoscaling_targets: SpannerInstanceAutoscalingConfigAutoscalingTargets

autoscaling_targets block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#autoscaling_targets SpannerInstance#autoscaling_targets}

SpannerInstanceAutoscalingConfigAutoscalingLimits

Initializer 

from cdktf_cdktf_provider_google import spanner_instance

spannerInstance.SpannerInstanceAutoscalingConfigAutoscalingLimits(
  max_nodes: typing.Union[int, float] = None,
  max_processing_units: typing.Union[int, float] = None,
  min_nodes: typing.Union[int, float] = None,
  min_processing_units: typing.Union[int, float] = None
)

Properties

Name Type Description
max_nodes typing.Union[int, float] Specifies maximum number of nodes allocated to the instance.
max_processing_units typing.Union[int, float] Specifies maximum number of processing units allocated to the instance.
min_nodes typing.Union[int, float] Specifies number of nodes allocated to the instance. If set, this number should be greater than or equal to 1.
min_processing_units typing.Union[int, float] Specifies minimum number of processing units allocated to the instance. If set, this number should be multiples of 1000.
max_nodesOptional 
max_nodes: typing.Union[int, float]
  • Type: typing.Union[int, float]

Specifies maximum number of nodes allocated to the instance.

If set, this number should be greater than or equal to min_nodes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#max_nodes SpannerInstance#max_nodes}

max_processing_unitsOptional 
max_processing_units: typing.Union[int, float]
  • Type: typing.Union[int, float]

Specifies maximum number of processing units allocated to the instance.

If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#max_processing_units SpannerInstance#max_processing_units}

min_nodesOptional 
min_nodes: typing.Union[int, float]
  • Type: typing.Union[int, float]

Specifies number of nodes allocated to the instance. If set, this number should be greater than or equal to 1.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#min_nodes SpannerInstance#min_nodes}

min_processing_unitsOptional 
min_processing_units: typing.Union[int, float]
  • Type: typing.Union[int, float]

Specifies minimum number of processing units allocated to the instance. If set, this number should be multiples of 1000.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#min_processing_units SpannerInstance#min_processing_units}

SpannerInstanceAutoscalingConfigAutoscalingTargets

Initializer 

from cdktf_cdktf_provider_google import spanner_instance

spannerInstance.SpannerInstanceAutoscalingConfigAutoscalingTargets(
  high_priority_cpu_utilization_percent: typing.Union[int, float] = None,
  storage_utilization_percent: typing.Union[int, float] = None
)

Properties

Name Type Description
high_priority_cpu_utilization_percent typing.Union[int, float] Specifies the target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance.
storage_utilization_percent typing.Union[int, float] Specifies the target storage utilization percentage that the autoscaler should be trying to achieve for the instance.
high_priority_cpu_utilization_percentOptional 
high_priority_cpu_utilization_percent: typing.Union[int, float]
  • Type: typing.Union[int, float]

Specifies the target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance.

This number is on a scale from 0 (no utilization) to 100 (full utilization)..

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#high_priority_cpu_utilization_percent SpannerInstance#high_priority_cpu_utilization_percent}

storage_utilization_percentOptional 
storage_utilization_percent: typing.Union[int, float]
  • Type: typing.Union[int, float]

Specifies the target storage utilization percentage that the autoscaler should be trying to achieve for the instance.

This number is on a scale from 0 (no utilization) to 100 (full utilization).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#storage_utilization_percent SpannerInstance#storage_utilization_percent}

SpannerInstanceConfig

Initializer 

from cdktf_cdktf_provider_google import spanner_instance

spannerInstance.SpannerInstanceConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  config: str,
  display_name: str,
  autoscaling_config: SpannerInstanceAutoscalingConfig = None,
  edition: str = None,
  force_destroy: typing.Union[bool, IResolvable] = None,
  id: str = None,
  labels: typing.Mapping[str] = None,
  name: str = None,
  num_nodes: typing.Union[int, float] = None,
  processing_units: typing.Union[int, float] = None,
  project: str = None,
  timeouts: SpannerInstanceTimeouts = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
config str The name of the instance's configuration (similar but not quite the same as a region) which defines the geographic placement and replication of your databases in this instance.
display_name str The descriptive name for this instance as it appears in UIs.
autoscaling_config SpannerInstanceAutoscalingConfig autoscaling_config block.
edition str The edition selected for this instance.
force_destroy typing.Union[bool, cdktf.IResolvable] When deleting a spanner instance, this boolean option will delete all backups of this instance.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#id SpannerInstance#id}.
labels typing.Mapping[str] An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
name str A unique identifier for the instance, which cannot be changed after the instance is created.
num_nodes typing.Union[int, float] The number of nodes allocated to this instance. Exactly one of either node_count or processing_units must be present in terraform.
processing_units typing.Union[int, float] The number of processing units allocated to this instance. Exactly one of processing_units or node_count must be present in terraform.
project str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#project SpannerInstance#project}.
timeouts SpannerInstanceTimeouts timeouts block.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
configRequired 
config: str
  • Type: str

The name of the instance's configuration (similar but not quite the same as a region) which defines the geographic placement and replication of your databases in this instance.

It determines where your data is stored. Values are typically of the form 'regional-europe-west1' , 'us-central' etc. In order to obtain a valid list please consult the Configuration section of the docs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#config SpannerInstance#config}

display_nameRequired 
display_name: str
  • Type: str

The descriptive name for this instance as it appears in UIs.

Must be unique per project and between 4 and 30 characters in length.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#display_name SpannerInstance#display_name}

autoscaling_configOptional 
autoscaling_config: SpannerInstanceAutoscalingConfig

autoscaling_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#autoscaling_config SpannerInstance#autoscaling_config}

editionOptional 
edition: str
  • Type: str

The edition selected for this instance.

Different editions provide different capabilities at different price points. Possible values: ["EDITION_UNSPECIFIED", "STANDARD", "ENTERPRISE", "ENTERPRISE_PLUS"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#edition SpannerInstance#edition}

force_destroyOptional 
force_destroy: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

When deleting a spanner instance, this boolean option will delete all backups of this instance.

This must be set to true if you created a backup manually in the console.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#force_destroy SpannerInstance#force_destroy}

idOptional 
id: str
  • Type: str

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

labelsOptional 
labels: typing.Mapping[str]
  • Type: typing.Mapping[str]

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#labels SpannerInstance#labels}

nameOptional 
name: str
  • Type: str

A unique identifier for the instance, which cannot be changed after the instance is created.

The name must be between 6 and 30 characters in length. If not provided, a random string starting with 'tf-' will be selected.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#name SpannerInstance#name}

num_nodesOptional 
num_nodes: typing.Union[int, float]
  • Type: typing.Union[int, float]

The number of nodes allocated to this instance. Exactly one of either node_count or processing_units must be present in terraform.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#num_nodes SpannerInstance#num_nodes}

processing_unitsOptional 
processing_units: typing.Union[int, float]
  • Type: typing.Union[int, float]

The number of processing units allocated to this instance. Exactly one of processing_units or node_count must be present in terraform.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#processing_units SpannerInstance#processing_units}

projectOptional 
project: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#project SpannerInstance#project}.

timeoutsOptional 
timeouts: SpannerInstanceTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#timeouts SpannerInstance#timeouts}

SpannerInstanceTimeouts

Initializer 

from cdktf_cdktf_provider_google import spanner_instance

spannerInstance.SpannerInstanceTimeouts(
  create: str = None,
  delete: str = None,
  update: str = None
)

Properties

Name Type Description
create str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#create SpannerInstance#create}.
delete str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#delete SpannerInstance#delete}.
update str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#update SpannerInstance#update}.
createOptional 
create: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#create SpannerInstance#create}.

deleteOptional 
delete: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#delete SpannerInstance#delete}.

updateOptional 
update: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#update SpannerInstance#update}.

Classes

SpannerInstanceAutoscalingConfigAutoscalingLimitsOutputReference

Initializers 

from cdktf_cdktf_provider_google import spanner_instance

spannerInstance.SpannerInstanceAutoscalingConfigAutoscalingLimitsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_max_nodes No description.
reset_max_processing_units No description.
reset_min_nodes No description.
reset_min_processing_units No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_max_nodes 
def reset_max_nodes() -> None
reset_max_processing_units 
def reset_max_processing_units() -> None
reset_min_nodes 
def reset_min_nodes() -> None
reset_min_processing_units 
def reset_min_processing_units() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
max_nodes_input typing.Union[int, float] No description.
max_processing_units_input typing.Union[int, float] No description.
min_nodes_input typing.Union[int, float] No description.
min_processing_units_input typing.Union[int, float] No description.
max_nodes typing.Union[int, float] No description.
max_processing_units typing.Union[int, float] No description.
min_nodes typing.Union[int, float] No description.
min_processing_units typing.Union[int, float] No description.
internal_value SpannerInstanceAutoscalingConfigAutoscalingLimits No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

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 
fqn: str
  • Type: str
max_nodes_inputOptional 
max_nodes_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
max_processing_units_inputOptional 
max_processing_units_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
min_nodes_inputOptional 
min_nodes_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
min_processing_units_inputOptional 
min_processing_units_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
max_nodesRequired 
max_nodes: typing.Union[int, float]
  • Type: typing.Union[int, float]
max_processing_unitsRequired 
max_processing_units: typing.Union[int, float]
  • Type: typing.Union[int, float]
min_nodesRequired 
min_nodes: typing.Union[int, float]
  • Type: typing.Union[int, float]
min_processing_unitsRequired 
min_processing_units: typing.Union[int, float]
  • Type: typing.Union[int, float]
internal_valueOptional 
internal_value: SpannerInstanceAutoscalingConfigAutoscalingLimits

SpannerInstanceAutoscalingConfigAutoscalingTargetsOutputReference

Initializers 

from cdktf_cdktf_provider_google import spanner_instance

spannerInstance.SpannerInstanceAutoscalingConfigAutoscalingTargetsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_high_priority_cpu_utilization_percent No description.
reset_storage_utilization_percent No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_high_priority_cpu_utilization_percent 
def reset_high_priority_cpu_utilization_percent() -> None
reset_storage_utilization_percent 
def reset_storage_utilization_percent() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
high_priority_cpu_utilization_percent_input typing.Union[int, float] No description.
storage_utilization_percent_input typing.Union[int, float] No description.
high_priority_cpu_utilization_percent typing.Union[int, float] No description.
storage_utilization_percent typing.Union[int, float] No description.
internal_value SpannerInstanceAutoscalingConfigAutoscalingTargets No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

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 
fqn: str
  • Type: str
high_priority_cpu_utilization_percent_inputOptional 
high_priority_cpu_utilization_percent_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
storage_utilization_percent_inputOptional 
storage_utilization_percent_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
high_priority_cpu_utilization_percentRequired 
high_priority_cpu_utilization_percent: typing.Union[int, float]
  • Type: typing.Union[int, float]
storage_utilization_percentRequired 
storage_utilization_percent: typing.Union[int, float]
  • Type: typing.Union[int, float]
internal_valueOptional 
internal_value: SpannerInstanceAutoscalingConfigAutoscalingTargets

SpannerInstanceAutoscalingConfigOutputReference

Initializers 

from cdktf_cdktf_provider_google import spanner_instance

spannerInstance.SpannerInstanceAutoscalingConfigOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
put_autoscaling_limits No description.
put_autoscaling_targets No description.
reset_autoscaling_limits No description.
reset_autoscaling_targets No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

put_autoscaling_limits 
def put_autoscaling_limits(
  max_nodes: typing.Union[int, float] = None,
  max_processing_units: typing.Union[int, float] = None,
  min_nodes: typing.Union[int, float] = None,
  min_processing_units: typing.Union[int, float] = None
) -> None
max_nodesOptional
  • Type: typing.Union[int, float]

Specifies maximum number of nodes allocated to the instance.

If set, this number should be greater than or equal to min_nodes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#max_nodes SpannerInstance#max_nodes}

max_processing_unitsOptional
  • Type: typing.Union[int, float]

Specifies maximum number of processing units allocated to the instance.

If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#max_processing_units SpannerInstance#max_processing_units}

min_nodesOptional
  • Type: typing.Union[int, float]

Specifies number of nodes allocated to the instance. If set, this number should be greater than or equal to 1.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#min_nodes SpannerInstance#min_nodes}

min_processing_unitsOptional
  • Type: typing.Union[int, float]

Specifies minimum number of processing units allocated to the instance. If set, this number should be multiples of 1000.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#min_processing_units SpannerInstance#min_processing_units}

put_autoscaling_targets 
def put_autoscaling_targets(
  high_priority_cpu_utilization_percent: typing.Union[int, float] = None,
  storage_utilization_percent: typing.Union[int, float] = None
) -> None
high_priority_cpu_utilization_percentOptional
  • Type: typing.Union[int, float]

Specifies the target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance.

This number is on a scale from 0 (no utilization) to 100 (full utilization)..

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#high_priority_cpu_utilization_percent SpannerInstance#high_priority_cpu_utilization_percent}

storage_utilization_percentOptional
  • Type: typing.Union[int, float]

Specifies the target storage utilization percentage that the autoscaler should be trying to achieve for the instance.

This number is on a scale from 0 (no utilization) to 100 (full utilization).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/spanner_instance#storage_utilization_percent SpannerInstance#storage_utilization_percent}

reset_autoscaling_limits 
def reset_autoscaling_limits() -> None
reset_autoscaling_targets 
def reset_autoscaling_targets() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
autoscaling_limits SpannerInstanceAutoscalingConfigAutoscalingLimitsOutputReference No description.
autoscaling_targets SpannerInstanceAutoscalingConfigAutoscalingTargetsOutputReference No description.
autoscaling_limits_input SpannerInstanceAutoscalingConfigAutoscalingLimits No description.
autoscaling_targets_input SpannerInstanceAutoscalingConfigAutoscalingTargets No description.
internal_value SpannerInstanceAutoscalingConfig No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

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 
fqn: str
  • Type: str
autoscaling_limitsRequired 
autoscaling_limits: SpannerInstanceAutoscalingConfigAutoscalingLimitsOutputReference
autoscaling_targetsRequired 
autoscaling_targets: SpannerInstanceAutoscalingConfigAutoscalingTargetsOutputReference
autoscaling_limits_inputOptional 
autoscaling_limits_input: SpannerInstanceAutoscalingConfigAutoscalingLimits
autoscaling_targets_inputOptional 
autoscaling_targets_input: SpannerInstanceAutoscalingConfigAutoscalingTargets
internal_valueOptional 
internal_value: SpannerInstanceAutoscalingConfig

SpannerInstanceTimeoutsOutputReference

Initializers 

from cdktf_cdktf_provider_google import spanner_instance

spannerInstance.SpannerInstanceTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_create No description.
reset_delete No description.
reset_update No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_create 
def reset_create() -> None
reset_delete 
def reset_delete() -> None
reset_update 
def reset_update() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
create_input str No description.
delete_input str No description.
update_input str No description.
create str No description.
delete str No description.
update str No description.
internal_value typing.Union[cdktf.IResolvable, SpannerInstanceTimeouts] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

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 
fqn: str
  • Type: str
create_inputOptional 
create_input: str
  • Type: str
delete_inputOptional 
delete_input: str
  • Type: str
update_inputOptional 
update_input: str
  • Type: str
createRequired 
create: str
  • Type: str
deleteRequired 
delete: str
  • Type: str
updateRequired 
update: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, SpannerInstanceTimeouts]