mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-11 07:29:40 +00:00
134 lines
4.6 KiB
Text
134 lines
4.6 KiB
Text
NAME
|
|
gcloud apihub api-hub-instances create - create an Api Hub Instance
|
|
|
|
SYNOPSIS
|
|
gcloud apihub api-hub-instances create
|
|
(API_HUB_INSTANCE : --location=LOCATION)
|
|
(--config-cmek-key-name=CONFIG_CMEK_KEY_NAME --config-disable-search
|
|
--config-encryption-type=CONFIG_ENCRYPTION_TYPE
|
|
--config-vertex-location=CONFIG_VERTEX_LOCATION) [--async]
|
|
[--description=DESCRIPTION] [--labels=[LABELS,...]]
|
|
[GCLOUD_WIDE_FLAG ...]
|
|
|
|
DESCRIPTION
|
|
Create an api hub instance
|
|
|
|
EXAMPLES
|
|
To create an API Hub instance, run:
|
|
|
|
$ gcloud apihub api-hub-instances create --project=my-project \
|
|
--location=us-central1
|
|
|
|
POSITIONAL ARGUMENTS
|
|
ApiHubInstance resource - Identifier. Format:
|
|
projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}.
|
|
The arguments in this group can be used to specify the attributes of this
|
|
resource. (NOTE) Some attributes are not given arguments in this group but
|
|
can be set in other ways.
|
|
|
|
To set the project attribute:
|
|
◆ provide the argument api_hub_instance on the command line with a
|
|
fully specified name;
|
|
◆ provide the argument --project on the command line;
|
|
◆ set the property core/project.
|
|
|
|
This must be specified.
|
|
|
|
API_HUB_INSTANCE
|
|
ID of the apiHubInstance or fully qualified identifier for the
|
|
apiHubInstance.
|
|
|
|
To set the api_hub_instance attribute:
|
|
▸ provide the argument api_hub_instance on the command line.
|
|
|
|
This positional argument must be specified if any of the other
|
|
arguments in this group are specified.
|
|
|
|
--location=LOCATION
|
|
The location id of the apiHubInstance resource.
|
|
|
|
To set the location attribute:
|
|
▸ provide the argument api_hub_instance on the command line with a
|
|
fully specified name;
|
|
▸ provide the argument --location on the command line.
|
|
|
|
REQUIRED FLAGS
|
|
Available configurations to provision an ApiHub Instance.
|
|
|
|
At least one of these must be specified:
|
|
|
|
--config-cmek-key-name=CONFIG_CMEK_KEY_NAME
|
|
The Customer Managed Encryption Key (CMEK) used for data encryption.
|
|
The CMEK name should follow the format of
|
|
projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+),
|
|
where the location must match the instance location. If the CMEK is
|
|
not provided, a GMEK will be created for the instance.
|
|
|
|
--config-disable-search
|
|
If true, the search will be disabled for the instance. The default
|
|
value is false.
|
|
|
|
--config-encryption-type=CONFIG_ENCRYPTION_TYPE
|
|
Encryption type for the region. If the encryption type is CMEK, the
|
|
cmek_key_name must be provided. If no encryption type is provided,
|
|
GMEK will be used. CONFIG_ENCRYPTION_TYPE must be one of:
|
|
|
|
cmek
|
|
Encryption using customer managed encryption key.
|
|
gmek
|
|
Default encryption using Google managed encryption key.
|
|
|
|
--config-vertex-location=CONFIG_VERTEX_LOCATION
|
|
The name of the Vertex AI location where the data store is stored.
|
|
|
|
OPTIONAL FLAGS
|
|
--async
|
|
Return immediately, without waiting for the operation in progress to
|
|
complete.
|
|
|
|
--description=DESCRIPTION
|
|
Description of the ApiHub instance.
|
|
|
|
--labels=[LABELS,...]
|
|
Instance labels to represent user-provided metadata. Refer to cloud
|
|
documentation on labels for more details.
|
|
https://cloud.google.com/compute/docs/labeling-resources.
|
|
|
|
KEY
|
|
Keys must start with a lowercase character and contain only hyphens
|
|
(-), underscores (_), lowercase characters, and numbers.
|
|
|
|
VALUE
|
|
Values must contain only hyphens (-), underscores (_), lowercase
|
|
characters, and numbers.
|
|
|
|
Shorthand Example:
|
|
|
|
--labels=string=string
|
|
|
|
JSON Example:
|
|
|
|
--labels='{"string": "string"}'
|
|
|
|
File Example:
|
|
|
|
--labels=path_to_file.(yaml|json)
|
|
|
|
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.
|
|
|
|
API REFERENCE
|
|
This command uses the apihub/v1 API. The full documentation for this API
|
|
can be found at:
|
|
https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub
|
|
|
|
NOTES
|
|
This variant is also available:
|
|
|
|
$ gcloud alpha apihub api-hub-instances create
|
|
|