Creates a new migration job in a given project and location.
Create MigrationJob Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
@overload
def MigrationJob(resource_name: str,
args: MigrationJobArgs,
opts: Optional[ResourceOptions] = None)
@overload
def MigrationJob(resource_name: str,
opts: Optional[ResourceOptions] = None,
migration_job_id: Optional[str] = None,
type: Optional[MigrationJobType] = None,
destination: Optional[str] = None,
source: Optional[str] = None,
dump_flags: Optional[DumpFlagsArgs] = None,
project: Optional[str] = None,
dump_path: Optional[str] = None,
filter: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
location: Optional[str] = None,
display_name: Optional[str] = None,
name: Optional[str] = None,
performance_config: Optional[PerformanceConfigArgs] = None,
cmek_key_name: Optional[str] = None,
request_id: Optional[str] = None,
reverse_ssh_connectivity: Optional[ReverseSshConnectivityArgs] = None,
destination_database: Optional[DatabaseTypeArgs] = None,
source_database: Optional[DatabaseTypeArgs] = None,
state: Optional[MigrationJobState] = None,
static_ip_connectivity: Optional[StaticIpConnectivityArgs] = None,
conversion_workspace: Optional[ConversionWorkspaceInfoArgs] = None,
vpc_peering_connectivity: Optional[VpcPeeringConnectivityArgs] = None)
type: google-native:datamigration/v1:MigrationJob
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "google-native_datamigration_v1_migration_job" "name" {
# resource properties
}
Parameters
- resource_name
str
- The unique name of the resource.
- args
MigrationJobArgs
- 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
MigrationJobArgs
- The arguments to resource properties.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resource.
- args
MigrationJobArgs
- The arguments to resource properties.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var migrationJobResource = new GoogleNative.Datamigration.V1.MigrationJob("migrationJobResource", new()
{
MigrationJobId = "string",
Type = GoogleNative.Datamigration.V1.MigrationJobType.TypeUnspecified,
Destination = "string",
Source = "string",
DumpFlags = new GoogleNative.Datamigration.V1.Inputs.DumpFlagsArgs
{
DumpFlags = new[]
{
new GoogleNative.Datamigration.V1.Inputs.DumpFlagArgs
{
Name = "string",
Value = "string",
},
},
},
Project = "string",
DumpPath = "string",
Filter = "string",
Labels =
{
{ "string", "string" },
},
Location = "string",
DisplayName = "string",
Name = "string",
PerformanceConfig = new GoogleNative.Datamigration.V1.Inputs.PerformanceConfigArgs
{
DumpParallelLevel = GoogleNative.Datamigration.V1.PerformanceConfigDumpParallelLevel.DumpParallelLevelUnspecified,
},
CmekKeyName = "string",
RequestId = "string",
ReverseSshConnectivity = new GoogleNative.Datamigration.V1.Inputs.ReverseSshConnectivityArgs
{
VmIp = "string",
VmPort = 0,
Vm = "string",
Vpc = "string",
},
DestinationDatabase = new GoogleNative.Datamigration.V1.Inputs.DatabaseTypeArgs
{
Engine = GoogleNative.Datamigration.V1.DatabaseTypeEngine.DatabaseEngineUnspecified,
Provider = GoogleNative.Datamigration.V1.DatabaseTypeProvider.DatabaseProviderUnspecified,
},
SourceDatabase = new GoogleNative.Datamigration.V1.Inputs.DatabaseTypeArgs
{
Engine = GoogleNative.Datamigration.V1.DatabaseTypeEngine.DatabaseEngineUnspecified,
Provider = GoogleNative.Datamigration.V1.DatabaseTypeProvider.DatabaseProviderUnspecified,
},
State = GoogleNative.Datamigration.V1.MigrationJobState.StateUnspecified,
StaticIpConnectivity = new() { },
ConversionWorkspace = new GoogleNative.Datamigration.V1.Inputs.ConversionWorkspaceInfoArgs
{
CommitId = "string",
Name = "string",
},
VpcPeeringConnectivity = new GoogleNative.Datamigration.V1.Inputs.VpcPeeringConnectivityArgs
{
Vpc = "string",
},
});
example, err := datamigration.NewMigrationJob(ctx, "migrationJobResource", &datamigration.MigrationJobArgs{
MigrationJobId: pulumi.String("string"),
Type: datamigration.MigrationJobTypeTypeUnspecified,
Destination: pulumi.String("string"),
Source: pulumi.String("string"),
DumpFlags: &datamigration.DumpFlagsArgs{
DumpFlags: datamigration.DumpFlagArray{
&datamigration.DumpFlagArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
Project: pulumi.String("string"),
DumpPath: pulumi.String("string"),
Filter: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Location: pulumi.String("string"),
DisplayName: pulumi.String("string"),
Name: pulumi.String("string"),
PerformanceConfig: &datamigration.PerformanceConfigArgs{
DumpParallelLevel: datamigration.PerformanceConfigDumpParallelLevelDumpParallelLevelUnspecified,
},
CmekKeyName: pulumi.String("string"),
RequestId: pulumi.String("string"),
ReverseSshConnectivity: &datamigration.ReverseSshConnectivityArgs{
VmIp: pulumi.String("string"),
VmPort: pulumi.Int(0),
Vm: pulumi.String("string"),
Vpc: pulumi.String("string"),
},
DestinationDatabase: &datamigration.DatabaseTypeArgs{
Engine: datamigration.DatabaseTypeEngineDatabaseEngineUnspecified,
Provider: datamigration.DatabaseTypeProviderDatabaseProviderUnspecified,
},
SourceDatabase: &datamigration.DatabaseTypeArgs{
Engine: datamigration.DatabaseTypeEngineDatabaseEngineUnspecified,
Provider: datamigration.DatabaseTypeProviderDatabaseProviderUnspecified,
},
State: datamigration.MigrationJobStateStateUnspecified,
StaticIpConnectivity: &datamigration.StaticIpConnectivityArgs{},
ConversionWorkspace: &datamigration.ConversionWorkspaceInfoArgs{
CommitId: pulumi.String("string"),
Name: pulumi.String("string"),
},
VpcPeeringConnectivity: &datamigration.VpcPeeringConnectivityArgs{
Vpc: pulumi.String("string"),
},
})
resource "google-native_datamigration_v1_migration_job" "migrationJobResource" {
lifecycle {
create_before_destroy = true
}
migration_job_id = "string"
type = "TYPE_UNSPECIFIED"
destination = "string"
source = "string"
dump_flags = {
dump_flags = [{
name = "string"
value = "string"
}]
}
project = "string"
dump_path = "string"
filter = "string"
labels = {
"string" = "string"
}
location = "string"
display_name = "string"
name = "string"
performance_config = {
dump_parallel_level = "DUMP_PARALLEL_LEVEL_UNSPECIFIED"
}
cmek_key_name = "string"
request_id = "string"
reverse_ssh_connectivity = {
vm_ip = "string"
vm_port = 0
vm = "string"
vpc = "string"
}
destination_database = {
engine = "DATABASE_ENGINE_UNSPECIFIED"
provider = "DATABASE_PROVIDER_UNSPECIFIED"
}
source_database = {
engine = "DATABASE_ENGINE_UNSPECIFIED"
provider = "DATABASE_PROVIDER_UNSPECIFIED"
}
state = "STATE_UNSPECIFIED"
static_ip_connectivity = {}
conversion_workspace = {
commit_id = "string"
name = "string"
}
vpc_peering_connectivity = {
vpc = "string"
}
}
var migrationJobResource = new com.pulumi.googlenative.datamigration_v1.MigrationJob("migrationJobResource", com.pulumi.googlenative.datamigration_v1.MigrationJobArgs.builder()
.migrationJobId("string")
.type(com.pulumi.googlenative.datamigration_v1.enums.MigrationJobType.TypeUnspecified)
.destination("string")
.source("string")
.dumpFlags(DumpFlagsArgs.builder()
.dumpFlags(DumpFlagArgs.builder()
.name("string")
.value("string")
.build())
.build())
.project("string")
.dumpPath("string")
.filter("string")
.labels(Map.of("string", "string"))
.location("string")
.displayName("string")
.name("string")
.performanceConfig(PerformanceConfigArgs.builder()
.dumpParallelLevel(com.pulumi.googlenative.datamigration_v1.enums.PerformanceConfigDumpParallelLevel.DumpParallelLevelUnspecified)
.build())
.cmekKeyName("string")
.requestId("string")
.reverseSshConnectivity(com.pulumi.googlenative.datamigration_v1.inputs.ReverseSshConnectivityArgs.builder()
.vmIp("string")
.vmPort(0)
.vm("string")
.vpc("string")
.build())
.destinationDatabase(com.pulumi.googlenative.datamigration_v1.inputs.DatabaseTypeArgs.builder()
.engine(com.pulumi.googlenative.datamigration_v1.enums.DatabaseTypeEngine.DatabaseEngineUnspecified)
.provider(com.pulumi.googlenative.datamigration_v1.enums.DatabaseTypeProvider.DatabaseProviderUnspecified)
.build())
.sourceDatabase(com.pulumi.googlenative.datamigration_v1.inputs.DatabaseTypeArgs.builder()
.engine(com.pulumi.googlenative.datamigration_v1.enums.DatabaseTypeEngine.DatabaseEngineUnspecified)
.provider(com.pulumi.googlenative.datamigration_v1.enums.DatabaseTypeProvider.DatabaseProviderUnspecified)
.build())
.state(com.pulumi.googlenative.datamigration_v1.enums.MigrationJobState.StateUnspecified)
.staticIpConnectivity(com.pulumi.googlenative.datamigration_v1.inputs.StaticIpConnectivityArgs.builder()
.build())
.conversionWorkspace(ConversionWorkspaceInfoArgs.builder()
.commitId("string")
.name("string")
.build())
.vpcPeeringConnectivity(com.pulumi.googlenative.datamigration_v1.inputs.VpcPeeringConnectivityArgs.builder()
.vpc("string")
.build())
.build());
migration_job_resource = google_native.datamigration.v1.MigrationJob("migrationJobResource",
migration_job_id="string",
type=google_native.datamigration.v1.MigrationJobType.TYPE_UNSPECIFIED,
destination="string",
source="string",
dump_flags={
"dump_flags": [{
"name": "string",
"value": "string",
}],
},
project="string",
dump_path="string",
filter="string",
labels={
"string": "string",
},
location="string",
display_name="string",
name="string",
performance_config={
"dump_parallel_level": google_native.datamigration.v1.PerformanceConfigDumpParallelLevel.DUMP_PARALLEL_LEVEL_UNSPECIFIED,
},
cmek_key_name="string",
request_id="string",
reverse_ssh_connectivity={
"vm_ip": "string",
"vm_port": 0,
"vm": "string",
"vpc": "string",
},
destination_database={
"engine": google_native.datamigration.v1.DatabaseTypeEngine.DATABASE_ENGINE_UNSPECIFIED,
"provider": google_native.datamigration.v1.DatabaseTypeProvider.DATABASE_PROVIDER_UNSPECIFIED,
},
source_database={
"engine": google_native.datamigration.v1.DatabaseTypeEngine.DATABASE_ENGINE_UNSPECIFIED,
"provider": google_native.datamigration.v1.DatabaseTypeProvider.DATABASE_PROVIDER_UNSPECIFIED,
},
state=google_native.datamigration.v1.MigrationJobState.STATE_UNSPECIFIED,
static_ip_connectivity={},
conversion_workspace={
"commit_id": "string",
"name": "string",
},
vpc_peering_connectivity={
"vpc": "string",
})
const migrationJobResource = new google_native.datamigration.v1.MigrationJob("migrationJobResource", {
migrationJobId: "string",
type: google_native.datamigration.v1.MigrationJobType.TypeUnspecified,
destination: "string",
source: "string",
dumpFlags: {
dumpFlags: [{
name: "string",
value: "string",
}],
},
project: "string",
dumpPath: "string",
filter: "string",
labels: {
string: "string",
},
location: "string",
displayName: "string",
name: "string",
performanceConfig: {
dumpParallelLevel: google_native.datamigration.v1.PerformanceConfigDumpParallelLevel.DumpParallelLevelUnspecified,
},
cmekKeyName: "string",
requestId: "string",
reverseSshConnectivity: {
vmIp: "string",
vmPort: 0,
vm: "string",
vpc: "string",
},
destinationDatabase: {
engine: google_native.datamigration.v1.DatabaseTypeEngine.DatabaseEngineUnspecified,
provider: google_native.datamigration.v1.DatabaseTypeProvider.DatabaseProviderUnspecified,
},
sourceDatabase: {
engine: google_native.datamigration.v1.DatabaseTypeEngine.DatabaseEngineUnspecified,
provider: google_native.datamigration.v1.DatabaseTypeProvider.DatabaseProviderUnspecified,
},
state: google_native.datamigration.v1.MigrationJobState.StateUnspecified,
staticIpConnectivity: {},
conversionWorkspace: {
commitId: "string",
name: "string",
},
vpcPeeringConnectivity: {
vpc: "string",
},
});
type: google-native:datamigration/v1:MigrationJob
properties:
cmekKeyName: string
conversionWorkspace:
commitId: string
name: string
destination: string
destinationDatabase:
engine: DATABASE_ENGINE_UNSPECIFIED
provider: DATABASE_PROVIDER_UNSPECIFIED
displayName: string
dumpFlags:
dumpFlags:
- name: string
value: string
dumpPath: string
filter: string
labels:
string: string
location: string
migrationJobId: string
name: string
performanceConfig:
dumpParallelLevel: DUMP_PARALLEL_LEVEL_UNSPECIFIED
project: string
requestId: string
reverseSshConnectivity:
vm: string
vmIp: string
vmPort: 0
vpc: string
source: string
sourceDatabase:
engine: DATABASE_ENGINE_UNSPECIFIED
provider: DATABASE_PROVIDER_UNSPECIFIED
state: STATE_UNSPECIFIED
staticIpConnectivity: {}
type: TYPE_UNSPECIFIED
vpcPeeringConnectivity:
vpc: string
MigrationJob Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The MigrationJob resource accepts the following input properties:
- Destination
string
- The resource name (URI) of the destination connection profile.
- MigrationJobId
string
- Required. The ID of the instance to create.
- Source
string
- The resource name (URI) of the source connection profile.
- Type
Pulumi.GoogleNative.Datamigration.V1.MigrationJobType
- The migration job type.
- CmekKeyName
string
- The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
- ConversionWorkspace
Pulumi.GoogleNative.Datamigration.V1.Inputs.ConversionWorkspaceInfo
- The conversion workspace used by the migration.
- DestinationDatabase
Pulumi.GoogleNative.Datamigration.V1.Inputs.DatabaseType
- The database engine type and provider of the destination.
- DisplayName
string
- The migration job display name.
- DumpFlags
Pulumi.GoogleNative.Datamigration.V1.Inputs.DumpFlags
- The initial dump flags. This field and the "dump_path" field are mutually exclusive.
- DumpPath
string
- The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive.
- Filter
string
- This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.
- Labels
Dictionary<string, string>
- The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example:
{ "name": "wrench", "mass": "1.3kg", "count": "3" }. - Location
string
- Name
string
- The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
- PerformanceConfig
Pulumi.GoogleNative.Datamigration.V1.Inputs.PerformanceConfig
- Optional. Data dump parallelism settings used by the migration. Currently applicable only for MySQL to Cloud SQL for MySQL migrations only.
- Project
string
- RequestId
string
- Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- ReverseSshConnectivity
Pulumi.GoogleNative.Datamigration.V1.Inputs.ReverseSshConnectivity
- The details needed to communicate to the source over Reverse SSH tunnel connectivity.
- SourceDatabase
Pulumi.GoogleNative.Datamigration.V1.Inputs.DatabaseType
- The database engine type and provider of the source.
- State
Pulumi.GoogleNative.Datamigration.V1.MigrationJobState
- The current migration job state.
- StaticIpConnectivity
Pulumi.GoogleNative.Datamigration.V1.Inputs.StaticIpConnectivity
- static ip connectivity data (default, no additional details needed).
- VpcPeeringConnectivity
Pulumi.GoogleNative.Datamigration.V1.Inputs.VpcPeeringConnectivity
- The details of the VPC network that the source database is located in.
- Destination
string
- The resource name (URI) of the destination connection profile.
- MigrationJobId
string
- Required. The ID of the instance to create.
- Source
string
- The resource name (URI) of the source connection profile.
- Type
MigrationJobType
- The migration job type.
- CmekKeyName
string
- The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
- ConversionWorkspace
ConversionWorkspaceInfoArgs
- The conversion workspace used by the migration.
- DestinationDatabase
DatabaseTypeArgs
- The database engine type and provider of the destination.
- DisplayName
string
- The migration job display name.
- DumpFlags
DumpFlagsArgs
- The initial dump flags. This field and the "dump_path" field are mutually exclusive.
- DumpPath
string
- The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive.
- Filter
string
- This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.
- Labels
map[string]string
- The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example:
{ "name": "wrench", "mass": "1.3kg", "count": "3" }. - Location
string
- Name
string
- The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
- PerformanceConfig
PerformanceConfigArgs
- Optional. Data dump parallelism settings used by the migration. Currently applicable only for MySQL to Cloud SQL for MySQL migrations only.
- Project
string
- RequestId
string
- Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- ReverseSshConnectivity
ReverseSshConnectivityArgs
- The details needed to communicate to the source over Reverse SSH tunnel connectivity.
- SourceDatabase
DatabaseTypeArgs
- The database engine type and provider of the source.
- State
MigrationJobStateEnum
- The current migration job state.
- StaticIpConnectivity
StaticIpConnectivityArgs
- static ip connectivity data (default, no additional details needed).
- VpcPeeringConnectivity
VpcPeeringConnectivityArgs
- The details of the VPC network that the source database is located in.
- destination
string
- The resource name (URI) of the destination connection profile.
- migration_job_id
string
- Required. The ID of the instance to create.
- source
string
- The resource name (URI) of the source connection profile.
- type
"TYPE_UNSPECIFIED" | "ONE_TIME" | "CONTINUOUS"
- The migration job type.
- cmek_key_name
string
- The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
- conversion_workspace
object
- The conversion workspace used by the migration.
- destination_database
object
- The database engine type and provider of the destination.
- display_name
string
- The migration job display name.
- dump_flags
object
- The initial dump flags. This field and the "dump_path" field are mutually exclusive.
- dump_path
string
- The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive.
- filter
string
- This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.
- labels
map(string)
- The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example:
{ "name": "wrench", "mass": "1.3kg", "count": "3" }. - location
string
- name
string
- The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
- performance_config
object
- Optional. Data dump parallelism settings used by the migration. Currently applicable only for MySQL to Cloud SQL for MySQL migrations only.
- project
string
- request_id
string
- Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- reverse_ssh_connectivity
object
- The details needed to communicate to the source over Reverse SSH tunnel connectivity.
- source_database
object
- The database engine type and provider of the source.
- state
"STATE_UNSPECIFIED" | "MAINTENANCE" | "DRAFT" | "CREATING" | "NOT_STARTED" | "RUNNING" | "FAILED" | "COMPLETED" | "DELETING" | "STOPPING" | "STOPPED" | "DELETED" | "UPDATING" | "STARTING" | "RESTARTING" | "RESUMING"
- The current migration job state.
- static_ip_connectivity
object
- static ip connectivity data (default, no additional details needed).
- vpc_peering_connectivity
object
- The details of the VPC network that the source database is located in.
- destination
String
- The resource name (URI) of the destination connection profile.
- migrationJobId
String
- Required. The ID of the instance to create.
- source
String
- The resource name (URI) of the source connection profile.
- type
MigrationJobType
- The migration job type.
- cmekKeyName
String
- The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
- conversionWorkspace
ConversionWorkspaceInfo
- The conversion workspace used by the migration.
- destinationDatabase
DatabaseType
- The database engine type and provider of the destination.
- displayName
String
- The migration job display name.
- dumpFlags
DumpFlags
- The initial dump flags. This field and the "dump_path" field are mutually exclusive.
- dumpPath
String
- The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive.
- filter
String
- This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.
- labels
Map<String,String>
- The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example:
{ "name": "wrench", "mass": "1.3kg", "count": "3" }. - location
String
- name
String
- The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
- performanceConfig
PerformanceConfig
- Optional. Data dump parallelism settings used by the migration. Currently applicable only for MySQL to Cloud SQL for MySQL migrations only.
- project
String
- requestId
String
- Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- reverseSshConnectivity
ReverseSshConnectivity
- The details needed to communicate to the source over Reverse SSH tunnel connectivity.
- sourceDatabase
DatabaseType
- The database engine type and provider of the source.
- state
MigrationJobState
- The current migration job state.
- staticIpConnectivity
StaticIpConnectivity
- static ip connectivity data (default, no additional details needed).
- vpcPeeringConnectivity
VpcPeeringConnectivity
- The details of the VPC network that the source database is located in.
- destination
string
- The resource name (URI) of the destination connection profile.
- migrationJobId
string
- Required. The ID of the instance to create.
- source
string
- The resource name (URI) of the source connection profile.
- type
MigrationJobType
- The migration job type.
- cmekKeyName
string
- The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
- conversionWorkspace
ConversionWorkspaceInfo
- The conversion workspace used by the migration.
- destinationDatabase
DatabaseType
- The database engine type and provider of the destination.
- displayName
string
- The migration job display name.
- dumpFlags
DumpFlags
- The initial dump flags. This field and the "dump_path" field are mutually exclusive.
- dumpPath
string
- The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive.
- filter
string
- This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.
- labels
{[key: string]: string}
- The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example:
{ "name": "wrench", "mass": "1.3kg", "count": "3" }. - location
string
- name
string
- The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
- performanceConfig
PerformanceConfig
- Optional. Data dump parallelism settings used by the migration. Currently applicable only for MySQL to Cloud SQL for MySQL migrations only.
- project
string
- requestId
string
- Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- reverseSshConnectivity
ReverseSshConnectivity
- The details needed to communicate to the source over Reverse SSH tunnel connectivity.
- sourceDatabase
DatabaseType
- The database engine type and provider of the source.
- state
MigrationJobState
- The current migration job state.
- staticIpConnectivity
StaticIpConnectivity
- static ip connectivity data (default, no additional details needed).
- vpcPeeringConnectivity
VpcPeeringConnectivity
- The details of the VPC network that the source database is located in.
- destination
str
- The resource name (URI) of the destination connection profile.
- migration_job_id
str
- Required. The ID of the instance to create.
- source
str
- The resource name (URI) of the source connection profile.
- type
MigrationJobType
- The migration job type.
- cmek_key_name
str
- The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
- conversion_workspace
ConversionWorkspaceInfoArgs
- The conversion workspace used by the migration.
- destination_database
DatabaseTypeArgs
- The database engine type and provider of the destination.
- display_name
str
- The migration job display name.
- dump_flags
DumpFlagsArgs
- The initial dump flags. This field and the "dump_path" field are mutually exclusive.
- dump_path
str
- The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive.
- filter
str
- This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.
- labels
Mapping[str, str]
- The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example:
{ "name": "wrench", "mass": "1.3kg", "count": "3" }. - location
str
- name
str
- The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
- performance_config
PerformanceConfigArgs
- Optional. Data dump parallelism settings used by the migration. Currently applicable only for MySQL to Cloud SQL for MySQL migrations only.
- project
str
- request_id
str
- Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- reverse_ssh_connectivity
ReverseSshConnectivityArgs
- The details needed to communicate to the source over Reverse SSH tunnel connectivity.
- source_database
DatabaseTypeArgs
- The database engine type and provider of the source.
- state
MigrationJobState
- The current migration job state.
- static_ip_connectivity
StaticIpConnectivityArgs
- static ip connectivity data (default, no additional details needed).
- vpc_peering_connectivity
VpcPeeringConnectivityArgs
- The details of the VPC network that the source database is located in.
- destination
String
- The resource name (URI) of the destination connection profile.
- migrationJobId
String
- Required. The ID of the instance to create.
- source
String
- The resource name (URI) of the source connection profile.
- type
"TYPE_UNSPECIFIED" | "ONE_TIME" | "CONTINUOUS"
- The migration job type.
- cmekKeyName
String
- The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
- conversionWorkspace
Property Map
- The conversion workspace used by the migration.
- destinationDatabase
Property Map
- The database engine type and provider of the destination.
- displayName
String
- The migration job display name.
- dumpFlags
Property Map
- The initial dump flags. This field and the "dump_path" field are mutually exclusive.
- dumpPath
String
- The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive.
- filter
String
- This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.
- labels
Map<String>
- The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example:
{ "name": "wrench", "mass": "1.3kg", "count": "3" }. - location
String
- name
String
- The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
- performanceConfig
Property Map
- Optional. Data dump parallelism settings used by the migration. Currently applicable only for MySQL to Cloud SQL for MySQL migrations only.
- project
String
- requestId
String
- Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
- reverseSshConnectivity
Property Map
- The details needed to communicate to the source over Reverse SSH tunnel connectivity.
- sourceDatabase
Property Map
- The database engine type and provider of the source.
- state
"STATE_UNSPECIFIED" | "MAINTENANCE" | "DRAFT" | "CREATING" | "NOT_STARTED" | "RUNNING" | "FAILED" | "COMPLETED" | "DELETING" | "STOPPING" | "STOPPED" | "DELETED" | "UPDATING" | "STARTING" | "RESTARTING" | "RESUMING"
- The current migration job state.
- staticIpConnectivity
Property Map
- static ip connectivity data (default, no additional details needed).
- vpcPeeringConnectivity
Property Map
- The details of the VPC network that the source database is located in.
Outputs
All input properties are implicitly available as output properties. Additionally, the MigrationJob resource produces the following output properties:
- CreateTime
string
- The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
- Duration
string
- The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
- EndTime
string
- If the migration job is completed, the time when it was completed.
- Error
Pulumi.GoogleNative.Datamigration.V1.Outputs.StatusResponse
- The error details in case of state FAILED.
- Id
string
- The provider-assigned unique ID for this managed resource.
- Phase
string
- The current migration job phase.
- UpdateTime
string
- The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
- CreateTime
string
- The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
- Duration
string
- The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
- EndTime
string
- If the migration job is completed, the time when it was completed.
- Error
StatusResponse
- The error details in case of state FAILED.
- Id
string
- The provider-assigned unique ID for this managed resource.
- Phase
string
- The current migration job phase.
- UpdateTime
string
- The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
- create_time
string
- The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
- duration
string
- The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
- end_time
string
- If the migration job is completed, the time when it was completed.
- error
object
- The error details in case of state FAILED.
- id
string
- The provider-assigned unique ID for this managed resource.
- phase
string
- The current migration job phase.
- update_time
string
- The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
- createTime
String
- The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
- duration
String
- The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
- endTime
String
- If the migration job is completed, the time when it was completed.
- error
StatusResponse
- The error details in case of state FAILED.
- id
String
- The provider-assigned unique ID for this managed resource.
- phase
String
- The current migration job phase.
- updateTime
String
- The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
- createTime
string
- The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
- duration
string
- The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
- endTime
string
- If the migration job is completed, the time when it was completed.
- error
StatusResponse
- The error details in case of state FAILED.
- id
string
- The provider-assigned unique ID for this managed resource.
- phase
string
- The current migration job phase.
- updateTime
string
- The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
- create_time
str
- The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
- duration
str
- The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
- end_time
str
- If the migration job is completed, the time when it was completed.
- error
StatusResponse
- The error details in case of state FAILED.
- id
str
- The provider-assigned unique ID for this managed resource.
- phase
str
- The current migration job phase.
- update_time
str
- The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
- createTime
String
- The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
- duration
String
- The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
- endTime
String
- If the migration job is completed, the time when it was completed.
- error
Property Map
- The error details in case of state FAILED.
- id
String
- The provider-assigned unique ID for this managed resource.
- phase
String
- The current migration job phase.
- updateTime
String
- The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
Look up Existing MigrationJob Resource
Get an existing MigrationJob resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static MigrationJob get(String name, Output<String> id, CustomResourceOptions options)
resources: existingMigrationJob: type: google-native:datamigration/v1:MigrationJob get: id: ${id}
import {
to = google-native_datamigration_v1_migration_job.example
id = "${id}"
}
- name
string
- The unique name of the resulting resource.
- id
Input<ID>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resulting resource.
- id
str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id
IDInput
- The unique provider ID of the resource to look up.
- state
MigrationJobState
- Pass nil. This resource has no state arguments.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resulting resource.
- id
Input<string>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resulting resource.
- id
Output<String>
- The unique provider ID of the resource to look up.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
ConversionWorkspaceInfo, ConversionWorkspaceInfoArgs
A conversion workspace's version.
- CommitId
string
- The commit ID of the conversion workspace.
- Name
string
- The resource name (URI) of the conversion workspace.
- CommitId
string
- The commit ID of the conversion workspace.
- Name
string
- The resource name (URI) of the conversion workspace.
- commit_id
string
- The commit ID of the conversion workspace.
- name
string
- The resource name (URI) of the conversion workspace.
- commitId
String
- The commit ID of the conversion workspace.
- name
String
- The resource name (URI) of the conversion workspace.
- commitId
string
- The commit ID of the conversion workspace.
- name
string
- The resource name (URI) of the conversion workspace.
- commit_id
str
- The commit ID of the conversion workspace.
- name
str
- The resource name (URI) of the conversion workspace.
- commitId
String
- The commit ID of the conversion workspace.
- name
String
- The resource name (URI) of the conversion workspace.
ConversionWorkspaceInfoResponse
A conversion workspace's version.
- CommitId
string
- The commit ID of the conversion workspace.
- Name
string
- The resource name (URI) of the conversion workspace.
- CommitId
string
- The commit ID of the conversion workspace.
- Name
string
- The resource name (URI) of the conversion workspace.
- commit_id
string
- The commit ID of the conversion workspace.
- name
string
- The resource name (URI) of the conversion workspace.
- commitId
String
- The commit ID of the conversion workspace.
- name
String
- The resource name (URI) of the conversion workspace.
- commitId
string
- The commit ID of the conversion workspace.
- name
string
- The resource name (URI) of the conversion workspace.
- commit_id
str
- The commit ID of the conversion workspace.
- name
str
- The resource name (URI) of the conversion workspace.
- commitId
String
- The commit ID of the conversion workspace.
- name
String
- The resource name (URI) of the conversion workspace.
DatabaseType, DatabaseTypeArgs
A message defining the database engine and provider.
DatabaseTypeEngine
The database engine.
| Name | Value | Description |
|---|
| DatabaseEngineUnspecified | DATABASE_ENGINE_UNSPECIFIED | The source database engine of the migration job is unknown. |
| Mysql | MYSQL | The source engine is MySQL. |
| Postgresql | POSTGRESQL | The source engine is PostgreSQL. |
| Oracle | ORACLE | The source engine is Oracle. |
| Name | Value | Description |
|---|
| DatabaseTypeEngineDatabaseEngineUnspecified | DATABASE_ENGINE_UNSPECIFIED | The source database engine of the migration job is unknown. |
| DatabaseTypeEngineMysql | MYSQL | The source engine is MySQL. |
| DatabaseTypeEnginePostgresql | POSTGRESQL | The source engine is PostgreSQL. |
| DatabaseTypeEngineOracle | ORACLE | The source engine is Oracle. |
| Value | Description |
|---|
DATABASE_ENGINE_UNSPECIFIED | The source database engine of the migration job is unknown. |
MYSQL | The source engine is MySQL. |
POSTGRESQL | The source engine is PostgreSQL. |
ORACLE | The source engine is Oracle. |
| Name | Value | Description |
|---|
| DatabaseEngineUnspecified | DATABASE_ENGINE_UNSPECIFIED | The source database engine of the migration job is unknown. |
| Mysql | MYSQL | The source engine is MySQL. |
| Postgresql | POSTGRESQL | The source engine is PostgreSQL. |
| Oracle | ORACLE | The source engine is Oracle. |
| Name | Value | Description |
|---|
| DatabaseEngineUnspecified | DATABASE_ENGINE_UNSPECIFIED | The source database engine of the migration job is unknown. |
| Mysql | MYSQL | The source engine is MySQL. |
| Postgresql | POSTGRESQL | The source engine is PostgreSQL. |
| Oracle | ORACLE | The source engine is Oracle. |
| Name | Value | Description |
|---|
| DATABASE_ENGINE_UNSPECIFIED | DATABASE_ENGINE_UNSPECIFIED | The source database engine of the migration job is unknown. |
| MYSQL | MYSQL | The source engine is MySQL. |
| POSTGRESQL | POSTGRESQL | The source engine is PostgreSQL. |
| ORACLE | ORACLE | The source engine is Oracle. |
| Value | Description |
|---|
DATABASE_ENGINE_UNSPECIFIED | The source database engine of the migration job is unknown. |
MYSQL | The source engine is MySQL. |
POSTGRESQL | The source engine is PostgreSQL. |
ORACLE | The source engine is Oracle. |
DatabaseTypeProvider
The database provider.
| Name | Value | Description |
|---|
| DatabaseProviderUnspecified | DATABASE_PROVIDER_UNSPECIFIED | The database provider is unknown. |
| Cloudsql | CLOUDSQL | CloudSQL runs the database. |
| Rds | RDS | RDS runs the database. |
| Aurora | AURORA | Amazon Aurora. |
| Alloydb | ALLOYDB | AlloyDB. |
| Name | Value | Description |
|---|
| DatabaseTypeProviderDatabaseProviderUnspecified | DATABASE_PROVIDER_UNSPECIFIED | The database provider is unknown. |
| DatabaseTypeProviderCloudsql | CLOUDSQL | CloudSQL runs the database. |
| DatabaseTypeProviderRds | RDS | RDS runs the database. |
| DatabaseTypeProviderAurora | AURORA | Amazon Aurora. |
| DatabaseTypeProviderAlloydb | ALLOYDB | AlloyDB. |
| Value | Description |
|---|
DATABASE_PROVIDER_UNSPECIFIED | The database provider is unknown. |
CLOUDSQL | CloudSQL runs the database. |
RDS | RDS runs the database. |
AURORA | Amazon Aurora. |
ALLOYDB | AlloyDB. |
| Name | Value | Description |
|---|
| DatabaseProviderUnspecified | DATABASE_PROVIDER_UNSPECIFIED | The database provider is unknown. |
| Cloudsql | CLOUDSQL | CloudSQL runs the database. |
| Rds | RDS | RDS runs the database. |
| Aurora | AURORA | Amazon Aurora. |
| Alloydb | ALLOYDB | AlloyDB. |
| Name | Value | Description |
|---|
| DatabaseProviderUnspecified | DATABASE_PROVIDER_UNSPECIFIED | The database provider is unknown. |
| Cloudsql | CLOUDSQL | CloudSQL runs the database. |
| Rds | RDS | RDS runs the database. |
| Aurora | AURORA | Amazon Aurora. |
| Alloydb | ALLOYDB | AlloyDB. |
| Name | Value | Description |
|---|
| DATABASE_PROVIDER_UNSPECIFIED | DATABASE_PROVIDER_UNSPECIFIED | The database provider is unknown. |
| CLOUDSQL | CLOUDSQL | CloudSQL runs the database. |
| RDS | RDS | RDS runs the database. |
| AURORA | AURORA | Amazon Aurora. |
| ALLOYDB | ALLOYDB | AlloyDB. |
| Value | Description |
|---|
DATABASE_PROVIDER_UNSPECIFIED | The database provider is unknown. |
CLOUDSQL | CloudSQL runs the database. |
RDS | RDS runs the database. |
AURORA | Amazon Aurora. |
ALLOYDB | AlloyDB. |
DatabaseTypeResponse
A message defining the database engine and provider.
- Engine
string
- The database engine.
- Provider
string
- The database provider.
- Engine
string
- The database engine.
- Provider
string
- The database provider.
- engine
string
- The database engine.
- provider
string
- The database provider.
- engine
String
- The database engine.
- provider
String
- The database provider.
- engine
string
- The database engine.
- provider
string
- The database provider.
- engine
String
- The database engine.
- provider
String
- The database provider.
DumpFlag, DumpFlagArgs
Dump flag definition.
- Name
string
- The name of the flag
- Value
string
- The value of the flag.
- Name
string
- The name of the flag
- Value
string
- The value of the flag.
- name
string
- The name of the flag
- value
string
- The value of the flag.
- name
String
- The name of the flag
- value
String
- The value of the flag.
- name
string
- The name of the flag
- value
string
- The value of the flag.
- name
str
- The name of the flag
- value
str
- The value of the flag.
- name
String
- The name of the flag
- value
String
- The value of the flag.
DumpFlagResponse
Dump flag definition.
- Name
string
- The name of the flag
- Value
string
- The value of the flag.
- Name
string
- The name of the flag
- Value
string
- The value of the flag.
- name
string
- The name of the flag
- value
string
- The value of the flag.
- name
String
- The name of the flag
- value
String
- The value of the flag.
- name
string
- The name of the flag
- value
string
- The value of the flag.
- name
str
- The name of the flag
- value
str
- The value of the flag.
- name
String
- The name of the flag
- value
String
- The value of the flag.
DumpFlags, DumpFlagsArgs
Dump flags definition.
DumpFlagsResponse
Dump flags definition.
MigrationJobState
The current migration job state.
| Name | Value | Description |
|---|
| StateUnspecified | STATE_UNSPECIFIED | The state of the migration job is unknown. |
| Maintenance | MAINTENANCE | The migration job is down for maintenance. |
| Draft | DRAFT | The migration job is in draft mode and no resources are created. |
| Creating | CREATING | The migration job is being created. |
| NotStarted | NOT_STARTED | The migration job is created and not started. |
| Running | RUNNING | The migration job is running. |
| Failed | FAILED | The migration job failed. |
| Completed | COMPLETED | The migration job has been completed. |
| Deleting | DELETING | The migration job is being deleted. |
| Stopping | STOPPING | The migration job is being stopped. |
| Stopped | STOPPED | The migration job is currently stopped. |
| Deleted | DELETED | The migration job has been deleted. |
| Updating | UPDATING | The migration job is being updated. |
| Starting | STARTING | The migration job is starting. |
| Restarting | RESTARTING | The migration job is restarting. |
| Resuming | RESUMING | The migration job is resuming. |
| Name | Value | Description |
|---|
| MigrationJobStateStateUnspecified | STATE_UNSPECIFIED | The state of the migration job is unknown. |
| MigrationJobStateMaintenance | MAINTENANCE | The migration job is down for maintenance. |
| MigrationJobStateDraft | DRAFT | The migration job is in draft mode and no resources are created. |
| MigrationJobStateCreating | CREATING | The migration job is being created. |
| MigrationJobStateNotStarted | NOT_STARTED | The migration job is created and not started. |
| MigrationJobStateRunning | RUNNING | The migration job is running. |
| MigrationJobStateFailed | FAILED | The migration job failed. |
| MigrationJobStateCompleted | COMPLETED | The migration job has been completed. |
| MigrationJobStateDeleting | DELETING | The migration job is being deleted. |
| MigrationJobStateStopping | STOPPING | The migration job is being stopped. |
| MigrationJobStateStopped | STOPPED | The migration job is currently stopped. |
| MigrationJobStateDeleted | DELETED | The migration job has been deleted. |
| MigrationJobStateUpdating | UPDATING | The migration job is being updated. |
| MigrationJobStateStarting | STARTING | The migration job is starting. |
| MigrationJobStateRestarting | RESTARTING | The migration job is restarting. |
| MigrationJobStateResuming | RESUMING | The migration job is resuming. |
| Value | Description |
|---|
STATE_UNSPECIFIED | The state of the migration job is unknown. |
MAINTENANCE | The migration job is down for maintenance. |
DRAFT | The migration job is in draft mode and no resources are created. |
CREATING | The migration job is being created. |
NOT_STARTED | The migration job is created and not started. |
RUNNING | The migration job is running. |
FAILED | The migration job failed. |
COMPLETED | The migration job has been completed. |
DELETING | The migration job is being deleted. |
STOPPING | The migration job is being stopped. |
STOPPED | The migration job is currently stopped. |
DELETED | The migration job has been deleted. |
UPDATING | The migration job is being updated. |
STARTING | The migration job is starting. |
RESTARTING | The migration job is restarting. |
RESUMING | The migration job is resuming. |
| Name | Value | Description |
|---|
| StateUnspecified | STATE_UNSPECIFIED | The state of the migration job is unknown. |
| Maintenance | MAINTENANCE | The migration job is down for maintenance. |
| Draft | DRAFT | The migration job is in draft mode and no resources are created. |
| Creating | CREATING | The migration job is being created. |
| NotStarted | NOT_STARTED | The migration job is created and not started. |
| Running | RUNNING | The migration job is running. |
| Failed | FAILED | The migration job failed. |
| Completed | COMPLETED | The migration job has been completed. |
| Deleting | DELETING | The migration job is being deleted. |
| Stopping | STOPPING | The migration job is being stopped. |
| Stopped | STOPPED | The migration job is currently stopped. |
| Deleted | DELETED | The migration job has been deleted. |
| Updating | UPDATING | The migration job is being updated. |
| Starting | STARTING | The migration job is starting. |
| Restarting | RESTARTING | The migration job is restarting. |
| Resuming | RESUMING | The migration job is resuming. |
| Name | Value | Description |
|---|
| StateUnspecified | STATE_UNSPECIFIED | The state of the migration job is unknown. |
| Maintenance | MAINTENANCE | The migration job is down for maintenance. |
| Draft | DRAFT | The migration job is in draft mode and no resources are created. |
| Creating | CREATING | The migration job is being created. |
| NotStarted | NOT_STARTED | The migration job is created and not started. |
| Running | RUNNING | The migration job is running. |
| Failed | FAILED | The migration job failed. |
| Completed | COMPLETED | The migration job has been completed. |
| Deleting | DELETING | The migration job is being deleted. |
| Stopping | STOPPING | The migration job is being stopped. |
| Stopped | STOPPED | The migration job is currently stopped. |
| Deleted | DELETED | The migration job has been deleted. |
| Updating | UPDATING | The migration job is being updated. |
| Starting | STARTING | The migration job is starting. |
| Restarting | RESTARTING | The migration job is restarting. |
| Resuming | RESUMING | The migration job is resuming. |
| Name | Value | Description |
|---|
| STATE_UNSPECIFIED | STATE_UNSPECIFIED | The state of the migration job is unknown. |
| MAINTENANCE | MAINTENANCE | The migration job is down for maintenance. |
| DRAFT | DRAFT | The migration job is in draft mode and no resources are created. |
| CREATING | CREATING | The migration job is being created. |
| NOT_STARTED | NOT_STARTED | The migration job is created and not started. |
| RUNNING | RUNNING | The migration job is running. |
| FAILED | FAILED | The migration job failed. |
| COMPLETED | COMPLETED | The migration job has been completed. |
| DELETING | DELETING | The migration job is being deleted. |
| STOPPING | STOPPING | The migration job is being stopped. |
| STOPPED | STOPPED | The migration job is currently stopped. |
| DELETED | DELETED | The migration job has been deleted. |
| UPDATING | UPDATING | The migration job is being updated. |
| STARTING | STARTING | The migration job is starting. |
| RESTARTING | RESTARTING | The migration job is restarting. |
| RESUMING | RESUMING | The migration job is resuming. |
| Value | Description |
|---|
STATE_UNSPECIFIED | The state of the migration job is unknown. |
MAINTENANCE | The migration job is down for maintenance. |
DRAFT | The migration job is in draft mode and no resources are created. |
CREATING | The migration job is being created. |
NOT_STARTED | The migration job is created and not started. |
RUNNING | The migration job is running. |
FAILED | The migration job failed. |
COMPLETED | The migration job has been completed. |
DELETING | The migration job is being deleted. |
STOPPING | The migration job is being stopped. |
STOPPED | The migration job is currently stopped. |
DELETED | The migration job has been deleted. |
UPDATING | The migration job is being updated. |
STARTING | The migration job is starting. |
RESTARTING | The migration job is restarting. |
RESUMING | The migration job is resuming. |
MigrationJobType
Required. The migration job type.
| Name | Value | Description |
|---|
| TypeUnspecified | TYPE_UNSPECIFIED | The type of the migration job is unknown. |
| OneTime | ONE_TIME | The migration job is a one time migration. |
| Continuous | CONTINUOUS | The migration job is a continuous migration. |
| Name | Value | Description |
|---|
| MigrationJobTypeTypeUnspecified | TYPE_UNSPECIFIED | The type of the migration job is unknown. |
| MigrationJobTypeOneTime | ONE_TIME | The migration job is a one time migration. |
| MigrationJobTypeContinuous | CONTINUOUS | The migration job is a continuous migration. |
| Value | Description |
|---|
TYPE_UNSPECIFIED | The type of the migration job is unknown. |
ONE_TIME | The migration job is a one time migration. |
CONTINUOUS | The migration job is a continuous migration. |
| Name | Value | Description |
|---|
| TypeUnspecified | TYPE_UNSPECIFIED | The type of the migration job is unknown. |
| OneTime | ONE_TIME | The migration job is a one time migration. |
| Continuous | CONTINUOUS | The migration job is a continuous migration. |
| Name | Value | Description |
|---|
| TypeUnspecified | TYPE_UNSPECIFIED | The type of the migration job is unknown. |
| OneTime | ONE_TIME | The migration job is a one time migration. |
| Continuous | CONTINUOUS | The migration job is a continuous migration. |
| Name | Value | Description |
|---|
| TYPE_UNSPECIFIED | TYPE_UNSPECIFIED | The type of the migration job is unknown. |
| ONE_TIME | ONE_TIME | The migration job is a one time migration. |
| CONTINUOUS | CONTINUOUS | The migration job is a continuous migration. |
| Value | Description |
|---|
TYPE_UNSPECIFIED | The type of the migration job is unknown. |
ONE_TIME | The migration job is a one time migration. |
CONTINUOUS | The migration job is a continuous migration. |
Performance configuration definition.
Initial dump parallelism level.
| Name | Value | Description |
|---|
| DumpParallelLevelUnspecified | DUMP_PARALLEL_LEVEL_UNSPECIFIED | Unknown dump parallel level. Will be defaulted to OPTIMAL. |
| Min | MIN | Minimal parallel level. |
| Optimal | OPTIMAL | Optimal parallel level. |
| Max | MAX | Maximum parallel level. |
| Name | Value | Description |
|---|
| PerformanceConfigDumpParallelLevelDumpParallelLevelUnspecified | DUMP_PARALLEL_LEVEL_UNSPECIFIED | Unknown dump parallel level. Will be defaulted to OPTIMAL. |
| PerformanceConfigDumpParallelLevelMin | MIN | Minimal parallel level. |
| PerformanceConfigDumpParallelLevelOptimal | OPTIMAL | Optimal parallel level. |
| PerformanceConfigDumpParallelLevelMax | MAX | Maximum parallel level. |
| Value | Description |
|---|
DUMP_PARALLEL_LEVEL_UNSPECIFIED | Unknown dump parallel level. Will be defaulted to OPTIMAL. |
MIN | Minimal parallel level. |
OPTIMAL | Optimal parallel level. |
MAX | Maximum parallel level. |
| Name | Value | Description |
|---|
| DumpParallelLevelUnspecified | DUMP_PARALLEL_LEVEL_UNSPECIFIED | Unknown dump parallel level. Will be defaulted to OPTIMAL. |
| Min | MIN | Minimal parallel level. |
| Optimal | OPTIMAL | Optimal parallel level. |
| Max | MAX | Maximum parallel level. |
| Name | Value | Description |
|---|
| DumpParallelLevelUnspecified | DUMP_PARALLEL_LEVEL_UNSPECIFIED | Unknown dump parallel level. Will be defaulted to OPTIMAL. |
| Min | MIN | Minimal parallel level. |
| Optimal | OPTIMAL | Optimal parallel level. |
| Max | MAX | Maximum parallel level. |
| Name | Value | Description |
|---|
| DUMP_PARALLEL_LEVEL_UNSPECIFIED | DUMP_PARALLEL_LEVEL_UNSPECIFIED | Unknown dump parallel level. Will be defaulted to OPTIMAL. |
| MIN | MIN | Minimal parallel level. |
| OPTIMAL | OPTIMAL | Optimal parallel level. |
| MAX | MAX | Maximum parallel level. |
| Value | Description |
|---|
DUMP_PARALLEL_LEVEL_UNSPECIFIED | Unknown dump parallel level. Will be defaulted to OPTIMAL. |
MIN | Minimal parallel level. |
OPTIMAL | Optimal parallel level. |
MAX | Maximum parallel level. |
Performance configuration definition.
ReverseSshConnectivity, ReverseSshConnectivityArgs
The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC.
- VmIp
string
- The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- VmPort
int
- The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- Vm
string
- The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- Vpc
string
- The name of the VPC to peer with the Cloud SQL private network.
- VmIp
string
- The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- VmPort
int
- The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- Vm
string
- The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- Vpc
string
- The name of the VPC to peer with the Cloud SQL private network.
- vm_ip
string
- The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vm_port
number
- The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vm
string
- The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vpc
string
- The name of the VPC to peer with the Cloud SQL private network.
- vmIp
String
- The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vmPort
Integer
- The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vm
String
- The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vpc
String
- The name of the VPC to peer with the Cloud SQL private network.
- vmIp
string
- The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vmPort
number
- The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vm
string
- The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vpc
string
- The name of the VPC to peer with the Cloud SQL private network.
- vm_ip
str
- The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vm_port
int
- The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vm
str
- The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vpc
str
- The name of the VPC to peer with the Cloud SQL private network.
- vmIp
String
- The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vmPort
Number
- The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vm
String
- The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vpc
String
- The name of the VPC to peer with the Cloud SQL private network.
ReverseSshConnectivityResponse
The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC.
- Vm
string
- The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- VmIp
string
- The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- VmPort
int
- The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- Vpc
string
- The name of the VPC to peer with the Cloud SQL private network.
- Vm
string
- The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- VmIp
string
- The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- VmPort
int
- The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- Vpc
string
- The name of the VPC to peer with the Cloud SQL private network.
- vm
string
- The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vm_ip
string
- The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vm_port
number
- The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vpc
string
- The name of the VPC to peer with the Cloud SQL private network.
- vm
String
- The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vmIp
String
- The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vmPort
Integer
- The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vpc
String
- The name of the VPC to peer with the Cloud SQL private network.
- vm
string
- The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vmIp
string
- The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vmPort
number
- The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vpc
string
- The name of the VPC to peer with the Cloud SQL private network.
- vm
str
- The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vm_ip
str
- The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vm_port
int
- The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vpc
str
- The name of the VPC to peer with the Cloud SQL private network.
- vm
String
- The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vmIp
String
- The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vmPort
Number
- The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
- vpc
String
- The name of the VPC to peer with the Cloud SQL private network.
StatusResponse
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
- Code
int
- The status code, which should be an enum value of google.rpc.Code.
- Details
List<ImmutableDictionary<string, string>>
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message
string
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- Code
int
- The status code, which should be an enum value of google.rpc.Code.
- Details
[]map[string]string
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message
string
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code
number
- The status code, which should be an enum value of google.rpc.Code.
- details
list(map(string))
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message
string
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code
Integer
- The status code, which should be an enum value of google.rpc.Code.
- details
List<Map<String,String>>
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message
String
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code
number
- The status code, which should be an enum value of google.rpc.Code.
- details
{[key: string]: string}[]
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message
string
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code
int
- The status code, which should be an enum value of google.rpc.Code.
- details
Sequence[Mapping[str, str]]
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message
str
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code
Number
- The status code, which should be an enum value of google.rpc.Code.
- details
List<Map<String>>
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message
String
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
VpcPeeringConnectivity, VpcPeeringConnectivityArgs
The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC.
- Vpc
string
- The name of the VPC network to peer with the Cloud SQL private network.
- Vpc
string
- The name of the VPC network to peer with the Cloud SQL private network.
- vpc
string
- The name of the VPC network to peer with the Cloud SQL private network.
- vpc
String
- The name of the VPC network to peer with the Cloud SQL private network.
- vpc
string
- The name of the VPC network to peer with the Cloud SQL private network.
- vpc
str
- The name of the VPC network to peer with the Cloud SQL private network.
- vpc
String
- The name of the VPC network to peer with the Cloud SQL private network.
VpcPeeringConnectivityResponse
The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC.
- Vpc
string
- The name of the VPC network to peer with the Cloud SQL private network.
- Vpc
string
- The name of the VPC network to peer with the Cloud SQL private network.
- vpc
string
- The name of the VPC network to peer with the Cloud SQL private network.
- vpc
String
- The name of the VPC network to peer with the Cloud SQL private network.
- vpc
string
- The name of the VPC network to peer with the Cloud SQL private network.
- vpc
str
- The name of the VPC network to peer with the Cloud SQL private network.
- vpc
String
- The name of the VPC network to peer with the Cloud SQL private network.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0