@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
245 lines • 10 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* ImportDataFile represents a user-uploaded data payload file containing infrastructure discovery data.
*
* ## Example Usage
*
* ### Migration Center Import Data File Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.migrationcenter.Source("default", {
* location: "us-central1",
* sourceId: "source-test",
* type: "SOURCE_TYPE_CUSTOM",
* });
* const defaultImportJob = new gcp.migrationcenter.ImportJob("default", {
* location: "us-central1",
* importJobId: "import-job-test",
* assetSource: _default.id,
* });
* const defaultImportDataFile = new gcp.migrationcenter.ImportDataFile("default", {
* location: "us-central1",
* importJob: defaultImportJob.importJobId,
* importDataFileId: "import-data-file-test",
* displayName: "Terraform integration test display",
* format: "IMPORT_JOB_FORMAT_RVTOOLS_XLSX",
* });
* ```
*
* ## Import
*
* ImportDataFile can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/importJobs/{{import_job}}/importDataFiles/{{import_data_file_id}}`
* * `{{project}}/{{location}}/{{import_job}}/{{import_data_file_id}}`
* * `{{location}}/{{import_job}}/{{import_data_file_id}}`
*
* When using the `pulumi import` command, ImportDataFile can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:migrationcenter/importDataFile:ImportDataFile default projects/{{project}}/locations/{{location}}/importJobs/{{import_job}}/importDataFiles/{{import_data_file_id}}
* $ pulumi import gcp:migrationcenter/importDataFile:ImportDataFile default {{project}}/{{location}}/{{import_job}}/{{import_data_file_id}}
* $ pulumi import gcp:migrationcenter/importDataFile:ImportDataFile default {{location}}/{{import_job}}/{{import_data_file_id}}
* ```
*/
export declare class ImportDataFile extends pulumi.CustomResource {
/**
* Get an existing ImportDataFile resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ImportDataFileState, opts?: pulumi.CustomResourceOptions): ImportDataFile;
/**
* Returns true if the given object is an instance of ImportDataFile. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ImportDataFile;
/**
* The timestamp when the file was created.
*/
readonly createTime: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* User-friendly display name. Maximum length is 63 characters.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* Possible values:
* IMPORT_JOB_FORMAT_RVTOOLS_XLSX
* IMPORT_JOB_FORMAT_RVTOOLS_CSV
* IMPORT_JOB_FORMAT_EXPORTED_AWS_CSV
* IMPORT_JOB_FORMAT_EXPORTED_AZURE_CSV
* IMPORT_JOB_FORMAT_STRATOZONE_CSV
* IMPORT_JOB_FORMAT_DATABASE_ZIP
*/
readonly format: pulumi.Output<string>;
/**
* The ID of the new data file.
*/
readonly importDataFileId: pulumi.Output<string>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
readonly importJob: pulumi.Output<string>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
readonly location: pulumi.Output<string>;
/**
* The name of the file.
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The state of the import data file.
* Possible values:
* CREATING
* ACTIVE
*/
readonly state: pulumi.Output<string>;
/**
* A resource that contains a URI to which a data file can be uploaded.
* Structure is documented below.
*/
readonly uploadFileInfos: pulumi.Output<outputs.migrationcenter.ImportDataFileUploadFileInfo[]>;
/**
* Create a ImportDataFile resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ImportDataFileArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ImportDataFile resources.
*/
export interface ImportDataFileState {
/**
* The timestamp when the file was created.
*/
createTime?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* User-friendly display name. Maximum length is 63 characters.
*/
displayName?: pulumi.Input<string | undefined>;
/**
* Possible values:
* IMPORT_JOB_FORMAT_RVTOOLS_XLSX
* IMPORT_JOB_FORMAT_RVTOOLS_CSV
* IMPORT_JOB_FORMAT_EXPORTED_AWS_CSV
* IMPORT_JOB_FORMAT_EXPORTED_AZURE_CSV
* IMPORT_JOB_FORMAT_STRATOZONE_CSV
* IMPORT_JOB_FORMAT_DATABASE_ZIP
*/
format?: pulumi.Input<string | undefined>;
/**
* The ID of the new data file.
*/
importDataFileId?: pulumi.Input<string | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
importJob?: pulumi.Input<string | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
location?: pulumi.Input<string | undefined>;
/**
* The name of the file.
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The state of the import data file.
* Possible values:
* CREATING
* ACTIVE
*/
state?: pulumi.Input<string | undefined>;
/**
* A resource that contains a URI to which a data file can be uploaded.
* Structure is documented below.
*/
uploadFileInfos?: pulumi.Input<pulumi.Input<inputs.migrationcenter.ImportDataFileUploadFileInfo>[] | undefined>;
}
/**
* The set of arguments for constructing a ImportDataFile resource.
*/
export interface ImportDataFileArgs {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* User-friendly display name. Maximum length is 63 characters.
*/
displayName?: pulumi.Input<string | undefined>;
/**
* Possible values:
* IMPORT_JOB_FORMAT_RVTOOLS_XLSX
* IMPORT_JOB_FORMAT_RVTOOLS_CSV
* IMPORT_JOB_FORMAT_EXPORTED_AWS_CSV
* IMPORT_JOB_FORMAT_EXPORTED_AZURE_CSV
* IMPORT_JOB_FORMAT_STRATOZONE_CSV
* IMPORT_JOB_FORMAT_DATABASE_ZIP
*/
format: pulumi.Input<string>;
/**
* The ID of the new data file.
*/
importDataFileId: pulumi.Input<string>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
importJob: pulumi.Input<string>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
location: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=importDataFile.d.ts.map