google.cloud.gcp_alloydb_instance module – Creates a GCP Alloydb.Instance resource

access_token

string

The access token used to authenticate.

activation_policy

string

‘Specifies whether an instance needs to spin up.

Once the instance is active, the activation policy can be updated to the `NEVER` to stop the instance.

Likewise, the activation policy can be updated to `ALWAYS` to start the instance.

There are restrictions around when an instance can/cannot be activated (for example, a read pool instance should be stopped before stopping primary etc.).

Please refer to the API documentation for more details.

Possible values are: `ACTIVATION_POLICY_UNSPECIFIED`, `ALWAYS`, `NEVER`.’.

Choices:

• "ACTIVATION_POLICY_UNSPECIFIED"
• "ALWAYS"
• "NEVER"

annotations

dictionary

Annotations to allow client tools to store small amount of arbitrary data.

This is distinct from labels.

auth_kind

string / required

The type of credential used.

Choices:

• "accesstoken"
• "application"
• "machineaccount"
• "serviceaccount"

availability_type

string

‘Availability type of an Instance.

Defaults to REGIONAL for both primary and read instances.

Note that primary and read instances can have different availability types.

Primary instances can be either ZONAL or REGIONAL.

Read Pool instances can also be either ZONAL or REGIONAL.

Read pools of size 1 can only have zonal availability.

Read pools with a node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region).

Possible values are: `AVAILABILITY_TYPE_UNSPECIFIED`, `ZONAL`, `REGIONAL`.’.

Choices:

• "AVAILABILITY_TYPE_UNSPECIFIED"
• "ZONAL"
• "REGIONAL"

client_connection_config

dictionary

Client connection specific configurations.

require_connectors

boolean

Configuration to enforce connectors only (ex: AuthProxy) connections to the database.

Choices:

• false
• true

ssl_config

dictionary

SSL config option for this instance.

ssl_mode

string

SSL mode.

Specifies client-server SSL/TLS connection behavior.

Choices:

• "ENCRYPTED_ONLY"
• "ALLOW_UNENCRYPTED_AND_ENCRYPTED"

cluster

dictionary / required

Identifies the alloydb cluster.

Must be in the format ‘projects/{project}/locations/{location}/clusters/{cluster_id}’.

This field is a reference to a Cluster resource in GCP.

It can be specified in two ways: First, you can place a dictionary with key ‘name’ matching your resource.

Alternatively, you can add `register: name-of-resource` to a Cluster task and then set this field to `{{ name-of-resource }}`.

database_flags

dictionary

Database flags.

Set at instance level.

* They are copied from primary instance on read instance creation.

* Read instances can set new or override existing flags that are relevant for reads, e.g.

for enabling columnar cache on a read instance.

Flags set on read instance may or may not be present on primary.

display_name

string

User-settable and human-readable display name for the Instance.

env_type

string

Specifies which Ansible environment you’re running this module within.

This should not be set unless you know what you’re doing.

This only alters the User Agent string for any API requests.

gce_zone

string

The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances.

If present for a REGIONAL instance, an error will be thrown.

If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.

instance_id

string / required

The ID of the alloydb instance.

instance_type

string / required

The type of the instance.

If the instance type is SECONDARY, point to the cluster_type of the associated secondary cluster instead of mentioning SECONDARY.

Choices:

• "PRIMARY"
• "READ_POOL"
• "SECONDARY"

labels

dictionary

User-defined labels for the alloydb instance.

machine_config

dictionary

Configurations for the machines that host the underlying database engine.

cpu_count

integer

The number of CPU’s in the VM instance.

machine_type

string

Machine type of the VM instance.

E.g.

“n2-highmem-4”, “n2-highmem-8”, “c4a-highmem-4-lssd”.

`cpu_count` must match the number of vCPUs in the machine type.

network_config

dictionary

Instance level network configuration.

authorized_external_networks

list / elements=dictionary

A list of external networks authorized to access this instance.

This field is only allowed to be set when `enable_public_ip` is set to true.

cidr_range

string

CIDR range for one authorized network of the instance.

enable_outbound_public_ip

boolean

Enabling outbound public ip for the instance.

Choices:

• false
• true

enable_public_ip

boolean

Enabling public ip for the instance.

If a user wishes to disable this, please also clear the list of the authorized external networks set on the same instance.

Choices:

• false
• true

observability_config

dictionary

Configuration for enhanced query insights.

assistive_experiences_enabled

boolean

Whether assistive experiences are enabled for this AlloyDB instance.

Choices:

• false
• true

enabled

boolean

Observability feature status for an instance.

Choices:

• false
• true

max_query_string_length

integer

Query string length.

The default value is 10240.

Any integer between 1024 and 100000 is considered valid.

preserve_comments

boolean

Preserve comments in the query string.

Choices:

• false
• true

query_plans_per_minute

integer

Number of query execution plans captured by Insights per minute for all queries combined.

The default value is 5.

Any integer between 0 and 200 is considered valid.

record_application_tags

boolean

Record application tags for an instance.

This flag is turned “on” by default.

Choices:

• false
• true

track_active_queries

boolean

Track actively running queries.

If not set, default value is “off”.

Choices:

• false
• true

track_wait_event_types

boolean

Record wait event types during query execution for an instance.

Choices:

• false
• true

track_wait_events

boolean

Record wait events during query execution for an instance.

Choices:

• false
• true

project

string

The Google Cloud Platform project to use.

psc_instance_config

dictionary

Configuration for Private Service Connect (PSC) for the instance.

allowed_consumer_projects

list / elements=string

List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance.

These should be specified as project numbers only.

psc_auto_connections

list / elements=dictionary

Configurations for setting up PSC service automation.

consumer_network

string

The consumer network for the PSC service automation, example: “projects/vpc-host-project/global/networks/default”.

The consumer network might be hosted a different project than the consumer project.

The API expects the consumer project specified to be the project ID (and not the project number).

consumer_network_status

string

The status of the service connection policy.

consumer_project

string

The consumer project to which the PSC service automation endpoint will be created.

The API expects the consumer project to be the project ID( and not the project number).

ip_address

string

The IP address of the PSC service automation endpoint.

status

string

The status of the PSC service automation connection.

psc_dns_name

string

The DNS name of the instance for PSC connectivity.

Name convention: <uid>.<uid>.<region>.alloydb-psc.goog.

psc_interface_configs

list / elements=dictionary

Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity.

Currently, AlloyDB supports only 0 or 1 PSC interface.

network_attachment_resource

string

The network attachment resource created in the consumer project to which the PSC interface will be linked.

This is of the format: “projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}”.

The network attachment must be in the same region as the instance.

service_attachment_link

string

The service attachment created when Private Service Connect (PSC) is enabled for the instance.

The name of the resource will be in the format of `projects/<alloydb-tenant-project-number>/regions/<region-name>/serviceAttachments/<service-attachment-name>`.

query_insights_config

dictionary

Configuration for query insights.

query_plans_per_minute

integer

Number of query execution plans captured by Insights per minute for all queries combined.

The default value is 5.

Any integer between 0 and 20 is considered valid.

query_string_length

integer

Query string length.

The default value is 1024.

Any integer between 256 and 4500 is considered valid.

record_application_tags

boolean

Record application tags for an instance.

This flag is turned “on” by default.

Choices:

• false
• true

record_client_address

boolean

Record client address for an instance.

Client address is PII information.

This flag is turned “on” by default.

Choices:

• false
• true

read_pool_config

dictionary

Read pool specific config.

If the instance type is READ_POOL, this configuration must be provided.

node_count

integer

Read capacity, i.e.

number of nodes in a read pool instance.

scopes

list / elements=string

Array of scopes to be used.

service_account_contents

jsonarg

The contents of a Service Account JSON file,

either in a dictionary or as a JSON string that represents it.

service_account_email

string

An optional service account email address if machineaccount is

selected and the user does not wish to use the default email.

service_account_file

path

The path of a Service Account JSON file if serviceaccount

is selected as type.

state

string

Whether the resource should exist in GCP.

Choices:

• "present" ← (default)
• "absent"

changed

boolean

Whether the resource was changed.

Returned: always

createTime

string

Time the Instance was created in UTC.

Returned: success

ipAddress

string

The IP address for the Instance.

This is the connection endpoint for an end-user application.

Returned: success

name

string

The name of the instance resource.

Returned: success

outboundPublicIpAddresses

list / elements=string

The outbound public IP addresses for the instance.

This is available ONLY when networkConfig.enableOutboundPublicIp is set to true.

These IP addresses are used for outbound connections.

Returned: success

publicIpAddress

string

The public IP addresses for the Instance.

This is available ONLY when networkConfig.enablePublicIp is set to true.

This is the connection endpoint for an end-user application.

Returned: success

reconciling

boolean

Set to true if the current state of Instance does not match the user’s intended state, and the service is actively updating the resource to reconcile them.

This can happen due to user-triggered updates or system actions like failover or maintenance.

Returned: success

state

string

The current state of the alloydb instance.

Returned: success

uid

string

The system-generated UID of the resource.

Returned: success

updateTime

string

Time the Instance was updated in UTC.

Returned: success