BigtableCreateInstanceOperator

Google

Creates a new Cloud Bigtable instance. If the Cloud Bigtable instance with the given ID exists, the operator does not compare its configuration and immediately succeeds. No changes are made to the existing instance.

View Source

Last Updated: May. 7, 2021

Access Instructions

Install the Google provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.

Parameters

instance_idstrThe ID of the Cloud Bigtable instance to create.
main_cluster_idstrThe ID for main cluster for the new instance.
main_cluster_zonestrThe zone for main cluster See https://cloud.google.com/bigtable/docs/locations for more details.
project_idstrOptional, the ID of the Google Cloud project. If set to None or missing, the default project_id from the Google Cloud connection is used.
replica_clustersList[Dict[str, str]](optional) A list of replica clusters for the new instance. Each cluster dictionary contains an id and a zone. Example: [{"id": "replica-1", "zone": "us-west1-a"}]
replica_cluster_idstr(deprecated) The ID for replica cluster for the new instance.
replica_cluster_zonestr(deprecated) The zone for replica cluster.
instance_typeenum.IntEnum(optional) The type of the instance.
instance_display_namestr(optional) Human-readable name of the instance. Defaults to instance_id.
instance_labelsdict(optional) Dictionary of labels to associate with the instance.
cluster_nodesint(optional) Number of nodes for cluster.
cluster_storage_typeenum.IntEnum(optional) The type of storage.
timeoutint(optional) timeout (in seconds) for instance creation. If None is not specified, Operator will wait indefinitely.
gcp_conn_idstrThe connection ID to use to connect to Google Cloud.
impersonation_chainUnion[str, Sequence[str]]Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

Documentation

Creates a new Cloud Bigtable instance. If the Cloud Bigtable instance with the given ID exists, the operator does not compare its configuration and immediately succeeds. No changes are made to the existing instance.

For more details about instance creation have a look at the reference: https://googleapis.github.io/google-cloud-python/latest/bigtable/instance.html#google.cloud.bigtable.instance.Instance.create

See also

For more information on how to use this operator, take a look at the guide: BigtableCreateInstanceOperator

Was this page helpful?