MigrationJob class
Creates a new migration job in a given project and location.
Constructors
- MigrationJob(String name, {MigrationJobArgs? args, CustomResourceOptions? options})
-
Creates a new MigrationJob.
nameThe Pulumi resource name.argsArguments used to configure this MigrationJob. The set of arguments for MigrationJob.optionsResource options controlling this resource's behavior.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
cmekKeyName
↔ Output<
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_NAMElatefinal -
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
conversionWorkspace
↔ Output<
ConversionWorkspaceInfoResponse> -
The conversion workspace used by the migration.
latefinal
-
createTime
↔ Output<
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".
latefinal
-
destination
↔ Output<
String> -
The resource name (URI) of the destination connection profile.
latefinal
-
destinationDatabase
↔ Output<
DatabaseTypeResponse> -
The database engine type and provider of the destination.
latefinal
-
displayName
↔ Output<
String> -
The migration job display name.
latefinal
-
dumpFlags
↔ Output<
DumpFlagsResponse> -
The initial dump flags. This field and the "dump_path" field are mutually exclusive.
latefinal
-
dumpPath
↔ Output<
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.latefinal -
duration
↔ Output<
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".
latefinal
-
endTime
↔ Output<
String> -
If the migration job is completed, the time when it was completed.
latefinal
-
error
↔ Output<
StatusResponse> -
The error details in case of state FAILED.
latefinal
-
filter
↔ Output<
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.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
labels
↔ Output<
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" }.latefinal -
location
↔ Output<
String> -
latefinal
-
migrationJobId
↔ Output<
String> -
Required. The ID of the instance to create.
latefinal
-
name
↔ Output<
String> -
The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
latefinal
-
performanceConfig
↔ Output<
PerformanceConfigResponse> -
Optional. Data dump parallelism settings used by the migration. Currently applicable only for MySQL to Cloud SQL for MySQL migrations only.
latefinal
-
phase
↔ Output<
String> -
The current migration job phase.
latefinal
-
project
↔ Output<
String> -
latefinal
-
requestId
↔ Output<
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.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
reverseSshConnectivity
↔ Output<
ReverseSshConnectivityResponse> -
The details needed to communicate to the source over Reverse SSH tunnel connectivity.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
source
↔ Output<
String> -
The resource name (URI) of the source connection profile.
latefinal
-
sourceDatabase
↔ Output<
DatabaseTypeResponse> -
The database engine type and provider of the source.
latefinal
-
state
↔ Output<
String> -
The current migration job state.
latefinal
-
staticIpConnectivity
↔ Output<
Map< String, dynamic> > -
static ip connectivity data (default, no additional details needed).
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
type
↔ Output<
String> -
The migration job type.
latefinal
-
updateTime
↔ Output<
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".
latefinal
-
urn
↔ Output<
String> -
latefinalinherited
-
vpcPeeringConnectivity
↔ Output<
VpcPeeringConnectivityResponse> -
The details of the VPC network that the source database is located in.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited