Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. bigqueryconnection
  5. bigqueryconnection/v1beta1
  6. Connection

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.bigqueryconnection/v1beta1.Connection

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Creates a new connection.

Create Connection Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Connection(name: string, args?: ConnectionArgs, opts?: CustomResourceOptions);
@overload
def Connection(resource_name: str,
               args: Optional[ConnectionArgs] = None,
               opts: Optional[ResourceOptions] = None)

@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)
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.

Parameters

name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
The unique name of the resource.
args This property is required. ConnectionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var google_nativeConnectionResource = new GoogleNative.BigQueryConnection.V1Beta1.Connection("google-nativeConnectionResource", new()
{
    CloudSql = new GoogleNative.BigQueryConnection.V1Beta1.Inputs.CloudSqlPropertiesArgs
    {
        Credential = new GoogleNative.BigQueryConnection.V1Beta1.Inputs.CloudSqlCredentialArgs
        {
            Password = "string",
            Username = "string",
        },
        Database = "string",
        InstanceId = "string",
        Type = GoogleNative.BigQueryConnection.V1Beta1.CloudSqlPropertiesType.DatabaseTypeUnspecified,
    },
    ConnectionId = "string",
    Description = "string",
    FriendlyName = "string",
    Location = "string",
    Name = "string",
    Project = "string",
});
Copy
example, err := bigqueryconnection.NewConnection(ctx, "google-nativeConnectionResource", &bigqueryconnection.ConnectionArgs{
	CloudSql: &bigqueryconnection.CloudSqlPropertiesArgs{
		Credential: &bigqueryconnection.CloudSqlCredentialArgs{
			Password: pulumi.String("string"),
			Username: pulumi.String("string"),
		},
		Database:   pulumi.String("string"),
		InstanceId: pulumi.String("string"),
		Type:       bigqueryconnection.CloudSqlPropertiesTypeDatabaseTypeUnspecified,
	},
	ConnectionId: pulumi.String("string"),
	Description:  pulumi.String("string"),
	FriendlyName: pulumi.String("string"),
	Location:     pulumi.String("string"),
	Name:         pulumi.String("string"),
	Project:      pulumi.String("string"),
})
Copy
var google_nativeConnectionResource = new Connection("google-nativeConnectionResource", ConnectionArgs.builder()
    .cloudSql(CloudSqlPropertiesArgs.builder()
        .credential(CloudSqlCredentialArgs.builder()
            .password("string")
            .username("string")
            .build())
        .database("string")
        .instanceId("string")
        .type("DATABASE_TYPE_UNSPECIFIED")
        .build())
    .connectionId("string")
    .description("string")
    .friendlyName("string")
    .location("string")
    .name("string")
    .project("string")
    .build());
Copy
google_native_connection_resource = google_native.bigqueryconnection.v1beta1.Connection("google-nativeConnectionResource",
    cloud_sql={
        "credential": {
            "password": "string",
            "username": "string",
        },
        "database": "string",
        "instance_id": "string",
        "type": google_native.bigqueryconnection.v1beta1.CloudSqlPropertiesType.DATABASE_TYPE_UNSPECIFIED,
    },
    connection_id="string",
    description="string",
    friendly_name="string",
    location="string",
    name="string",
    project="string")
Copy
const google_nativeConnectionResource = new google_native.bigqueryconnection.v1beta1.Connection("google-nativeConnectionResource", {
    cloudSql: {
        credential: {
            password: "string",
            username: "string",
        },
        database: "string",
        instanceId: "string",
        type: google_native.bigqueryconnection.v1beta1.CloudSqlPropertiesType.DatabaseTypeUnspecified,
    },
    connectionId: "string",
    description: "string",
    friendlyName: "string",
    location: "string",
    name: "string",
    project: "string",
});
Copy
type: google-native:bigqueryconnection/v1beta1:Connection
properties:
    cloudSql:
        credential:
            password: string
            username: string
        database: string
        instanceId: string
        type: DATABASE_TYPE_UNSPECIFIED
    connectionId: string
    description: string
    friendlyName: string
    location: string
    name: string
    project: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Connection resource accepts the following input properties:

CloudSql Pulumi.GoogleNative.BigQueryConnection.V1Beta1.Inputs.CloudSqlProperties
Cloud SQL properties.
ConnectionId string
Optional. Connection id that should be assigned to the created connection.
Description string
User provided description.
FriendlyName string
User provided display name for the connection.
Location Changes to this property will trigger replacement. string
Name string
The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}
Project Changes to this property will trigger replacement. string
CloudSql CloudSqlPropertiesArgs
Cloud SQL properties.
ConnectionId string
Optional. Connection id that should be assigned to the created connection.
Description string
User provided description.
FriendlyName string
User provided display name for the connection.
Location Changes to this property will trigger replacement. string
Name string
The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}
Project Changes to this property will trigger replacement. string
cloudSql CloudSqlProperties
Cloud SQL properties.
connectionId String
Optional. Connection id that should be assigned to the created connection.
description String
User provided description.
friendlyName String
User provided display name for the connection.
location Changes to this property will trigger replacement. String
name String
The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}
project Changes to this property will trigger replacement. String
cloudSql CloudSqlProperties
Cloud SQL properties.
connectionId string
Optional. Connection id that should be assigned to the created connection.
description string
User provided description.
friendlyName string
User provided display name for the connection.
location Changes to this property will trigger replacement. string
name string
The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}
project Changes to this property will trigger replacement. string
cloud_sql CloudSqlPropertiesArgs
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 Changes to this property will trigger replacement. str
name str
The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}
project Changes to this property will trigger replacement. str
cloudSql Property Map
Cloud SQL properties.
connectionId String
Optional. Connection id that should be assigned to the created connection.
description String
User provided description.
friendlyName String
User provided display name for the connection.
location Changes to this property will trigger replacement. String
name String
The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}
project Changes to this property will trigger replacement. String

Outputs

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

CreationTime string
The creation timestamp of the connection.
HasCredential bool
True, if credential is configured for this connection.
Id string
The provider-assigned unique ID for this managed resource.
LastModifiedTime string
The last update timestamp of the connection.
CreationTime string
The creation timestamp of the connection.
HasCredential bool
True, if credential is configured for this connection.
Id string
The provider-assigned unique ID for this managed resource.
LastModifiedTime string
The last update timestamp of the connection.
creationTime String
The creation timestamp of the connection.
hasCredential Boolean
True, if credential is configured for this connection.
id String
The provider-assigned unique ID for this managed resource.
lastModifiedTime String
The last update timestamp of the connection.
creationTime string
The creation timestamp of the connection.
hasCredential boolean
True, if credential is configured for this connection.
id string
The provider-assigned unique ID for this managed resource.
lastModifiedTime string
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_time str
The last update timestamp of the connection.
creationTime String
The creation timestamp of the connection.
hasCredential Boolean
True, if credential is configured for this connection.
id String
The provider-assigned unique ID for this managed resource.
lastModifiedTime String
The last update timestamp of the connection.

Supporting Types

CloudSqlCredential
, CloudSqlCredentialArgs

Password string
The password for the credential.
Username string
The username for the credential.
Password string
The password for the credential.
Username string
The username for the credential.
password String
The password for the credential.
username String
The username for the credential.
password string
The password for the credential.
username string
The username for the credential.
password str
The password for the credential.
username str
The username for the credential.
password String
The password for the credential.
username String
The username for the credential.

CloudSqlCredentialResponse
, CloudSqlCredentialResponseArgs

Password This property is required. string
The password for the credential.
Username This property is required. string
The username for the credential.
Password This property is required. string
The password for the credential.
Username This property is required. string
The username for the credential.
password This property is required. String
The password for the credential.
username This property is required. String
The username for the credential.
password This property is required. string
The password for the credential.
username This property is required. string
The username for the credential.
password This property is required. str
The password for the credential.
username This property is required. str
The username for the credential.
password This property is required. String
The password for the credential.
username This property is required. String
The username for the credential.

CloudSqlProperties
, CloudSqlPropertiesArgs

Credential Pulumi.GoogleNative.BigQueryConnection.V1Beta1.Inputs.CloudSqlCredential
Input only. Cloud SQL credential.
Database string
Database name.
InstanceId string
Cloud SQL instance ID in the form project:location:instance.
Type Pulumi.GoogleNative.BigQueryConnection.V1Beta1.CloudSqlPropertiesType
Type of the Cloud SQL database.
Credential CloudSqlCredential
Input only. Cloud SQL credential.
Database string
Database name.
InstanceId string
Cloud SQL instance ID in the form project:location:instance.
Type CloudSqlPropertiesType
Type of the Cloud SQL database.
credential CloudSqlCredential
Input only. Cloud SQL credential.
database String
Database name.
instanceId String
Cloud SQL instance ID in the form project:location:instance.
type CloudSqlPropertiesType
Type of the Cloud SQL database.
credential CloudSqlCredential
Input only. Cloud SQL credential.
database string
Database name.
instanceId string
Cloud SQL instance ID in the form project:location:instance.
type CloudSqlPropertiesType
Type of the Cloud SQL database.
credential CloudSqlCredential
Input only. Cloud SQL credential.
database str
Database name.
instance_id str
Cloud SQL instance ID in the form project:location:instance.
type CloudSqlPropertiesType
Type of the Cloud SQL database.
credential Property Map
Input only. Cloud SQL credential.
database String
Database name.
instanceId String
Cloud SQL instance ID in the form project:location:instance.
type "DATABASE_TYPE_UNSPECIFIED" | "POSTGRES" | "MYSQL"
Type of the Cloud SQL database.

CloudSqlPropertiesResponse
, CloudSqlPropertiesResponseArgs

Credential This property is required. Pulumi.GoogleNative.BigQueryConnection.V1Beta1.Inputs.CloudSqlCredentialResponse
Input only. Cloud SQL credential.
Database This property is required. string
Database name.
InstanceId This property is required. string
Cloud SQL instance ID in the form project:location:instance.
ServiceAccountId This property is required. string
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 This property is required. string
Type of the Cloud SQL database.
Credential This property is required. CloudSqlCredentialResponse
Input only. Cloud SQL credential.
Database This property is required. string
Database name.
InstanceId This property is required. string
Cloud SQL instance ID in the form project:location:instance.
ServiceAccountId This property is required. string
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 This property is required. string
Type of the Cloud SQL database.
credential This property is required. CloudSqlCredentialResponse
Input only. Cloud SQL credential.
database This property is required. String
Database name.
instanceId This property is required. String
Cloud SQL instance ID in the form project:location:instance.
serviceAccountId This property is required. String
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 This property is required. String
Type of the Cloud SQL database.
credential This property is required. CloudSqlCredentialResponse
Input only. Cloud SQL credential.
database This property is required. string
Database name.
instanceId This property is required. string
Cloud SQL instance ID in the form project:location:instance.
serviceAccountId This property is required. string
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 This property is required. string
Type of the Cloud SQL database.
credential This property is required. CloudSqlCredentialResponse
Input only. Cloud SQL credential.
database This property is required. str
Database name.
instance_id This property is required. str
Cloud SQL instance ID in the form project:location:instance.
service_account_id This property is required. str
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 This property is required. str
Type of the Cloud SQL database.
credential This property is required. Property Map
Input only. Cloud SQL credential.
database This property is required. String
Database name.
instanceId This property is required. String
Cloud SQL instance ID in the form project:location:instance.
serviceAccountId This property is required. String
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 This property is required. String
Type of the Cloud SQL database.

CloudSqlPropertiesType
, CloudSqlPropertiesTypeArgs

DatabaseTypeUnspecified
DATABASE_TYPE_UNSPECIFIEDUnspecified database type.
Postgres
POSTGRESCloud SQL for PostgreSQL.
Mysql
MYSQLCloud SQL for MySQL.
CloudSqlPropertiesTypeDatabaseTypeUnspecified
DATABASE_TYPE_UNSPECIFIEDUnspecified database type.
CloudSqlPropertiesTypePostgres
POSTGRESCloud SQL for PostgreSQL.
CloudSqlPropertiesTypeMysql
MYSQLCloud SQL for MySQL.
DatabaseTypeUnspecified
DATABASE_TYPE_UNSPECIFIEDUnspecified database type.
Postgres
POSTGRESCloud SQL for PostgreSQL.
Mysql
MYSQLCloud SQL for MySQL.
DatabaseTypeUnspecified
DATABASE_TYPE_UNSPECIFIEDUnspecified database type.
Postgres
POSTGRESCloud SQL for PostgreSQL.
Mysql
MYSQLCloud SQL for MySQL.
DATABASE_TYPE_UNSPECIFIED
DATABASE_TYPE_UNSPECIFIEDUnspecified database type.
POSTGRES
POSTGRESCloud SQL for PostgreSQL.
MYSQL
MYSQLCloud SQL for MySQL.
"DATABASE_TYPE_UNSPECIFIED"
DATABASE_TYPE_UNSPECIFIEDUnspecified database type.
"POSTGRES"
POSTGRESCloud SQL for PostgreSQL.
"MYSQL"
MYSQLCloud 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.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native