Connection

A connection allows BigQuery connections to external data sources..

To get more information about Connection, see:

API documentation
How-to Guides
- Cloud SQL federated queries

Warning: All arguments including cloud_sql.credential.password will be stored in the raw state as plain-text. Read more about sensitive data in state.

Create a Connection Resource

new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);

def Connection(resource_name, opts=None, cloud_sql=None, connection_id=None, description=None, friendly_name=None, location=None, project=None, __props__=None);

func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)

public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Connection Resource Properties

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

Inputs

The Connection resource accepts the following input properties:

CloudSql ConnectionCloudSqlArgs: Cloud SQL properties. 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. The default value is US.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

CloudSql ConnectionCloudSql: Cloud SQL properties. 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. The default value is US.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

cloudSql ConnectionCloudSql: Cloud SQL properties. 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. The default value is US.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

cloud_sql Dict[ConnectionCloudSql]: Cloud SQL properties. 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. The default value is US.
project str: 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}”

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}”

Look up an 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

static get(resource_name, id, opts=None, cloud_sql=None, connection_id=None, description=None, friendly_name=None, has_credential=None, location=None, name=None, project=None, __props__=None);

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)

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.

The following state arguments are supported:

CloudSql ConnectionCloudSqlArgs: Cloud SQL properties. 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. The default value is US.
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.

CloudSql ConnectionCloudSql: Cloud SQL properties. 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. The default value is US.
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.

cloudSql ConnectionCloudSql: Cloud SQL properties. 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. The default value is US.
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.

cloud_sql Dict[ConnectionCloudSql]: Cloud SQL properties. 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. The default value is US.
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.

Supporting Types

ConnectionCloudSql

See the input and output API doc for this type.

Credential ConnectionCloudSqlCredentialArgs: 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.

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.

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.

credential Dict[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.

ConnectionCloudSqlCredential

See the input and output API doc for this type.

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.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud