Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

gcp_alloydb_instance

ancestors

Type: UNORDERED_LIST_STRING

availability_type

Type: STRING
Provider name: availabilityType
Description: Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
Possible values:

  • AVAILABILITY_TYPE_UNSPECIFIED - This is an unknown Availability type.
  • ZONAL - Zonal available instance.
  • REGIONAL - Regional (or Highly) available instance.

client_connection_config

Type: STRUCT
Provider name: clientConnectionConfig
Description: Optional. Client connection specific configurations

  • require_connectors
    Type: BOOLEAN
    Provider name: requireConnectors
    Description: Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
  • ssl_config
    Type: STRUCT
    Provider name: sslConfig
    Description: Optional. SSL configuration option for this instance.
    • ca_source
      Type: STRING
      Provider name: caSource
      Description: Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
      Possible values:
      • CA_SOURCE_UNSPECIFIED - Certificate Authority (CA) source not specified. Defaults to CA_SOURCE_MANAGED.
      • CA_SOURCE_MANAGED - Certificate Authority (CA) managed by the AlloyDB Cluster.
    • ssl_mode
      Type: STRING
      Provider name: sslMode
      Description: Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
      Possible values:
      • SSL_MODE_UNSPECIFIED - SSL mode is not specified. Defaults to ENCRYPTED_ONLY.
      • SSL_MODE_ALLOW - SSL connections are optional. CA verification not enforced.
      • SSL_MODE_REQUIRE - SSL connections are required. CA verification not enforced. Clients may use locally self-signed certificates (default psql client behavior).
      • SSL_MODE_VERIFY_CA - SSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, for example, using GenerateClientCertificate.
      • ALLOW_UNENCRYPTED_AND_ENCRYPTED - SSL connections are optional. CA verification not enforced.
      • ENCRYPTED_ONLY - SSL connections are required. CA verification not enforced.

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. Create time stamp

delete_time

Type: TIMESTAMP
Provider name: deleteTime
Description: Output only. Delete time stamp

etag

Type: STRING
Provider name: etag
Description: For Resource freshness validation (https://google.aip.dev/154)

gce_zone

Type: STRING
Provider name: gceZone
Description: 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.

gcp_display_name

Type: STRING
Provider name: displayName
Description: User-settable and human-readable display name for the Instance.

instance_type

Type: STRING
Provider name: instanceType
Description: Required. The type of the instance. Specified at creation time.
Possible values:

  • INSTANCE_TYPE_UNSPECIFIED - The type of the instance is unknown.
  • PRIMARY - PRIMARY instances support read and write operations.
  • READ_POOL - READ POOL instances support read operations only. Each read pool instance consists of one or more homogeneous nodes. * Read pool of size 1 can only have zonal availability. * Read pools with node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region).
  • SECONDARY - SECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica

ip_address

Type: STRING
Provider name: ipAddress
Description: Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.

labels

Type: UNORDERED_LIST_STRING

machine_config

Type: STRUCT
Provider name: machineConfig
Description: Configurations for the machines that host the underlying database engine.

  • cpu_count
    Type: INT32
    Provider name: cpuCount
    Description: The number of CPU’s in the VM instance.

name

Type: STRING
Provider name: name
Description: Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}

network_config

Type: STRUCT
Provider name: networkConfig
Description: Optional. Instance-level network configuration.

  • authorized_external_networks
    Type: UNORDERED_LIST_STRUCT
    Provider name: authorizedExternalNetworks
    Description: Optional. A list of external network authorized to access this instance.
    • cidr_range
      Type: STRING
      Provider name: cidrRange
      Description: CIDR range for one authorzied network of the instance.
  • enable_outbound_public_ip
    Type: BOOLEAN
    Provider name: enableOutboundPublicIp
    Description: Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.
  • enable_public_ip
    Type: BOOLEAN
    Provider name: enablePublicIp
    Description: Optional. Enabling public ip for the instance.

nodes

Type: UNORDERED_LIST_STRUCT
Provider name: nodes
Description: Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.

  • id
    Type: STRING
    Provider name: id
    Description: The identifier of the VM e.g. “test-read-0601-407e52be-ms3l”.
  • ip
    Type: STRING
    Provider name: ip
    Description: The private IP address of the VM e.g. “10.57.0.34”.
  • state
    Type: STRING
    Provider name: state
    Description: Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
  • zone_id
    Type: STRING
    Provider name: zoneId
    Description: The Compute Engine zone of the VM e.g. “us-central1-b”.

organization_id

Type: STRING

outbound_public_ip_addresses

Type: UNORDERED_LIST_STRING
Provider name: outboundPublicIpAddresses
Description: Output only. All outbound public IP addresses configured for the instance.

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

psc_instance_config

Type: STRUCT
Provider name: pscInstanceConfig
Description: Optional. The configuration for Private Service Connect (PSC) for the instance.

  • allowed_consumer_projects
    Type: UNORDERED_LIST_STRING
    Provider name: allowedConsumerProjects
    Description: Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance.
  • psc_dns_name
    Type: STRING
    Provider name: pscDnsName
    Description: Output only. The DNS name of the instance for PSC connectivity. Name convention: …alloydb-psc.goog
  • service_attachment_link
    Type: STRING
    Provider name: serviceAttachmentLink
    Description: Output only. 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//regions//serviceAttachments/

public_ip_address

Type: STRING
Provider name: publicIpAddress
Description: Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.

query_insights_config

Type: STRUCT
Provider name: queryInsightsConfig
Description: Configuration for query insights.

  • query_plans_per_minute
    Type: INT32
    Provider name: queryPlansPerMinute
    Description: 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
    Type: INT32
    Provider name: queryStringLength
    Description: Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
  • record_application_tags
    Type: BOOLEAN
    Provider name: recordApplicationTags
    Description: Record application tags for an instance. This flag is turned “on” by default.
  • record_client_address
    Type: BOOLEAN
    Provider name: recordClientAddress
    Description: Record client address for an instance. Client address is PII information. This flag is turned “on” by default.

read_pool_config

Type: STRUCT
Provider name: readPoolConfig
Description: Read pool instance configuration. This is required if the value of instanceType is READ_POOL.

  • node_count
    Type: INT32
    Provider name: nodeCount
    Description: Read capacity, i.e. number of nodes in a read pool instance.

reconciling

Type: BOOLEAN
Provider name: reconciling
Description: Output only. Reconciling (https://google.aip.dev/128#reconciliation). 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.

resource_name

Type: STRING

satisfies_pzs

Type: BOOLEAN
Provider name: satisfiesPzs
Description: Output only. Reserved for future use.

state

Type: STRING
Provider name: state
Description: Output only. The current serving state of the instance.
Possible values:

  • STATE_UNSPECIFIED - The state of the instance is unknown.
  • READY - The instance is active and running.
  • STOPPED - The instance is stopped. Instance name and IP resources are preserved.
  • CREATING - The instance is being created.
  • DELETING - The instance is being deleted.
  • MAINTENANCE - The instance is down for maintenance.
  • FAILED - The creation of the instance failed or a fatal error occurred during an operation on the instance. Note: Instances in this state would tried to be auto-repaired. And Customers should be able to restart, update or delete these instances.
  • BOOTSTRAPPING - Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that index unused in case that state also needs to exposed via consumer apis in future. The instance has been configured to sync data from some other source.
  • PROMOTING - The instance is being promoted.

tags

Type: UNORDERED_LIST_STRING

uid

Type: STRING
Provider name: uid
Description: Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. Update time stamp

writable_node

Type: STRUCT
Provider name: writableNode
Description: Output only. This is set for the read-write VM of the PRIMARY instance only.

  • id
    Type: STRING
    Provider name: id
    Description: The identifier of the VM e.g. “test-read-0601-407e52be-ms3l”.
  • ip
    Type: STRING
    Provider name: ip
    Description: The private IP address of the VM e.g. “10.57.0.34”.
  • state
    Type: STRING
    Provider name: state
    Description: Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
  • zone_id
    Type: STRING
    Provider name: zoneId
    Description: The Compute Engine zone of the VM e.g. “us-central1-b”.