1. Pulumi Registry
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. bigquery
  5. Connection
gcp logo
Google Cloud Classic v6.52.0, Mar 22 23

gcp.bigquery.Connection

Import

Connection can be imported using any of these accepted formats

 $ pulumi import gcp:bigquery/connection:Connection default projects/{{project}}/locations/{{location}}/connections/{{connection_id}}

 $ pulumi import gcp:bigquery/connection:Connection default {{project}}/{{location}}/{{connection_id}}

 $ pulumi import gcp:bigquery/connection:Connection default {{location}}/{{connection_id}}

Example Usage

Bigquery Connection Cloud Resource

using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var connection = new Gcp.BigQuery.Connection("connection", new()
    {
        CloudResource = null,
        ConnectionId = "my-connection",
        Description = "a riveting description",
        FriendlyName = "👋",
        Location = "US",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/bigquery"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bigquery.NewConnection(ctx, "connection", &bigquery.ConnectionArgs{
			CloudResource: nil,
			ConnectionId:  pulumi.String("my-connection"),
			Description:   pulumi.String("a riveting description"),
			FriendlyName:  pulumi.String("👋"),
			Location:      pulumi.String("US"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.bigquery.Connection;
import com.pulumi.gcp.bigquery.ConnectionArgs;
import com.pulumi.gcp.bigquery.inputs.ConnectionCloudResourceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var connection = new Connection("connection", ConnectionArgs.builder()        
            .cloudResource()
            .connectionId("my-connection")
            .description("a riveting description")
            .friendlyName("👋")
            .location("US")
            .build());

    }
}

import pulumi
import pulumi_gcp as gcp

connection = gcp.bigquery.Connection("connection",
    cloud_resource=gcp.bigquery.ConnectionCloudResourceArgs(),
    connection_id="my-connection",
    description="a riveting description",
    friendly_name="👋",
    location="US")

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

const connection = new gcp.bigquery.Connection("connection", {
    cloudResource: {},
    connectionId: "my-connection",
    description: "a riveting description",
    friendlyName: "👋",
    location: "US",
});

resources:
  connection:
    type: gcp:bigquery:Connection
    properties:
      cloudResource: {}
      connectionId: my-connection
      description: a riveting description
      friendlyName: "\U0001F44B"
      location: US

Bigquery Connection Basic

using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;
using Random = Pulumi.Random;

return await Deployment.RunAsync(() => 
{
    var instance = new Gcp.Sql.DatabaseInstance("instance", new()
    {
        DatabaseVersion = "POSTGRES_11",
        Region = "us-central1",
        Settings = new Gcp.Sql.Inputs.DatabaseInstanceSettingsArgs
        {
            Tier = "db-f1-micro",
        },
        DeletionProtection = true,
    });

    var db = new Gcp.Sql.Database("db", new()
    {
        Instance = instance.Name,
    });

    var pwd = new Random.RandomPassword("pwd", new()
    {
        Length = 16,
        Special = false,
    });

    var user = new Gcp.Sql.User("user", new()
    {
        Instance = instance.Name,
        Password = pwd.Result,
    });

    var connection = new Gcp.BigQuery.Connection("connection", new()
    {
        FriendlyName = "👋",
        Description = "a riveting description",
        Location = "US",
        CloudSql = new Gcp.BigQuery.Inputs.ConnectionCloudSqlArgs
        {
            InstanceId = instance.ConnectionName,
            Database = db.Name,
            Type = "POSTGRES",
            Credential = new Gcp.BigQuery.Inputs.ConnectionCloudSqlCredentialArgs
            {
                Username = user.Name,
                Password = user.Password,
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/bigquery"
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/sql"
	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		instance, err := sql.NewDatabaseInstance(ctx, "instance", &sql.DatabaseInstanceArgs{
			DatabaseVersion: pulumi.String("POSTGRES_11"),
			Region:          pulumi.String("us-central1"),
			Settings: &sql.DatabaseInstanceSettingsArgs{
				Tier: pulumi.String("db-f1-micro"),
			},
			DeletionProtection: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		db, err := sql.NewDatabase(ctx, "db", &sql.DatabaseArgs{
			Instance: instance.Name,
		})
		if err != nil {
			return err
		}
		pwd, err := random.NewRandomPassword(ctx, "pwd", &random.RandomPasswordArgs{
			Length:  pulumi.Int(16),
			Special: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		user, err := sql.NewUser(ctx, "user", &sql.UserArgs{
			Instance: instance.Name,
			Password: pwd.Result,
		})
		if err != nil {
			return err
		}
		_, err = bigquery.NewConnection(ctx, "connection", &bigquery.ConnectionArgs{
			FriendlyName: pulumi.String("👋"),
			Description:  pulumi.String("a riveting description"),
			Location:     pulumi.String("US"),
			CloudSql: &bigquery.ConnectionCloudSqlArgs{
				InstanceId: instance.ConnectionName,
				Database:   db.Name,
				Type:       pulumi.String("POSTGRES"),
				Credential: &bigquery.ConnectionCloudSqlCredentialArgs{
					Username: user.Name,
					Password: user.Password,
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.sql.DatabaseInstance;
import com.pulumi.gcp.sql.DatabaseInstanceArgs;
import com.pulumi.gcp.sql.inputs.DatabaseInstanceSettingsArgs;
import com.pulumi.gcp.sql.Database;
import com.pulumi.gcp.sql.DatabaseArgs;
import com.pulumi.random.RandomPassword;
import com.pulumi.random.RandomPasswordArgs;
import com.pulumi.gcp.sql.User;
import com.pulumi.gcp.sql.UserArgs;
import com.pulumi.gcp.bigquery.Connection;
import com.pulumi.gcp.bigquery.ConnectionArgs;
import com.pulumi.gcp.bigquery.inputs.ConnectionCloudSqlArgs;
import com.pulumi.gcp.bigquery.inputs.ConnectionCloudSqlCredentialArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var instance = new DatabaseInstance("instance", DatabaseInstanceArgs.builder()        
            .databaseVersion("POSTGRES_11")
            .region("us-central1")
            .settings(DatabaseInstanceSettingsArgs.builder()
                .tier("db-f1-micro")
                .build())
            .deletionProtection("true")
            .build());

        var db = new Database("db", DatabaseArgs.builder()        
            .instance(instance.name())
            .build());

        var pwd = new RandomPassword("pwd", RandomPasswordArgs.builder()        
            .length(16)
            .special(false)
            .build());

        var user = new User("user", UserArgs.builder()        
            .instance(instance.name())
            .password(pwd.result())
            .build());

        var connection = new Connection("connection", ConnectionArgs.builder()        
            .friendlyName("👋")
            .description("a riveting description")
            .location("US")
            .cloudSql(ConnectionCloudSqlArgs.builder()
                .instanceId(instance.connectionName())
                .database(db.name())
                .type("POSTGRES")
                .credential(ConnectionCloudSqlCredentialArgs.builder()
                    .username(user.name())
                    .password(user.password())
                    .build())
                .build())
            .build());

    }
}

import pulumi
import pulumi_gcp as gcp
import pulumi_random as random

instance = gcp.sql.DatabaseInstance("instance",
    database_version="POSTGRES_11",
    region="us-central1",
    settings=gcp.sql.DatabaseInstanceSettingsArgs(
        tier="db-f1-micro",
    ),
    deletion_protection=True)
db = gcp.sql.Database("db", instance=instance.name)
pwd = random.RandomPassword("pwd",
    length=16,
    special=False)
user = gcp.sql.User("user",
    instance=instance.name,
    password=pwd.result)
connection = gcp.bigquery.Connection("connection",
    friendly_name="👋",
    description="a riveting description",
    location="US",
    cloud_sql=gcp.bigquery.ConnectionCloudSqlArgs(
        instance_id=instance.connection_name,
        database=db.name,
        type="POSTGRES",
        credential=gcp.bigquery.ConnectionCloudSqlCredentialArgs(
            username=user.name,
            password=user.password,
        ),
    ))

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

const instance = new gcp.sql.DatabaseInstance("instance", {
    databaseVersion: "POSTGRES_11",
    region: "us-central1",
    settings: {
        tier: "db-f1-micro",
    },
    deletionProtection: true,
});
const db = new gcp.sql.Database("db", {instance: instance.name});
const pwd = new random.RandomPassword("pwd", {
    length: 16,
    special: false,
});
const user = new gcp.sql.User("user", {
    instance: instance.name,
    password: pwd.result,
});
const connection = new gcp.bigquery.Connection("connection", {
    friendlyName: "👋",
    description: "a riveting description",
    location: "US",
    cloudSql: {
        instanceId: instance.connectionName,
        database: db.name,
        type: "POSTGRES",
        credential: {
            username: user.name,
            password: user.password,
        },
    },
});

resources:
  instance:
    type: gcp:sql:DatabaseInstance
    properties:
      databaseVersion: POSTGRES_11
      region: us-central1
      settings:
        tier: db-f1-micro
      deletionProtection: 'true'
  db:
    type: gcp:sql:Database
    properties:
      instance: ${instance.name}
  pwd:
    type: random:RandomPassword
    properties:
      length: 16
      special: false
  user:
    type: gcp:sql:User
    properties:
      instance: ${instance.name}
      password: ${pwd.result}
  connection:
    type: gcp:bigquery:Connection
    properties:
      friendlyName: "\U0001F44B"
      description: a riveting description
      location: US
      cloudSql:
        instanceId: ${instance.connectionName}
        database: ${db.name}
        type: POSTGRES
        credential:
          username: ${user.name}
          password: ${user.password}

Bigquery Connection Full

using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;
using Random = Pulumi.Random;

return await Deployment.RunAsync(() => 
{
    var instance = new Gcp.Sql.DatabaseInstance("instance", new()
    {
        DatabaseVersion = "POSTGRES_11",
        Region = "us-central1",
        Settings = new Gcp.Sql.Inputs.DatabaseInstanceSettingsArgs
        {
            Tier = "db-f1-micro",
        },
        DeletionProtection = true,
    });

    var db = new Gcp.Sql.Database("db", new()
    {
        Instance = instance.Name,
    });

    var pwd = new Random.RandomPassword("pwd", new()
    {
        Length = 16,
        Special = false,
    });

    var user = new Gcp.Sql.User("user", new()
    {
        Instance = instance.Name,
        Password = pwd.Result,
    });

    var connection = new Gcp.BigQuery.Connection("connection", new()
    {
        ConnectionId = "my-connection",
        Location = "US",
        FriendlyName = "👋",
        Description = "a riveting description",
        CloudSql = new Gcp.BigQuery.Inputs.ConnectionCloudSqlArgs
        {
            InstanceId = instance.ConnectionName,
            Database = db.Name,
            Type = "POSTGRES",
            Credential = new Gcp.BigQuery.Inputs.ConnectionCloudSqlCredentialArgs
            {
                Username = user.Name,
                Password = user.Password,
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/bigquery"
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/sql"
	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		instance, err := sql.NewDatabaseInstance(ctx, "instance", &sql.DatabaseInstanceArgs{
			DatabaseVersion: pulumi.String("POSTGRES_11"),
			Region:          pulumi.String("us-central1"),
			Settings: &sql.DatabaseInstanceSettingsArgs{
				Tier: pulumi.String("db-f1-micro"),
			},
			DeletionProtection: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		db, err := sql.NewDatabase(ctx, "db", &sql.DatabaseArgs{
			Instance: instance.Name,
		})
		if err != nil {
			return err
		}
		pwd, err := random.NewRandomPassword(ctx, "pwd", &random.RandomPasswordArgs{
			Length:  pulumi.Int(16),
			Special: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		user, err := sql.NewUser(ctx, "user", &sql.UserArgs{
			Instance: instance.Name,
			Password: pwd.Result,
		})
		if err != nil {
			return err
		}
		_, err = bigquery.NewConnection(ctx, "connection", &bigquery.ConnectionArgs{
			ConnectionId: pulumi.String("my-connection"),
			Location:     pulumi.String("US"),
			FriendlyName: pulumi.String("👋"),
			Description:  pulumi.String("a riveting description"),
			CloudSql: &bigquery.ConnectionCloudSqlArgs{
				InstanceId: instance.ConnectionName,
				Database:   db.Name,
				Type:       pulumi.String("POSTGRES"),
				Credential: &bigquery.ConnectionCloudSqlCredentialArgs{
					Username: user.Name,
					Password: user.Password,
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.sql.DatabaseInstance;
import com.pulumi.gcp.sql.DatabaseInstanceArgs;
import com.pulumi.gcp.sql.inputs.DatabaseInstanceSettingsArgs;
import com.pulumi.gcp.sql.Database;
import com.pulumi.gcp.sql.DatabaseArgs;
import com.pulumi.random.RandomPassword;
import com.pulumi.random.RandomPasswordArgs;
import com.pulumi.gcp.sql.User;
import com.pulumi.gcp.sql.UserArgs;
import com.pulumi.gcp.bigquery.Connection;
import com.pulumi.gcp.bigquery.ConnectionArgs;
import com.pulumi.gcp.bigquery.inputs.ConnectionCloudSqlArgs;
import com.pulumi.gcp.bigquery.inputs.ConnectionCloudSqlCredentialArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var instance = new DatabaseInstance("instance", DatabaseInstanceArgs.builder()        
            .databaseVersion("POSTGRES_11")
            .region("us-central1")
            .settings(DatabaseInstanceSettingsArgs.builder()
                .tier("db-f1-micro")
                .build())
            .deletionProtection("true")
            .build());

        var db = new Database("db", DatabaseArgs.builder()        
            .instance(instance.name())
            .build());

        var pwd = new RandomPassword("pwd", RandomPasswordArgs.builder()        
            .length(16)
            .special(false)
            .build());

        var user = new User("user", UserArgs.builder()        
            .instance(instance.name())
            .password(pwd.result())
            .build());

        var connection = new Connection("connection", ConnectionArgs.builder()        
            .connectionId("my-connection")
            .location("US")
            .friendlyName("👋")
            .description("a riveting description")
            .cloudSql(ConnectionCloudSqlArgs.builder()
                .instanceId(instance.connectionName())
                .database(db.name())
                .type("POSTGRES")
                .credential(ConnectionCloudSqlCredentialArgs.builder()
                    .username(user.name())
                    .password(user.password())
                    .build())
                .build())
            .build());

    }
}

import pulumi
import pulumi_gcp as gcp
import pulumi_random as random

instance = gcp.sql.DatabaseInstance("instance",
    database_version="POSTGRES_11",
    region="us-central1",
    settings=gcp.sql.DatabaseInstanceSettingsArgs(
        tier="db-f1-micro",
    ),
    deletion_protection=True)
db = gcp.sql.Database("db", instance=instance.name)
pwd = random.RandomPassword("pwd",
    length=16,
    special=False)
user = gcp.sql.User("user",
    instance=instance.name,
    password=pwd.result)
connection = gcp.bigquery.Connection("connection",
    connection_id="my-connection",
    location="US",
    friendly_name="👋",
    description="a riveting description",
    cloud_sql=gcp.bigquery.ConnectionCloudSqlArgs(
        instance_id=instance.connection_name,
        database=db.name,
        type="POSTGRES",
        credential=gcp.bigquery.ConnectionCloudSqlCredentialArgs(
            username=user.name,
            password=user.password,
        ),
    ))

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

const instance = new gcp.sql.DatabaseInstance("instance", {
    databaseVersion: "POSTGRES_11",
    region: "us-central1",
    settings: {
        tier: "db-f1-micro",
    },
    deletionProtection: true,
});
const db = new gcp.sql.Database("db", {instance: instance.name});
const pwd = new random.RandomPassword("pwd", {
    length: 16,
    special: false,
});
const user = new gcp.sql.User("user", {
    instance: instance.name,
    password: pwd.result,
});
const connection = new gcp.bigquery.Connection("connection", {
    connectionId: "my-connection",
    location: "US",
    friendlyName: "👋",
    description: "a riveting description",
    cloudSql: {
        instanceId: instance.connectionName,
        database: db.name,
        type: "POSTGRES",
        credential: {
            username: user.name,
            password: user.password,
        },
    },
});

resources:
  instance:
    type: gcp:sql:DatabaseInstance
    properties:
      databaseVersion: POSTGRES_11
      region: us-central1
      settings:
        tier: db-f1-micro
      deletionProtection: 'true'
  db:
    type: gcp:sql:Database
    properties:
      instance: ${instance.name}
  pwd:
    type: random:RandomPassword
    properties:
      length: 16
      special: false
  user:
    type: gcp:sql:User
    properties:
      instance: ${instance.name}
      password: ${pwd.result}
  connection:
    type: gcp:bigquery:Connection
    properties:
      connectionId: my-connection
      location: US
      friendlyName: "\U0001F44B"
      description: a riveting description
      cloudSql:
        instanceId: ${instance.connectionName}
        database: ${db.name}
        type: POSTGRES
        credential:
          username: ${user.name}
          password: ${user.password}

Bigquery Connection Aws

using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var connection = new Gcp.BigQuery.Connection("connection", new()
    {
        Aws = new Gcp.BigQuery.Inputs.ConnectionAwsArgs
        {
            AccessRole = new Gcp.BigQuery.Inputs.ConnectionAwsAccessRoleArgs
            {
                IamRoleId = "arn:aws:iam::999999999999:role/omnirole",
            },
        },
        ConnectionId = "my-connection",
        Description = "a riveting description",
        FriendlyName = "👋",
        Location = "aws-us-east-1",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/bigquery"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bigquery.NewConnection(ctx, "connection", &bigquery.ConnectionArgs{
			Aws: &bigquery.ConnectionAwsArgs{
				AccessRole: &bigquery.ConnectionAwsAccessRoleArgs{
					IamRoleId: pulumi.String("arn:aws:iam::999999999999:role/omnirole"),
				},
			},
			ConnectionId: pulumi.String("my-connection"),
			Description:  pulumi.String("a riveting description"),
			FriendlyName: pulumi.String("👋"),
			Location:     pulumi.String("aws-us-east-1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.bigquery.Connection;
import com.pulumi.gcp.bigquery.ConnectionArgs;
import com.pulumi.gcp.bigquery.inputs.ConnectionAwsArgs;
import com.pulumi.gcp.bigquery.inputs.ConnectionAwsAccessRoleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var connection = new Connection("connection", ConnectionArgs.builder()        
            .aws(ConnectionAwsArgs.builder()
                .accessRole(ConnectionAwsAccessRoleArgs.builder()
                    .iamRoleId("arn:aws:iam::999999999999:role/omnirole")
                    .build())
                .build())
            .connectionId("my-connection")
            .description("a riveting description")
            .friendlyName("👋")
            .location("aws-us-east-1")
            .build());

    }
}

import pulumi
import pulumi_gcp as gcp

connection = gcp.bigquery.Connection("connection",
    aws=gcp.bigquery.ConnectionAwsArgs(
        access_role=gcp.bigquery.ConnectionAwsAccessRoleArgs(
            iam_role_id="arn:aws:iam::999999999999:role/omnirole",
        ),
    ),
    connection_id="my-connection",
    description="a riveting description",
    friendly_name="👋",
    location="aws-us-east-1")

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

const connection = new gcp.bigquery.Connection("connection", {
    aws: {
        accessRole: {
            iamRoleId: "arn:aws:iam::999999999999:role/omnirole",
        },
    },
    connectionId: "my-connection",
    description: "a riveting description",
    friendlyName: "👋",
    location: "aws-us-east-1",
});

resources:
  connection:
    type: gcp:bigquery:Connection
    properties:
      aws:
        accessRole:
          iamRoleId: arn:aws:iam::999999999999:role/omnirole
      connectionId: my-connection
      description: a riveting description
      friendlyName: "\U0001F44B"
      location: aws-us-east-1

Bigquery Connection Azure

using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var connection = new Gcp.BigQuery.Connection("connection", new()
    {
        Azure = new Gcp.BigQuery.Inputs.ConnectionAzureArgs
        {
            CustomerTenantId = "customer-tenant-id",
            FederatedApplicationClientId = "b43eeeee-eeee-eeee-eeee-a480155501ce",
        },
        ConnectionId = "my-connection",
        Description = "a riveting description",
        FriendlyName = "👋",
        Location = "azure-eastus2",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/bigquery"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bigquery.NewConnection(ctx, "connection", &bigquery.ConnectionArgs{
			Azure: &bigquery.ConnectionAzureArgs{
				CustomerTenantId:             pulumi.String("customer-tenant-id"),
				FederatedApplicationClientId: pulumi.String("b43eeeee-eeee-eeee-eeee-a480155501ce"),
			},
			ConnectionId: pulumi.String("my-connection"),
			Description:  pulumi.String("a riveting description"),
			FriendlyName: pulumi.String("👋"),
			Location:     pulumi.String("azure-eastus2"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.bigquery.Connection;
import com.pulumi.gcp.bigquery.ConnectionArgs;
import com.pulumi.gcp.bigquery.inputs.ConnectionAzureArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var connection = new Connection("connection", ConnectionArgs.builder()        
            .azure(ConnectionAzureArgs.builder()
                .customerTenantId("customer-tenant-id")
                .federatedApplicationClientId("b43eeeee-eeee-eeee-eeee-a480155501ce")
                .build())
            .connectionId("my-connection")
            .description("a riveting description")
            .friendlyName("👋")
            .location("azure-eastus2")
            .build());

    }
}

import pulumi
import pulumi_gcp as gcp

connection = gcp.bigquery.Connection("connection",
    azure=gcp.bigquery.ConnectionAzureArgs(
        customer_tenant_id="customer-tenant-id",
        federated_application_client_id="b43eeeee-eeee-eeee-eeee-a480155501ce",
    ),
    connection_id="my-connection",
    description="a riveting description",
    friendly_name="👋",
    location="azure-eastus2")

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

const connection = new gcp.bigquery.Connection("connection", {
    azure: {
        customerTenantId: "customer-tenant-id",
        federatedApplicationClientId: "b43eeeee-eeee-eeee-eeee-a480155501ce",
    },
    connectionId: "my-connection",
    description: "a riveting description",
    friendlyName: "👋",
    location: "azure-eastus2",
});

resources:
  connection:
    type: gcp:bigquery:Connection
    properties:
      azure:
        customerTenantId: customer-tenant-id
        federatedApplicationClientId: b43eeeee-eeee-eeee-eeee-a480155501ce
      connectionId: my-connection
      description: a riveting description
      friendlyName: "\U0001F44B"
      location: azure-eastus2

Bigquery Connection Cloudspanner

using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var connection = new Gcp.BigQuery.Connection("connection", new()
    {
        CloudSpanner = new Gcp.BigQuery.Inputs.ConnectionCloudSpannerArgs
        {
            Database = "projects/project/instances/instance/databases/database",
        },
        ConnectionId = "my-connection",
        Description = "a riveting description",
        FriendlyName = "👋",
        Location = "US",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/bigquery"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bigquery.NewConnection(ctx, "connection", &bigquery.ConnectionArgs{
			CloudSpanner: &bigquery.ConnectionCloudSpannerArgs{
				Database: pulumi.String("projects/project/instances/instance/databases/database"),
			},
			ConnectionId: pulumi.String("my-connection"),
			Description:  pulumi.String("a riveting description"),
			FriendlyName: pulumi.String("👋"),
			Location:     pulumi.String("US"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.bigquery.Connection;
import com.pulumi.gcp.bigquery.ConnectionArgs;
import com.pulumi.gcp.bigquery.inputs.ConnectionCloudSpannerArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var connection = new Connection("connection", ConnectionArgs.builder()        
            .cloudSpanner(ConnectionCloudSpannerArgs.builder()
                .database("projects/project/instances/instance/databases/database")
                .build())
            .connectionId("my-connection")
            .description("a riveting description")
            .friendlyName("👋")
            .location("US")
            .build());

    }
}

import pulumi
import pulumi_gcp as gcp

connection = gcp.bigquery.Connection("connection",
    cloud_spanner=gcp.bigquery.ConnectionCloudSpannerArgs(
        database="projects/project/instances/instance/databases/database",
    ),
    connection_id="my-connection",
    description="a riveting description",
    friendly_name="👋",
    location="US")

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

const connection = new gcp.bigquery.Connection("connection", {
    cloudSpanner: {
        database: "projects/project/instances/instance/databases/database",
    },
    connectionId: "my-connection",
    description: "a riveting description",
    friendlyName: "👋",
    location: "US",
});

resources:
  connection:
    type: gcp:bigquery:Connection
    properties:
      cloudSpanner:
        database: projects/project/instances/instance/databases/database
      connectionId: my-connection
      description: a riveting description
      friendlyName: "\U0001F44B"
      location: US

Create Connection Resource

new Connection(name: string, args?: ConnectionArgs, opts?: CustomResourceOptions);
@overload
def Connection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               aws: Optional[ConnectionAwsArgs] = None,
               azure: Optional[ConnectionAzureArgs] = None,
               cloud_resource: Optional[ConnectionCloudResourceArgs] = None,
               cloud_spanner: Optional[ConnectionCloudSpannerArgs] = None,
               cloud_sql: Optional[ConnectionCloudSqlArgs] = None,
               connection_id: Optional[str] = None,
               description: Optional[str] = None,
               friendly_name: Optional[str] = None,
               location: Optional[str] = None,
               project: Optional[str] = None)
@overload
def Connection(resource_name: str,
               args: Optional[ConnectionArgs] = None,
               opts: Optional[ResourceOptions] = None)
func NewConnection(ctx *Context, name string, args *ConnectionArgs, opts ...ResourceOption) (*Connection, error)
public Connection(string name, ConnectionArgs? args = null, CustomResourceOptions? opts = null)
public Connection(String name, ConnectionArgs args)
public Connection(String name, ConnectionArgs args, CustomResourceOptions options)

type: gcp:bigquery:Connection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ConnectionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ConnectionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ConnectionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Connection Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Connection resource accepts the following input properties:

Aws ConnectionAwsArgs

Connection properties specific to Amazon Web Services. Structure is documented below.

Azure ConnectionAzureArgs

Container for connection properties specific to Azure. Structure is documented below.

CloudResource ConnectionCloudResourceArgs

Container for connection properties for delegation of access to GCP resources. Structure is documented below.

CloudSpanner ConnectionCloudSpannerArgs

Connection properties specific to Cloud Spanner Structure is documented below.

CloudSql ConnectionCloudSqlArgs

Connection properties specific to the Cloud SQL. Structure is documented below.

ConnectionId string

Optional connection id that should be assigned to the created connection.

Description string

A descriptive description for the connection

FriendlyName string

A descriptive name for the connection

Location string

The geographic location where the connection should reside. Cloud SQL instance must be in the same location as the connection with following exceptions: Cloud SQL us-central1 maps to BigQuery US, Cloud SQL europe-west1 maps to BigQuery EU. Examples: US, EU, asia-northeast1, us-central1, europe-west1. Spanner Connections same as spanner region AWS allowed regions are aws-us-east-1 Azure allowed regions are azure-eastus2

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Aws ConnectionAwsArgs

Connection properties specific to Amazon Web Services. Structure is documented below.

Azure ConnectionAzureArgs

Container for connection properties specific to Azure. Structure is documented below.

CloudResource ConnectionCloudResourceArgs

Container for connection properties for delegation of access to GCP resources. Structure is documented below.

CloudSpanner ConnectionCloudSpannerArgs

Connection properties specific to Cloud Spanner Structure is documented below.

CloudSql ConnectionCloudSqlArgs

Connection properties specific to the Cloud SQL. Structure is documented below.

ConnectionId string

Optional connection id that should be assigned to the created connection.

Description string

A descriptive description for the connection

FriendlyName string

A descriptive name for the connection

Location string

The geographic location where the connection should reside. Cloud SQL instance must be in the same location as the connection with following exceptions: Cloud SQL us-central1 maps to BigQuery US, Cloud SQL europe-west1 maps to BigQuery EU. Examples: US, EU, asia-northeast1, us-central1, europe-west1. Spanner Connections same as spanner region AWS allowed regions are aws-us-east-1 Azure allowed regions are azure-eastus2

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

aws ConnectionAwsArgs

Connection properties specific to Amazon Web Services. Structure is documented below.

azure ConnectionAzureArgs

Container for connection properties specific to Azure. Structure is documented below.

cloudResource ConnectionCloudResourceArgs

Container for connection properties for delegation of access to GCP resources. Structure is documented below.

cloudSpanner ConnectionCloudSpannerArgs

Connection properties specific to Cloud Spanner Structure is documented below.

cloudSql ConnectionCloudSqlArgs

Connection properties specific to the Cloud SQL. Structure is documented below.

connectionId String

Optional connection id that should be assigned to the created connection.

description String

A descriptive description for the connection

friendlyName String

A descriptive name for the connection

location String

The geographic location where the connection should reside. Cloud SQL instance must be in the same location as the connection with following exceptions: Cloud SQL us-central1 maps to BigQuery US, Cloud SQL europe-west1 maps to BigQuery EU. Examples: US, EU, asia-northeast1, us-central1, europe-west1. Spanner Connections same as spanner region AWS allowed regions are aws-us-east-1 Azure allowed regions are azure-eastus2

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

aws ConnectionAwsArgs

Connection properties specific to Amazon Web Services. Structure is documented below.

azure ConnectionAzureArgs

Container for connection properties specific to Azure. Structure is documented below.

cloudResource ConnectionCloudResourceArgs

Container for connection properties for delegation of access to GCP resources. Structure is documented below.

cloudSpanner ConnectionCloudSpannerArgs

Connection properties specific to Cloud Spanner Structure is documented below.

cloudSql ConnectionCloudSqlArgs

Connection properties specific to the Cloud SQL. Structure is documented below.

connectionId string

Optional connection id that should be assigned to the created connection.

description string

A descriptive description for the connection

friendlyName string

A descriptive name for the connection

location string

The geographic location where the connection should reside. Cloud SQL instance must be in the same location as the connection with following exceptions: Cloud SQL us-central1 maps to BigQuery US, Cloud SQL europe-west1 maps to BigQuery EU. Examples: US, EU, asia-northeast1, us-central1, europe-west1. Spanner Connections same as spanner region AWS allowed regions are aws-us-east-1 Azure allowed regions are azure-eastus2

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

aws ConnectionAwsArgs

Connection properties specific to Amazon Web Services. Structure is documented below.

azure ConnectionAzureArgs

Container for connection properties specific to Azure. Structure is documented below.

cloud_resource ConnectionCloudResourceArgs

Container for connection properties for delegation of access to GCP resources. Structure is documented below.

cloud_spanner ConnectionCloudSpannerArgs

Connection properties specific to Cloud Spanner Structure is documented below.

cloud_sql ConnectionCloudSqlArgs

Connection properties specific to the Cloud SQL. Structure is documented below.

connection_id str

Optional connection id that should be assigned to the created connection.

description str

A descriptive description for the connection

friendly_name str

A descriptive name for the connection

location str

The geographic location where the connection should reside. Cloud SQL instance must be in the same location as the connection with following exceptions: Cloud SQL us-central1 maps to BigQuery US, Cloud SQL europe-west1 maps to BigQuery EU. Examples: US, EU, asia-northeast1, us-central1, europe-west1. Spanner Connections same as spanner region AWS allowed regions are aws-us-east-1 Azure allowed regions are azure-eastus2

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

aws Property Map

Connection properties specific to Amazon Web Services. Structure is documented below.

azure Property Map

Container for connection properties specific to Azure. Structure is documented below.

cloudResource Property Map

Container for connection properties for delegation of access to GCP resources. Structure is documented below.

cloudSpanner Property Map

Connection properties specific to Cloud Spanner Structure is documented below.

cloudSql Property Map

Connection properties specific to the Cloud SQL. Structure is documented below.

connectionId String

Optional connection id that should be assigned to the created connection.

description String

A descriptive description for the connection

friendlyName String

A descriptive name for the connection

location String

The geographic location where the connection should reside. Cloud SQL instance must be in the same location as the connection with following exceptions: Cloud SQL us-central1 maps to BigQuery US, Cloud SQL europe-west1 maps to BigQuery EU. Examples: US, EU, asia-northeast1, us-central1, europe-west1. Spanner Connections same as spanner region AWS allowed regions are aws-us-east-1 Azure allowed regions are azure-eastus2

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Outputs

All input properties are implicitly available as output properties. Additionally, the Connection resource produces the following output properties:

HasCredential bool

True if the connection has credential assigned.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The resource name of the connection in the form of: "projects/{project_id}/locations/{location_id}/connections/{connectionId}"

HasCredential bool

True if the connection has credential assigned.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The resource name of the connection in the form of: "projects/{project_id}/locations/{location_id}/connections/{connectionId}"

hasCredential Boolean

True if the connection has credential assigned.

id String

The provider-assigned unique ID for this managed resource.

name String

The resource name of the connection in the form of: "projects/{project_id}/locations/{location_id}/connections/{connectionId}"

hasCredential boolean

True if the connection has credential assigned.

id string

The provider-assigned unique ID for this managed resource.

name string

The resource name of the connection in the form of: "projects/{project_id}/locations/{location_id}/connections/{connectionId}"

has_credential bool

True if the connection has credential assigned.

id str

The provider-assigned unique ID for this managed resource.

name str

The resource name of the connection in the form of: "projects/{project_id}/locations/{location_id}/connections/{connectionId}"

hasCredential Boolean

True if the connection has credential assigned.

id String

The provider-assigned unique ID for this managed resource.

name String

The resource name of the connection in the form of: "projects/{project_id}/locations/{location_id}/connections/{connectionId}"

Look up Existing Connection Resource

Get an existing Connection resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ConnectionState, opts?: CustomResourceOptions): Connection
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws: Optional[ConnectionAwsArgs] = None,
        azure: Optional[ConnectionAzureArgs] = None,
        cloud_resource: Optional[ConnectionCloudResourceArgs] = None,
        cloud_spanner: Optional[ConnectionCloudSpannerArgs] = None,
        cloud_sql: Optional[ConnectionCloudSqlArgs] = None,
        connection_id: Optional[str] = None,
        description: Optional[str] = None,
        friendly_name: Optional[str] = None,
        has_credential: Optional[bool] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None) -> Connection
func GetConnection(ctx *Context, name string, id IDInput, state *ConnectionState, opts ...ResourceOption) (*Connection, error)
public static Connection Get(string name, Input<string> id, ConnectionState? state, CustomResourceOptions? opts = null)
public static Connection get(String name, Output<String> id, ConnectionState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Aws ConnectionAwsArgs

Connection properties specific to Amazon Web Services. Structure is documented below.

Azure ConnectionAzureArgs

Container for connection properties specific to Azure. Structure is documented below.

CloudResource ConnectionCloudResourceArgs

Container for connection properties for delegation of access to GCP resources. Structure is documented below.

CloudSpanner ConnectionCloudSpannerArgs

Connection properties specific to Cloud Spanner Structure is documented below.

CloudSql ConnectionCloudSqlArgs

Connection properties specific to the Cloud SQL. Structure is documented below.

ConnectionId string

Optional connection id that should be assigned to the created connection.

Description string

A descriptive description for the connection

FriendlyName string

A descriptive name for the connection

HasCredential bool

True if the connection has credential assigned.

Location string

The geographic location where the connection should reside. Cloud SQL instance must be in the same location as the connection with following exceptions: Cloud SQL us-central1 maps to BigQuery US, Cloud SQL europe-west1 maps to BigQuery EU. Examples: US, EU, asia-northeast1, us-central1, europe-west1. Spanner Connections same as spanner region AWS allowed regions are aws-us-east-1 Azure allowed regions are azure-eastus2

Name string

The resource name of the connection in the form of: "projects/{project_id}/locations/{location_id}/connections/{connectionId}"

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Aws ConnectionAwsArgs

Connection properties specific to Amazon Web Services. Structure is documented below.

Azure ConnectionAzureArgs

Container for connection properties specific to Azure. Structure is documented below.

CloudResource ConnectionCloudResourceArgs

Container for connection properties for delegation of access to GCP resources. Structure is documented below.

CloudSpanner ConnectionCloudSpannerArgs

Connection properties specific to Cloud Spanner Structure is documented below.

CloudSql ConnectionCloudSqlArgs

Connection properties specific to the Cloud SQL. Structure is documented below.

ConnectionId string

Optional connection id that should be assigned to the created connection.

Description string

A descriptive description for the connection

FriendlyName string

A descriptive name for the connection

HasCredential bool

True if the connection has credential assigned.

Location string

The geographic location where the connection should reside. Cloud SQL instance must be in the same location as the connection with following exceptions: Cloud SQL us-central1 maps to BigQuery US, Cloud SQL europe-west1 maps to BigQuery EU. Examples: US, EU, asia-northeast1, us-central1, europe-west1. Spanner Connections same as spanner region AWS allowed regions are aws-us-east-1 Azure allowed regions are azure-eastus2

Name string

The resource name of the connection in the form of: "projects/{project_id}/locations/{location_id}/connections/{connectionId}"

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

aws ConnectionAwsArgs

Connection properties specific to Amazon Web Services. Structure is documented below.

azure ConnectionAzureArgs

Container for connection properties specific to Azure. Structure is documented below.

cloudResource ConnectionCloudResourceArgs

Container for connection properties for delegation of access to GCP resources. Structure is documented below.

cloudSpanner ConnectionCloudSpannerArgs

Connection properties specific to Cloud Spanner Structure is documented below.

cloudSql ConnectionCloudSqlArgs

Connection properties specific to the Cloud SQL. Structure is documented below.

connectionId String

Optional connection id that should be assigned to the created connection.

description String

A descriptive description for the connection

friendlyName String

A descriptive name for the connection

hasCredential Boolean

True if the connection has credential assigned.

location String

The geographic location where the connection should reside. Cloud SQL instance must be in the same location as the connection with following exceptions: Cloud SQL us-central1 maps to BigQuery US, Cloud SQL europe-west1 maps to BigQuery EU. Examples: US, EU, asia-northeast1, us-central1, europe-west1. Spanner Connections same as spanner region AWS allowed regions are aws-us-east-1 Azure allowed regions are azure-eastus2

name String

The resource name of the connection in the form of: "projects/{project_id}/locations/{location_id}/connections/{connectionId}"

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

aws ConnectionAwsArgs

Connection properties specific to Amazon Web Services. Structure is documented below.

azure ConnectionAzureArgs

Container for connection properties specific to Azure. Structure is documented below.

cloudResource ConnectionCloudResourceArgs

Container for connection properties for delegation of access to GCP resources. Structure is documented below.

cloudSpanner ConnectionCloudSpannerArgs

Connection properties specific to Cloud Spanner Structure is documented below.

cloudSql ConnectionCloudSqlArgs

Connection properties specific to the Cloud SQL. Structure is documented below.

connectionId string

Optional connection id that should be assigned to the created connection.

description string

A descriptive description for the connection

friendlyName string

A descriptive name for the connection

hasCredential boolean

True if the connection has credential assigned.

location string

The geographic location where the connection should reside. Cloud SQL instance must be in the same location as the connection with following exceptions: Cloud SQL us-central1 maps to BigQuery US, Cloud SQL europe-west1 maps to BigQuery EU. Examples: US, EU, asia-northeast1, us-central1, europe-west1. Spanner Connections same as spanner region AWS allowed regions are aws-us-east-1 Azure allowed regions are azure-eastus2

name string

The resource name of the connection in the form of: "projects/{project_id}/locations/{location_id}/connections/{connectionId}"

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

aws ConnectionAwsArgs

Connection properties specific to Amazon Web Services. Structure is documented below.

azure ConnectionAzureArgs

Container for connection properties specific to Azure. Structure is documented below.

cloud_resource ConnectionCloudResourceArgs

Container for connection properties for delegation of access to GCP resources. Structure is documented below.

cloud_spanner ConnectionCloudSpannerArgs

Connection properties specific to Cloud Spanner Structure is documented below.

cloud_sql ConnectionCloudSqlArgs

Connection properties specific to the Cloud SQL. Structure is documented below.

connection_id str

Optional connection id that should be assigned to the created connection.

description str

A descriptive description for the connection

friendly_name str

A descriptive name for the connection

has_credential bool

True if the connection has credential assigned.

location str

The geographic location where the connection should reside. Cloud SQL instance must be in the same location as the connection with following exceptions: Cloud SQL us-central1 maps to BigQuery US, Cloud SQL europe-west1 maps to BigQuery EU. Examples: US, EU, asia-northeast1, us-central1, europe-west1. Spanner Connections same as spanner region AWS allowed regions are aws-us-east-1 Azure allowed regions are azure-eastus2

name str

The resource name of the connection in the form of: "projects/{project_id}/locations/{location_id}/connections/{connectionId}"

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

aws Property Map

Connection properties specific to Amazon Web Services. Structure is documented below.

azure Property Map

Container for connection properties specific to Azure. Structure is documented below.

cloudResource Property Map

Container for connection properties for delegation of access to GCP resources. Structure is documented below.

cloudSpanner Property Map

Connection properties specific to Cloud Spanner Structure is documented below.

cloudSql Property Map

Connection properties specific to the Cloud SQL. Structure is documented below.

connectionId String

Optional connection id that should be assigned to the created connection.

description String

A descriptive description for the connection

friendlyName String

A descriptive name for the connection

hasCredential Boolean

True if the connection has credential assigned.

location String

The geographic location where the connection should reside. Cloud SQL instance must be in the same location as the connection with following exceptions: Cloud SQL us-central1 maps to BigQuery US, Cloud SQL europe-west1 maps to BigQuery EU. Examples: US, EU, asia-northeast1, us-central1, europe-west1. Spanner Connections same as spanner region AWS allowed regions are aws-us-east-1 Azure allowed regions are azure-eastus2

name String

The resource name of the connection in the form of: "projects/{project_id}/locations/{location_id}/connections/{connectionId}"

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Supporting Types

ConnectionAws

AccessRole ConnectionAwsAccessRole

Authentication using Google owned service account to assume into customer's AWS IAM Role. Structure is documented below.

AccessRole ConnectionAwsAccessRole

Authentication using Google owned service account to assume into customer's AWS IAM Role. Structure is documented below.

accessRole ConnectionAwsAccessRole

Authentication using Google owned service account to assume into customer's AWS IAM Role. Structure is documented below.

accessRole ConnectionAwsAccessRole

Authentication using Google owned service account to assume into customer's AWS IAM Role. Structure is documented below.

access_role ConnectionAwsAccessRole

Authentication using Google owned service account to assume into customer's AWS IAM Role. Structure is documented below.

accessRole Property Map

Authentication using Google owned service account to assume into customer's AWS IAM Role. Structure is documented below.

ConnectionAwsAccessRole

IamRoleId string

The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection.

Identity string

(Output) A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's AWS IAM Role.

IamRoleId string

The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection.

Identity string

(Output) A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's AWS IAM Role.

iamRoleId String

The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection.

identity String

(Output) A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's AWS IAM Role.

iamRoleId string

The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection.

identity string

(Output) A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's AWS IAM Role.

iam_role_id str

The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection.

identity str

(Output) A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's AWS IAM Role.

iamRoleId String

The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection.

identity String

(Output) A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's AWS IAM Role.

ConnectionAzure

CustomerTenantId string

The id of customer's directory that host the data.

Application string

(Output) The name of the Azure Active Directory Application.

ClientId string

(Output) The client id of the Azure Active Directory Application.

FederatedApplicationClientId string

The Azure Application (client) ID where the federated credentials will be hosted.

Identity string

(Output) A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's Azure Active Directory Application.

ObjectId string

(Output) The object id of the Azure Active Directory Application.

RedirectUri string

(Output) The URL user will be redirected to after granting consent during connection setup.

CustomerTenantId string

The id of customer's directory that host the data.

Application string

(Output) The name of the Azure Active Directory Application.

ClientId string

(Output) The client id of the Azure Active Directory Application.

FederatedApplicationClientId string

The Azure Application (client) ID where the federated credentials will be hosted.

Identity string

(Output) A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's Azure Active Directory Application.

ObjectId string

(Output) The object id of the Azure Active Directory Application.

RedirectUri string

(Output) The URL user will be redirected to after granting consent during connection setup.

customerTenantId String

The id of customer's directory that host the data.

application String

(Output) The name of the Azure Active Directory Application.

clientId String

(Output) The client id of the Azure Active Directory Application.

federatedApplicationClientId String

The Azure Application (client) ID where the federated credentials will be hosted.

identity String

(Output) A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's Azure Active Directory Application.

objectId String

(Output) The object id of the Azure Active Directory Application.

redirectUri String

(Output) The URL user will be redirected to after granting consent during connection setup.

customerTenantId string

The id of customer's directory that host the data.

application string

(Output) The name of the Azure Active Directory Application.

clientId string

(Output) The client id of the Azure Active Directory Application.

federatedApplicationClientId string

The Azure Application (client) ID where the federated credentials will be hosted.

identity string

(Output) A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's Azure Active Directory Application.

objectId string

(Output) The object id of the Azure Active Directory Application.

redirectUri string

(Output) The URL user will be redirected to after granting consent during connection setup.

customer_tenant_id str

The id of customer's directory that host the data.

application str

(Output) The name of the Azure Active Directory Application.

client_id str

(Output) The client id of the Azure Active Directory Application.

federated_application_client_id str

The Azure Application (client) ID where the federated credentials will be hosted.

identity str

(Output) A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's Azure Active Directory Application.

object_id str

(Output) The object id of the Azure Active Directory Application.

redirect_uri str

(Output) The URL user will be redirected to after granting consent during connection setup.

customerTenantId String

The id of customer's directory that host the data.

application String

(Output) The name of the Azure Active Directory Application.

clientId String

(Output) The client id of the Azure Active Directory Application.

federatedApplicationClientId String

The Azure Application (client) ID where the federated credentials will be hosted.

identity String

(Output) A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's Azure Active Directory Application.

objectId String

(Output) The object id of the Azure Active Directory Application.

redirectUri String

(Output) The URL user will be redirected to after granting consent during connection setup.

ConnectionCloudResource

ServiceAccountId string

(Output) The account ID of the service created for the purpose of this connection.

ServiceAccountId string

(Output) The account ID of the service created for the purpose of this connection.

serviceAccountId String

(Output) The account ID of the service created for the purpose of this connection.

serviceAccountId string

(Output) The account ID of the service created for the purpose of this connection.

service_account_id str

(Output) The account ID of the service created for the purpose of this connection.

serviceAccountId String

(Output) The account ID of the service created for the purpose of this connection.

ConnectionCloudSpanner

Database string

Cloud Spanner database in the form `project/instance/database'

UseParallelism bool

If parallelism should be used when reading from Cloud Spanner

UseServerlessAnalytics bool

If the serverless analytics service should be used to read data from Cloud Spanner. useParallelism must be set when using serverless analytics

Database string

Cloud Spanner database in the form `project/instance/database'

UseParallelism bool

If parallelism should be used when reading from Cloud Spanner

UseServerlessAnalytics bool

If the serverless analytics service should be used to read data from Cloud Spanner. useParallelism must be set when using serverless analytics

database String

Cloud Spanner database in the form `project/instance/database'

useParallelism Boolean

If parallelism should be used when reading from Cloud Spanner

useServerlessAnalytics Boolean

If the serverless analytics service should be used to read data from Cloud Spanner. useParallelism must be set when using serverless analytics

database string

Cloud Spanner database in the form `project/instance/database'

useParallelism boolean

If parallelism should be used when reading from Cloud Spanner

useServerlessAnalytics boolean

If the serverless analytics service should be used to read data from Cloud Spanner. useParallelism must be set when using serverless analytics

database str

Cloud Spanner database in the form `project/instance/database'

use_parallelism bool

If parallelism should be used when reading from Cloud Spanner

use_serverless_analytics bool

If the serverless analytics service should be used to read data from Cloud Spanner. useParallelism must be set when using serverless analytics

database String

Cloud Spanner database in the form `project/instance/database'

useParallelism Boolean

If parallelism should be used when reading from Cloud Spanner

useServerlessAnalytics Boolean

If the serverless analytics service should be used to read data from Cloud Spanner. useParallelism must be set when using serverless analytics

ConnectionCloudSql

Credential ConnectionCloudSqlCredential

Cloud SQL properties. Structure is documented below.

Database string

Database name.

InstanceId string

Cloud SQL instance ID in the form project:location:instance.

Type string

Type of the Cloud SQL database. Possible values are DATABASE_TYPE_UNSPECIFIED, POSTGRES, and MYSQL.

ServiceAccountId string

(Output) When the connection is used in the context of an operation in BigQuery, this service account will serve as the identity being used for connecting to the CloudSQL instance specified in this connection.

Credential ConnectionCloudSqlCredential

Cloud SQL properties. Structure is documented below.

Database string

Database name.

InstanceId string

Cloud SQL instance ID in the form project:location:instance.

Type string

Type of the Cloud SQL database. Possible values are DATABASE_TYPE_UNSPECIFIED, POSTGRES, and MYSQL.

ServiceAccountId string

(Output) When the connection is used in the context of an operation in BigQuery, this service account will serve as the identity being used for connecting to the CloudSQL instance specified in this connection.

credential ConnectionCloudSqlCredential

Cloud SQL properties. Structure is documented below.

database String

Database name.

instanceId String

Cloud SQL instance ID in the form project:location:instance.

type String

Type of the Cloud SQL database. Possible values are DATABASE_TYPE_UNSPECIFIED, POSTGRES, and MYSQL.

serviceAccountId String

(Output) When the connection is used in the context of an operation in BigQuery, this service account will serve as the identity being used for connecting to the CloudSQL instance specified in this connection.

credential ConnectionCloudSqlCredential

Cloud SQL properties. Structure is documented below.

database string

Database name.

instanceId string

Cloud SQL instance ID in the form project:location:instance.

type string

Type of the Cloud SQL database. Possible values are DATABASE_TYPE_UNSPECIFIED, POSTGRES, and MYSQL.

serviceAccountId string

(Output) When the connection is used in the context of an operation in BigQuery, this service account will serve as the identity being used for connecting to the CloudSQL instance specified in this connection.

credential ConnectionCloudSqlCredential

Cloud SQL properties. Structure is documented below.

database str

Database name.

instance_id str

Cloud SQL instance ID in the form project:location:instance.

type str

Type of the Cloud SQL database. Possible values are DATABASE_TYPE_UNSPECIFIED, POSTGRES, and MYSQL.

service_account_id str

(Output) When the connection is used in the context of an operation in BigQuery, this service account will serve as the identity being used for connecting to the CloudSQL instance specified in this connection.

credential Property Map

Cloud SQL properties. Structure is documented below.

database String

Database name.

instanceId String

Cloud SQL instance ID in the form project:location:instance.

type String

Type of the Cloud SQL database. Possible values are DATABASE_TYPE_UNSPECIFIED, POSTGRES, and MYSQL.

serviceAccountId String

(Output) When the connection is used in the context of an operation in BigQuery, this service account will serve as the identity being used for connecting to the CloudSQL instance specified in this connection.

ConnectionCloudSqlCredential

Password string

Password for database. Note: This property is sensitive and will not be displayed in the plan.

Username string

Username for database.

Password string

Password for database. Note: This property is sensitive and will not be displayed in the plan.

Username string

Username for database.

password String

Password for database. Note: This property is sensitive and will not be displayed in the plan.

username String

Username for database.

password string

Password for database. Note: This property is sensitive and will not be displayed in the plan.

username string

Username for database.

password str

Password for database. Note: This property is sensitive and will not be displayed in the plan.

username str

Username for database.

password String

Password for database. Note: This property is sensitive and will not be displayed in the plan.

username String

Username for database.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes

This Pulumi package is based on the google-beta Terraform Provider.