1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-13 16:37:00 +00:00
gcloud-help/gcloud/beta/alloydb/clusters/create-secondary
2026-03-26 12:11:21 +00:00

261 lines
11 KiB
Text

NAME
gcloud beta alloydb clusters create-secondary - create a new AlloyDB
SECONDARY cluster within a given project
SYNOPSIS
gcloud beta alloydb clusters create-secondary CLUSTER
--primary-cluster=PRIMARY_CLUSTER --region=REGION
[--allocated-ip-range-name=ALLOCATED_IP_RANGE_NAME] [--async]
[--[no-]enable-dataplex-integration] [--tags=[KEY=VALUE,...]]
[--automated-backup-days-of-week=[DAYS_OF_WEEK,...]
--automated-backup-start-times=[START_TIMES,...]
--automated-backup-window=TIMEOUT_PERIOD --enable-automated-backup
[--automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY
: --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT] --automated-backup-retention-count=RETENTION_COUNT | --automated-backup-retention-period=RETENTION_PERIOD]
[--continuous-backup-recovery-window-days=RECOVERY_PERIOD
--enable-continuous-backup
[--continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY
: --continuous-backup-encryption-key-keyring=CONTINUOUS_BACKUP_ENCRYPTION_KEY_KEYRING --continuous-backup-encryption-key-location=CONTINUOUS_BACKUP_ENCRYPTION_KEY_LOCATION --continuous-backup-encryption-key-project=CONTINUOUS_BACKUP_ENCRYPTION_KEY_PROJECT]]
[--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING
--kms-location=KMS_LOCATION --kms-project=KMS_PROJECT]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Create a new AlloyDB SECONDARY cluster within a given project.
EXAMPLES
To create a new cluster, run:
$ gcloud beta alloydb clusters create-secondary my-cluster \
--region=us-central1 \
--primary-cluster=projects/12345/locations/us-central1/\
clusters/cluster1
POSITIONAL ARGUMENTS
CLUSTER
AlloyDB cluster ID
REQUIRED FLAGS
--primary-cluster=PRIMARY_CLUSTER
AlloyDB primary cluster ID
--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
--allocated-ip-range-name=ALLOCATED_IP_RANGE_NAME
Name of the allocated IP range for the private IP AlloyDB cluster, for
example: "google-managed-services-default". If set, the instance IPs
for this cluster will be created in the allocated range. The range name
must comply with RFC 1035. Specifically, the name must be 1-63
characters long and match the regular expression
[a-z]([-a-z0-9]*[a-z0-9])?.
--async
Return immediately, without waiting for the operation in progress to
complete.
--[no-]enable-dataplex-integration
Enable or disable Dataplex integration for this cluster (Enabled by
default). Use --enable-dataplex-integration to enable and
--no-enable-dataplex-integration to disable.
--tags=[KEY=VALUE,...]
List of tags KEY=VALUE pairs to bind. Each item must be expressed as
<tag-key-namespaced-name>=<tag-value-short-name>.
Example: 123/environment=production,123/costCenter=marketing
Automated backup policy. If unspecified, automated backups are copied from
the associated primary cluster.
--automated-backup-days-of-week=[DAYS_OF_WEEK,...]
Comma-separated list of days of the week to perform a backup. At least
one day of the week must be provided. (e.g.,
--automated-backup-days-of-week=MONDAY,WEDNESDAY,SUNDAY). DAYS_OF_WEEK
must be one of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY,
SUNDAY.
--automated-backup-start-times=[START_TIMES,...]
Comma-separated list of times during the day to start a backup. At
least one start time must be provided. The start times are assumed to
be in UTC and required to be an exact hour in the format HH:00. (e.g.,
--automated-backup-start-times=01:00,13:00)
--automated-backup-window=TIMEOUT_PERIOD
The length of the time window beginning at start time during which a
backup can be taken. If a backup does not succeed within this time
window, it will be canceled and considered failed. The backup window
must be at least 5 minutes long. There is no upper bound on the window.
If not set, it will default to 1 hour.
--enable-automated-backup
Enables Automated Backups on the cluster.
Key resource - The Cloud KMS (Key Management Service) cryptokey that will
be used to protect the automated backups. The 'AlloyDB Service Agent'
service account must hold permission 'Cloud KMS CryptoKey
Encrypter/Decrypter'. The arguments in this group can be used to specify
the attributes of this resource.
--automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY
ID of the key or fully qualified identifier for the key.
To set the kms-key attribute:
◆ provide the argument --automated-backup-encryption-key on the
command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING
The KMS keyring of the key.
To set the kms-keyring attribute:
◆ provide the argument --automated-backup-encryption-key on the
command line with a fully specified name;
◆ provide the argument --automated-backup-encryption-key-keyring on
the command line.
--automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION
The Google Cloud location for the key.
To set the kms-location attribute:
◆ provide the argument --automated-backup-encryption-key on the
command line with a fully specified name;
◆ provide the argument --automated-backup-encryption-key-location on
the command line.
--automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT
The Google Cloud project for the key.
To set the kms-project attribute:
◆ provide the argument --automated-backup-encryption-key on the
command line with a fully specified name;
◆ provide the argument --automated-backup-encryption-key-project on
the command line;
◆ set the property core/project.
Retention policy. If no retention policy is provided, all automated
backups will be retained.
At most one of these can be specified:
--automated-backup-retention-count=RETENTION_COUNT
Number of most recent successful backups retained.
--automated-backup-retention-period=RETENTION_PERIOD
Retention period of the backup relative to creation time. See $
gcloud topic datetimes for information on duration formats.
Continuous Backup configuration. If unspecified, continuous backups are
copied from the associated primary cluster.
--continuous-backup-recovery-window-days=RECOVERY_PERIOD
Recovery window of the log files and backups saved to support
Continuous Backups.
--enable-continuous-backup
Enables Continuous Backups on the cluster.
Key resource - The Cloud KMS (Key Management Service) cryptokey that will
be used to protect the continuous backup. The 'AlloyDB Service Agent's
service account must hold permission 'Cloud KMS CryptoKey
Encrypter/Decrypter'. The arguments in this group can be used to specify
the attributes of this resource.
--continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY
ID of the key or fully qualified identifier for the key.
To set the kms-key attribute:
◆ provide the argument --continuous-backup-encryption-key on the
command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--continuous-backup-encryption-key-keyring=CONTINUOUS_BACKUP_ENCRYPTION_KEY_KEYRING
The KMS keyring of the key.
To set the kms-keyring attribute:
◆ provide the argument --continuous-backup-encryption-key on the
command line with a fully specified name;
◆ provide the argument --continuous-backup-encryption-key-keyring on
the command line.
--continuous-backup-encryption-key-location=CONTINUOUS_BACKUP_ENCRYPTION_KEY_LOCATION
The Google Cloud location for the key.
To set the kms-location attribute:
◆ provide the argument --continuous-backup-encryption-key on the
command line with a fully specified name;
◆ provide the argument --continuous-backup-encryption-key-location on
the command line.
--continuous-backup-encryption-key-project=CONTINUOUS_BACKUP_ENCRYPTION_KEY_PROJECT
The Google Cloud project for the key.
To set the kms-project attribute:
◆ provide the argument --continuous-backup-encryption-key on the
command line with a fully specified name;
◆ provide the argument --continuous-backup-encryption-key-project on
the command line;
◆ set the property core/project.
Key resource - The Cloud KMS (Key Management Service) cryptokey that will
be used to protect the cluster. The 'AlloyDB Service Agent' service
account must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'.
The arguments in this group can be used to specify the attributes of this
resource.
--kms-key=KMS_KEY
ID of the key or fully qualified identifier for the key.
To set the kms-key attribute:
◆ provide the argument --kms-key on the command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--kms-keyring=KMS_KEYRING
The KMS keyring of the key.
To set the kms-keyring attribute:
◆ provide the argument --kms-key on the command line with a fully
specified name;
◆ provide the argument --kms-keyring on the command line.
--kms-location=KMS_LOCATION
The Google Cloud location for the key.
To set the kms-location attribute:
◆ provide the argument --kms-key on the command line with a fully
specified name;
◆ provide the argument --kms-location on the command line.
--kms-project=KMS_PROJECT
The Google Cloud project for the key.
To set the kms-project attribute:
◆ provide the argument --kms-key on the command line with a fully
specified name;
◆ provide the argument --kms-project on the command line;
◆ set the property core/project.
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 beta and might change without notice. These
variants are also available:
$ gcloud alloydb clusters create-secondary
$ gcloud alpha alloydb clusters create-secondary