Class 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.

Inheritance

System.Object

Resource

CustomResource

Connection

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.BigQuery

Assembly: Pulumi.Gcp.dll

Syntax

public class Connection : CustomResource

Constructors

Connection(String, ConnectionArgs, CustomResourceOptions)

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

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ConnectionArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

CloudSql

Cloud SQL properties. Structure is documented below.

Declaration

public Output<ConnectionCloudSql> CloudSql { get; }

Property Value

Type	Description
Output<ConnectionCloudSql>

ConnectionId

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

Declaration

public Output<string> ConnectionId { get; }

Property Value

Type	Description
Output<System.String>

Description

A descriptive description for the connection

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

FriendlyName

A descriptive name for the connection

Declaration

public Output<string> FriendlyName { get; }

Property Value

Type	Description
Output<System.String>

HasCredential

True if the connection has credential assigned.

Declaration

public Output<bool> HasCredential { get; }

Property Value

Type	Description
Output<System.Boolean>

Location

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.

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

Name

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

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Project

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

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ConnectionState, CustomResourceOptions)

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

Declaration

public static Connection Get(string name, Input<string> id, ConnectionState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ConnectionState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Connection