gcloud alpha alloydb clusters update

gcloud alpha alloydb clusters update - update an AlloyDB cluster within a given project and region

gcloud alpha alloydb clusters update CLUSTER --region=REGION [--async] [--subscription-type=SUBSCRIPTION_TYPE] [--clear-automated-backup     | --disable-automated-backup     | --automated-backup-days-of-week=[DAYS_OF_WEEK,…] --automated-backup-start-times=[START_TIMES,…] --automated-backup-window=TIMEOUT_PERIOD [--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 --clear-continuous-backup-encryption-key     | [--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]] [--maintenance-window-any     | --maintenance-window-day=MAINTENANCE_WINDOW_DAY --maintenance-window-hour=MAINTENANCE_WINDOW_HOUR] [GCLOUD_WIDE_FLAG …]

CLUSTER

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

--async

Return immediately, without waiting for the operation in progress to complete.

--subscription-type=SUBSCRIPTION_TYPE

Subscription type of the cluster. SUBSCRIPTION_TYPE must be one of: STANDARD, TRIAL.

Automated backup policy.

At most one of these can be specified:

--clear-automated-backup

Clears the automated backup policy on the cluster. The default automated backup policy will be used.

--disable-automated-backup

Disables automated backups on the cluster.

Enable automated backup policy.

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

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.

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.

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

Encryption configuration for Continuous Backups.

At most one of these can be specified:

--clear-continuous-backup-encryption-key

Clears the encryption configuration for Continuous Backups. Google default encryption will be used for future Continuous Backups.

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.

Configure a preferred maintenance window.

At most one of these can be specified:

--maintenance-window-any

Remove the user-specified maintenance window.

Specify preferred day and time for maintenance.

--maintenance-window-day=MAINTENANCE_WINDOW_DAY

Day of week for maintenance window, in UTC time zone. MAINTENANCE_WINDOW_DAY must be one of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

This flag argument must be specified if any of the other arguments in this group are specified.

--maintenance-window-hour=MAINTENANCE_WINDOW_HOUR

Hour of day for maintenance window, in UTC time zone.

This flag argument must be specified if any of the other arguments in this group are specified.

Run $ gcloud help for details.