sqlSourceRepresentationInstance.python.md

sqlSourceRepresentationInstance Submodule

Constructs

SqlSourceRepresentationInstance

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance google_sql_source_representation_instance}.

Initializers

from cdktf_cdktf_provider_google import sql_source_representation_instance

sqlSourceRepresentationInstance.SqlSourceRepresentationInstance(
  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,
  database_version: str,
  host: str,
  name: str,
  ca_certificate: str = None,
  client_certificate: str = None,
  client_key: str = None,
  dump_file_path: str = None,
  id: str = None,
  password: str = None,
  port: typing.Union[int, float] = None,
  project: str = None,
  region: str = None,
  timeouts: SqlSourceRepresentationInstanceTimeouts = None,
  username: str = 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.
database_version	str	The MySQL version running on your source database server.
host	str	The IPv4 address and port for the external server, or the the DNS address for the external server.
name	str	The name of the source representation instance. Use any valid Cloud SQL instance name.
ca_certificate	str	The CA certificate on the external server. Include only if SSL/TLS is used on the external server.
client_certificate	str	The client certificate on the external server.
client_key	str	The private key file for the client certificate on the external server.
dump_file_path	str	A file in the bucket that contains the data from the external server.
id	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#id SqlSourceRepresentationInstance#id}.
password	str	The password for the replication user account.
port	typing.Union[int, float]	The externally accessible port for the source database server. Defaults to 3306.
project	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#project SqlSourceRepresentationInstance#project}.
region	str	The Region in which the created instance should reside. If it is not provided, the provider region is used.
timeouts	SqlSourceRepresentationInstanceTimeouts	timeouts block.
username	str	The replication user account on the external server.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

connection^Optional

• Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

---

count^Optional

• Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

---

depends_on^Optional

• Type: typing.List[cdktf.ITerraformDependable]

---

for_each^Optional

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

• Type: cdktf.TerraformProvider

---

provisioners^Optional

• Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

---

database_version^Required

• Type: str

The MySQL version running on your source database server.

Possible values: ["MYSQL_5_6", "MYSQL_5_7", "MYSQL_8_0", "POSTGRES_9_6", "POSTGRES_10", "POSTGRES_11", "POSTGRES_12", "POSTGRES_13", "POSTGRES_14"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#database_version SqlSourceRepresentationInstance#database_version}

---

host^Required

• Type: str

The IPv4 address and port for the external server, or the the DNS address for the external server.

If the external server is hosted on Cloud SQL, the port is 5432.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#host SqlSourceRepresentationInstance#host}

---

name^Required

• Type: str

The name of the source representation instance. Use any valid Cloud SQL instance name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#name SqlSourceRepresentationInstance#name}

---

ca_certificate^Optional

• Type: str

The CA certificate on the external server. Include only if SSL/TLS is used on the external server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#ca_certificate SqlSourceRepresentationInstance#ca_certificate}

---

client_certificate^Optional

• Type: str

The client certificate on the external server.

Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#client_certificate SqlSourceRepresentationInstance#client_certificate}

---

client_key^Optional

• Type: str

The private key file for the client certificate on the external server.

Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#client_key SqlSourceRepresentationInstance#client_key}

---

dump_file_path^Optional

• Type: str

A file in the bucket that contains the data from the external server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#dump_file_path SqlSourceRepresentationInstance#dump_file_path}

---

id^Optional

• Type: str

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

---

password^Optional

• Type: str

The password for the replication user account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#password SqlSourceRepresentationInstance#password}

---

port^Optional

• Type: typing.Union[int, float]

The externally accessible port for the source database server. Defaults to 3306.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#port SqlSourceRepresentationInstance#port}

---

project^Optional

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#project SqlSourceRepresentationInstance#project}.

---

region^Optional

• Type: str

The Region in which the created instance should reside. If it is not provided, the provider region is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#region SqlSourceRepresentationInstance#region}

---

timeouts^Optional

• Type: SqlSourceRepresentationInstanceTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#timeouts SqlSourceRepresentationInstance#timeouts}

---

username^Optional

• Type: str

The replication user account on the external server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#username SqlSourceRepresentationInstance#username}

---

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_timeouts	No description.
reset_ca_certificate	No description.
reset_client_certificate	No description.
reset_client_key	No description.
reset_dump_file_path	No description.
reset_id	No description.
reset_password	No description.
reset_port	No description.
reset_project	No description.
reset_region	No description.
reset_timeouts	No description.
reset_username	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

path^Required

• Type: str

---

value^Required

• 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_id^Required

• 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_target^Required

• 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_attribute^Required

• Type: str

---

get_boolean_attribute

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

terraform_attribute^Required

• Type: str

---

get_boolean_map_attribute

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

terraform_attribute^Required

• Type: str

---

get_list_attribute

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

terraform_attribute^Required

• Type: str

---

get_number_attribute

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

terraform_attribute^Required

• Type: str

---

get_number_list_attribute

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_number_map_attribute

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_string_attribute

def get_string_attribute(
  terraform_attribute: str
) -> str

terraform_attribute^Required

• Type: str

---

get_string_map_attribute

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

terraform_attribute^Required

• Type: str

---

has_resource_move

def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]

import_from

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

id^Required

• Type: str

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolation_for_attribute

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

terraform_attribute^Required

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

id^Required

• 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_target^Required

• Type: str

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

---

index^Optional

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

id^Required

• Type: str

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

---

put_timeouts

def put_timeouts(
  create: str = None,
  delete: str = None
) -> None

create^Optional

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#create SqlSourceRepresentationInstance#create}.

---

delete^Optional

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#delete SqlSourceRepresentationInstance#delete}.

---

reset_ca_certificate

def reset_ca_certificate() -> None

reset_client_certificate

def reset_client_certificate() -> None

reset_client_key

def reset_client_key() -> None

reset_dump_file_path

def reset_dump_file_path() -> None

reset_id

def reset_id() -> None

reset_password

def reset_password() -> None

reset_port

def reset_port() -> None

reset_project

def reset_project() -> None

reset_region

def reset_region() -> None

reset_timeouts

def reset_timeouts() -> None

reset_username

def reset_username() -> 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 SqlSourceRepresentationInstance resource upon running "cdktf plan ".

---

is_construct

from cdktf_cdktf_provider_google import sql_source_representation_instance

sqlSourceRepresentationInstance.SqlSourceRepresentationInstance.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.

x^Required

• Type: typing.Any

Any object.

---

is_terraform_element

from cdktf_cdktf_provider_google import sql_source_representation_instance

sqlSourceRepresentationInstance.SqlSourceRepresentationInstance.is_terraform_element(
  x: typing.Any
)

x^Required

• Type: typing.Any

---

is_terraform_resource

from cdktf_cdktf_provider_google import sql_source_representation_instance

sqlSourceRepresentationInstance.SqlSourceRepresentationInstance.is_terraform_resource(
  x: typing.Any
)

x^Required

• Type: typing.Any

---

generate_config_for_import

from cdktf_cdktf_provider_google import sql_source_representation_instance

sqlSourceRepresentationInstance.SqlSourceRepresentationInstance.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

import_to_id^Required

• Type: str

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

---

import_from_id^Required

• Type: str

The id of the existing SqlSourceRepresentationInstance that should be imported.

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

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the SqlSourceRepresentationInstance 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.
timeouts	SqlSourceRepresentationInstanceTimeoutsOutputReference	No description.
ca_certificate_input	str	No description.
client_certificate_input	str	No description.
client_key_input	str	No description.
database_version_input	str	No description.
dump_file_path_input	str	No description.
host_input	str	No description.
id_input	str	No description.
name_input	str	No description.
password_input	str	No description.
port_input	typing.Union[int, float]	No description.
project_input	str	No description.
region_input	str	No description.
timeouts_input	typing.Union[cdktf.IResolvable, SqlSourceRepresentationInstanceTimeouts]	No description.
username_input	str	No description.
ca_certificate	str	No description.
client_certificate	str	No description.
client_key	str	No description.
database_version	str	No description.
dump_file_path	str	No description.
host	str	No description.
id	str	No description.
name	str	No description.
password	str	No description.
port	typing.Union[int, float]	No description.
project	str	No description.
region	str	No description.
username	str	No description.

---

node^Required

node: Node

• Type: constructs.Node

The tree node.

---

cdktf_stack^Required

cdktf_stack: TerraformStack

• Type: cdktf.TerraformStack

---

fqn^Required

fqn: str

• Type: str

---

friendly_unique_id^Required

friendly_unique_id: str

• Type: str

---

terraform_meta_arguments^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

• Type: typing.Mapping[typing.Any]

---

terraform_resource_type^Required

terraform_resource_type: str

• Type: str

---

terraform_generator_metadata^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

• Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

---

count^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

• Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

---

depends_on^Optional

depends_on: typing.List[str]

• Type: typing.List[str]

---

for_each^Optional

for_each: ITerraformIterator

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

lifecycle: TerraformResourceLifecycle

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

provider: TerraformProvider

• Type: cdktf.TerraformProvider

---

provisioners^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

• Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

---

timeouts^Required

timeouts: SqlSourceRepresentationInstanceTimeoutsOutputReference

• Type: SqlSourceRepresentationInstanceTimeoutsOutputReference

---

ca_certificate_input^Optional

ca_certificate_input: str

• Type: str

---

client_certificate_input^Optional

client_certificate_input: str

• Type: str

---

client_key_input^Optional

client_key_input: str

• Type: str

---

database_version_input^Optional

database_version_input: str

• Type: str

---

dump_file_path_input^Optional

dump_file_path_input: str

• Type: str

---

host_input^Optional

host_input: str

• Type: str

---

id_input^Optional

id_input: str

• Type: str

---

name_input^Optional

name_input: str

• Type: str

---

password_input^Optional

password_input: str

• Type: str

---

port_input^Optional

port_input: typing.Union[int, float]

• Type: typing.Union[int, float]

---

project_input^Optional

project_input: str

• Type: str

---

region_input^Optional

region_input: str

• Type: str

---

timeouts_input^Optional

timeouts_input: typing.Union[IResolvable, SqlSourceRepresentationInstanceTimeouts]

• Type: typing.Union[cdktf.IResolvable, SqlSourceRepresentationInstanceTimeouts]

---

username_input^Optional

username_input: str

• Type: str

---

ca_certificate^Required

ca_certificate: str

• Type: str

---

client_certificate^Required

client_certificate: str

• Type: str

---

client_key^Required

client_key: str

• Type: str

---

database_version^Required

database_version: str

• Type: str

---

dump_file_path^Required

dump_file_path: str

• Type: str

---

host^Required

host: str

• Type: str

---

id^Required

id: str

• Type: str

---

name^Required

name: str

• Type: str

---

password^Required

password: str

• Type: str

---

port^Required

port: typing.Union[int, float]

• Type: typing.Union[int, float]

---

project^Required

project: str

• Type: str

---

region^Required

region: str

• Type: str

---

username^Required

username: str

• Type: str

---

Constants

Name	Type	Description
tfResourceType	str	No description.

---

tfResourceType^Required

tfResourceType: str

• Type: str

---

Structs

SqlSourceRepresentationInstanceConfig

Initializer

from cdktf_cdktf_provider_google import sql_source_representation_instance

sqlSourceRepresentationInstance.SqlSourceRepresentationInstanceConfig(
  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,
  database_version: str,
  host: str,
  name: str,
  ca_certificate: str = None,
  client_certificate: str = None,
  client_key: str = None,
  dump_file_path: str = None,
  id: str = None,
  password: str = None,
  port: typing.Union[int, float] = None,
  project: str = None,
  region: str = None,
  timeouts: SqlSourceRepresentationInstanceTimeouts = None,
  username: str = 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.
database_version	str	The MySQL version running on your source database server.
host	str	The IPv4 address and port for the external server, or the the DNS address for the external server.
name	str	The name of the source representation instance. Use any valid Cloud SQL instance name.
ca_certificate	str	The CA certificate on the external server. Include only if SSL/TLS is used on the external server.
client_certificate	str	The client certificate on the external server.
client_key	str	The private key file for the client certificate on the external server.
dump_file_path	str	A file in the bucket that contains the data from the external server.
id	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#id SqlSourceRepresentationInstance#id}.
password	str	The password for the replication user account.
port	typing.Union[int, float]	The externally accessible port for the source database server. Defaults to 3306.
project	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#project SqlSourceRepresentationInstance#project}.
region	str	The Region in which the created instance should reside. If it is not provided, the provider region is used.
timeouts	SqlSourceRepresentationInstanceTimeouts	timeouts block.
username	str	The replication user account on the external server.

---

connection^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

• Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

---

count^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

• Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

---

depends_on^Optional

depends_on: typing.List[ITerraformDependable]

• Type: typing.List[cdktf.ITerraformDependable]

---

for_each^Optional

for_each: ITerraformIterator

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

lifecycle: TerraformResourceLifecycle

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

provider: TerraformProvider

• Type: cdktf.TerraformProvider

---

provisioners^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

• Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

---

database_version^Required

database_version: str

• Type: str

The MySQL version running on your source database server.

Possible values: ["MYSQL_5_6", "MYSQL_5_7", "MYSQL_8_0", "POSTGRES_9_6", "POSTGRES_10", "POSTGRES_11", "POSTGRES_12", "POSTGRES_13", "POSTGRES_14"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#database_version SqlSourceRepresentationInstance#database_version}

---

host^Required

host: str

• Type: str

The IPv4 address and port for the external server, or the the DNS address for the external server.

If the external server is hosted on Cloud SQL, the port is 5432.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#host SqlSourceRepresentationInstance#host}

---

name^Required

name: str

• Type: str

The name of the source representation instance. Use any valid Cloud SQL instance name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#name SqlSourceRepresentationInstance#name}

---

ca_certificate^Optional

ca_certificate: str

• Type: str

The CA certificate on the external server. Include only if SSL/TLS is used on the external server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#ca_certificate SqlSourceRepresentationInstance#ca_certificate}

---

client_certificate^Optional

client_certificate: str

• Type: str

The client certificate on the external server.

Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#client_certificate SqlSourceRepresentationInstance#client_certificate}

---

client_key^Optional

client_key: str

• Type: str

The private key file for the client certificate on the external server.

Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#client_key SqlSourceRepresentationInstance#client_key}

---

dump_file_path^Optional

dump_file_path: str

• Type: str

A file in the bucket that contains the data from the external server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#dump_file_path SqlSourceRepresentationInstance#dump_file_path}

---

id^Optional

id: str

• Type: str

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

---

password^Optional

password: str

• Type: str

The password for the replication user account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#password SqlSourceRepresentationInstance#password}

---

port^Optional

port: typing.Union[int, float]

• Type: typing.Union[int, float]

The externally accessible port for the source database server. Defaults to 3306.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#port SqlSourceRepresentationInstance#port}

---

project^Optional

project: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#project SqlSourceRepresentationInstance#project}.

---

region^Optional

region: str

• Type: str

The Region in which the created instance should reside. If it is not provided, the provider region is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#region SqlSourceRepresentationInstance#region}

---

timeouts^Optional

timeouts: SqlSourceRepresentationInstanceTimeouts

• Type: SqlSourceRepresentationInstanceTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#timeouts SqlSourceRepresentationInstance#timeouts}

---

username^Optional

username: str

• Type: str

The replication user account on the external server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#username SqlSourceRepresentationInstance#username}

---

SqlSourceRepresentationInstanceTimeouts

Initializer

from cdktf_cdktf_provider_google import sql_source_representation_instance

sqlSourceRepresentationInstance.SqlSourceRepresentationInstanceTimeouts(
  create: str = None,
  delete: str = None
)

Properties

Name	Type	Description
create	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#create SqlSourceRepresentationInstance#create}.
delete	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#delete SqlSourceRepresentationInstance#delete}.

---

create^Optional

create: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#create SqlSourceRepresentationInstance#create}.

---

delete^Optional

delete: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/sql_source_representation_instance#delete SqlSourceRepresentationInstance#delete}.

---

Classes

SqlSourceRepresentationInstanceTimeoutsOutputReference

Initializers

from cdktf_cdktf_provider_google import sql_source_representation_instance

sqlSourceRepresentationInstance.SqlSourceRepresentationInstanceTimeoutsOutputReference(
  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_resource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraform_attribute^Required

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

---

compute_fqn

def compute_fqn() -> str

get_any_map_attribute

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

terraform_attribute^Required

• Type: str

---

get_boolean_attribute

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

terraform_attribute^Required

• Type: str

---

get_boolean_map_attribute

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

terraform_attribute^Required

• Type: str

---

get_list_attribute

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

terraform_attribute^Required

• Type: str

---

get_number_attribute

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

terraform_attribute^Required

• Type: str

---

get_number_list_attribute

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_number_map_attribute

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_string_attribute

def get_string_attribute(
  terraform_attribute: str
) -> str

terraform_attribute^Required

• Type: str

---

get_string_map_attribute

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

terraform_attribute^Required

• Type: str

---

interpolation_for_attribute

def interpolation_for_attribute(
  property: str
) -> IResolvable

property^Required

• Type: str

---

resolve

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_context^Required

• 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

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.
create	str	No description.
delete	str	No description.
internal_value	typing.Union[cdktf.IResolvable, SqlSourceRepresentationInstanceTimeouts]	No description.

---

creation_stack^Required

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.

---

fqn^Required

fqn: str

• Type: str

---

create_input^Optional

create_input: str

• Type: str

---

delete_input^Optional

delete_input: str

• Type: str

---

create^Required

create: str

• Type: str

---

delete^Required

delete: str

• Type: str

---

internal_value^Optional

internal_value: typing.Union[IResolvable, SqlSourceRepresentationInstanceTimeouts]

• Type: typing.Union[cdktf.IResolvable, SqlSourceRepresentationInstanceTimeouts]

---