1. Packages
  2. Google Cloud Native
  3. API Docs
  4. bigqueryconnection
  5. bigqueryconnection/v1beta1
  6. getConnection

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

google-native.bigqueryconnection/v1beta1.getConnection

Explore with Pulumi AI

google-native logo

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

    Returns specified connection.

    Using getConnection

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getConnection(args: GetConnectionArgs, opts?: InvokeOptions): Promise<GetConnectionResult>
    function getConnectionOutput(args: GetConnectionOutputArgs, opts?: InvokeOptions): Output<GetConnectionResult>
    def get_connection(connection_id: Optional[str] = None,
                       location: Optional[str] = None,
                       project: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetConnectionResult
    def get_connection_output(connection_id: Optional[pulumi.Input[str]] = None,
                       location: Optional[pulumi.Input[str]] = None,
                       project: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetConnectionResult]
    func LookupConnection(ctx *Context, args *LookupConnectionArgs, opts ...InvokeOption) (*LookupConnectionResult, error)
    func LookupConnectionOutput(ctx *Context, args *LookupConnectionOutputArgs, opts ...InvokeOption) LookupConnectionResultOutput

    > Note: This function is named LookupConnection in the Go SDK.

    public static class GetConnection 
    {
        public static Task<GetConnectionResult> InvokeAsync(GetConnectionArgs args, InvokeOptions? opts = null)
        public static Output<GetConnectionResult> Invoke(GetConnectionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: google-native:bigqueryconnection/v1beta1:getConnection
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ConnectionId string
    Location string
    Project string
    ConnectionId string
    Location string
    Project string
    connectionId String
    location String
    project String
    connectionId string
    location string
    project string
    connectionId String
    location String
    project String

    getConnection Result

    The following output properties are available:

    CloudSql Pulumi.GoogleNative.BigQueryConnection.V1Beta1.Outputs.CloudSqlPropertiesResponse
    Cloud SQL properties.
    CreationTime string
    The creation timestamp of the connection.
    Description string
    User provided description.
    FriendlyName string
    User provided display name for the connection.
    HasCredential bool
    True, if credential is configured for this connection.
    LastModifiedTime string
    The last update timestamp of the connection.
    Name string
    The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}
    CloudSql CloudSqlPropertiesResponse
    Cloud SQL properties.
    CreationTime string
    The creation timestamp of the connection.
    Description string
    User provided description.
    FriendlyName string
    User provided display name for the connection.
    HasCredential bool
    True, if credential is configured for this connection.
    LastModifiedTime string
    The last update timestamp of the connection.
    Name string
    The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}
    cloudSql CloudSqlPropertiesResponse
    Cloud SQL properties.
    creationTime String
    The creation timestamp of the connection.
    description String
    User provided description.
    friendlyName String
    User provided display name for the connection.
    hasCredential Boolean
    True, if credential is configured for this connection.
    lastModifiedTime String
    The last update timestamp of the connection.
    name String
    The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}
    cloudSql CloudSqlPropertiesResponse
    Cloud SQL properties.
    creationTime string
    The creation timestamp of the connection.
    description string
    User provided description.
    friendlyName string
    User provided display name for the connection.
    hasCredential boolean
    True, if credential is configured for this connection.
    lastModifiedTime string
    The last update timestamp of the connection.
    name string
    The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}
    cloud_sql CloudSqlPropertiesResponse
    Cloud SQL properties.
    creation_time str
    The creation timestamp of the connection.
    description str
    User provided description.
    friendly_name str
    User provided display name for the connection.
    has_credential bool
    True, if credential is configured for this connection.
    last_modified_time str
    The last update timestamp of the connection.
    name str
    The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}
    cloudSql Property Map
    Cloud SQL properties.
    creationTime String
    The creation timestamp of the connection.
    description String
    User provided description.
    friendlyName String
    User provided display name for the connection.
    hasCredential Boolean
    True, if credential is configured for this connection.
    lastModifiedTime String
    The last update timestamp of the connection.
    name String
    The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}

    Supporting Types

    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.

    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.

    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.32.0 published on Wednesday, Nov 29, 2023 by Pulumi