imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-16 12:22:03 +00:00
Code Activity

gcloud: Thu Jan 19 00:56:33 UTC 2023

Browse source
This commit is contained in:
Automated 2023-01-19 00:56:33 +00:00
parent 348d9760ee
commit 1248f773ec
1462 changed files with 51835 additions and 5402 deletions
Download patch file Download diff file Expand all files Collapse all files

183
gcloud/alloydb/clusters/create Normal file
View file

@ -0,0 +1,183 @@
NAME
gcloud alloydb clusters create - create a new AlloyDB cluster within a
given project
SYNOPSIS
gcloud alloydb clusters create CLUSTER --password=PASSWORD --region=REGION
[--async] [--network=NETWORK]
[--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]]
[--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING
--kms-location=KMS_LOCATION --kms-project=KMS_PROJECT]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Create a new AlloyDB cluster within a given project.
EXAMPLES
To create a new cluster, run:
$ gcloud alloydb clusters create my-cluster --region=us-central1 \
--password=postgres
POSITIONAL ARGUMENTS
CLUSTER
AlloyDB cluster ID
REQUIRED FLAGS
--password=PASSWORD
Initial postgres user password to set up during cluster creation.
--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
--async
Return immediately, without waiting for the operation in progress to
complete.
--network=NETWORK
Network in the current project that the instance will be part of. To
specify using a network with a shared VPC, use the full URL of the
network. For an example host project, 'testproject', and shared
network, 'testsharednetwork', this would be of the
form:--network=projects/testproject/global/networks/testsharednetwork
Automated backup policy. If unspecified, automated backups are enabled.
At most one of these can be specified:
--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.
This flag argument must be specified if any of the other arguments
in this group are specified.
--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)
This flag argument must be specified if any of the other arguments
in this group are specified.
--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.
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 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 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.
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 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 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
These variants are also available:
$ gcloud alpha alloydb clusters create
$ gcloud beta alloydb clusters create

54
gcloud/alloydb/clusters/delete Normal file
View file

@ -0,0 +1,54 @@
NAME
gcloud alloydb clusters delete - delete an AlloyDB cluster in a given
region
SYNOPSIS
gcloud alloydb clusters delete CLUSTER --region=REGION [--async] [--force]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Delete an AlloyDB cluster in a given region.
EXAMPLES
To delete a cluster, run:
$ gcloud alloydb clusters delete my-cluster --region=us-central1
POSITIONAL ARGUMENTS
CLUSTER
AlloyDB cluster ID
REQUIRED FLAGS
--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
--async
Return immediately, without waiting for the operation in progress to
complete.
--force
Default value is false.
If flag is specified, deletes instances (if any) within this cluster,
before deleting the cluster.
If flag is not specified, cluster delete will fail if there are
instances present in the cluster.
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
These variants are also available:
$ gcloud alpha alloydb clusters delete
$ gcloud beta alloydb clusters delete

40
gcloud/alloydb/clusters/describe Normal file
View file

@ -0,0 +1,40 @@
NAME
gcloud alloydb clusters describe - describe an AlloyDB cluster in a given
project and region
SYNOPSIS
gcloud alloydb clusters describe CLUSTER --region=REGION
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Describe an AlloyDB cluster in a given project and region.
EXAMPLES
To describe a cluster, run:
$ gcloud alloydb clusters describe my-cluster --region=us-central1
POSITIONAL ARGUMENTS
CLUSTER
AlloyDB cluster ID
REQUIRED FLAGS
--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.
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
These variants are also available:
$ gcloud alpha alloydb clusters describe
$ gcloud beta alloydb clusters describe

43
gcloud/alloydb/clusters/help Normal file
View file

@ -0,0 +1,43 @@
NAME
gcloud alloydb clusters - provide commands for managing AlloyDB clusters
SYNOPSIS
gcloud alloydb clusters COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Provide commands for managing AlloyDB clusters including creating,
configuring, restarting, and deleting clusters.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
Create a new AlloyDB cluster within a given project.
delete
Delete an AlloyDB cluster in a given region.
describe
Describe an AlloyDB cluster in a given project and region.
list
List AlloyDB clusters in a given project and region.
restore
Restore an AlloyDB cluster from a given backup.
update
Update an AlloyDB cluster within a given project and region.
NOTES
These variants are also available:
$ gcloud alpha alloydb clusters
$ gcloud beta alloydb clusters

71
gcloud/alloydb/clusters/list Normal file
View file

@ -0,0 +1,71 @@
NAME
gcloud alloydb clusters list - list AlloyDB clusters in a given project and
region
SYNOPSIS
gcloud alloydb clusters list [--region=REGION; default="-"]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List AlloyDB clusters in a given project in alphabetical order based on the
cluster name.
EXAMPLES
To list clusters, run:
$ gcloud alloydb clusters list --region=us-central1
FLAGS
--region=REGION; default="-"
Regional location (e.g. asia-east1, us-east1). See the full list of
regions at https://cloud.google.com/sql/docs/instance-locations.
Default: list clusters in all regions.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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
These variants are also available:
$ gcloud alpha alloydb clusters list
$ gcloud beta alloydb clusters list

92
gcloud/alloydb/clusters/restore Normal file
View file

@ -0,0 +1,92 @@
NAME
gcloud alloydb clusters restore - restore an AlloyDB cluster from a given
backup
SYNOPSIS
gcloud alloydb clusters restore CLUSTER --backup=BACKUP --region=REGION
[--async] [--network=NETWORK]
[--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING
--kms-location=KMS_LOCATION --kms-project=KMS_PROJECT]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Restore an AlloyDB cluster from a given backup.
EXAMPLES
To restore a cluster from a backup, run:
$ gcloud alloydb clusters restore my-cluster --region=us-central1 \
--backup=my-backup
POSITIONAL ARGUMENTS
CLUSTER
AlloyDB cluster ID
REQUIRED FLAGS
--backup=BACKUP
AlloyDB backup 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
--async
Return immediately, without waiting for the operation in progress to
complete.
--network=NETWORK
Network in the current project that the instance will be part of. To
specify using a network with a shared VPC, use the full URL of the
network. For an example host project, 'testproject', and shared
network, 'testsharednetwork', this would be of the
form:--network=projects/testproject/global/networks/testsharednetwork
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 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 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
These variants are also available:
$ gcloud alpha alloydb clusters restore
$ gcloud beta alloydb clusters restore

143
gcloud/alloydb/clusters/update Normal file
View file

@ -0,0 +1,143 @@
NAME
gcloud alloydb clusters update - update an AlloyDB cluster within a given
project and region
SYNOPSIS
gcloud alloydb clusters update CLUSTER --region=REGION [--async]
[--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]]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Update an AlloyDB cluster within a given project and region.
EXAMPLES
To update a cluster, run:
$ gcloud alloydb clusters update my-cluster --region=us-central1 \
--automated-backup-start-times=12:00 \
--automated-backup-days-of-week=MONDAY \
--automated-backup-retention-count=10
POSITIONAL ARGUMENTS
CLUSTER
AlloyDB cluster ID
REQUIRED FLAGS
--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
--async
Return immediately, without waiting for the operation in progress to
complete.
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.
This flag argument must be specified if any of the other arguments
in this group are specified.
--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)
This flag argument must be specified if any of the other arguments
in this group are specified.
--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.
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 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 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.
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
These variants are also available:
$ gcloud alpha alloydb clusters update
$ gcloud beta alloydb clusters update