Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.bigqueryconnection/v1beta1.Connection
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Creates a new connection.
Create Connection Resource
new Connection(name: string, args?: ConnectionArgs, opts?: CustomResourceOptions);
@overload
def Connection(resource_name: str,
opts: Optional[ResourceOptions] = None,
cloud_sql: Optional[CloudSqlPropertiesArgs] = None,
connection_id: Optional[str] = None,
description: Optional[str] = None,
friendly_name: Optional[str] = None,
location: Optional[str] = None,
name: 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: google-native:bigqueryconnection/v1beta1: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:
- Cloud
Sql Pulumi.Google Native. Big Query Connection. V1Beta1. Inputs. Cloud Sql Properties Args Cloud SQL properties.
- Connection
Id string Optional. Connection id that should be assigned to the created connection.
- Description string
User provided description.
- Friendly
Name string User provided display name for the connection.
- Location string
- Name string
The resource name of the connection in the form of:
projects/{project_id}/locations/{location_id}/connections/{connection_id}
- Project string
- Cloud
Sql CloudSql Properties Args Cloud SQL properties.
- Connection
Id string Optional. Connection id that should be assigned to the created connection.
- Description string
User provided description.
- Friendly
Name string User provided display name for the connection.
- Location string
- Name string
The resource name of the connection in the form of:
projects/{project_id}/locations/{location_id}/connections/{connection_id}
- Project string
- cloud
Sql CloudSql Properties Args Cloud SQL properties.
- connection
Id String Optional. Connection id that should be assigned to the created connection.
- description String
User provided description.
- friendly
Name String User provided display name for the connection.
- location String
- name String
The resource name of the connection in the form of:
projects/{project_id}/locations/{location_id}/connections/{connection_id}
- project String
- cloud
Sql CloudSql Properties Args Cloud SQL properties.
- connection
Id string Optional. Connection id that should be assigned to the created connection.
- description string
User provided description.
- friendly
Name string User provided display name for the connection.
- location string
- name string
The resource name of the connection in the form of:
projects/{project_id}/locations/{location_id}/connections/{connection_id}
- project string
- cloud_
sql CloudSql Properties Args Cloud SQL properties.
- connection_
id str Optional. Connection id that should be assigned to the created connection.
- description str
User provided description.
- friendly_
name str User provided display name for the connection.
- location str
- name str
The resource name of the connection in the form of:
projects/{project_id}/locations/{location_id}/connections/{connection_id}
- project str
- cloud
Sql Property Map Cloud SQL properties.
- connection
Id String Optional. Connection id that should be assigned to the created connection.
- description String
User provided description.
- friendly
Name String User provided display name for the connection.
- location String
- name String
The resource name of the connection in the form of:
projects/{project_id}/locations/{location_id}/connections/{connection_id}
- project String
Outputs
All input properties are implicitly available as output properties. Additionally, the Connection resource produces the following output properties:
- Creation
Time string The creation timestamp of the connection.
- Has
Credential bool True, if credential is configured for this connection.
- Id string
The provider-assigned unique ID for this managed resource.
- Last
Modified stringTime The last update timestamp of the connection.
- Creation
Time string The creation timestamp of the connection.
- Has
Credential bool True, if credential is configured for this connection.
- Id string
The provider-assigned unique ID for this managed resource.
- Last
Modified stringTime The last update timestamp of the connection.
- creation
Time String The creation timestamp of the connection.
- has
Credential Boolean True, if credential is configured for this connection.
- id String
The provider-assigned unique ID for this managed resource.
- last
Modified StringTime The last update timestamp of the connection.
- creation
Time string The creation timestamp of the connection.
- has
Credential boolean True, if credential is configured for this connection.
- id string
The provider-assigned unique ID for this managed resource.
- last
Modified stringTime The last update timestamp of the connection.
- creation_
time str The creation timestamp of the connection.
- has_
credential bool True, if credential is configured for this connection.
- id str
The provider-assigned unique ID for this managed resource.
- last_
modified_ strtime The last update timestamp of the connection.
- creation
Time String The creation timestamp of the connection.
- has
Credential Boolean True, if credential is configured for this connection.
- id String
The provider-assigned unique ID for this managed resource.
- last
Modified StringTime The last update timestamp of the connection.
Supporting Types
CloudSqlCredential
CloudSqlCredentialResponse
CloudSqlProperties
- Credential
Pulumi.
Google Native. Big Query Connection. V1Beta1. Inputs. Cloud Sql Credential Input only. Cloud SQL credential.
- Database string
Database name.
- Instance
Id string Cloud SQL instance ID in the form
project:location:instance
.- Type
Pulumi.
Google Native. Big Query Connection. V1Beta1. Cloud Sql Properties Type Type of the Cloud SQL database.
- Credential
Cloud
Sql Credential Input only. Cloud SQL credential.
- Database string
Database name.
- Instance
Id string Cloud SQL instance ID in the form
project:location:instance
.- Type
Cloud
Sql Properties Type Type of the Cloud SQL database.
- credential
Cloud
Sql Credential Input only. Cloud SQL credential.
- database String
Database name.
- instance
Id String Cloud SQL instance ID in the form
project:location:instance
.- type
Cloud
Sql Properties Type Type of the Cloud SQL database.
- credential
Cloud
Sql Credential Input only. Cloud SQL credential.
- database string
Database name.
- instance
Id string Cloud SQL instance ID in the form
project:location:instance
.- type
Cloud
Sql Properties Type Type of the Cloud SQL database.
- credential
Cloud
Sql Credential Input only. Cloud SQL credential.
- database str
Database name.
- instance_
id str Cloud SQL instance ID in the form
project:location:instance
.- type
Cloud
Sql Properties Type Type of the Cloud SQL database.
- credential Property Map
Input only. Cloud SQL credential.
- database String
Database name.
- instance
Id String Cloud SQL instance ID in the form
project:location:instance
.- type "DATABASE_TYPE_UNSPECIFIED" | "POSTGRES" | "MYSQL"
Type of the Cloud SQL database.
CloudSqlPropertiesResponse
- Credential
Pulumi.
Google Native. Big Query Connection. V1Beta1. Inputs. Cloud Sql Credential Response Input only. Cloud SQL credential.
- Database string
Database name.
- Instance
Id string Cloud SQL instance ID in the form
project:location:instance
.- Service
Account stringId The account ID of the service used for the purpose of this connection. 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.
- Type string
Type of the Cloud SQL database.
- Credential
Cloud
Sql Credential Response Input only. Cloud SQL credential.
- Database string
Database name.
- Instance
Id string Cloud SQL instance ID in the form
project:location:instance
.- Service
Account stringId The account ID of the service used for the purpose of this connection. 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.
- Type string
Type of the Cloud SQL database.
- credential
Cloud
Sql Credential Response Input only. Cloud SQL credential.
- database String
Database name.
- instance
Id String Cloud SQL instance ID in the form
project:location:instance
.- service
Account StringId The account ID of the service used for the purpose of this connection. 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.
- type String
Type of the Cloud SQL database.
- credential
Cloud
Sql Credential Response Input only. Cloud SQL credential.
- database string
Database name.
- instance
Id string Cloud SQL instance ID in the form
project:location:instance
.- service
Account stringId The account ID of the service used for the purpose of this connection. 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.
- type string
Type of the Cloud SQL database.
- credential
Cloud
Sql Credential Response Input only. Cloud SQL credential.
- database str
Database name.
- instance_
id str Cloud SQL instance ID in the form
project:location:instance
.- service_
account_ strid The account ID of the service used for the purpose of this connection. 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.
- type str
Type of the Cloud SQL database.
- credential Property Map
Input only. Cloud SQL credential.
- database String
Database name.
- instance
Id String Cloud SQL instance ID in the form
project:location:instance
.- service
Account StringId The account ID of the service used for the purpose of this connection. 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.
- type String
Type of the Cloud SQL database.
CloudSqlPropertiesType
- Database
Type Unspecified - DATABASE_TYPE_UNSPECIFIED
Unspecified database type.
- Postgres
- POSTGRES
Cloud SQL for PostgreSQL.
- Mysql
- MYSQL
Cloud SQL for MySQL.
- Cloud
Sql Properties Type Database Type Unspecified - DATABASE_TYPE_UNSPECIFIED
Unspecified database type.
- Cloud
Sql Properties Type Postgres - POSTGRES
Cloud SQL for PostgreSQL.
- Cloud
Sql Properties Type Mysql - MYSQL
Cloud SQL for MySQL.
- Database
Type Unspecified - DATABASE_TYPE_UNSPECIFIED
Unspecified database type.
- Postgres
- POSTGRES
Cloud SQL for PostgreSQL.
- Mysql
- MYSQL
Cloud SQL for MySQL.
- Database
Type Unspecified - DATABASE_TYPE_UNSPECIFIED
Unspecified database type.
- Postgres
- POSTGRES
Cloud SQL for PostgreSQL.
- Mysql
- MYSQL
Cloud SQL for MySQL.
- DATABASE_TYPE_UNSPECIFIED
- DATABASE_TYPE_UNSPECIFIED
Unspecified database type.
- POSTGRES
- POSTGRES
Cloud SQL for PostgreSQL.
- MYSQL
- MYSQL
Cloud SQL for MySQL.
- "DATABASE_TYPE_UNSPECIFIED"
- DATABASE_TYPE_UNSPECIFIED
Unspecified database type.
- "POSTGRES"
- POSTGRES
Cloud SQL for PostgreSQL.
- "MYSQL"
- MYSQL
Cloud SQL for MySQL.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.