1. Pulumi Registry
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. sql
  5. SourceRepresentationInstance
gcp logo
Google Cloud Classic v6.52.0, Mar 22 23

gcp.sql.SourceRepresentationInstance

Import

SourceRepresentationInstance can be imported using any of these accepted formats

 $ pulumi import gcp:sql/sourceRepresentationInstance:SourceRepresentationInstance default projects/{{project}}/instances/{{name}}

 $ pulumi import gcp:sql/sourceRepresentationInstance:SourceRepresentationInstance default {{project}}/{{name}}

 $ pulumi import gcp:sql/sourceRepresentationInstance:SourceRepresentationInstance default {{name}}

Example Usage

Sql Source Representation Instance Basic

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

return await Deployment.RunAsync(() => 
{
    var instance = new Gcp.Sql.SourceRepresentationInstance("instance", new()
    {
        DatabaseVersion = "MYSQL_8_0",
        DumpFilePath = "gs://replica-bucket/source-database.sql.gz",
        Host = "10.20.30.40",
        Password = "password-for-the-user",
        Port = 3306,
        Region = "us-central1",
        Username = "some-user",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sql.NewSourceRepresentationInstance(ctx, "instance", &sql.SourceRepresentationInstanceArgs{
			DatabaseVersion: pulumi.String("MYSQL_8_0"),
			DumpFilePath:    pulumi.String("gs://replica-bucket/source-database.sql.gz"),
			Host:            pulumi.String("10.20.30.40"),
			Password:        pulumi.String("password-for-the-user"),
			Port:            pulumi.Int(3306),
			Region:          pulumi.String("us-central1"),
			Username:        pulumi.String("some-user"),
		})
		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.SourceRepresentationInstance;
import com.pulumi.gcp.sql.SourceRepresentationInstanceArgs;
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 SourceRepresentationInstance("instance", SourceRepresentationInstanceArgs.builder()        
            .databaseVersion("MYSQL_8_0")
            .dumpFilePath("gs://replica-bucket/source-database.sql.gz")
            .host("10.20.30.40")
            .password("password-for-the-user")
            .port(3306)
            .region("us-central1")
            .username("some-user")
            .build());

    }
}

import pulumi
import pulumi_gcp as gcp

instance = gcp.sql.SourceRepresentationInstance("instance",
    database_version="MYSQL_8_0",
    dump_file_path="gs://replica-bucket/source-database.sql.gz",
    host="10.20.30.40",
    password="password-for-the-user",
    port=3306,
    region="us-central1",
    username="some-user")

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const instance = new gcp.sql.SourceRepresentationInstance("instance", {
    databaseVersion: "MYSQL_8_0",
    dumpFilePath: "gs://replica-bucket/source-database.sql.gz",
    host: "10.20.30.40",
    password: "password-for-the-user",
    port: 3306,
    region: "us-central1",
    username: "some-user",
});

resources:
  instance:
    type: gcp:sql:SourceRepresentationInstance
    properties:
      databaseVersion: MYSQL_8_0
      dumpFilePath: gs://replica-bucket/source-database.sql.gz
      host: 10.20.30.40
      password: password-for-the-user
      port: 3306
      region: us-central1
      username: some-user

Create SourceRepresentationInstance Resource

new SourceRepresentationInstance(name: string, args: SourceRepresentationInstanceArgs, opts?: CustomResourceOptions);
@overload
def SourceRepresentationInstance(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 ca_certificate: Optional[str] = None,
                                 client_certificate: Optional[str] = None,
                                 client_key: Optional[str] = None,
                                 database_version: Optional[str] = None,
                                 dump_file_path: Optional[str] = None,
                                 host: Optional[str] = None,
                                 name: Optional[str] = None,
                                 password: Optional[str] = None,
                                 port: Optional[int] = None,
                                 project: Optional[str] = None,
                                 region: Optional[str] = None,
                                 username: Optional[str] = None)
@overload
def SourceRepresentationInstance(resource_name: str,
                                 args: SourceRepresentationInstanceArgs,
                                 opts: Optional[ResourceOptions] = None)
func NewSourceRepresentationInstance(ctx *Context, name string, args SourceRepresentationInstanceArgs, opts ...ResourceOption) (*SourceRepresentationInstance, error)
public SourceRepresentationInstance(string name, SourceRepresentationInstanceArgs args, CustomResourceOptions? opts = null)
public SourceRepresentationInstance(String name, SourceRepresentationInstanceArgs args)
public SourceRepresentationInstance(String name, SourceRepresentationInstanceArgs args, CustomResourceOptions options)

type: gcp:sql:SourceRepresentationInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args SourceRepresentationInstanceArgs
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 SourceRepresentationInstanceArgs
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 SourceRepresentationInstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args SourceRepresentationInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args SourceRepresentationInstanceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

DatabaseVersion string

The MySQL version running on your source database server. Possible values are MYSQL_5_5, MYSQL_5_6, MYSQL_5_7, and MYSQL_8_0.

Host string

The externally accessible IPv4 address for the source database server.

CaCertificate string

The CA certificate on the external server. Include only if SSL/TLS is used on the external server.

ClientCertificate string

The client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

ClientKey string

The private key file for the client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

DumpFilePath string

A file in the bucket that contains the data from the external server.

Name string

The name of the source representation instance. Use any valid Cloud SQL instance name.

Password string

The password for the replication user account. Note: This property is sensitive and will not be displayed in the plan.

Port int

The externally accessible port for the source database server. Defaults to 3306.

Project string

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

Region string

The Region in which the created instance should reside. If it is not provided, the provider region is used.

Username string

The replication user account on the external server.

DatabaseVersion string

The MySQL version running on your source database server. Possible values are MYSQL_5_5, MYSQL_5_6, MYSQL_5_7, and MYSQL_8_0.

Host string

The externally accessible IPv4 address for the source database server.

CaCertificate string

The CA certificate on the external server. Include only if SSL/TLS is used on the external server.

ClientCertificate string

The client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

ClientKey string

The private key file for the client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

DumpFilePath string

A file in the bucket that contains the data from the external server.

Name string

The name of the source representation instance. Use any valid Cloud SQL instance name.

Password string

The password for the replication user account. Note: This property is sensitive and will not be displayed in the plan.

Port int

The externally accessible port for the source database server. Defaults to 3306.

Project string

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

Region string

The Region in which the created instance should reside. If it is not provided, the provider region is used.

Username string

The replication user account on the external server.

databaseVersion String

The MySQL version running on your source database server. Possible values are MYSQL_5_5, MYSQL_5_6, MYSQL_5_7, and MYSQL_8_0.

host String

The externally accessible IPv4 address for the source database server.

caCertificate String

The CA certificate on the external server. Include only if SSL/TLS is used on the external server.

clientCertificate String

The client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

clientKey String

The private key file for the client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

dumpFilePath String

A file in the bucket that contains the data from the external server.

name String

The name of the source representation instance. Use any valid Cloud SQL instance name.

password String

The password for the replication user account. Note: This property is sensitive and will not be displayed in the plan.

port Integer

The externally accessible port for the source database server. Defaults to 3306.

project String

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

region String

The Region in which the created instance should reside. If it is not provided, the provider region is used.

username String

The replication user account on the external server.

databaseVersion string

The MySQL version running on your source database server. Possible values are MYSQL_5_5, MYSQL_5_6, MYSQL_5_7, and MYSQL_8_0.

host string

The externally accessible IPv4 address for the source database server.

caCertificate string

The CA certificate on the external server. Include only if SSL/TLS is used on the external server.

clientCertificate string

The client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

clientKey string

The private key file for the client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

dumpFilePath string

A file in the bucket that contains the data from the external server.

name string

The name of the source representation instance. Use any valid Cloud SQL instance name.

password string

The password for the replication user account. Note: This property is sensitive and will not be displayed in the plan.

port number

The externally accessible port for the source database server. Defaults to 3306.

project string

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

region string

The Region in which the created instance should reside. If it is not provided, the provider region is used.

username string

The replication user account on the external server.

database_version str

The MySQL version running on your source database server. Possible values are MYSQL_5_5, MYSQL_5_6, MYSQL_5_7, and MYSQL_8_0.

host str

The externally accessible IPv4 address for the source database server.

ca_certificate str

The CA certificate on the external server. Include only if SSL/TLS is used on the external server.

client_certificate str

The client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

client_key str

The private key file for the client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

dump_file_path str

A file in the bucket that contains the data from the external server.

name str

The name of the source representation instance. Use any valid Cloud SQL instance name.

password str

The password for the replication user account. Note: This property is sensitive and will not be displayed in the plan.

port int

The externally accessible port for the source database server. Defaults to 3306.

project str

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

region str

The Region in which the created instance should reside. If it is not provided, the provider region is used.

username str

The replication user account on the external server.

databaseVersion String

The MySQL version running on your source database server. Possible values are MYSQL_5_5, MYSQL_5_6, MYSQL_5_7, and MYSQL_8_0.

host String

The externally accessible IPv4 address for the source database server.

caCertificate String

The CA certificate on the external server. Include only if SSL/TLS is used on the external server.

clientCertificate String

The client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

clientKey String

The private key file for the client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

dumpFilePath String

A file in the bucket that contains the data from the external server.

name String

The name of the source representation instance. Use any valid Cloud SQL instance name.

password String

The password for the replication user account. Note: This property is sensitive and will not be displayed in the plan.

port Number

The externally accessible port for the source database server. Defaults to 3306.

project String

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

region String

The Region in which the created instance should reside. If it is not provided, the provider region is used.

username String

The replication user account on the external server.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing SourceRepresentationInstance Resource

Get an existing SourceRepresentationInstance 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?: SourceRepresentationInstanceState, opts?: CustomResourceOptions): SourceRepresentationInstance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ca_certificate: Optional[str] = None,
        client_certificate: Optional[str] = None,
        client_key: Optional[str] = None,
        database_version: Optional[str] = None,
        dump_file_path: Optional[str] = None,
        host: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        port: Optional[int] = None,
        project: Optional[str] = None,
        region: Optional[str] = None,
        username: Optional[str] = None) -> SourceRepresentationInstance
func GetSourceRepresentationInstance(ctx *Context, name string, id IDInput, state *SourceRepresentationInstanceState, opts ...ResourceOption) (*SourceRepresentationInstance, error)
public static SourceRepresentationInstance Get(string name, Input<string> id, SourceRepresentationInstanceState? state, CustomResourceOptions? opts = null)
public static SourceRepresentationInstance get(String name, Output<String> id, SourceRepresentationInstanceState 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:
CaCertificate string

The CA certificate on the external server. Include only if SSL/TLS is used on the external server.

ClientCertificate string

The client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

ClientKey string

The private key file for the client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

DatabaseVersion string

The MySQL version running on your source database server. Possible values are MYSQL_5_5, MYSQL_5_6, MYSQL_5_7, and MYSQL_8_0.

DumpFilePath string

A file in the bucket that contains the data from the external server.

Host string

The externally accessible IPv4 address for the source database server.

Name string

The name of the source representation instance. Use any valid Cloud SQL instance name.

Password string

The password for the replication user account. Note: This property is sensitive and will not be displayed in the plan.

Port int

The externally accessible port for the source database server. Defaults to 3306.

Project string

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

Region string

The Region in which the created instance should reside. If it is not provided, the provider region is used.

Username string

The replication user account on the external server.

CaCertificate string

The CA certificate on the external server. Include only if SSL/TLS is used on the external server.

ClientCertificate string

The client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

ClientKey string

The private key file for the client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

DatabaseVersion string

The MySQL version running on your source database server. Possible values are MYSQL_5_5, MYSQL_5_6, MYSQL_5_7, and MYSQL_8_0.

DumpFilePath string

A file in the bucket that contains the data from the external server.

Host string

The externally accessible IPv4 address for the source database server.

Name string

The name of the source representation instance. Use any valid Cloud SQL instance name.

Password string

The password for the replication user account. Note: This property is sensitive and will not be displayed in the plan.

Port int

The externally accessible port for the source database server. Defaults to 3306.

Project string

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

Region string

The Region in which the created instance should reside. If it is not provided, the provider region is used.

Username string

The replication user account on the external server.

caCertificate String

The CA certificate on the external server. Include only if SSL/TLS is used on the external server.

clientCertificate String

The client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

clientKey String

The private key file for the client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

databaseVersion String

The MySQL version running on your source database server. Possible values are MYSQL_5_5, MYSQL_5_6, MYSQL_5_7, and MYSQL_8_0.

dumpFilePath String

A file in the bucket that contains the data from the external server.

host String

The externally accessible IPv4 address for the source database server.

name String

The name of the source representation instance. Use any valid Cloud SQL instance name.

password String

The password for the replication user account. Note: This property is sensitive and will not be displayed in the plan.

port Integer

The externally accessible port for the source database server. Defaults to 3306.

project String

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

region String

The Region in which the created instance should reside. If it is not provided, the provider region is used.

username String

The replication user account on the external server.

caCertificate string

The CA certificate on the external server. Include only if SSL/TLS is used on the external server.

clientCertificate string

The client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

clientKey string

The private key file for the client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

databaseVersion string

The MySQL version running on your source database server. Possible values are MYSQL_5_5, MYSQL_5_6, MYSQL_5_7, and MYSQL_8_0.

dumpFilePath string

A file in the bucket that contains the data from the external server.

host string

The externally accessible IPv4 address for the source database server.

name string

The name of the source representation instance. Use any valid Cloud SQL instance name.

password string

The password for the replication user account. Note: This property is sensitive and will not be displayed in the plan.

port number

The externally accessible port for the source database server. Defaults to 3306.

project string

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

region string

The Region in which the created instance should reside. If it is not provided, the provider region is used.

username string

The replication user account on the external server.

ca_certificate str

The CA certificate on the external server. Include only if SSL/TLS is used on the external server.

client_certificate str

The client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

client_key str

The private key file for the client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

database_version str

The MySQL version running on your source database server. Possible values are MYSQL_5_5, MYSQL_5_6, MYSQL_5_7, and MYSQL_8_0.

dump_file_path str

A file in the bucket that contains the data from the external server.

host str

The externally accessible IPv4 address for the source database server.

name str

The name of the source representation instance. Use any valid Cloud SQL instance name.

password str

The password for the replication user account. Note: This property is sensitive and will not be displayed in the plan.

port int

The externally accessible port for the source database server. Defaults to 3306.

project str

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

region str

The Region in which the created instance should reside. If it is not provided, the provider region is used.

username str

The replication user account on the external server.

caCertificate String

The CA certificate on the external server. Include only if SSL/TLS is used on the external server.

clientCertificate String

The client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

clientKey String

The private key file for the client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server.

databaseVersion String

The MySQL version running on your source database server. Possible values are MYSQL_5_5, MYSQL_5_6, MYSQL_5_7, and MYSQL_8_0.

dumpFilePath String

A file in the bucket that contains the data from the external server.

host String

The externally accessible IPv4 address for the source database server.

name String

The name of the source representation instance. Use any valid Cloud SQL instance name.

password String

The password for the replication user account. Note: This property is sensitive and will not be displayed in the plan.

port Number

The externally accessible port for the source database server. Defaults to 3306.

project String

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

region String

The Region in which the created instance should reside. If it is not provided, the provider region is used.

username String

The replication user account on the external server.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes

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