1. Packages
  2. Google Cloud Native
  3. API Docs
  4. datastream
  5. datastream/v1alpha1
  6. getConnectionProfile

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.datastream/v1alpha1.getConnectionProfile

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

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>
Copy
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]
Copy
func LookupConnectionProfile(ctx *Context, args *LookupConnectionProfileArgs, opts ...InvokeOption) (*LookupConnectionProfileResult, error)
func LookupConnectionProfileOutput(ctx *Context, args *LookupConnectionProfileOutputArgs, opts ...InvokeOption) LookupConnectionProfileResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetConnectionProfileResult> getConnectionProfile(GetConnectionProfileArgs args, InvokeOptions options)
public static Output<GetConnectionProfileResult> getConnectionProfile(GetConnectionProfileArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:datastream/v1alpha1:getConnectionProfile
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConnectionProfileId This property is required. string
Location This property is required. string
Project string
ConnectionProfileId This property is required. string
Location This property is required. string
Project string
connectionProfileId This property is required. String
location This property is required. String
project String
connectionProfileId This property is required. string
location This property is required. string
project string
connection_profile_id This property is required. str
location This property is required. str
project str
connectionProfileId This property is required. String
location This property is required. String
project String

getConnectionProfile Result

The following output properties are available:

CreateTime string
The create time of the resource.
DisplayName string
Display name.
ForwardSshConnectivity Pulumi.GoogleNative.Datastream.V1Alpha1.Outputs.ForwardSshTunnelConnectivityResponse
Forward SSH tunnel connectivity.
GcsProfile Pulumi.GoogleNative.Datastream.V1Alpha1.Outputs.GcsProfileResponse
Cloud Storage ConnectionProfile configuration.
Labels Dictionary<string, string>
Labels.
MysqlProfile Pulumi.GoogleNative.Datastream.V1Alpha1.Outputs.MysqlProfileResponse
MySQL ConnectionProfile configuration.
Name string
The resource's name.
NoConnectivity Pulumi.GoogleNative.Datastream.V1Alpha1.Outputs.NoConnectivitySettingsResponse
No connectivity option chosen.
OracleProfile Pulumi.GoogleNative.Datastream.V1Alpha1.Outputs.OracleProfileResponse
Oracle ConnectionProfile configuration.
PrivateConnectivity Pulumi.GoogleNative.Datastream.V1Alpha1.Outputs.PrivateConnectivityResponse
Private connectivity.
StaticServiceIpConnectivity Pulumi.GoogleNative.Datastream.V1Alpha1.Outputs.StaticServiceIpConnectivityResponse
Static Service IP connectivity.
UpdateTime string
The update time of the resource.
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.
NoConnectivity NoConnectivitySettingsResponse
No connectivity option chosen.
OracleProfile OracleProfileResponse
Oracle ConnectionProfile configuration.
PrivateConnectivity PrivateConnectivityResponse
Private connectivity.
StaticServiceIpConnectivity StaticServiceIpConnectivityResponse
Static Service IP connectivity.
UpdateTime string
The update time of the resource.
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.
noConnectivity NoConnectivitySettingsResponse
No connectivity option chosen.
oracleProfile OracleProfileResponse
Oracle ConnectionProfile configuration.
privateConnectivity PrivateConnectivityResponse
Private connectivity.
staticServiceIpConnectivity StaticServiceIpConnectivityResponse
Static Service IP connectivity.
updateTime String
The update time of the resource.
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.
noConnectivity NoConnectivitySettingsResponse
No connectivity option chosen.
oracleProfile OracleProfileResponse
Oracle ConnectionProfile configuration.
privateConnectivity PrivateConnectivityResponse
Private connectivity.
staticServiceIpConnectivity StaticServiceIpConnectivityResponse
Static Service IP connectivity.
updateTime string
The update time of the resource.
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.
no_connectivity NoConnectivitySettingsResponse
No connectivity option chosen.
oracle_profile OracleProfileResponse
Oracle ConnectionProfile configuration.
private_connectivity PrivateConnectivityResponse
Private connectivity.
static_service_ip_connectivity StaticServiceIpConnectivityResponse
Static Service IP connectivity.
update_time str
The update time of the resource.
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.
noConnectivity Property Map
No connectivity option chosen.
oracleProfile Property Map
Oracle ConnectionProfile 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 This property is required. string
Hostname for the SSH tunnel.
Password This property is required. string
Input only. SSH password.
Port This property is required. int
Port for the SSH tunnel, default value is 22.
PrivateKey This property is required. string
Input only. SSH private key.
Username This property is required. string
Username for the SSH tunnel.
Hostname This property is required. string
Hostname for the SSH tunnel.
Password This property is required. string
Input only. SSH password.
Port This property is required. int
Port for the SSH tunnel, default value is 22.
PrivateKey This property is required. string
Input only. SSH private key.
Username This property is required. string
Username for the SSH tunnel.
hostname This property is required. String
Hostname for the SSH tunnel.
password This property is required. String
Input only. SSH password.
port This property is required. Integer
Port for the SSH tunnel, default value is 22.
privateKey This property is required. String
Input only. SSH private key.
username This property is required. String
Username for the SSH tunnel.
hostname This property is required. string
Hostname for the SSH tunnel.
password This property is required. string
Input only. SSH password.
port This property is required. number
Port for the SSH tunnel, default value is 22.
privateKey This property is required. string
Input only. SSH private key.
username This property is required. string
Username for the SSH tunnel.
hostname This property is required. str
Hostname for the SSH tunnel.
password This property is required. str
Input only. SSH password.
port This property is required. int
Port for the SSH tunnel, default value is 22.
private_key This property is required. str
Input only. SSH private key.
username This property is required. str
Username for the SSH tunnel.
hostname This property is required. String
Hostname for the SSH tunnel.
password This property is required. String
Input only. SSH password.
port This property is required. Number
Port for the SSH tunnel, default value is 22.
privateKey This property is required. String
Input only. SSH private key.
username This property is required. String
Username for the SSH tunnel.

GcsProfileResponse

BucketName This property is required. string
The full project and resource path for Cloud Storage bucket including the name.
RootPath This property is required. string
The root path inside the Cloud Storage bucket.
BucketName This property is required. string
The full project and resource path for Cloud Storage bucket including the name.
RootPath This property is required. string
The root path inside the Cloud Storage bucket.
bucketName This property is required. String
The full project and resource path for Cloud Storage bucket including the name.
rootPath This property is required. String
The root path inside the Cloud Storage bucket.
bucketName This property is required. string
The full project and resource path for Cloud Storage bucket including the name.
rootPath This property is required. string
The root path inside the Cloud Storage bucket.
bucket_name This property is required. str
The full project and resource path for Cloud Storage bucket including the name.
root_path This property is required. str
The root path inside the Cloud Storage bucket.
bucketName This property is required. String
The full project and resource path for Cloud Storage bucket including the name.
rootPath This property is required. String
The root path inside the Cloud Storage bucket.

MysqlProfileResponse

Hostname This property is required. string
Hostname for the MySQL connection.
Password This property is required. string
Input only. Password for the MySQL connection.
Port This property is required. int
Port for the MySQL connection, default value is 3306.
SslConfig This property is required. Pulumi.GoogleNative.Datastream.V1Alpha1.Inputs.MysqlSslConfigResponse
SSL configuration for the MySQL connection.
Username This property is required. string
Username for the MySQL connection.
Hostname This property is required. string
Hostname for the MySQL connection.
Password This property is required. string
Input only. Password for the MySQL connection.
Port This property is required. int
Port for the MySQL connection, default value is 3306.
SslConfig This property is required. MysqlSslConfigResponse
SSL configuration for the MySQL connection.
Username This property is required. string
Username for the MySQL connection.
hostname This property is required. String
Hostname for the MySQL connection.
password This property is required. String
Input only. Password for the MySQL connection.
port This property is required. Integer
Port for the MySQL connection, default value is 3306.
sslConfig This property is required. MysqlSslConfigResponse
SSL configuration for the MySQL connection.
username This property is required. String
Username for the MySQL connection.
hostname This property is required. string
Hostname for the MySQL connection.
password This property is required. string
Input only. Password for the MySQL connection.
port This property is required. number
Port for the MySQL connection, default value is 3306.
sslConfig This property is required. MysqlSslConfigResponse
SSL configuration for the MySQL connection.
username This property is required. string
Username for the MySQL connection.
hostname This property is required. str
Hostname for the MySQL connection.
password This property is required. str
Input only. Password for the MySQL connection.
port This property is required. int
Port for the MySQL connection, default value is 3306.
ssl_config This property is required. MysqlSslConfigResponse
SSL configuration for the MySQL connection.
username This property is required. str
Username for the MySQL connection.
hostname This property is required. String
Hostname for the MySQL connection.
password This property is required. String
Input only. Password for the MySQL connection.
port This property is required. Number
Port for the MySQL connection, default value is 3306.
sslConfig This property is required. Property Map
SSL configuration for the MySQL connection.
username This property is required. String
Username for the MySQL connection.

MysqlSslConfigResponse

CaCertificate This property is required. string
Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
CaCertificateSet This property is required. bool
Indicates whether the ca_certificate field is set.
ClientCertificate This property is required. 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 This property is required. bool
Indicates whether the client_certificate field is set.
ClientKey This property is required. 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 This property is required. bool
Indicates whether the client_key field is set.
CaCertificate This property is required. string
Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
CaCertificateSet This property is required. bool
Indicates whether the ca_certificate field is set.
ClientCertificate This property is required. 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 This property is required. bool
Indicates whether the client_certificate field is set.
ClientKey This property is required. 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 This property is required. bool
Indicates whether the client_key field is set.
caCertificate This property is required. String
Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
caCertificateSet This property is required. Boolean
Indicates whether the ca_certificate field is set.
clientCertificate This property is required. 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 This property is required. Boolean
Indicates whether the client_certificate field is set.
clientKey This property is required. 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 This property is required. Boolean
Indicates whether the client_key field is set.
caCertificate This property is required. string
Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
caCertificateSet This property is required. boolean
Indicates whether the ca_certificate field is set.
clientCertificate This property is required. 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 This property is required. boolean
Indicates whether the client_certificate field is set.
clientKey This property is required. 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 This property is required. boolean
Indicates whether the client_key field is set.
ca_certificate This property is required. str
Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
ca_certificate_set This property is required. bool
Indicates whether the ca_certificate field is set.
client_certificate This property is required. 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 This property is required. bool
Indicates whether the client_certificate field is set.
client_key This property is required. 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 This property is required. bool
Indicates whether the client_key field is set.
caCertificate This property is required. String
Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
caCertificateSet This property is required. Boolean
Indicates whether the ca_certificate field is set.
clientCertificate This property is required. 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 This property is required. Boolean
Indicates whether the client_certificate field is set.
clientKey This property is required. 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 This property is required. Boolean
Indicates whether the client_key field is set.

OracleProfileResponse

ConnectionAttributes This property is required. Dictionary<string, string>
Connection string attributes
DatabaseService This property is required. string
Database for the Oracle connection.
Hostname This property is required. string
Hostname for the Oracle connection.
Password This property is required. string
Password for the Oracle connection.
Port This property is required. int
Port for the Oracle connection, default value is 1521.
Username This property is required. string
Username for the Oracle connection.
ConnectionAttributes This property is required. map[string]string
Connection string attributes
DatabaseService This property is required. string
Database for the Oracle connection.
Hostname This property is required. string
Hostname for the Oracle connection.
Password This property is required. string
Password for the Oracle connection.
Port This property is required. int
Port for the Oracle connection, default value is 1521.
Username This property is required. string
Username for the Oracle connection.
connectionAttributes This property is required. Map<String,String>
Connection string attributes
databaseService This property is required. String
Database for the Oracle connection.
hostname This property is required. String
Hostname for the Oracle connection.
password This property is required. String
Password for the Oracle connection.
port This property is required. Integer
Port for the Oracle connection, default value is 1521.
username This property is required. String
Username for the Oracle connection.
connectionAttributes This property is required. {[key: string]: string}
Connection string attributes
databaseService This property is required. string
Database for the Oracle connection.
hostname This property is required. string
Hostname for the Oracle connection.
password This property is required. string
Password for the Oracle connection.
port This property is required. number
Port for the Oracle connection, default value is 1521.
username This property is required. string
Username for the Oracle connection.
connection_attributes This property is required. Mapping[str, str]
Connection string attributes
database_service This property is required. str
Database for the Oracle connection.
hostname This property is required. str
Hostname for the Oracle connection.
password This property is required. str
Password for the Oracle connection.
port This property is required. int
Port for the Oracle connection, default value is 1521.
username This property is required. str
Username for the Oracle connection.
connectionAttributes This property is required. Map<String>
Connection string attributes
databaseService This property is required. String
Database for the Oracle connection.
hostname This property is required. String
Hostname for the Oracle connection.
password This property is required. String
Password for the Oracle connection.
port This property is required. Number
Port for the Oracle connection, default value is 1521.
username This property is required. String
Username for the Oracle connection.

PrivateConnectivityResponse

PrivateConnectionName This property is required. string
PrivateConnectionName This property is required. string
privateConnectionName This property is required. String
privateConnectionName This property is required. string
private_connection_name This property is required. str
privateConnectionName This property is required. String

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