sqlProvisionScript.csharp.md

sqlProvisionScript Submodule

Constructs

SqlProvisionScript

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/resources/sql_provision_script google_sql_provision_script}.

Initializers

using Io.Cdktn.Providers.Google;

new SqlProvisionScript(Construct Scope, string Id, SqlProvisionScriptConfig Config);

Name	Type	Description
Scope	Constructs.Construct	The scope in which to define this construct.
Id	string	The scoped construct ID.
Config	SqlProvisionScriptConfig	No description.

---

Scope^Required

• Type: Constructs.Construct

The scope in which to define this construct.

---

Id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

Config^Required

• Type: SqlProvisionScriptConfig

---

Methods

Name	Description
ToString	Returns a string representation of this construct.
With	Applies one or more mixins to 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".
ResetDatabase	No description.
ResetDeletionPolicy	No description.
ResetDescription	No description.
ResetId	No description.
ResetProject	No description.

---

ToString

private string ToString()

Returns a string representation of this construct.

With

private IConstruct With(params IMixin[] Mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Mixins^Required

• Type: params Constructs.IMixin[]

The mixins to apply.

---

AddOverride

private void AddOverride(string Path, object Value)

Path^Required

• Type: string

---

Value^Required

• Type: object

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

ResetOverrideLogicalId

private void ResetOverrideLogicalId()

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

ToHclTerraform

private object ToHclTerraform()

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget

private void AddMoveTarget(string MoveTarget)

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

MoveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

GetAnyMapAttribute

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

HasResourceMove

private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove()

ImportFrom

private void ImportFrom(string Id, TerraformProvider Provider = null)

Id^Required

• Type: string

---

Provider^Optional

• Type: Io.Cdktn.TerraformProvider

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

MoveFromId

private void MoveFromId(string Id)

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

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

Id^Required

• Type: string

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

---

MoveTo

private void MoveTo(string MoveTarget, string|double Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTarget^Required

• Type: string

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

---

Index^Optional

• Type: string|double

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

---

MoveToId

private void MoveToId(string Id)

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

Id^Required

• Type: string

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

---

ResetDatabase

private void ResetDatabase()

ResetDeletionPolicy

private void ResetDeletionPolicy()

ResetDescription

private void ResetDescription()

ResetId

private void ResetId()

ResetProject

private void ResetProject()

Static Functions

Name	Description
IsConstruct	Checks if x is a construct.
IsTerraformElement	No description.
IsTerraformResource	No description.
GenerateConfigForImport	Generates CDKTN code for importing a SqlProvisionScript resource upon running "cdktn plan ".

---

IsConstruct

using Io.Cdktn.Providers.Google;

SqlProvisionScript.IsConstruct(object X);

Checks if x is a construct.

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

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

X^Required

• Type: object

Any object.

---

IsTerraformElement

using Io.Cdktn.Providers.Google;

SqlProvisionScript.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using Io.Cdktn.Providers.Google;

SqlProvisionScript.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using Io.Cdktn.Providers.Google;

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

Generates CDKTN code for importing a SqlProvisionScript resource upon running "cdktn plan ".

Scope^Required

• Type: Constructs.Construct

The scope in which to define this construct.

---

ImportToId^Required

• Type: string

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

---

ImportFromId^Required

• Type: string

The id of the existing SqlProvisionScript that should be imported.

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

---

Provider^Optional

• Type: Io.Cdktn.TerraformProvider

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

---

Properties

Name	Type	Description
Node	Constructs.Node	The tree node.
CdktfStack	Io.Cdktn.TerraformStack	No description.
Fqn	string	No description.
FriendlyUniqueId	string	No description.
TerraformMetaArguments	System.Collections.Generic.IDictionary<string, object>	No description.
TerraformResourceType	string	No description.
TerraformGeneratorMetadata	Io.Cdktn.TerraformProviderGeneratorMetadata	No description.
Connection	Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection	No description.
Count	double|Io.Cdktn.TerraformCount	No description.
DependsOn	string[]	No description.
ForEach	Io.Cdktn.ITerraformIterator	No description.
Lifecycle	Io.Cdktn.TerraformResourceLifecycle	No description.
Provider	Io.Cdktn.TerraformProvider	No description.
Provisioners	Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]	No description.
DatabaseInput	string	No description.
DeletionPolicyInput	string	No description.
DescriptionInput	string	No description.
IdInput	string	No description.
InstanceInput	string	No description.
ProjectInput	string	No description.
ScriptInput	string	No description.
Database	string	No description.
DeletionPolicy	string	No description.
Description	string	No description.
Id	string	No description.
Instance	string	No description.
Project	string	No description.
Script	string	No description.

---

Node^Required

public Node Node { get; }

• Type: Constructs.Node

The tree node.

---

CdktfStack^Required

public TerraformStack CdktfStack { get; }

• Type: Io.Cdktn.TerraformStack

---

Fqn^Required

public string Fqn { get; }

• Type: string

---

FriendlyUniqueId^Required

public string FriendlyUniqueId { get; }

• Type: string

---

TerraformMetaArguments^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

• Type: System.Collections.Generic.IDictionary<string, object>

---

TerraformResourceType^Required

public string TerraformResourceType { get; }

• Type: string

---

TerraformGeneratorMetadata^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

• Type: Io.Cdktn.TerraformProviderGeneratorMetadata

---

Connection^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; }

• Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

---

Count^Optional

public double|TerraformCount Count { get; }

• Type: double|Io.Cdktn.TerraformCount

---

DependsOn^Optional

public string[] DependsOn { get; }

• Type: string[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; }

• Type: Io.Cdktn.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; }

• Type: Io.Cdktn.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; }

• Type: Io.Cdktn.TerraformProvider

---

Provisioners^Optional

public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; }

• Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

---

DatabaseInput^Optional

public string DatabaseInput { get; }

• Type: string

---

DeletionPolicyInput^Optional

public string DeletionPolicyInput { get; }

• Type: string

---

DescriptionInput^Optional

public string DescriptionInput { get; }

• Type: string

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

InstanceInput^Optional

public string InstanceInput { get; }

• Type: string

---

ProjectInput^Optional

public string ProjectInput { get; }

• Type: string

---

ScriptInput^Optional

public string ScriptInput { get; }

• Type: string

---

Database^Required

public string Database { get; }

• Type: string

---

DeletionPolicy^Required

public string DeletionPolicy { get; }

• Type: string

---

Description^Required

public string Description { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

Instance^Required

public string Instance { get; }

• Type: string

---

Project^Required

public string Project { get; }

• Type: string

---

Script^Required

public string Script { get; }

• Type: string

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

SqlProvisionScriptConfig

Initializer

using Io.Cdktn.Providers.Google;

new SqlProvisionScriptConfig {
    SSHProvisionerConnection|WinrmProvisionerConnection Connection = null,
    double|TerraformCount Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners = null,
    string Instance,
    string Script,
    string Database = null,
    string DeletionPolicy = null,
    string Description = null,
    string Id = null,
    string Project = null
};

Properties

Name	Type	Description
Connection	Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection	No description.
Count	double|Io.Cdktn.TerraformCount	No description.
DependsOn	Io.Cdktn.ITerraformDependable[]	No description.
ForEach	Io.Cdktn.ITerraformIterator	No description.
Lifecycle	Io.Cdktn.TerraformResourceLifecycle	No description.
Provider	Io.Cdktn.TerraformProvider	No description.
Provisioners	Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]	No description.
Instance	string	The name of the Cloud SQL instance. Changing this forces the script to be run on the new instance.
Script	string	The SQL script to provision database resources.
Database	string	The name of the database to which Terraform connects.
DeletionPolicy	string	The deletion policy for the resources created by the script.
Description	string	The description of the provision script.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/resources/sql_provision_script#id SqlProvisionScript#id}.
Project	string	The ID of the project in which the resource belongs.

---

Connection^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; }

• Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

---

Count^Optional

public double|TerraformCount Count { get; set; }

• Type: double|Io.Cdktn.TerraformCount

---

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: Io.Cdktn.ITerraformDependable[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: Io.Cdktn.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: Io.Cdktn.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: Io.Cdktn.TerraformProvider

---

Provisioners^Optional

public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; }

• Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

---

Instance^Required

public string Instance { get; set; }

• Type: string

The name of the Cloud SQL instance. Changing this forces the script to be run on the new instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/resources/sql_provision_script#instance SqlProvisionScript#instance}

---

Script^Required

public string Script { get; set; }

• Type: string

The SQL script to provision database resources.

Its execution time limit is 30 s. Changing this forces the script to be rerun. Make sure the script is idempotent. You can use statements like "create if not exists …" or "if not exists (select …) then … end if" to prevent existence-related errors. If it's not possible to make a statement idempotent, you can run it once and then remove it from this script.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/resources/sql_provision_script#script SqlProvisionScript#script}

---

Database^Optional

public string Database { get; set; }

• Type: string

The name of the database to which Terraform connects.

Changing this forces Terraform to connect to the new database and run the script. This argument is required for Postgres instances. It's optional for MySQL, but some of your queries may require a database. You can create and use a database in the script or explicitly reference a google_sql_database.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/resources/sql_provision_script#database SqlProvisionScript#database}

---

DeletionPolicy^Optional

public string DeletionPolicy { get; set; }

• Type: string

The deletion policy for the resources created by the script.

The default is "ABANDON". It must be "ABANDON" to allow Terraform to abandon the resources. If you want to delete resources, add statements in the script such as "drop … if exists".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/resources/sql_provision_script#deletion_policy SqlProvisionScript#deletion_policy}

---

Description^Optional

public string Description { get; set; }

• Type: string

The description of the provision script.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/resources/sql_provision_script#description SqlProvisionScript#description}

---

Id^Optional

public string Id { get; set; }

• Type: string

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

---

Project^Optional

public string Project { get; set; }

• Type: string

The ID of the project in which the resource belongs.

If it is not provided, the provider project is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/resources/sql_provision_script#project SqlProvisionScript#project}

---