1. Docs
2. Reference
3. API
4. @pulumi/gcp

Package @pulumi/gcp

The Google Cloud Platform (GCP) provider package offers support for all GCP services and their properties. Services are exposed as types from modules such as compute, container, sql, and storage, among many others. Using this package allows you to programmatically declare instances of any GCP services using infrastructure as code, which Pulumi then uses to drive the GCP API.

If this is your first time using this package, these two resources may be helpful:

• GCP Getting Started Guide: Get up and running quickly.
• GCP Pulumi Setup Documentation: How to configure Pulumi for use with your GCP account.

Use the navigation below to see detailed documentation, including sample code, for each of the supported GCP services.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-gcp repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-google repo.

var gcp = require("@pulumi/gcp");

import * as gcp from "@pulumi/gcp";

Modules

• accesscontextmanager
• appengine
• artifactregistry
• bigquery
• bigtable
• billing
• binaryauthorization
• cloudbuild
• cloudfunctions
• cloudrun
• cloudscheduler
• cloudtasks
• composer
• compute
• config
• container
• containeranalysis
• datacatalog
• dataflow
• datafusion
• dataproc
• datastore
• deploymentmanager
• diagflow
• dns
• endpoints
• filestore
• firebase
• firestore
• folder
• gameservices
• healthcare
• iam
• iap
• identityplatform
• iot
• kms
• logging
• ml
• monitoring
• organizations
• oslogin
• projects
• pubsub
• redis
• resourcemanager
• runtimeconfig
• secretmanager
• securitycenter
• serviceAccount
• servicedirectory
• servicenetworking
• serviceusage
• sourcerepo
• spanner
• sql
• storage
• tpu
• types
• vpcaccess

Resources

• Provider

Others

• getEnv
• getEnvBoolean
• getEnvNumber
• getVersion
• ProviderArgs

Resources

Resource Provider

class Provider extends ProviderResource

The provider type for the google-beta package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

constructor

new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)

Create a Provider resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Provider

Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method register

static register(provider: ProviderResource | undefined): Promise<string | undefined>

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

function getEnv

getEnv(vars: string[]): string | undefined

function getEnvBoolean

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber

getEnvNumber(vars: string[]): number | undefined

function getVersion

getVersion(): string

interface ProviderArgs

interface ProviderArgs

The set of arguments for constructing a Provider resource.

property accessContextManagerCustomEndpoint

accessContextManagerCustomEndpoint?: pulumi.Input<string>;

property accessToken

accessToken?: pulumi.Input<string>;

property appEngineCustomEndpoint

appEngineCustomEndpoint?: pulumi.Input<string>;

property artifactRegistryCustomEndpoint

artifactRegistryCustomEndpoint?: pulumi.Input<string>;

property batching

batching?: pulumi.Input<ProviderBatching>;

property bigQueryCustomEndpoint

bigQueryCustomEndpoint?: pulumi.Input<string>;

property bigqueryConnectionCustomEndpoint

bigqueryConnectionCustomEndpoint?: pulumi.Input<string>;

property bigqueryDataTransferCustomEndpoint

bigqueryDataTransferCustomEndpoint?: pulumi.Input<string>;

property bigqueryReservationCustomEndpoint

bigqueryReservationCustomEndpoint?: pulumi.Input<string>;

property bigtableCustomEndpoint

bigtableCustomEndpoint?: pulumi.Input<string>;

property billingCustomEndpoint

billingCustomEndpoint?: pulumi.Input<string>;

property binaryAuthorizationCustomEndpoint

binaryAuthorizationCustomEndpoint?: pulumi.Input<string>;

property cloudBillingCustomEndpoint

cloudBillingCustomEndpoint?: pulumi.Input<string>;

property cloudBuildCustomEndpoint

cloudBuildCustomEndpoint?: pulumi.Input<string>;

property cloudFunctionsCustomEndpoint

cloudFunctionsCustomEndpoint?: pulumi.Input<string>;

property cloudIotCustomEndpoint

cloudIotCustomEndpoint?: pulumi.Input<string>;

property cloudRunCustomEndpoint

cloudRunCustomEndpoint?: pulumi.Input<string>;

property cloudSchedulerCustomEndpoint

cloudSchedulerCustomEndpoint?: pulumi.Input<string>;

property cloudTasksCustomEndpoint

cloudTasksCustomEndpoint?: pulumi.Input<string>;

property composerCustomEndpoint

composerCustomEndpoint?: pulumi.Input<string>;

property computeBetaCustomEndpoint

computeBetaCustomEndpoint?: pulumi.Input<string>;

property computeCustomEndpoint

computeCustomEndpoint?: pulumi.Input<string>;

property containerAnalysisCustomEndpoint

containerAnalysisCustomEndpoint?: pulumi.Input<string>;

property containerBetaCustomEndpoint

containerBetaCustomEndpoint?: pulumi.Input<string>;

property containerCustomEndpoint

containerCustomEndpoint?: pulumi.Input<string>;

property credentials

credentials?: pulumi.Input<string>;

property dataCatalogCustomEndpoint

dataCatalogCustomEndpoint?: pulumi.Input<string>;

property dataFusionCustomEndpoint

dataFusionCustomEndpoint?: pulumi.Input<string>;

property dataflowCustomEndpoint

dataflowCustomEndpoint?: pulumi.Input<string>;

property dataprocBetaCustomEndpoint

dataprocBetaCustomEndpoint?: pulumi.Input<string>;

property dataprocCustomEndpoint

dataprocCustomEndpoint?: pulumi.Input<string>;

property datastoreCustomEndpoint

datastoreCustomEndpoint?: pulumi.Input<string>;

property deploymentManagerCustomEndpoint

deploymentManagerCustomEndpoint?: pulumi.Input<string>;

property dialogflowCustomEndpoint

dialogflowCustomEndpoint?: pulumi.Input<string>;

property dnsBetaCustomEndpoint

dnsBetaCustomEndpoint?: pulumi.Input<string>;

property dnsCustomEndpoint

dnsCustomEndpoint?: pulumi.Input<string>;

property filestoreCustomEndpoint

filestoreCustomEndpoint?: pulumi.Input<string>;

property firebaseCustomEndpoint

firebaseCustomEndpoint?: pulumi.Input<string>;

property firestoreCustomEndpoint

firestoreCustomEndpoint?: pulumi.Input<string>;

property gameServicesCustomEndpoint

gameServicesCustomEndpoint?: pulumi.Input<string>;

property healthcareCustomEndpoint

healthcareCustomEndpoint?: pulumi.Input<string>;

property iamCredentialsCustomEndpoint

iamCredentialsCustomEndpoint?: pulumi.Input<string>;

property iamCustomEndpoint

iamCustomEndpoint?: pulumi.Input<string>;

property iapCustomEndpoint

iapCustomEndpoint?: pulumi.Input<string>;

property identityPlatformCustomEndpoint

identityPlatformCustomEndpoint?: pulumi.Input<string>;

property kmsCustomEndpoint

kmsCustomEndpoint?: pulumi.Input<string>;

property loggingCustomEndpoint

loggingCustomEndpoint?: pulumi.Input<string>;

property mlEngineCustomEndpoint

mlEngineCustomEndpoint?: pulumi.Input<string>;

property monitoringCustomEndpoint

monitoringCustomEndpoint?: pulumi.Input<string>;

property osLoginCustomEndpoint

osLoginCustomEndpoint?: pulumi.Input<string>;

property project

project?: pulumi.Input<string>;

property pubsubCustomEndpoint

pubsubCustomEndpoint?: pulumi.Input<string>;

property redisCustomEndpoint

redisCustomEndpoint?: pulumi.Input<string>;

property region

region?: pulumi.Input<string>;

property requestTimeout

requestTimeout?: pulumi.Input<string>;

property resourceManagerCustomEndpoint

resourceManagerCustomEndpoint?: pulumi.Input<string>;

property resourceManagerV2beta1CustomEndpoint

resourceManagerV2beta1CustomEndpoint?: pulumi.Input<string>;

property runtimeConfigCustomEndpoint

runtimeConfigCustomEndpoint?: pulumi.Input<string>;

property runtimeconfigCustomEndpoint

runtimeconfigCustomEndpoint?: pulumi.Input<string>;

property scopes

scopes?: pulumi.Input<pulumi.Input<string>[]>;

property secretManagerCustomEndpoint

secretManagerCustomEndpoint?: pulumi.Input<string>;

property securityCenterCustomEndpoint

securityCenterCustomEndpoint?: pulumi.Input<string>;

property securityScannerCustomEndpoint

securityScannerCustomEndpoint?: pulumi.Input<string>;

property serviceDirectoryCustomEndpoint

serviceDirectoryCustomEndpoint?: pulumi.Input<string>;

property serviceManagementCustomEndpoint

serviceManagementCustomEndpoint?: pulumi.Input<string>;

property serviceNetworkingCustomEndpoint

serviceNetworkingCustomEndpoint?: pulumi.Input<string>;

property serviceUsageCustomEndpoint

serviceUsageCustomEndpoint?: pulumi.Input<string>;

property sourceRepoCustomEndpoint

sourceRepoCustomEndpoint?: pulumi.Input<string>;

property spannerCustomEndpoint

spannerCustomEndpoint?: pulumi.Input<string>;

property sqlCustomEndpoint

sqlCustomEndpoint?: pulumi.Input<string>;

property storageCustomEndpoint

storageCustomEndpoint?: pulumi.Input<string>;

property storageTransferCustomEndpoint

storageTransferCustomEndpoint?: pulumi.Input<string>;

property tpuCustomEndpoint

tpuCustomEndpoint?: pulumi.Input<string>;

property userProjectOverride

userProjectOverride?: pulumi.Input<boolean>;

property vpcAccessCustomEndpoint

vpcAccessCustomEndpoint?: pulumi.Input<string>;

property zone

zone?: pulumi.Input<string>;