Docs Packages
  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.30.0 published on Friday, Apr 14, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.bigqueryconnection/v1beta1.Connection

Explore with Pulumi AI

google-native logo

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

Google Cloud Native v0.30.0 published on Friday, Apr 14, 2023 by Pulumi
pulumi/pulumi-google-native

    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:

    CloudSql Pulumi.GoogleNative.BigQueryConnection.V1Beta1.Inputs.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 string
    Name string

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

    Project 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 string
    Name string

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

    Project 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 String
    name String

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

    project 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 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 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 str
    name str

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

    project 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 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:

    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

    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

    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.

    CloudSqlProperties

    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

    Credential Pulumi.GoogleNative.BigQueryConnection.V1Beta1.Inputs.CloudSqlCredentialResponse

    Input only. Cloud SQL credential.

    Database string

    Database name.

    InstanceId string

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

    ServiceAccountId 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 string

    Type of the Cloud SQL database.

    Credential CloudSqlCredentialResponse

    Input only. Cloud SQL credential.

    Database string

    Database name.

    InstanceId string

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

    ServiceAccountId 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 string

    Type of the Cloud SQL database.

    credential CloudSqlCredentialResponse

    Input only. Cloud SQL credential.

    database String

    Database name.

    instanceId String

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

    serviceAccountId 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 String

    Type of the Cloud SQL database.

    credential CloudSqlCredentialResponse

    Input only. Cloud SQL credential.

    database string

    Database name.

    instanceId string

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

    serviceAccountId 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 string

    Type of the Cloud SQL database.

    credential CloudSqlCredentialResponse

    Input only. Cloud SQL credential.

    database str

    Database name.

    instance_id str

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

    service_account_id 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 str

    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.

    serviceAccountId 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 String

    Type of the Cloud SQL database.

    CloudSqlPropertiesType

    DatabaseTypeUnspecified
    DATABASE_TYPE_UNSPECIFIED

    Unspecified database type.

    Postgres
    POSTGRES

    Cloud SQL for PostgreSQL.

    Mysql
    MYSQL

    Cloud SQL for MySQL.

    CloudSqlPropertiesTypeDatabaseTypeUnspecified
    DATABASE_TYPE_UNSPECIFIED

    Unspecified database type.

    CloudSqlPropertiesTypePostgres
    POSTGRES

    Cloud SQL for PostgreSQL.

    CloudSqlPropertiesTypeMysql
    MYSQL

    Cloud SQL for MySQL.

    DatabaseTypeUnspecified
    DATABASE_TYPE_UNSPECIFIED

    Unspecified database type.

    Postgres
    POSTGRES

    Cloud SQL for PostgreSQL.

    Mysql
    MYSQL

    Cloud SQL for MySQL.

    DatabaseTypeUnspecified
    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-native logo

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

    Google Cloud Native v0.30.0 published on Friday, Apr 14, 2023 by Pulumi
    pulumi/pulumi-google-native