Skip to content

Latest commit

 

History

History
2313 lines (1437 loc) · 121 KB

googleSpannerInstanceConfig.java.md

File metadata and controls

2313 lines (1437 loc) · 121 KB

googleSpannerInstanceConfig Submodule

Constructs

GoogleSpannerInstanceConfigA

Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config google_spanner_instance_config}.

Initializers

import com.hashicorp.cdktf.providers.google_beta.google_spanner_instance_config.GoogleSpannerInstanceConfigA;

GoogleSpannerInstanceConfigA.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .displayName(java.lang.String)
    .replicas(IResolvable)
    .replicas(java.util.List<GoogleSpannerInstanceConfigReplicas>)
//  .baseConfig(java.lang.String)
//  .id(java.lang.String)
//  .labels(java.util.Map<java.lang.String, java.lang.String>)
//  .name(java.lang.String)
//  .project(java.lang.String)
//  .timeouts(GoogleSpannerInstanceConfigTimeouts)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
displayName java.lang.String The name of this instance configuration as it appears in UIs.
replicas com.hashicorp.cdktf.IResolvable OR java.util.List<GoogleSpannerInstanceConfigReplicas> replicas block.
baseConfig java.lang.String Base configuration name, e.g. nam3, based on which this configuration is created. Only set for user managed configurations. baseConfig must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#id GoogleSpannerInstanceConfigA#id}.
labels java.util.Map<java.lang.String, java.lang.String> An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
name java.lang.String A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/[a-z][-a-z0-9]*.
project java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#project GoogleSpannerInstanceConfigA#project}.
timeouts GoogleSpannerInstanceConfigTimeouts timeouts block.

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope


connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

displayNameRequired
  • Type: java.lang.String

The name of this instance configuration as it appears in UIs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#display_name GoogleSpannerInstanceConfigA#display_name}


replicasRequired

replicas block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#replicas GoogleSpannerInstanceConfigA#replicas}


baseConfigOptional
  • Type: java.lang.String

Base configuration name, e.g. nam3, based on which this configuration is created. Only set for user managed configurations. baseConfig must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#base_config GoogleSpannerInstanceConfigA#base_config}


idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#id GoogleSpannerInstanceConfigA#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: java.util.Map<java.lang.String, java.lang.String>

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-beta/5.34.0/docs/resources/google_spanner_instance_config#labels GoogleSpannerInstanceConfigA#labels}


nameOptional
  • Type: java.lang.String

A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/[a-z][-a-z0-9]*.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#name GoogleSpannerInstanceConfigA#name}


projectOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#project GoogleSpannerInstanceConfigA#project}.


timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#timeouts GoogleSpannerInstanceConfigA#timeouts}


Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putReplicas No description.
putTimeouts No description.
resetBaseConfig No description.
resetId No description.
resetLabels No description.
resetName No description.
resetProject No description.
resetTimeouts No description.

toString
public java.lang.String toString()

Returns a string representation of this construct.

addOverride
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String

valueRequired
  • Type: java.lang.Object

overrideLogicalId
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.


resetOverrideLogicalId
public void resetOverrideLogicalId()

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

toHclTerraform
public java.lang.Object toHclTerraform()
toMetadata
public java.lang.Object toMetadata()
toTerraform
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget
public void addMoveTarget(java.lang.String moveTarget)

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

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.


getAnyMapAttribute
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanAttribute
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanMapAttribute
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getListAttribute
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberAttribute
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberListAttribute
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberMapAttribute
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringAttribute
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringMapAttribute
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

hasResourceMove
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

moveFromId
public void moveFromId(java.lang.String id)

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

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: java.lang.String

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


moveTo
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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


indexOptional
  • Type: java.lang.String OR java.lang.Number

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


moveToId
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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


putReplicas
public void putReplicas(IResolvable OR java.util.List<GoogleSpannerInstanceConfigReplicas> value)
valueRequired

putTimeouts
public void putTimeouts(GoogleSpannerInstanceConfigTimeouts value)
valueRequired

resetBaseConfig
public void resetBaseConfig()
resetId
public void resetId()
resetLabels
public void resetLabels()
resetName
public void resetName()
resetProject
public void resetProject()
resetTimeouts
public void resetTimeouts()

Static Functions

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

isConstruct
import com.hashicorp.cdktf.providers.google_beta.google_spanner_instance_config.GoogleSpannerInstanceConfigA;

GoogleSpannerInstanceConfigA.isConstruct(java.lang.Object x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: java.lang.Object

Any object.


isTerraformElement
import com.hashicorp.cdktf.providers.google_beta.google_spanner_instance_config.GoogleSpannerInstanceConfigA;

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

isTerraformResource
import com.hashicorp.cdktf.providers.google_beta.google_spanner_instance_config.GoogleSpannerInstanceConfigA;

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

generateConfigForImport
import com.hashicorp.cdktf.providers.google_beta.google_spanner_instance_config.GoogleSpannerInstanceConfigA;

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

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: java.lang.String

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


importFromIdRequired
  • Type: java.lang.String

The id of the existing GoogleSpannerInstanceConfigA that should be imported.

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


providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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


Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
configType java.lang.String No description.
effectiveLabels com.hashicorp.cdktf.StringMap No description.
replicas GoogleSpannerInstanceConfigReplicasList No description.
terraformLabels com.hashicorp.cdktf.StringMap No description.
timeouts GoogleSpannerInstanceConfigTimeoutsOutputReference No description.
baseConfigInput java.lang.String No description.
displayNameInput java.lang.String No description.
idInput java.lang.String No description.
labelsInput java.util.Map<java.lang.String, java.lang.String> No description.
nameInput java.lang.String No description.
projectInput java.lang.String No description.
replicasInput com.hashicorp.cdktf.IResolvable OR java.util.List<GoogleSpannerInstanceConfigReplicas> No description.
timeoutsInput com.hashicorp.cdktf.IResolvable OR GoogleSpannerInstanceConfigTimeouts No description.
baseConfig java.lang.String No description.
displayName java.lang.String No description.
id java.lang.String No description.
labels java.util.Map<java.lang.String, java.lang.String> No description.
name java.lang.String No description.
project java.lang.String No description.

nodeRequired
public Node getNode();
  • Type: software.constructs.Node

The tree node.


cdktfStackRequired
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack

fqnRequired
public java.lang.String getFqn();
  • Type: java.lang.String

friendlyUniqueIdRequired
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String

terraformMetaArgumentsRequired
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>

terraformResourceTypeRequired
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String

terraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

configTypeRequired
public java.lang.String getConfigType();
  • Type: java.lang.String

effectiveLabelsRequired
public StringMap getEffectiveLabels();
  • Type: com.hashicorp.cdktf.StringMap

replicasRequired
public GoogleSpannerInstanceConfigReplicasList getReplicas();

terraformLabelsRequired
public StringMap getTerraformLabels();
  • Type: com.hashicorp.cdktf.StringMap

timeoutsRequired
public GoogleSpannerInstanceConfigTimeoutsOutputReference getTimeouts();

baseConfigInputOptional
public java.lang.String getBaseConfigInput();
  • Type: java.lang.String

displayNameInputOptional
public java.lang.String getDisplayNameInput();
  • Type: java.lang.String

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

labelsInputOptional
public java.util.Map<java.lang.String, java.lang.String> getLabelsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>

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

projectInputOptional
public java.lang.String getProjectInput();
  • Type: java.lang.String

replicasInputOptional
public java.lang.Object getReplicasInput();

timeoutsInputOptional
public java.lang.Object getTimeoutsInput();

baseConfigRequired
public java.lang.String getBaseConfig();
  • Type: java.lang.String

displayNameRequired
public java.lang.String getDisplayName();
  • Type: java.lang.String

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

labelsRequired
public java.util.Map<java.lang.String, java.lang.String> getLabels();
  • Type: java.util.Map<java.lang.String, java.lang.String>

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

projectRequired
public java.lang.String getProject();
  • Type: java.lang.String

Constants

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

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

Structs

GoogleSpannerInstanceConfigAConfig

Initializer

import com.hashicorp.cdktf.providers.google_beta.google_spanner_instance_config.GoogleSpannerInstanceConfigAConfig;

GoogleSpannerInstanceConfigAConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .displayName(java.lang.String)
    .replicas(IResolvable)
    .replicas(java.util.List<GoogleSpannerInstanceConfigReplicas>)
//  .baseConfig(java.lang.String)
//  .id(java.lang.String)
//  .labels(java.util.Map<java.lang.String, java.lang.String>)
//  .name(java.lang.String)
//  .project(java.lang.String)
//  .timeouts(GoogleSpannerInstanceConfigTimeouts)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
displayName java.lang.String The name of this instance configuration as it appears in UIs.
replicas com.hashicorp.cdktf.IResolvable OR java.util.List<GoogleSpannerInstanceConfigReplicas> replicas block.
baseConfig java.lang.String Base configuration name, e.g. nam3, based on which this configuration is created. Only set for user managed configurations. baseConfig must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#id GoogleSpannerInstanceConfigA#id}.
labels java.util.Map<java.lang.String, java.lang.String> An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
name java.lang.String A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/[a-z][-a-z0-9]*.
project java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#project GoogleSpannerInstanceConfigA#project}.
timeouts GoogleSpannerInstanceConfigTimeouts timeouts block.

connectionOptional
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

displayNameRequired
public java.lang.String getDisplayName();
  • Type: java.lang.String

The name of this instance configuration as it appears in UIs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#display_name GoogleSpannerInstanceConfigA#display_name}


replicasRequired
public java.lang.Object getReplicas();

replicas block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#replicas GoogleSpannerInstanceConfigA#replicas}


baseConfigOptional
public java.lang.String getBaseConfig();
  • Type: java.lang.String

Base configuration name, e.g. nam3, based on which this configuration is created. Only set for user managed configurations. baseConfig must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#base_config GoogleSpannerInstanceConfigA#base_config}


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#id GoogleSpannerInstanceConfigA#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
public java.util.Map<java.lang.String, java.lang.String> getLabels();
  • Type: java.util.Map<java.lang.String, java.lang.String>

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-beta/5.34.0/docs/resources/google_spanner_instance_config#labels GoogleSpannerInstanceConfigA#labels}


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

A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/[a-z][-a-z0-9]*.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#name GoogleSpannerInstanceConfigA#name}


projectOptional
public java.lang.String getProject();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#project GoogleSpannerInstanceConfigA#project}.


timeoutsOptional
public GoogleSpannerInstanceConfigTimeouts getTimeouts();

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#timeouts GoogleSpannerInstanceConfigA#timeouts}


GoogleSpannerInstanceConfigReplicas

Initializer

import com.hashicorp.cdktf.providers.google_beta.google_spanner_instance_config.GoogleSpannerInstanceConfigReplicas;

GoogleSpannerInstanceConfigReplicas.builder()
//  .defaultLeaderLocation(java.lang.Boolean)
//  .defaultLeaderLocation(IResolvable)
//  .location(java.lang.String)
//  .type(java.lang.String)
    .build();

Properties

Name Type Description
defaultLeaderLocation java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If true, this location is designated as the default leader location where leader replicas are placed.
location java.lang.String The location of the serving resources, e.g. "us-central1".
type java.lang.String Indicates the type of replica. See the replica types documentation for more details. Possible values: ["READ_WRITE", "READ_ONLY", "WITNESS"].

defaultLeaderLocationOptional
public java.lang.Object getDefaultLeaderLocation();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

If true, this location is designated as the default leader location where leader replicas are placed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#default_leader_location GoogleSpannerInstanceConfigA#default_leader_location}


locationOptional
public java.lang.String getLocation();
  • Type: java.lang.String

The location of the serving resources, e.g. "us-central1".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#location GoogleSpannerInstanceConfigA#location}


typeOptional
public java.lang.String getType();
  • Type: java.lang.String

Indicates the type of replica. See the replica types documentation for more details. Possible values: ["READ_WRITE", "READ_ONLY", "WITNESS"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#type GoogleSpannerInstanceConfigA#type}


GoogleSpannerInstanceConfigTimeouts

Initializer

import com.hashicorp.cdktf.providers.google_beta.google_spanner_instance_config.GoogleSpannerInstanceConfigTimeouts;

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

Properties

Name Type Description
create java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#create GoogleSpannerInstanceConfigA#create}.
delete java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#delete GoogleSpannerInstanceConfigA#delete}.
update java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#update GoogleSpannerInstanceConfigA#update}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#create GoogleSpannerInstanceConfigA#create}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#delete GoogleSpannerInstanceConfigA#delete}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/5.34.0/docs/resources/google_spanner_instance_config#update GoogleSpannerInstanceConfigA#update}.


Classes

GoogleSpannerInstanceConfigReplicasList

Initializers

import com.hashicorp.cdktf.providers.google_beta.google_spanner_instance_config.GoogleSpannerInstanceConfigReplicasList;

new GoogleSpannerInstanceConfigReplicasList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
wrapsSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.


wrapsSetRequired
  • Type: java.lang.Boolean

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


Methods

Name Description
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.

allWithMapKey
public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName)

Creating an iterator for this complex list.

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

mapKeyAttributeNameRequired
  • Type: java.lang.String

computeFqn
public java.lang.String computeFqn()
resolve
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext

toString
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

get
public GoogleSpannerInstanceConfigReplicasOutputReference get(java.lang.Number index)
indexRequired
  • Type: java.lang.Number

the index of the item to return.


Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR java.util.List<GoogleSpannerInstanceConfigReplicas> No description.

creationStackRequired
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public java.lang.String getFqn();
  • Type: java.lang.String

internalValueOptional
public java.lang.Object getInternalValue();

GoogleSpannerInstanceConfigReplicasOutputReference

Initializers

import com.hashicorp.cdktf.providers.google_beta.google_spanner_instance_config.GoogleSpannerInstanceConfigReplicasOutputReference;

new GoogleSpannerInstanceConfigReplicasOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
complexObjectIndex java.lang.Number the index of this item in the list.
complexObjectIsFromSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: java.lang.Number

the index of this item in the list.


complexObjectIsFromSetRequired
  • Type: java.lang.Boolean

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


Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetDefaultLeaderLocation No description.
resetLocation No description.
resetType No description.

computeFqn
public java.lang.String computeFqn()
getAnyMapAttribute
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanAttribute
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanMapAttribute
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getListAttribute
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberAttribute
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberListAttribute
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberMapAttribute
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringAttribute
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringMapAttribute
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String

resolve
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext

toString
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetDefaultLeaderLocation
public void resetDefaultLeaderLocation()
resetLocation
public void resetLocation()
resetType
public void resetType()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
defaultLeaderLocationInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
locationInput java.lang.String No description.
typeInput java.lang.String No description.
defaultLeaderLocation java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
location java.lang.String No description.
type java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR GoogleSpannerInstanceConfigReplicas No description.

creationStackRequired
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public java.lang.String getFqn();
  • Type: java.lang.String

defaultLeaderLocationInputOptional
public java.lang.Object getDefaultLeaderLocationInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

locationInputOptional
public java.lang.String getLocationInput();
  • Type: java.lang.String

typeInputOptional
public java.lang.String getTypeInput();
  • Type: java.lang.String

defaultLeaderLocationRequired
public java.lang.Object getDefaultLeaderLocation();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

locationRequired
public java.lang.String getLocation();
  • Type: java.lang.String

typeRequired
public java.lang.String getType();
  • Type: java.lang.String

internalValueOptional
public java.lang.Object getInternalValue();

GoogleSpannerInstanceConfigTimeoutsOutputReference

Initializers

import com.hashicorp.cdktf.providers.google_beta.google_spanner_instance_config.GoogleSpannerInstanceConfigTimeoutsOutputReference;

new GoogleSpannerInstanceConfigTimeoutsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.


Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetCreate No description.
resetDelete No description.
resetUpdate No description.

computeFqn
public java.lang.String computeFqn()
getAnyMapAttribute
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanAttribute
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanMapAttribute
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getListAttribute
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberAttribute
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberListAttribute
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberMapAttribute
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringAttribute
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringMapAttribute
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String

resolve
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext

toString
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

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

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
createInput java.lang.String No description.
deleteInput java.lang.String No description.
updateInput java.lang.String No description.
create java.lang.String No description.
delete java.lang.String No description.
update java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR GoogleSpannerInstanceConfigTimeouts No description.

creationStackRequired
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public java.lang.String getFqn();
  • Type: java.lang.String

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

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

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

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

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

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

internalValueOptional
public java.lang.Object getInternalValue();