Orchestration Pipelines provisioned resource types reference

Preview

This product is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA products are available "as is" and might have limited support. For more information, see the launch stage descriptions.

This page describes resource types that can be provisioned in Orchestration Pipelines.

For more information about provisioning resources, see Provision resources.

Note: You can get the latest list of available resource types by running the orchestration-pipelines resource-types list command in Google Cloud CLI.

Resource types overview

Resource type	API reference	Description
artifactregistry.repository	v1	Artifact Registry repository configurations.
bigquery.dataset	v2	BigQuery Dataset configurations. Definition handling: datasetReference: automatically populated with project and dataset IDs.
bigquery.routine	v2	BigQuery Routine configurations.
bigquery.table	v2	BigQuery Table configurations. Definition handling: tableReference: automatically populated with project, dataset, and table IDs.
bigquerydatatransfer.transferConfig	v1	BigQuery Data Transfer Service configurations. Metadata: service_account_name: authorization service account Definition handling: displayName: used to find existing resource instead of exact ID match
cloudkms.keyRing	v1	Cloud Key Management Service KeyRing resources.
cloudkms.keyRing.cryptoKey	v1	Cloud Key Management Service CryptoKey resources. Parent resource type: cloudkms.keyRing.
composer.environment	v1	Managed Service for Apache Airflow environment configurations.
compute.address	v1	Compute Engine Address resources. Special handling: updates: in-place updates are supported only for labels
compute.firewall	v1	Compute Engine Firewall resources.
compute.forwardingRule	v1	Compute Engine Forwarding Rule resources. Special handling: portRange: automatically normalized during comparison (for example, 80 becomes 80-80)
compute.instance	v1	Compute Engine Instance resources. Special handling: zone: derived from metadata.location if omitted disks[].initializeParams: ignored during comparison
compute.instanceGroupManager	v1	Compute Engine Instance Group Manager resources. Special handling: zone: derived from metadata.location if omitted
compute.instanceTemplate	v1	Compute Engine Instance Template resources. Special handling: updates: in-place updates are not supported
compute.network	v1	Compute Engine Network resources.
compute.network.networkPeering	v1	Compute Engine Network Peering resources. Special handling: lifecycle: managed through parent Network peering methods (AddPeering, UpdatePeering) Parent resource type: compute.network.
compute.route	v1	Compute Engine Route resources. Special handling: updates: in-place updates are not supported
compute.router	v1	Compute Engine Router resources.
compute.subnetwork	v1	Compute Engine Target Instance resources. Special handling: updates: in-place updates are not supported
dataform.repository	v1beta1	Dataform Repository resources.
dataform.repository.releaseConfig	v1beta1	Dataform ReleaseConfig resources. Special handling: releaseCompilationResult: setting to auto in definition triggers compilation after resource creation or update Parent resource type: dataform.repository.
dataform.repository.workflowConfig	v1beta1	Compute Engine WorkflowConfig resources. Definition handling: releaseConfig: accepts short ID of config within the same repository instead of full URI Parent resource type: dataform.repository.
dataform.repository.workspace	v1beta1	Compute Engine Workspace resources. Parent resource type: dataform.repository.
dataproc.autoscalingPolicy	v1	Managed Service for Apache Spark Autoscaling Policies.
dataproc.cluster	v1	Managed Service for Apache Spark Cluster resources. Definition handling: config.autoDeleteTtl: ignored during comparison config.softwareConfig: ignored during comparison
dataproc.workflowTemplate	v1	Managed Service for Apache Spark Workflow Templates. Definition handling: id: automatically populated with the logical name of the resource.
iam.serviceAccount	v1	IAM Service Accounts. Special handling: resource ID: implicitly formatted as email address for API requests. For example, if resource ID is example-account, the project is example-project, then the resource's name is formatted as [e-mail].
iam.workloadIdentityPool	v1	IAM Workload Identity Pools.
iam.workloadIdentityPoolProvider	v1	IAM Workload Identity Pool Providers.
pubsub.schema	v1	Pub/Sub Schema resources. Special handling: updates: in-place updates aren't fully supported yet.
pubsub.subscription	v1	Pub/Sub Subscription resources.
pubsub.topic	v1	Pub/Sub Topic resources.
secretmanager.secret	v1	Secret Manager Secret resources.
sqladmin.instance	v1beta4	Cloud SQL Admin Instance resources.
sqladmin.instance.database	v1beta4	Cloud SQL Admin Database resources. Parent resource type: sqladmin.instance.
sqladmin.instance.user	v1beta4	Cloud SQL Admin User resources. Parent resource type: sqladmin.instance.
storage.bucket	v1beta4	Cloud Storage Bucket resources.
storage.bucket.notification	v1	Cloud Storage Notification resources. Special handling: updates: in-place updates are not supported by the API; resources must be recreated dynamic ID resolution: resource ID is resolved dynamically from matching topic in API list output Definition handling: topic: prefix //pubsub.[DOMAIN]/ is ignored during comparison against API state Parent resource type: storage.bucket.

Resource types

This section lists available resource types.

artifactregistry.repository

Artifact Registry repository configurations.

API documentation for the resource's definition:

• v1

bigquery.dataset

BigQuery Dataset configurations.

Definition handling:

• datasetReference: automatically populated with project and dataset IDs.

API documentation for the resource's definition:

• v2

bigquery.routine

BigQuery Routine configurations.

API documentation for the resource's definition:

• v2

bigquery.table

BigQuery Table configurations.

Definition handling:

• tableReference: automatically populated with project, dataset, and table IDs.

API documentation for the resource's definition:

• v2

bigquerydatatransfer.transferConfig

BigQuery Data Transfer Service configurations.

Metadata:

• service_account_name: authorization service account

Definition handling:

• displayName: used to find existing resource instead of exact ID match

API documentation for the resource's definition:

• v1

cloudkms.keyRing

Cloud Key Management Service KeyRing resources.

API documentation for the resource's definition:

• v1

cloudkms.keyRing.cryptoKey

Cloud Key Management Service CryptoKey resources.

Parent resource:

• cloudkms.keyRing.

API documentation for the resource's definition:

• v1

composer.environment

Managed Service for Apache Airflow environment configurations.

API documentation for the resource's definition:

• v1

compute.address

Compute Engine Address resources.

Special handling:

• updates: in-place updates are supported only for labels

API documentation for the resource's definition:

• v1

compute.firewall

Compute Engine Firewall resources.

API documentation for the resource's definition:

• v1

compute.forwardingRule

Compute Engine Forwarding Rule resources.

Special handling:

• portRange: automatically normalized during comparison (for example, 80 becomes 80-80)

API documentation for the resource's definition:

• v1

compute.instance

Compute Engine Instance resources.

Special handling:

• zone: derived from metadata.location if omitted
• disks[].initializeParams: ignored during comparison

API documentation for the resource's definition:

• v1

compute.instanceGroupManager

Compute Engine Instance Group Manager resources.

Special handling:

• zone: derived from metadata.location if omitted

API documentation for the resource's definition:

• v1

compute.instanceTemplate

Compute Engine Instance Template resources.

Special handling:

• updates: in-place updates are not supported

API documentation for the resource's definition:

• v1

compute.network

Compute Engine Network resources.

API documentation for the resource's definition:

• v1

compute.network.networkPeering

Compute Engine Network Peering resources.

Special handling:

• lifecycle: managed through parent Network peering methods (AddPeering, UpdatePeering)

Parent resource:

• compute.network.

API documentation for the resource's definition:

• v1

compute.route

Compute Engine Route resources.

Special handling:

• updates: in-place updates are not supported

API documentation for the resource's definition:

• v1

compute.router

Compute Engine Router resources.

API documentation for the resource's definition:

• v1

compute.subnetwork

Compute Engine Target Instance resources.

Special handling:

• updates: in-place updates are not supported

API documentation for the resource's definition:

• v1

dataform.repository

Dataform Repository resources.

API documentation for the resource's definition:

• v1beta1

dataform.repository.releaseConfig

Dataform ReleaseConfig resources.

Special handling:

• releaseCompilationResult: setting to auto in definition triggers compilation after resource creation or update

Parent resource:

• dataform.repository.

API documentation for the resource's definition:

• v1beta1

dataform.repository.workflowConfig

Compute Engine WorkflowConfig resources.

Definition handling:

• releaseConfig: accepts short ID of config within the same repository instead of full URI

Parent resource:

• dataform.repository.

API documentation for the resource's definition:

• v1beta1

dataform.repository.workspace

Compute Engine Workspace resources.

Parent resource:

• dataform.repository.

API documentation for the resource's definition:

• v1beta1

dataproc.autoscalingPolicy

Managed Service for Apache Spark Autoscaling Policies.

API documentation for the resource's definition:

• v1

dataproc.cluster

Managed Service for Apache Spark Cluster resources.

Definition handling:

• config.autoDeleteTtl: ignored during comparison
• config.softwareConfig: ignored during comparison

API documentation for the resource's definition:

• v1

dataproc.workflowTemplate

Managed Service for Apache Spark Workflow Templates.

Definition handling:

• id: automatically populated with the logical name of the resource.

API documentation for the resource's definition:

• v1

iam.serviceAccount

IAM Service Accounts.

Special handling:

• resource ID: implicitly formatted as email address for API requests. For example, if resource ID is example-account, the project is example-project, then the resource's name is formatted as [e-mail].

API documentation for the resource's definition:

• v1

iam.workloadIdentityPool

IAM Workload Identity Pools.

API documentation for the resource's definition:

• v1

iam.workloadIdentityPoolProvider

IAM Workload Identity Pool Providers.

API documentation for the resource's definition:

• v1

pubsub.schema

Pub/Sub Schema resources.

Special handling:

• updates: in-place updates aren't fully supported yet.

API documentation for the resource's definition:

• v1

pubsub.subscription

Pub/Sub Subscription resources.

API documentation for the resource's definition:

• v1

pubsub.topic

Pub/Sub Topic resources.

API documentation for the resource's definition:

• v1

secretmanager.secret

Secret Manager Secret resources.

API documentation for the resource's definition:

• v1

sqladmin.instance

Cloud SQL Admin Instance resources.

API documentation for the resource's definition:

• v1beta4

sqladmin.instance.database

Cloud SQL Admin Database resources.

Parent resource:

• sqladmin.instance.

API documentation for the resource's definition:

• v1beta4

sqladmin.instance.user

Cloud SQL Admin User resources.

Parent resource:

• sqladmin.instance.

API documentation for the resource's definition:

• v1beta4

storage.bucket

Cloud Storage Bucket resources.

API documentation for the resource's definition:

• v1beta4

storage.bucket.notification

Cloud Storage Notification resources.

Special handling:

• updates: in-place updates are not supported by the API; resources must be recreated
• dynamic ID resolution: resource ID is resolved dynamically from matching topic in API list output

Definition handling:

• topic: prefix //pubsub.[DOMAIN]/ is ignored during comparison against API state

Parent resource:

• storage.bucket.

API documentation for the resource's definition:

• v1