gcloud alpha alloydb instances create

NAME
gcloud alpha alloydb instances create - creates a new AlloyDB instance within a given cluster
SYNOPSIS
gcloud alpha alloydb instances create INSTANCE --cluster=CLUSTER --cpu-count=CPU_COUNT --instance-type=INSTANCE_TYPE --region=REGION [--allowed-psc-projects=[ALLOWED_PSC_PROJECTS,…]] [--assign-inbound-public-ip=ASSIGN_INBOUND_PUBLIC_IP] [--async] [--authorized-external-networks=[AUTHORIZED_NETWORK,…]] [--availability-type=AVAILABILITY_TYPE] [--database-flags=FLAG=VALUE,[FLAG=VALUE,…]] [--insights-config-query-plans-per-minute=INSIGHTS_CONFIG_QUERY_PLANS_PER_MINUTE] [--insights-config-query-string-length=INSIGHTS_CONFIG_QUERY_STRING_LENGTH] [--[no-]insights-config-record-application-tags] [--[no-]insights-config-record-client-address] [--[no-]observability-config-enabled] [--observability-config-max-query-string-length=OBSERVABILITY_CONFIG_MAX_QUERY_STRING_LENGTH] [--[no-]observability-config-preserve-comments] [--observability-config-query-plans-per-minute=OBSERVABILITY_CONFIG_QUERY_PLANS_PER_MINUTE] [--[no-]observability-config-record-application-tags] [--[no-]observability-config-track-active-queries] [--observability-config-track-wait-events] [--[no-]outbound-public-ip] [--psc-network-attachment-url=PSC_NETWORK_ATTACHMENT_URL] [--read-pool-node-count=READ_POOL_NODE_COUNT] [--[no-]require-connectors] [--ssl-mode=SSL_MODE; default="ENCRYPTED_ONLY"] [GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA) Creates a new AlloyDB instance within a given cluster.
EXAMPLES
To create a new primary instance, run:
gcloud alpha alloydb instances create my-instance --cluster=my-cluster --region=us-central1 --instance-type=PRIMARY --cpu-count=4

To create a new read pool instance, run:

gcloud alpha alloydb instances create my-instance --cluster=my-cluster --region=us-central1 --instance-type=READ_POOL --read-pool-node-count=1 --cpu-count=4
POSITIONAL ARGUMENTS
INSTANCE
AlloyDB instance ID
REQUIRED FLAGS
--cluster=CLUSTER
AlloyDB cluster ID
--cpu-count=CPU_COUNT
Whole number value indicating how many vCPUs the machine should contain. Each vCPU count corresponds to a N2 high-mem machine: (https://cloud.google.com/compute/docs/general-purpose-machines#n2_machines). CPU_COUNT must be one of: 2, 4, 8, 16, 32, 64, 96, 128.
--instance-type=INSTANCE_TYPE
Specifies instance type. INSTANCE_TYPE must be one of:
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).
--region=REGION
Regional location (e.g. asia-east1, us-east1). See the full list of regions at https://cloud.google.com/sql/docs/instance-locations.
OPTIONAL FLAGS
--allowed-psc-projects=[ALLOWED_PSC_PROJECTS,…]
Comma-separated list of allowed consumer projects to create endpoints for Private Service Connect (PSC) connectivity for the instance. Only instances in PSC-enabled clusters are allowed to set this field.(e.g., --allowed-psc-projects=project1,12345678,project2)
--assign-inbound-public-ip=ASSIGN_INBOUND_PUBLIC_IP
Specify to enable or disable public IP on an instance. ASSIGN_INBOUND_PUBLIC_IP must be one of:
  • NO_PUBLIC_IP
    • This disables public IP on the instance. Updating an instance to disable public IP will clear the list of authorized networks.
  • ASSIGN_IPV4
    • Assign an inbound public IPv4 address for the instance. Public IP is enabled.
--async
Return immediately, without waiting for the operation in progress to complete.
--authorized-external-networks=[AUTHORIZED_NETWORK,…]
Comma-separated list of authorized external networks to set on the instance. Authorized networks should use CIDR notation (e.g. 1.2.3.4/30). This flag is only allowed to be set for instances with public IP enabled.
--availability-type=AVAILABILITY_TYPE
Specifies level of availability. AVAILABILITY_TYPE must be one of:
REGIONAL
Provide high availability instances. Recommended for production instances; instances automatically fail over to another zone within your selected region.
ZONAL
Provide zonal availability instances. Not recommended for production instances; instance does not automatically fail over to another zone.
--database-flags=FLAG=VALUE,[FLAG=VALUE,…]
Comma-separated list of database flags to set on the instance. Use an equals sign to separate flag name and value. Flags without values, like skip_grant_tables, can be written out without a value after, e.g., skip_grant_tables=. Use on/off for booleans. View the Instance Resource API for allowed flags. (e.g., --database-flags max_allowed_packet=55555,skip_grant_tables=,log_output=1)
--insights-config-query-plans-per-minute=INSIGHTS_CONFIG_QUERY_PLANS_PER_MINUTE
Number of query plans to sample every minute. Default value is 5. Allowed range: 0 to 20.
--insights-config-query-string-length=INSIGHTS_CONFIG_QUERY_STRING_LENGTH
Query string length in bytes to be stored by the query insights feature. Default length is 1024 bytes. Allowed range: 256 to 4500 bytes.
--[no-]insights-config-record-application-tags
Allow application tags to be recorded by the query insights feature.

Use --insights-config-record-application-tags to enable and --no-insights-config-record-application-tags to disable.

--[no-]insights-config-record-client-address
Allow the client address to be recorded by the query insights feature.

Use --insights-config-record-client-address to enable and --no-insights-config-record-client-address to disable.

--[no-]observability-config-enabled
Enable enhanced query insights feature. Use --observability-config-enabled to enable and --no-observability-config-enabled to disable.
--observability-config-max-query-string-length=OBSERVABILITY_CONFIG_MAX_QUERY_STRING_LENGTH
Query string length in bytes to be stored by the enhanced query insights feature. Default length is 10k bytes.
--[no-]observability-config-preserve-comments
Allow preservation of comments in query string recorded by the enhanced query insights feature.

Use --observability-config-preserve-comments to enable and --no-observability-config-preserve-comments to disable.

--observability-config-query-plans-per-minute=OBSERVABILITY_CONFIG_QUERY_PLANS_PER_MINUTE
Number of query plans to sample every minute. Default value is 200. Allowed range: 0 to 200.
--[no-]observability-config-record-application-tags
Allow application tags to be recorded by the enhanced query insights feature.

Use --observability-config-record-application-tags to enable and --no-observability-config-record-application-tags to disable.

--[no-]observability-config-track-active-queries
Track actively running queries. Use --observability-config-track-active-queries to enable and --no-observability-config-track-active-queries to disable.
--observability-config-track-wait-events
Track wait events during query execution.
--[no-]outbound-public-ip
Add outbound Public IP connectivity to an AlloyDB instance. Use --outbound-public-ip to enable and --no-outbound-public-ip to disable.
--psc-network-attachment-url=PSC_NETWORK_ATTACHMENT_URL
Full URL of the network attachment that is configured to support outbound connectivity from an AlloyDB instance which uses Private Service Connect (PSC). For example, this would be of the form:psc-network-attachment-url=projects/test-project/regions/us-central1/networkAttachments/my-na
--read-pool-node-count=READ_POOL_NODE_COUNT
Read capacity, i.e. number of nodes in a read pool instance.
--[no-]require-connectors
Enable or disable enforcing connectors only (ex: AuthProxy) connections to the database. Use --require-connectors to enable and --no-require-connectors to disable.
--ssl-mode=SSL_MODE; default="ENCRYPTED_ONLY"
Specify the SSL mode to use when the instance connects to the database. Default SSL mode is ENCRYPTED_ONLY. SSL_MODE must be one of:
ALLOW_UNENCRYPTED_AND_ENCRYPTED
SSL connections are optional. CA verification is not enforced.
ENCRYPTED_ONLY
SSL connections are required. CA verification is not enforced.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.

Run $ gcloud help for details.

NOTES
This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist. These variants are also available:
gcloud alloydb instances create
gcloud beta alloydb instances create