Google Cloud Native v0.30.0, Apr 14 23

google-native.datastream/v1.getConnectionProfile

Explore with Pulumi AI

Use this method to get details about a connection profile.

Using getConnectionProfile

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 getConnectionProfile(args: GetConnectionProfileArgs, opts?: InvokeOptions): Promise<GetConnectionProfileResult>
function getConnectionProfileOutput(args: GetConnectionProfileOutputArgs, opts?: InvokeOptions): Output<GetConnectionProfileResult>

def get_connection_profile(connection_profile_id: Optional[str] = None,
                           location: Optional[str] = None,
                           project: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetConnectionProfileResult
def get_connection_profile_output(connection_profile_id: Optional[pulumi.Input[str]] = None,
                           location: Optional[pulumi.Input[str]] = None,
                           project: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetConnectionProfileResult]

func LookupConnectionProfile(ctx *Context, args *LookupConnectionProfileArgs, opts ...InvokeOption) (*LookupConnectionProfileResult, error)
func LookupConnectionProfileOutput(ctx *Context, args *LookupConnectionProfileOutputArgs, opts ...InvokeOption) LookupConnectionProfileResultOutput

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

public static class GetConnectionProfile 
{
    public static Task<GetConnectionProfileResult> InvokeAsync(GetConnectionProfileArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectionProfileResult> Invoke(GetConnectionProfileInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetConnectionProfileResult> getConnectionProfile(GetConnectionProfileArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:datastream/v1:getConnectionProfile
  arguments:
    # arguments dictionary

The following arguments are supported:

ConnectionProfileId string
Location string
Project string

ConnectionProfileId string
Location string
Project string

connectionProfileId String
location String
project String

connectionProfileId string
location string
project string

connection_profile_id str
location str
project str

connectionProfileId String
location String
project String

getConnectionProfile Result

The following output properties are available:

BigqueryProfile Pulumi.GoogleNative.Datastream.V1.Outputs.BigQueryProfileResponse: BigQuery Connection Profile configuration.
CreateTime string: The create time of the resource.
DisplayName string: Display name.
ForwardSshConnectivity Pulumi.GoogleNative.Datastream.V1.Outputs.ForwardSshTunnelConnectivityResponse: Forward SSH tunnel connectivity.
GcsProfile Pulumi.GoogleNative.Datastream.V1.Outputs.GcsProfileResponse: Cloud Storage ConnectionProfile configuration.
Labels Dictionary<string, string>: Labels.
MysqlProfile Pulumi.GoogleNative.Datastream.V1.Outputs.MysqlProfileResponse: MySQL ConnectionProfile configuration.
Name string: The resource's name.
OracleProfile Pulumi.GoogleNative.Datastream.V1.Outputs.OracleProfileResponse: Oracle ConnectionProfile configuration.
PostgresqlProfile Pulumi.GoogleNative.Datastream.V1.Outputs.PostgresqlProfileResponse: PostgreSQL Connection Profile configuration.
PrivateConnectivity Pulumi.GoogleNative.Datastream.V1.Outputs.PrivateConnectivityResponse: Private connectivity.
StaticServiceIpConnectivity Pulumi.GoogleNative.Datastream.V1.Outputs.StaticServiceIpConnectivityResponse: Static Service IP connectivity.
UpdateTime string: The update time of the resource.

BigqueryProfile BigQueryProfileResponse: BigQuery Connection Profile configuration.
CreateTime string: The create time of the resource.
DisplayName string: Display name.
ForwardSshConnectivity ForwardSshTunnelConnectivityResponse: Forward SSH tunnel connectivity.
GcsProfile GcsProfileResponse: Cloud Storage ConnectionProfile configuration.
Labels map[string]string: Labels.
MysqlProfile MysqlProfileResponse: MySQL ConnectionProfile configuration.
Name string: The resource's name.
OracleProfile OracleProfileResponse: Oracle ConnectionProfile configuration.
PostgresqlProfile PostgresqlProfileResponse: PostgreSQL Connection Profile configuration.
PrivateConnectivity PrivateConnectivityResponse: Private connectivity.
StaticServiceIpConnectivity StaticServiceIpConnectivityResponse: Static Service IP connectivity.
UpdateTime string: The update time of the resource.

bigqueryProfile BigQueryProfileResponse: BigQuery Connection Profile configuration.
createTime String: The create time of the resource.
displayName String: Display name.
forwardSshConnectivity ForwardSshTunnelConnectivityResponse: Forward SSH tunnel connectivity.
gcsProfile GcsProfileResponse: Cloud Storage ConnectionProfile configuration.
labels Map<String,String>: Labels.
mysqlProfile MysqlProfileResponse: MySQL ConnectionProfile configuration.
name String: The resource's name.
oracleProfile OracleProfileResponse: Oracle ConnectionProfile configuration.
postgresqlProfile PostgresqlProfileResponse: PostgreSQL Connection Profile configuration.
privateConnectivity PrivateConnectivityResponse: Private connectivity.
staticServiceIpConnectivity StaticServiceIpConnectivityResponse: Static Service IP connectivity.
updateTime String: The update time of the resource.

bigqueryProfile BigQueryProfileResponse: BigQuery Connection Profile configuration.
createTime string: The create time of the resource.
displayName string: Display name.
forwardSshConnectivity ForwardSshTunnelConnectivityResponse: Forward SSH tunnel connectivity.
gcsProfile GcsProfileResponse: Cloud Storage ConnectionProfile configuration.
labels {[key: string]: string}: Labels.
mysqlProfile MysqlProfileResponse: MySQL ConnectionProfile configuration.
name string: The resource's name.
oracleProfile OracleProfileResponse: Oracle ConnectionProfile configuration.
postgresqlProfile PostgresqlProfileResponse: PostgreSQL Connection Profile configuration.
privateConnectivity PrivateConnectivityResponse: Private connectivity.
staticServiceIpConnectivity StaticServiceIpConnectivityResponse: Static Service IP connectivity.
updateTime string: The update time of the resource.

bigquery_profile BigQueryProfileResponse: BigQuery Connection Profile configuration.
create_time str: The create time of the resource.
display_name str: Display name.
forward_ssh_connectivity ForwardSshTunnelConnectivityResponse: Forward SSH tunnel connectivity.
gcs_profile GcsProfileResponse: Cloud Storage ConnectionProfile configuration.
labels Mapping[str, str]: Labels.
mysql_profile MysqlProfileResponse: MySQL ConnectionProfile configuration.
name str: The resource's name.
oracle_profile OracleProfileResponse: Oracle ConnectionProfile configuration.
postgresql_profile PostgresqlProfileResponse: PostgreSQL Connection Profile configuration.
private_connectivity PrivateConnectivityResponse: Private connectivity.
static_service_ip_connectivity StaticServiceIpConnectivityResponse: Static Service IP connectivity.
update_time str: The update time of the resource.

bigqueryProfile Property Map: BigQuery Connection Profile configuration.
createTime String: The create time of the resource.
displayName String: Display name.
forwardSshConnectivity Property Map: Forward SSH tunnel connectivity.
gcsProfile Property Map: Cloud Storage ConnectionProfile configuration.
labels Map<String>: Labels.
mysqlProfile Property Map: MySQL ConnectionProfile configuration.
name String: The resource's name.
oracleProfile Property Map: Oracle ConnectionProfile configuration.
postgresqlProfile Property Map: PostgreSQL Connection Profile configuration.
privateConnectivity Property Map: Private connectivity.
staticServiceIpConnectivity Property Map: Static Service IP connectivity.
updateTime String: The update time of the resource.

Supporting Types

ForwardSshTunnelConnectivityResponse

Hostname string: Hostname for the SSH tunnel.
Password string: Input only. SSH password.
Port int: Port for the SSH tunnel, default value is 22.
PrivateKey string: Input only. SSH private key.
Username string: Username for the SSH tunnel.

Hostname string: Hostname for the SSH tunnel.
Password string: Input only. SSH password.
Port int: Port for the SSH tunnel, default value is 22.
PrivateKey string: Input only. SSH private key.
Username string: Username for the SSH tunnel.

hostname String: Hostname for the SSH tunnel.
password String: Input only. SSH password.
port Integer: Port for the SSH tunnel, default value is 22.
privateKey String: Input only. SSH private key.
username String: Username for the SSH tunnel.

hostname string: Hostname for the SSH tunnel.
password string: Input only. SSH password.
port number: Port for the SSH tunnel, default value is 22.
privateKey string: Input only. SSH private key.
username string: Username for the SSH tunnel.

hostname str: Hostname for the SSH tunnel.
password str: Input only. SSH password.
port int: Port for the SSH tunnel, default value is 22.
private_key str: Input only. SSH private key.
username str: Username for the SSH tunnel.

hostname String: Hostname for the SSH tunnel.
password String: Input only. SSH password.
port Number: Port for the SSH tunnel, default value is 22.
privateKey String: Input only. SSH private key.
username String: Username for the SSH tunnel.

GcsProfileResponse

Bucket string: The Cloud Storage bucket name.
RootPath string: The root path inside the Cloud Storage bucket.

Bucket string: The Cloud Storage bucket name.
RootPath string: The root path inside the Cloud Storage bucket.

bucket String: The Cloud Storage bucket name.
rootPath String: The root path inside the Cloud Storage bucket.

bucket string: The Cloud Storage bucket name.
rootPath string: The root path inside the Cloud Storage bucket.

bucket str: The Cloud Storage bucket name.
root_path str: The root path inside the Cloud Storage bucket.

bucket String: The Cloud Storage bucket name.
rootPath String: The root path inside the Cloud Storage bucket.

MysqlProfileResponse

Hostname string: Hostname for the MySQL connection.
Password string: Input only. Password for the MySQL connection.
Port int: Port for the MySQL connection, default value is 3306.
SslConfig Pulumi.GoogleNative.Datastream.V1.Inputs.MysqlSslConfigResponse: SSL configuration for the MySQL connection.
Username string: Username for the MySQL connection.

Hostname string: Hostname for the MySQL connection.
Password string: Input only. Password for the MySQL connection.
Port int: Port for the MySQL connection, default value is 3306.
SslConfig MysqlSslConfigResponse: SSL configuration for the MySQL connection.
Username string: Username for the MySQL connection.

hostname String: Hostname for the MySQL connection.
password String: Input only. Password for the MySQL connection.
port Integer: Port for the MySQL connection, default value is 3306.
sslConfig MysqlSslConfigResponse: SSL configuration for the MySQL connection.
username String: Username for the MySQL connection.

hostname string: Hostname for the MySQL connection.
password string: Input only. Password for the MySQL connection.
port number: Port for the MySQL connection, default value is 3306.
sslConfig MysqlSslConfigResponse: SSL configuration for the MySQL connection.
username string: Username for the MySQL connection.

hostname str: Hostname for the MySQL connection.
password str: Input only. Password for the MySQL connection.
port int: Port for the MySQL connection, default value is 3306.
ssl_config MysqlSslConfigResponse: SSL configuration for the MySQL connection.
username str: Username for the MySQL connection.

hostname String: Hostname for the MySQL connection.
password String: Input only. Password for the MySQL connection.
port Number: Port for the MySQL connection, default value is 3306.
sslConfig Property Map: SSL configuration for the MySQL connection.
username String: Username for the MySQL connection.

MysqlSslConfigResponse

CaCertificate string: Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
CaCertificateSet bool: Indicates whether the ca_certificate field is set.
ClientCertificate string: Input only. PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'client_key' and the 'ca_certificate' fields are mandatory.
ClientCertificateSet bool: Indicates whether the client_certificate field is set.
ClientKey string: Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory.
ClientKeySet bool: Indicates whether the client_key field is set.

CaCertificate string: Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
CaCertificateSet bool: Indicates whether the ca_certificate field is set.
ClientCertificate string: Input only. PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'client_key' and the 'ca_certificate' fields are mandatory.
ClientCertificateSet bool: Indicates whether the client_certificate field is set.
ClientKey string: Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory.
ClientKeySet bool: Indicates whether the client_key field is set.

caCertificate String: Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
caCertificateSet Boolean: Indicates whether the ca_certificate field is set.
clientCertificate String: Input only. PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'client_key' and the 'ca_certificate' fields are mandatory.
clientCertificateSet Boolean: Indicates whether the client_certificate field is set.
clientKey String: Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory.
clientKeySet Boolean: Indicates whether the client_key field is set.

caCertificate string: Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
caCertificateSet boolean: Indicates whether the ca_certificate field is set.
clientCertificate string: Input only. PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'client_key' and the 'ca_certificate' fields are mandatory.
clientCertificateSet boolean: Indicates whether the client_certificate field is set.
clientKey string: Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory.
clientKeySet boolean: Indicates whether the client_key field is set.

ca_certificate str: Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
ca_certificate_set bool: Indicates whether the ca_certificate field is set.
client_certificate str: Input only. PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'client_key' and the 'ca_certificate' fields are mandatory.
client_certificate_set bool: Indicates whether the client_certificate field is set.
client_key str: Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory.
client_key_set bool: Indicates whether the client_key field is set.

caCertificate String: Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
caCertificateSet Boolean: Indicates whether the ca_certificate field is set.
clientCertificate String: Input only. PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'client_key' and the 'ca_certificate' fields are mandatory.
clientCertificateSet Boolean: Indicates whether the client_certificate field is set.
clientKey String: Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory.
clientKeySet Boolean: Indicates whether the client_key field is set.

OracleProfileResponse

ConnectionAttributes Dictionary<string, string>: Connection string attributes
DatabaseService string: Database for the Oracle connection.
Hostname string: Hostname for the Oracle connection.
Password string: Password for the Oracle connection.
Port int: Port for the Oracle connection, default value is 1521.
Username string: Username for the Oracle connection.

ConnectionAttributes map[string]string: Connection string attributes
DatabaseService string: Database for the Oracle connection.
Hostname string: Hostname for the Oracle connection.
Password string: Password for the Oracle connection.
Port int: Port for the Oracle connection, default value is 1521.
Username string: Username for the Oracle connection.

connectionAttributes Map<String,String>: Connection string attributes
databaseService String: Database for the Oracle connection.
hostname String: Hostname for the Oracle connection.
password String: Password for the Oracle connection.
port Integer: Port for the Oracle connection, default value is 1521.
username String: Username for the Oracle connection.

connectionAttributes {[key: string]: string}: Connection string attributes
databaseService string: Database for the Oracle connection.
hostname string: Hostname for the Oracle connection.
password string: Password for the Oracle connection.
port number: Port for the Oracle connection, default value is 1521.
username string: Username for the Oracle connection.

connection_attributes Mapping[str, str]: Connection string attributes
database_service str: Database for the Oracle connection.
hostname str: Hostname for the Oracle connection.
password str: Password for the Oracle connection.
port int: Port for the Oracle connection, default value is 1521.
username str: Username for the Oracle connection.

connectionAttributes Map<String>: Connection string attributes
databaseService String: Database for the Oracle connection.
hostname String: Hostname for the Oracle connection.
password String: Password for the Oracle connection.
port Number: Port for the Oracle connection, default value is 1521.
username String: Username for the Oracle connection.

PostgresqlProfileResponse

Database string: Database for the PostgreSQL connection.
Hostname string: Hostname for the PostgreSQL connection.
Password string: Password for the PostgreSQL connection.
Port int: Port for the PostgreSQL connection, default value is 5432.
Username string: Username for the PostgreSQL connection.

Database string: Database for the PostgreSQL connection.
Hostname string: Hostname for the PostgreSQL connection.
Password string: Password for the PostgreSQL connection.
Port int: Port for the PostgreSQL connection, default value is 5432.
Username string: Username for the PostgreSQL connection.

database String: Database for the PostgreSQL connection.
hostname String: Hostname for the PostgreSQL connection.
password String: Password for the PostgreSQL connection.
port Integer: Port for the PostgreSQL connection, default value is 5432.
username String: Username for the PostgreSQL connection.

database string: Database for the PostgreSQL connection.
hostname string: Hostname for the PostgreSQL connection.
password string: Password for the PostgreSQL connection.
port number: Port for the PostgreSQL connection, default value is 5432.
username string: Username for the PostgreSQL connection.

database str: Database for the PostgreSQL connection.
hostname str: Hostname for the PostgreSQL connection.
password str: Password for the PostgreSQL connection.
port int: Port for the PostgreSQL connection, default value is 5432.
username str: Username for the PostgreSQL connection.

database String: Database for the PostgreSQL connection.
hostname String: Hostname for the PostgreSQL connection.
password String: Password for the PostgreSQL connection.
port Number: Port for the PostgreSQL connection, default value is 5432.
username String: Username for the PostgreSQL connection.

PrivateConnectivityResponse

PrivateConnection string: A reference to a private connection resource. Format: projects/{project}/locations/{location}/privateConnections/{name}

PrivateConnection string: A reference to a private connection resource. Format: projects/{project}/locations/{location}/privateConnections/{name}

privateConnection String: A reference to a private connection resource. Format: projects/{project}/locations/{location}/privateConnections/{name}

privateConnection string: A reference to a private connection resource. Format: projects/{project}/locations/{location}/privateConnections/{name}

private_connection str: A reference to a private connection resource. Format: projects/{project}/locations/{location}/privateConnections/{name}

privateConnection String: A reference to a private connection resource. Format: projects/{project}/locations/{location}/privateConnections/{name}

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0