Google Cloud (GCP) Classic

v6.39.0 published on Wednesday, Sep 28, 2022 by Pulumi

ConnectionProfile

Import

ConnectionProfile can be imported using any of these accepted formats

 $ pulumi import gcp:datastream/connectionProfile:ConnectionProfile default projects/{{project}}/locations/{{location}}/connectionProfiles/{{connection_profile_id}}
 $ pulumi import gcp:datastream/connectionProfile:ConnectionProfile default {{project}}/{{location}}/{{connection_profile_id}}
 $ pulumi import gcp:datastream/connectionProfile:ConnectionProfile default {{location}}/{{connection_profile_id}}

Example Usage

Datastream Connection Profile Basic

using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var @default = new Gcp.Datastream.ConnectionProfile("default", new()
    {
        ConnectionProfileId = "my-profile",
        DisplayName = "Connection profile",
        GcsProfile = new Gcp.Datastream.Inputs.ConnectionProfileGcsProfileArgs
        {
            Bucket = "my-bucket",
            RootPath = "/path",
        },
        Location = "us-central1",
    });

});
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/datastream"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datastream.NewConnectionProfile(ctx, "default", &datastream.ConnectionProfileArgs{
			ConnectionProfileId: pulumi.String("my-profile"),
			DisplayName:         pulumi.String("Connection profile"),
			GcsProfile: &datastream.ConnectionProfileGcsProfileArgs{
				Bucket:   pulumi.String("my-bucket"),
				RootPath: pulumi.String("/path"),
			},
			Location: pulumi.String("us-central1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.datastream.ConnectionProfile;
import com.pulumi.gcp.datastream.ConnectionProfileArgs;
import com.pulumi.gcp.datastream.inputs.ConnectionProfileGcsProfileArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new ConnectionProfile("default", ConnectionProfileArgs.builder()        
            .connectionProfileId("my-profile")
            .displayName("Connection profile")
            .gcsProfile(ConnectionProfileGcsProfileArgs.builder()
                .bucket("my-bucket")
                .rootPath("/path")
                .build())
            .location("us-central1")
            .build());

    }
}
import pulumi
import pulumi_gcp as gcp

default = gcp.datastream.ConnectionProfile("default",
    connection_profile_id="my-profile",
    display_name="Connection profile",
    gcs_profile=gcp.datastream.ConnectionProfileGcsProfileArgs(
        bucket="my-bucket",
        root_path="/path",
    ),
    location="us-central1")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const defaultConnectionProfile = new gcp.datastream.ConnectionProfile("default", {
    connectionProfileId: "my-profile",
    displayName: "Connection profile",
    gcsProfile: {
        bucket: "my-bucket",
        rootPath: "/path",
    },
    location: "us-central1",
});
resources:
  default:
    type: gcp:datastream:ConnectionProfile
    properties:
      connectionProfileId: my-profile
      displayName: Connection profile
      gcsProfile:
        bucket: my-bucket
        rootPath: /path
      location: us-central1

Datastream Connection Profile Full

using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var @default = new Gcp.Datastream.ConnectionProfile("default", new()
    {
        ConnectionProfileId = "my-profile",
        DisplayName = "Connection profile",
        ForwardSshConnectivity = new Gcp.Datastream.Inputs.ConnectionProfileForwardSshConnectivityArgs
        {
            Hostname = "google.com",
            Password = "swordfish",
            Port = 8022,
            Username = "my-user",
        },
        GcsProfile = new Gcp.Datastream.Inputs.ConnectionProfileGcsProfileArgs
        {
            Bucket = "my-bucket",
            RootPath = "/path",
        },
        Location = "us-central1",
    });

});
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/datastream"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datastream.NewConnectionProfile(ctx, "default", &datastream.ConnectionProfileArgs{
			ConnectionProfileId: pulumi.String("my-profile"),
			DisplayName:         pulumi.String("Connection profile"),
			ForwardSshConnectivity: &datastream.ConnectionProfileForwardSshConnectivityArgs{
				Hostname: pulumi.String("google.com"),
				Password: pulumi.String("swordfish"),
				Port:     pulumi.Int(8022),
				Username: pulumi.String("my-user"),
			},
			GcsProfile: &datastream.ConnectionProfileGcsProfileArgs{
				Bucket:   pulumi.String("my-bucket"),
				RootPath: pulumi.String("/path"),
			},
			Location: pulumi.String("us-central1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.datastream.ConnectionProfile;
import com.pulumi.gcp.datastream.ConnectionProfileArgs;
import com.pulumi.gcp.datastream.inputs.ConnectionProfileForwardSshConnectivityArgs;
import com.pulumi.gcp.datastream.inputs.ConnectionProfileGcsProfileArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new ConnectionProfile("default", ConnectionProfileArgs.builder()        
            .connectionProfileId("my-profile")
            .displayName("Connection profile")
            .forwardSshConnectivity(ConnectionProfileForwardSshConnectivityArgs.builder()
                .hostname("google.com")
                .password("swordfish")
                .port(8022)
                .username("my-user")
                .build())
            .gcsProfile(ConnectionProfileGcsProfileArgs.builder()
                .bucket("my-bucket")
                .rootPath("/path")
                .build())
            .location("us-central1")
            .build());

    }
}
import pulumi
import pulumi_gcp as gcp

default = gcp.datastream.ConnectionProfile("default",
    connection_profile_id="my-profile",
    display_name="Connection profile",
    forward_ssh_connectivity=gcp.datastream.ConnectionProfileForwardSshConnectivityArgs(
        hostname="google.com",
        password="swordfish",
        port=8022,
        username="my-user",
    ),
    gcs_profile=gcp.datastream.ConnectionProfileGcsProfileArgs(
        bucket="my-bucket",
        root_path="/path",
    ),
    location="us-central1")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const defaultConnectionProfile = new gcp.datastream.ConnectionProfile("default", {
    connectionProfileId: "my-profile",
    displayName: "Connection profile",
    forwardSshConnectivity: {
        hostname: "google.com",
        password: "swordfish",
        port: 8022,
        username: "my-user",
    },
    gcsProfile: {
        bucket: "my-bucket",
        rootPath: "/path",
    },
    location: "us-central1",
});
resources:
  default:
    type: gcp:datastream:ConnectionProfile
    properties:
      connectionProfileId: my-profile
      displayName: Connection profile
      forwardSshConnectivity:
        hostname: google.com
        password: swordfish
        port: 8022
        username: my-user
      gcsProfile:
        bucket: my-bucket
        rootPath: /path
      location: us-central1

Datastream Connection Profile Postgres

using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;
using Random = Pulumi.Random;

return await Deployment.RunAsync(() => 
{
    var instance = new Gcp.Sql.DatabaseInstance("instance", new()
    {
        DatabaseVersion = "POSTGRES_14",
        Region = "us-central1",
        Settings = new Gcp.Sql.Inputs.DatabaseInstanceSettingsArgs
        {
            Tier = "db-f1-micro",
            IpConfiguration = new Gcp.Sql.Inputs.DatabaseInstanceSettingsIpConfigurationArgs
            {
                AuthorizedNetworks = new[]
                {
                    new Gcp.Sql.Inputs.DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs
                    {
                        Value = "34.71.242.81",
                    },
                    new Gcp.Sql.Inputs.DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs
                    {
                        Value = "34.72.28.29",
                    },
                    new Gcp.Sql.Inputs.DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs
                    {
                        Value = "34.67.6.157",
                    },
                    new Gcp.Sql.Inputs.DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs
                    {
                        Value = "34.67.234.134",
                    },
                    new Gcp.Sql.Inputs.DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs
                    {
                        Value = "34.72.239.218",
                    },
                },
            },
        },
        DeletionProtection = true,
    });

    var db = new Gcp.Sql.Database("db", new()
    {
        Instance = instance.Name,
    });

    var pwd = new Random.RandomPassword("pwd", new()
    {
        Length = 16,
        Special = false,
    });

    var user = new Gcp.Sql.User("user", new()
    {
        Instance = instance.Name,
        Password = pwd.Result,
    });

    var @default = new Gcp.Datastream.ConnectionProfile("default", new()
    {
        DisplayName = "Connection profile",
        Location = "us-central1",
        ConnectionProfileId = "my-profile",
        PostgresqlProfile = new Gcp.Datastream.Inputs.ConnectionProfilePostgresqlProfileArgs
        {
            Hostname = instance.PublicIpAddress,
            Username = user.Name,
            Password = user.Password,
            Database = db.Name,
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/datastream"
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/sql"
	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		instance, err := sql.NewDatabaseInstance(ctx, "instance", &sql.DatabaseInstanceArgs{
			DatabaseVersion: pulumi.String("POSTGRES_14"),
			Region:          pulumi.String("us-central1"),
			Settings: &sql.DatabaseInstanceSettingsArgs{
				Tier: pulumi.String("db-f1-micro"),
				IpConfiguration: &sql.DatabaseInstanceSettingsIpConfigurationArgs{
					AuthorizedNetworks: sql.DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArray{
						&sql.DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs{
							Value: pulumi.String("34.71.242.81"),
						},
						&sql.DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs{
							Value: pulumi.String("34.72.28.29"),
						},
						&sql.DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs{
							Value: pulumi.String("34.67.6.157"),
						},
						&sql.DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs{
							Value: pulumi.String("34.67.234.134"),
						},
						&sql.DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs{
							Value: pulumi.String("34.72.239.218"),
						},
					},
				},
			},
			DeletionProtection: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		db, err := sql.NewDatabase(ctx, "db", &sql.DatabaseArgs{
			Instance: instance.Name,
		})
		if err != nil {
			return err
		}
		pwd, err := random.NewRandomPassword(ctx, "pwd", &random.RandomPasswordArgs{
			Length:  pulumi.Int(16),
			Special: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		user, err := sql.NewUser(ctx, "user", &sql.UserArgs{
			Instance: instance.Name,
			Password: pwd.Result,
		})
		if err != nil {
			return err
		}
		_, err = datastream.NewConnectionProfile(ctx, "default", &datastream.ConnectionProfileArgs{
			DisplayName:         pulumi.String("Connection profile"),
			Location:            pulumi.String("us-central1"),
			ConnectionProfileId: pulumi.String("my-profile"),
			PostgresqlProfile: &datastream.ConnectionProfilePostgresqlProfileArgs{
				Hostname: instance.PublicIpAddress,
				Username: user.Name,
				Password: user.Password,
				Database: db.Name,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.sql.DatabaseInstance;
import com.pulumi.gcp.sql.DatabaseInstanceArgs;
import com.pulumi.gcp.sql.inputs.DatabaseInstanceSettingsArgs;
import com.pulumi.gcp.sql.inputs.DatabaseInstanceSettingsIpConfigurationArgs;
import com.pulumi.gcp.sql.Database;
import com.pulumi.gcp.sql.DatabaseArgs;
import com.pulumi.random.RandomPassword;
import com.pulumi.random.RandomPasswordArgs;
import com.pulumi.gcp.sql.User;
import com.pulumi.gcp.sql.UserArgs;
import com.pulumi.gcp.datastream.ConnectionProfile;
import com.pulumi.gcp.datastream.ConnectionProfileArgs;
import com.pulumi.gcp.datastream.inputs.ConnectionProfilePostgresqlProfileArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var instance = new DatabaseInstance("instance", DatabaseInstanceArgs.builder()        
            .databaseVersion("POSTGRES_14")
            .region("us-central1")
            .settings(DatabaseInstanceSettingsArgs.builder()
                .tier("db-f1-micro")
                .ipConfiguration(DatabaseInstanceSettingsIpConfigurationArgs.builder()
                    .authorizedNetworks(                    
                        DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs.builder()
                            .value("34.71.242.81")
                            .build(),
                        DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs.builder()
                            .value("34.72.28.29")
                            .build(),
                        DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs.builder()
                            .value("34.67.6.157")
                            .build(),
                        DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs.builder()
                            .value("34.67.234.134")
                            .build(),
                        DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs.builder()
                            .value("34.72.239.218")
                            .build())
                    .build())
                .build())
            .deletionProtection("true")
            .build());

        var db = new Database("db", DatabaseArgs.builder()        
            .instance(instance.name())
            .build());

        var pwd = new RandomPassword("pwd", RandomPasswordArgs.builder()        
            .length(16)
            .special(false)
            .build());

        var user = new User("user", UserArgs.builder()        
            .instance(instance.name())
            .password(pwd.result())
            .build());

        var default_ = new ConnectionProfile("default", ConnectionProfileArgs.builder()        
            .displayName("Connection profile")
            .location("us-central1")
            .connectionProfileId("my-profile")
            .postgresqlProfile(ConnectionProfilePostgresqlProfileArgs.builder()
                .hostname(instance.publicIpAddress())
                .username(user.name())
                .password(user.password())
                .database(db.name())
                .build())
            .build());

    }
}
import pulumi
import pulumi_gcp as gcp
import pulumi_random as random

instance = gcp.sql.DatabaseInstance("instance",
    database_version="POSTGRES_14",
    region="us-central1",
    settings=gcp.sql.DatabaseInstanceSettingsArgs(
        tier="db-f1-micro",
        ip_configuration=gcp.sql.DatabaseInstanceSettingsIpConfigurationArgs(
            authorized_networks=[
                gcp.sql.DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs(
                    value="34.71.242.81",
                ),
                gcp.sql.DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs(
                    value="34.72.28.29",
                ),
                gcp.sql.DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs(
                    value="34.67.6.157",
                ),
                gcp.sql.DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs(
                    value="34.67.234.134",
                ),
                gcp.sql.DatabaseInstanceSettingsIpConfigurationAuthorizedNetworkArgs(
                    value="34.72.239.218",
                ),
            ],
        ),
    ),
    deletion_protection=True)
db = gcp.sql.Database("db", instance=instance.name)
pwd = random.RandomPassword("pwd",
    length=16,
    special=False)
user = gcp.sql.User("user",
    instance=instance.name,
    password=pwd.result)
default = gcp.datastream.ConnectionProfile("default",
    display_name="Connection profile",
    location="us-central1",
    connection_profile_id="my-profile",
    postgresql_profile=gcp.datastream.ConnectionProfilePostgresqlProfileArgs(
        hostname=instance.public_ip_address,
        username=user.name,
        password=user.password,
        database=db.name,
    ))
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
import * as random from "@pulumi/random";

const instance = new gcp.sql.DatabaseInstance("instance", {
    databaseVersion: "POSTGRES_14",
    region: "us-central1",
    settings: {
        tier: "db-f1-micro",
        ipConfiguration: {
            authorizedNetworks: [
                {
                    value: "34.71.242.81",
                },
                {
                    value: "34.72.28.29",
                },
                {
                    value: "34.67.6.157",
                },
                {
                    value: "34.67.234.134",
                },
                {
                    value: "34.72.239.218",
                },
            ],
        },
    },
    deletionProtection: true,
});
const db = new gcp.sql.Database("db", {instance: instance.name});
const pwd = new random.RandomPassword("pwd", {
    length: 16,
    special: false,
});
const user = new gcp.sql.User("user", {
    instance: instance.name,
    password: pwd.result,
});
const _default = new gcp.datastream.ConnectionProfile("default", {
    displayName: "Connection profile",
    location: "us-central1",
    connectionProfileId: "my-profile",
    postgresqlProfile: {
        hostname: instance.publicIpAddress,
        username: user.name,
        password: user.password,
        database: db.name,
    },
});
resources:
  instance:
    type: gcp:sql:DatabaseInstance
    properties:
      databaseVersion: POSTGRES_14
      region: us-central1
      settings:
        tier: db-f1-micro
        ipConfiguration:
          authorizedNetworks:
            - value: 34.71.242.81
            - value: 34.72.28.29
            - value: 34.67.6.157
            - value: 34.67.234.134
            - value: 34.72.239.218
      deletionProtection: true
  db:
    type: gcp:sql:Database
    properties:
      instance: ${instance.name}
  pwd:
    type: random:RandomPassword
    properties:
      length: 16
      special: false
  user:
    type: gcp:sql:User
    properties:
      instance: ${instance.name}
      password: ${pwd.result}
  default:
    type: gcp:datastream:ConnectionProfile
    properties:
      displayName: Connection profile
      location: us-central1
      connectionProfileId: my-profile
      postgresqlProfile:
        hostname: ${instance.publicIpAddress}
        username: ${user.name}
        password: ${user.password}
        database: ${db.name}

Create a ConnectionProfile Resource

new ConnectionProfile(name: string, args: ConnectionProfileArgs, opts?: CustomResourceOptions);
@overload
def ConnectionProfile(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      connection_profile_id: Optional[str] = None,
                      display_name: Optional[str] = None,
                      forward_ssh_connectivity: Optional[ConnectionProfileForwardSshConnectivityArgs] = None,
                      gcs_profile: Optional[ConnectionProfileGcsProfileArgs] = None,
                      labels: Optional[Mapping[str, str]] = None,
                      location: Optional[str] = None,
                      mysql_profile: Optional[ConnectionProfileMysqlProfileArgs] = None,
                      oracle_profile: Optional[ConnectionProfileOracleProfileArgs] = None,
                      postgresql_profile: Optional[ConnectionProfilePostgresqlProfileArgs] = None,
                      project: Optional[str] = None)
@overload
def ConnectionProfile(resource_name: str,
                      args: ConnectionProfileArgs,
                      opts: Optional[ResourceOptions] = None)
func NewConnectionProfile(ctx *Context, name string, args ConnectionProfileArgs, opts ...ResourceOption) (*ConnectionProfile, error)
public ConnectionProfile(string name, ConnectionProfileArgs args, CustomResourceOptions? opts = null)
public ConnectionProfile(String name, ConnectionProfileArgs args)
public ConnectionProfile(String name, ConnectionProfileArgs args, CustomResourceOptions options)
type: gcp:datastream:ConnectionProfile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ConnectionProfileArgs
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 ConnectionProfileArgs
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 ConnectionProfileArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ConnectionProfileArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ConnectionProfileArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ConnectionProfile 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 ConnectionProfile resource accepts the following input properties:

ConnectionProfileId string

The connection profile identifier.

DisplayName string

Display name.

Location string

The name of the location this repository is located in.

ForwardSshConnectivity ConnectionProfileForwardSshConnectivityArgs

Forward SSH tunnel connectivity. Structure is documented below.

GcsProfile ConnectionProfileGcsProfileArgs

Cloud Storage bucket profile. Structure is documented below.

Labels Dictionary<string, string>

Labels.

MysqlProfile ConnectionProfileMysqlProfileArgs

MySQL database profile. Structure is documented below.

OracleProfile ConnectionProfileOracleProfileArgs

Oracle database profile. Structure is documented below.

PostgresqlProfile ConnectionProfilePostgresqlProfileArgs

PostgreSQL database profile. Structure is documented below.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

ConnectionProfileId string

The connection profile identifier.

DisplayName string

Display name.

Location string

The name of the location this repository is located in.

ForwardSshConnectivity ConnectionProfileForwardSshConnectivityArgs

Forward SSH tunnel connectivity. Structure is documented below.

GcsProfile ConnectionProfileGcsProfileArgs

Cloud Storage bucket profile. Structure is documented below.

Labels map[string]string

Labels.

MysqlProfile ConnectionProfileMysqlProfileArgs

MySQL database profile. Structure is documented below.

OracleProfile ConnectionProfileOracleProfileArgs

Oracle database profile. Structure is documented below.

PostgresqlProfile ConnectionProfilePostgresqlProfileArgs

PostgreSQL database profile. Structure is documented below.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

connectionProfileId String

The connection profile identifier.

displayName String

Display name.

location String

The name of the location this repository is located in.

forwardSshConnectivity ConnectionProfileForwardSshConnectivityArgs

Forward SSH tunnel connectivity. Structure is documented below.

gcsProfile ConnectionProfileGcsProfileArgs

Cloud Storage bucket profile. Structure is documented below.

labels Map<String,String>

Labels.

mysqlProfile ConnectionProfileMysqlProfileArgs

MySQL database profile. Structure is documented below.

oracleProfile ConnectionProfileOracleProfileArgs

Oracle database profile. Structure is documented below.

postgresqlProfile ConnectionProfilePostgresqlProfileArgs

PostgreSQL database profile. Structure is documented below.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

connectionProfileId string

The connection profile identifier.

displayName string

Display name.

location string

The name of the location this repository is located in.

forwardSshConnectivity ConnectionProfileForwardSshConnectivityArgs

Forward SSH tunnel connectivity. Structure is documented below.

gcsProfile ConnectionProfileGcsProfileArgs

Cloud Storage bucket profile. Structure is documented below.

labels {[key: string]: string}

Labels.

mysqlProfile ConnectionProfileMysqlProfileArgs

MySQL database profile. Structure is documented below.

oracleProfile ConnectionProfileOracleProfileArgs

Oracle database profile. Structure is documented below.

postgresqlProfile ConnectionProfilePostgresqlProfileArgs

PostgreSQL database profile. Structure is documented below.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

connection_profile_id str

The connection profile identifier.

display_name str

Display name.

location str

The name of the location this repository is located in.

forward_ssh_connectivity ConnectionProfileForwardSshConnectivityArgs

Forward SSH tunnel connectivity. Structure is documented below.

gcs_profile ConnectionProfileGcsProfileArgs

Cloud Storage bucket profile. Structure is documented below.

labels Mapping[str, str]

Labels.

mysql_profile ConnectionProfileMysqlProfileArgs

MySQL database profile. Structure is documented below.

oracle_profile ConnectionProfileOracleProfileArgs

Oracle database profile. Structure is documented below.

postgresql_profile ConnectionProfilePostgresqlProfileArgs

PostgreSQL database profile. Structure is documented below.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

connectionProfileId String

The connection profile identifier.

displayName String

Display name.

location String

The name of the location this repository is located in.

forwardSshConnectivity Property Map

Forward SSH tunnel connectivity. Structure is documented below.

gcsProfile Property Map

Cloud Storage bucket profile. Structure is documented below.

labels Map<String>

Labels.

mysqlProfile Property Map

MySQL database profile. Structure is documented below.

oracleProfile Property Map

Oracle database profile. Structure is documented below.

postgresqlProfile Property Map

PostgreSQL database profile. Structure is documented below.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Name string

The resource's name.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The resource's name.

id String

The provider-assigned unique ID for this managed resource.

name String

The resource's name.

id string

The provider-assigned unique ID for this managed resource.

name string

The resource's name.

id str

The provider-assigned unique ID for this managed resource.

name str

The resource's name.

id String

The provider-assigned unique ID for this managed resource.

name String

The resource's name.

Look up an Existing ConnectionProfile Resource

Get an existing ConnectionProfile resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ConnectionProfileState, opts?: CustomResourceOptions): ConnectionProfile
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connection_profile_id: Optional[str] = None,
        display_name: Optional[str] = None,
        forward_ssh_connectivity: Optional[ConnectionProfileForwardSshConnectivityArgs] = None,
        gcs_profile: Optional[ConnectionProfileGcsProfileArgs] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        mysql_profile: Optional[ConnectionProfileMysqlProfileArgs] = None,
        name: Optional[str] = None,
        oracle_profile: Optional[ConnectionProfileOracleProfileArgs] = None,
        postgresql_profile: Optional[ConnectionProfilePostgresqlProfileArgs] = None,
        project: Optional[str] = None) -> ConnectionProfile
func GetConnectionProfile(ctx *Context, name string, id IDInput, state *ConnectionProfileState, opts ...ResourceOption) (*ConnectionProfile, error)
public static ConnectionProfile Get(string name, Input<string> id, ConnectionProfileState? state, CustomResourceOptions? opts = null)
public static ConnectionProfile get(String name, Output<String> id, ConnectionProfileState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ConnectionProfileId string

The connection profile identifier.

DisplayName string

Display name.

ForwardSshConnectivity ConnectionProfileForwardSshConnectivityArgs

Forward SSH tunnel connectivity. Structure is documented below.

GcsProfile ConnectionProfileGcsProfileArgs

Cloud Storage bucket profile. Structure is documented below.

Labels Dictionary<string, string>

Labels.

Location string

The name of the location this repository is located in.

MysqlProfile ConnectionProfileMysqlProfileArgs

MySQL database profile. Structure is documented below.

Name string

The resource's name.

OracleProfile ConnectionProfileOracleProfileArgs

Oracle database profile. Structure is documented below.

PostgresqlProfile ConnectionProfilePostgresqlProfileArgs

PostgreSQL database profile. Structure is documented below.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

ConnectionProfileId string

The connection profile identifier.

DisplayName string

Display name.

ForwardSshConnectivity ConnectionProfileForwardSshConnectivityArgs

Forward SSH tunnel connectivity. Structure is documented below.

GcsProfile ConnectionProfileGcsProfileArgs

Cloud Storage bucket profile. Structure is documented below.

Labels map[string]string

Labels.

Location string

The name of the location this repository is located in.

MysqlProfile ConnectionProfileMysqlProfileArgs

MySQL database profile. Structure is documented below.

Name string

The resource's name.

OracleProfile ConnectionProfileOracleProfileArgs

Oracle database profile. Structure is documented below.

PostgresqlProfile ConnectionProfilePostgresqlProfileArgs

PostgreSQL database profile. Structure is documented below.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

connectionProfileId String

The connection profile identifier.

displayName String

Display name.

forwardSshConnectivity ConnectionProfileForwardSshConnectivityArgs

Forward SSH tunnel connectivity. Structure is documented below.

gcsProfile ConnectionProfileGcsProfileArgs

Cloud Storage bucket profile. Structure is documented below.

labels Map<String,String>

Labels.

location String

The name of the location this repository is located in.

mysqlProfile ConnectionProfileMysqlProfileArgs

MySQL database profile. Structure is documented below.

name String

The resource's name.

oracleProfile ConnectionProfileOracleProfileArgs

Oracle database profile. Structure is documented below.

postgresqlProfile ConnectionProfilePostgresqlProfileArgs

PostgreSQL database profile. Structure is documented below.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

connectionProfileId string

The connection profile identifier.

displayName string

Display name.

forwardSshConnectivity ConnectionProfileForwardSshConnectivityArgs

Forward SSH tunnel connectivity. Structure is documented below.

gcsProfile ConnectionProfileGcsProfileArgs

Cloud Storage bucket profile. Structure is documented below.

labels {[key: string]: string}

Labels.

location string

The name of the location this repository is located in.

mysqlProfile ConnectionProfileMysqlProfileArgs

MySQL database profile. Structure is documented below.

name string

The resource's name.

oracleProfile ConnectionProfileOracleProfileArgs

Oracle database profile. Structure is documented below.

postgresqlProfile ConnectionProfilePostgresqlProfileArgs

PostgreSQL database profile. Structure is documented below.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

connection_profile_id str

The connection profile identifier.

display_name str

Display name.

forward_ssh_connectivity ConnectionProfileForwardSshConnectivityArgs

Forward SSH tunnel connectivity. Structure is documented below.

gcs_profile ConnectionProfileGcsProfileArgs

Cloud Storage bucket profile. Structure is documented below.

labels Mapping[str, str]

Labels.

location str

The name of the location this repository is located in.

mysql_profile ConnectionProfileMysqlProfileArgs

MySQL database profile. Structure is documented below.

name str

The resource's name.

oracle_profile ConnectionProfileOracleProfileArgs

Oracle database profile. Structure is documented below.

postgresql_profile ConnectionProfilePostgresqlProfileArgs

PostgreSQL database profile. Structure is documented below.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

connectionProfileId String

The connection profile identifier.

displayName String

Display name.

forwardSshConnectivity Property Map

Forward SSH tunnel connectivity. Structure is documented below.

gcsProfile Property Map

Cloud Storage bucket profile. Structure is documented below.

labels Map<String>

Labels.

location String

The name of the location this repository is located in.

mysqlProfile Property Map

MySQL database profile. Structure is documented below.

name String

The resource's name.

oracleProfile Property Map

Oracle database profile. Structure is documented below.

postgresqlProfile Property Map

PostgreSQL database profile. Structure is documented below.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Supporting Types

ConnectionProfileForwardSshConnectivity

Hostname string

Hostname for the SSH tunnel.

Username string

Username for the SSH tunnel.

Password string

SSH password. Note: This property is sensitive and will not be displayed in the plan.

Port int

Port for the SSH tunnel.

PrivateKey string

SSH private key. Note: This property is sensitive and will not be displayed in the plan.

Hostname string

Hostname for the SSH tunnel.

Username string

Username for the SSH tunnel.

Password string

SSH password. Note: This property is sensitive and will not be displayed in the plan.

Port int

Port for the SSH tunnel.

PrivateKey string

SSH private key. Note: This property is sensitive and will not be displayed in the plan.

hostname String

Hostname for the SSH tunnel.

username String

Username for the SSH tunnel.

password String

SSH password. Note: This property is sensitive and will not be displayed in the plan.

port Integer

Port for the SSH tunnel.

privateKey String

SSH private key. Note: This property is sensitive and will not be displayed in the plan.

hostname string

Hostname for the SSH tunnel.

username string

Username for the SSH tunnel.

password string

SSH password. Note: This property is sensitive and will not be displayed in the plan.

port number

Port for the SSH tunnel.

privateKey string

SSH private key. Note: This property is sensitive and will not be displayed in the plan.

hostname str

Hostname for the SSH tunnel.

username str

Username for the SSH tunnel.

password str

SSH password. Note: This property is sensitive and will not be displayed in the plan.

port int

Port for the SSH tunnel.

private_key str

SSH private key. Note: This property is sensitive and will not be displayed in the plan.

hostname String

Hostname for the SSH tunnel.

username String

Username for the SSH tunnel.

password String

SSH password. Note: This property is sensitive and will not be displayed in the plan.

port Number

Port for the SSH tunnel.

privateKey String

SSH private key. Note: This property is sensitive and will not be displayed in the plan.

ConnectionProfileGcsProfile

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.

ConnectionProfileMysqlProfile

Hostname string

Hostname for the SSH tunnel.

Password string

SSH password. Note: This property is sensitive and will not be displayed in the plan.

Username string

Username for the SSH tunnel.

Port int

Port for the SSH tunnel.

SslConfig ConnectionProfileMysqlProfileSslConfig

SSL configuration for the MySQL connection. Structure is documented below.

Hostname string

Hostname for the SSH tunnel.

Password string

SSH password. Note: This property is sensitive and will not be displayed in the plan.

Username string

Username for the SSH tunnel.

Port int

Port for the SSH tunnel.

SslConfig ConnectionProfileMysqlProfileSslConfig

SSL configuration for the MySQL connection. Structure is documented below.

hostname String

Hostname for the SSH tunnel.

password String

SSH password. Note: This property is sensitive and will not be displayed in the plan.

username String

Username for the SSH tunnel.

port Integer

Port for the SSH tunnel.

sslConfig ConnectionProfileMysqlProfileSslConfig

SSL configuration for the MySQL connection. Structure is documented below.

hostname string

Hostname for the SSH tunnel.

password string

SSH password. Note: This property is sensitive and will not be displayed in the plan.

username string

Username for the SSH tunnel.

port number

Port for the SSH tunnel.

sslConfig ConnectionProfileMysqlProfileSslConfig

SSL configuration for the MySQL connection. Structure is documented below.

hostname str

Hostname for the SSH tunnel.

password str

SSH password. Note: This property is sensitive and will not be displayed in the plan.

username str

Username for the SSH tunnel.

port int

Port for the SSH tunnel.

ssl_config ConnectionProfileMysqlProfileSslConfig

SSL configuration for the MySQL connection. Structure is documented below.

hostname String

Hostname for the SSH tunnel.

password String

SSH password. Note: This property is sensitive and will not be displayed in the plan.

username String

Username for the SSH tunnel.

port Number

Port for the SSH tunnel.

sslConfig Property Map

SSL configuration for the MySQL connection. Structure is documented below.

ConnectionProfileMysqlProfileSslConfig

CaCertificate string

PEM-encoded certificate of the CA that signed the source database server's certificate. Note: This property is sensitive and will not be displayed in the plan.

CaCertificateSet bool

Indicates whether the clientKey field is set.

ClientCertificate string

PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'clientKey' and the 'caCertificate' fields are mandatory. Note: This property is sensitive and will not be displayed in the plan.

ClientCertificateSet bool

Indicates whether the clientCertificate field is set.

ClientKey string

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. Note: This property is sensitive and will not be displayed in the plan.

ClientKeySet bool

Indicates whether the clientKey field is set.

CaCertificate string

PEM-encoded certificate of the CA that signed the source database server's certificate. Note: This property is sensitive and will not be displayed in the plan.

CaCertificateSet bool

Indicates whether the clientKey field is set.

ClientCertificate string

PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'clientKey' and the 'caCertificate' fields are mandatory. Note: This property is sensitive and will not be displayed in the plan.

ClientCertificateSet bool

Indicates whether the clientCertificate field is set.

ClientKey string

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. Note: This property is sensitive and will not be displayed in the plan.

ClientKeySet bool

Indicates whether the clientKey field is set.

caCertificate String

PEM-encoded certificate of the CA that signed the source database server's certificate. Note: This property is sensitive and will not be displayed in the plan.

caCertificateSet Boolean

Indicates whether the clientKey field is set.

clientCertificate String

PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'clientKey' and the 'caCertificate' fields are mandatory. Note: This property is sensitive and will not be displayed in the plan.

clientCertificateSet Boolean

Indicates whether the clientCertificate field is set.

clientKey String

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. Note: This property is sensitive and will not be displayed in the plan.

clientKeySet Boolean

Indicates whether the clientKey field is set.

caCertificate string

PEM-encoded certificate of the CA that signed the source database server's certificate. Note: This property is sensitive and will not be displayed in the plan.

caCertificateSet boolean

Indicates whether the clientKey field is set.

clientCertificate string

PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'clientKey' and the 'caCertificate' fields are mandatory. Note: This property is sensitive and will not be displayed in the plan.

clientCertificateSet boolean

Indicates whether the clientCertificate field is set.

clientKey string

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. Note: This property is sensitive and will not be displayed in the plan.

clientKeySet boolean

Indicates whether the clientKey field is set.

ca_certificate str

PEM-encoded certificate of the CA that signed the source database server's certificate. Note: This property is sensitive and will not be displayed in the plan.

ca_certificate_set bool

Indicates whether the clientKey field is set.

client_certificate str

PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'clientKey' and the 'caCertificate' fields are mandatory. Note: This property is sensitive and will not be displayed in the plan.

client_certificate_set bool

Indicates whether the clientCertificate field is set.

client_key str

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. Note: This property is sensitive and will not be displayed in the plan.

client_key_set bool

Indicates whether the clientKey field is set.

caCertificate String

PEM-encoded certificate of the CA that signed the source database server's certificate. Note: This property is sensitive and will not be displayed in the plan.

caCertificateSet Boolean

Indicates whether the clientKey field is set.

clientCertificate String

PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'clientKey' and the 'caCertificate' fields are mandatory. Note: This property is sensitive and will not be displayed in the plan.

clientCertificateSet Boolean

Indicates whether the clientCertificate field is set.

clientKey String

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. Note: This property is sensitive and will not be displayed in the plan.

clientKeySet Boolean

Indicates whether the clientKey field is set.

ConnectionProfileOracleProfile

DatabaseService string

Database for the Oracle connection.

Hostname string

Hostname for the SSH tunnel.

Password string

SSH password. Note: This property is sensitive and will not be displayed in the plan.

Username string

Username for the SSH tunnel.

ConnectionAttributes Dictionary<string, string>

Connection string attributes

Port int

Port for the SSH tunnel.

DatabaseService string

Database for the Oracle connection.

Hostname string

Hostname for the SSH tunnel.

Password string

SSH password. Note: This property is sensitive and will not be displayed in the plan.

Username string

Username for the SSH tunnel.

ConnectionAttributes map[string]string

Connection string attributes

Port int

Port for the SSH tunnel.

databaseService String

Database for the Oracle connection.

hostname String

Hostname for the SSH tunnel.

password String

SSH password. Note: This property is sensitive and will not be displayed in the plan.

username String

Username for the SSH tunnel.

connectionAttributes Map<String,String>

Connection string attributes

port Integer

Port for the SSH tunnel.

databaseService string

Database for the Oracle connection.

hostname string

Hostname for the SSH tunnel.

password string

SSH password. Note: This property is sensitive and will not be displayed in the plan.

username string

Username for the SSH tunnel.

connectionAttributes {[key: string]: string}

Connection string attributes

port number

Port for the SSH tunnel.

database_service str

Database for the Oracle connection.

hostname str

Hostname for the SSH tunnel.

password str

SSH password. Note: This property is sensitive and will not be displayed in the plan.

username str

Username for the SSH tunnel.

connection_attributes Mapping[str, str]

Connection string attributes

port int

Port for the SSH tunnel.

databaseService String

Database for the Oracle connection.

hostname String

Hostname for the SSH tunnel.

password String

SSH password. Note: This property is sensitive and will not be displayed in the plan.

username String

Username for the SSH tunnel.

connectionAttributes Map<String>

Connection string attributes

port Number

Port for the SSH tunnel.

ConnectionProfilePostgresqlProfile

Database string

Database for the PostgreSQL connection.

Hostname string

Hostname for the SSH tunnel.

Password string

SSH password. Note: This property is sensitive and will not be displayed in the plan.

Username string

Username for the SSH tunnel.

Port int

Port for the SSH tunnel.

Database string

Database for the PostgreSQL connection.

Hostname string

Hostname for the SSH tunnel.

Password string

SSH password. Note: This property is sensitive and will not be displayed in the plan.

Username string

Username for the SSH tunnel.

Port int

Port for the SSH tunnel.

database String

Database for the PostgreSQL connection.

hostname String

Hostname for the SSH tunnel.

password String

SSH password. Note: This property is sensitive and will not be displayed in the plan.

username String

Username for the SSH tunnel.

port Integer

Port for the SSH tunnel.

database string

Database for the PostgreSQL connection.

hostname string

Hostname for the SSH tunnel.

password string

SSH password. Note: This property is sensitive and will not be displayed in the plan.

username string

Username for the SSH tunnel.

port number

Port for the SSH tunnel.

database str

Database for the PostgreSQL connection.

hostname str

Hostname for the SSH tunnel.

password str

SSH password. Note: This property is sensitive and will not be displayed in the plan.

username str

Username for the SSH tunnel.

port int

Port for the SSH tunnel.

database String

Database for the PostgreSQL connection.

hostname String

Hostname for the SSH tunnel.

password String

SSH password. Note: This property is sensitive and will not be displayed in the plan.

username String

Username for the SSH tunnel.

port Number

Port for the SSH tunnel.

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes

This Pulumi package is based on the google-beta Terraform Provider.