@pulumi/gcp/migrationcenter/assetsExportJob.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * AssetsExportJob represents a batch job that exports Migration Center assets to external destinations such as Cloud Storage.
 *
 * ## Example Usage
 *
 * ### Migration Center Assets Export Job Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const _default = new gcp.migrationcenter.AssetsExportJob("default", {
 *     location: "us-central1",
 *     assetsExportJobId: "assets-export-job-test",
 *     performanceData: {
 *         maxDays: 30,
 *     },
 *     showHidden: true,
 *     signedUriDestination: {
 *         fileFormat: "CSV",
 *     },
 *     labels: {
 *         key: "value",
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * AssetsExportJob can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/{{location}}/assetsExportJobs/{{assets_export_job_id}}`
 * * `{{project}}/{{location}}/{{assets_export_job_id}}`
 * * `{{location}}/{{assets_export_job_id}}`
 *
 * When using the `pulumi import` command, AssetsExportJob can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:migrationcenter/assetsExportJob:AssetsExportJob default projects/{{project}}/locations/{{location}}/assetsExportJobs/{{assets_export_job_id}}
 * $ pulumi import gcp:migrationcenter/assetsExportJob:AssetsExportJob default {{project}}/{{location}}/{{assets_export_job_id}}
 * $ pulumi import gcp:migrationcenter/assetsExportJob:AssetsExportJob default {{location}}/{{assets_export_job_id}}
 * ```
 */
export declare class AssetsExportJob extends pulumi.CustomResource {
    /**
     * Get an existing AssetsExportJob 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?: AssetsExportJobState, opts?: pulumi.CustomResourceOptions): AssetsExportJob;
    /**
     * Returns true if the given object is an instance of AssetsExportJob.  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 AssetsExportJob;
    /**
     * The ID to use for the asset export job.
     */
    readonly assetsExportJobId: pulumi.Output<string>;
    /**
     * Conditions for selecting assets to export.
     * Structure is documented below.
     */
    readonly condition: pulumi.Output<outputs.migrationcenter.AssetsExportJobCondition | undefined>;
    /**
     * Resource creation time.
     */
    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>;
    /**
     * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
     */
    readonly effectiveLabels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * Configuration for asset inventory details exports.
     */
    readonly inventories: pulumi.Output<outputs.migrationcenter.AssetsExportJobInventory[]>;
    /**
     * Labels as key value pairs.
     * Labels must meet the following constraints:
     * * Keys and values can contain only lowercase letters, numeric characters,
     *   underscores, and dashes.
     * * All characters must use UTF-8 encoding, and international characters are
     *   allowed.
     * * Keys must start with a lowercase letter or international character.
     * * Each resource is limited to a maximum of 64 labels.
     *   Both keys and values are additionally constrained to be <= 128 bytes.
     *   **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     *   Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    readonly labels: pulumi.Output<{
        [key: string]: 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.
     */
    readonly location: pulumi.Output<string>;
    /**
     * Identifier. Resource name.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Configuration for network dependencies exports.
     */
    readonly networkDependencies: pulumi.Output<outputs.migrationcenter.AssetsExportJobNetworkDependency[]>;
    /**
     * Configuration for performance data exports.
     * Structure is documented below.
     */
    readonly performanceData: pulumi.Output<outputs.migrationcenter.AssetsExportJobPerformanceData | undefined>;
    /**
     * 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 combination of labels configured directly on the resource
     *  and default labels configured on the provider.
     */
    readonly pulumiLabels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * Recent non expired executions of the job.
     * Structure is documented below.
     */
    readonly recentExecutions: pulumi.Output<outputs.migrationcenter.AssetsExportJobRecentExecution[]>;
    /**
     * When this value is set to 'true' the response will include all assets,
     * including those that are hidden.
     */
    readonly showHidden: pulumi.Output<boolean | undefined>;
    /**
     * Signed URI destination configuration.
     * Structure is documented below.
     */
    readonly signedUriDestination: pulumi.Output<outputs.migrationcenter.AssetsExportJobSignedUriDestination | undefined>;
    /**
     * Resource update time.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * Create a AssetsExportJob 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: AssetsExportJobArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering AssetsExportJob resources.
 */
export interface AssetsExportJobState {
    /**
     * The ID to use for the asset export job.
     */
    assetsExportJobId?: pulumi.Input<string | undefined>;
    /**
     * Conditions for selecting assets to export.
     * Structure is documented below.
     */
    condition?: pulumi.Input<inputs.migrationcenter.AssetsExportJobCondition | undefined>;
    /**
     * Resource creation time.
     */
    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>;
    /**
     * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
     */
    effectiveLabels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * Configuration for asset inventory details exports.
     */
    inventories?: pulumi.Input<pulumi.Input<inputs.migrationcenter.AssetsExportJobInventory>[] | undefined>;
    /**
     * Labels as key value pairs.
     * Labels must meet the following constraints:
     * * Keys and values can contain only lowercase letters, numeric characters,
     *   underscores, and dashes.
     * * All characters must use UTF-8 encoding, and international characters are
     *   allowed.
     * * Keys must start with a lowercase letter or international character.
     * * Each resource is limited to a maximum of 64 labels.
     *   Both keys and values are additionally constrained to be <= 128 bytes.
     *   **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     *   Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: 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>;
    /**
     * Identifier. Resource name.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Configuration for network dependencies exports.
     */
    networkDependencies?: pulumi.Input<pulumi.Input<inputs.migrationcenter.AssetsExportJobNetworkDependency>[] | undefined>;
    /**
     * Configuration for performance data exports.
     * Structure is documented below.
     */
    performanceData?: pulumi.Input<inputs.migrationcenter.AssetsExportJobPerformanceData | 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 combination of labels configured directly on the resource
     *  and default labels configured on the provider.
     */
    pulumiLabels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * Recent non expired executions of the job.
     * Structure is documented below.
     */
    recentExecutions?: pulumi.Input<pulumi.Input<inputs.migrationcenter.AssetsExportJobRecentExecution>[] | undefined>;
    /**
     * When this value is set to 'true' the response will include all assets,
     * including those that are hidden.
     */
    showHidden?: pulumi.Input<boolean | undefined>;
    /**
     * Signed URI destination configuration.
     * Structure is documented below.
     */
    signedUriDestination?: pulumi.Input<inputs.migrationcenter.AssetsExportJobSignedUriDestination | undefined>;
    /**
     * Resource update time.
     */
    updateTime?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a AssetsExportJob resource.
 */
export interface AssetsExportJobArgs {
    /**
     * The ID to use for the asset export job.
     */
    assetsExportJobId: pulumi.Input<string>;
    /**
     * Conditions for selecting assets to export.
     * Structure is documented below.
     */
    condition?: pulumi.Input<inputs.migrationcenter.AssetsExportJobCondition | 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>;
    /**
     * Labels as key value pairs.
     * Labels must meet the following constraints:
     * * Keys and values can contain only lowercase letters, numeric characters,
     *   underscores, and dashes.
     * * All characters must use UTF-8 encoding, and international characters are
     *   allowed.
     * * Keys must start with a lowercase letter or international character.
     * * Each resource is limited to a maximum of 64 labels.
     *   Both keys and values are additionally constrained to be <= 128 bytes.
     *   **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     *   Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: 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>;
    /**
     * Configuration for performance data exports.
     * Structure is documented below.
     */
    performanceData?: pulumi.Input<inputs.migrationcenter.AssetsExportJobPerformanceData | 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>;
    /**
     * When this value is set to 'true' the response will include all assets,
     * including those that are hidden.
     */
    showHidden?: pulumi.Input<boolean | undefined>;
    /**
     * Signed URI destination configuration.
     * Structure is documented below.
     */
    signedUriDestination?: pulumi.Input<inputs.migrationcenter.AssetsExportJobSignedUriDestination | undefined>;
}
//# sourceMappingURL=assetsExportJob.d.ts.map