@pulumi/gcp/gkebackup/restoreChannel.d.ts

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

import * as pulumi from "@pulumi/pulumi";
/**
 * A RestoreChannel imposes constraints on where backups can be restored.
 * The RestoreChannel should be in the same project and region
 * as the backups. The backups can only be restored in the
 * destination_project.
 *
 * To get more information about RestoreChannel, see:
 *
 * * [API documentation](https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/reference/rest/v1/projects.locations.restoreChannels)
 * * How-to Guides
 *     * [Official Documentation](https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke)
 *
 * ## Example Usage
 *
 * ### Gkebackup Restorechannel Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const basic = new gcp.gkebackup.RestoreChannel("basic", {
 *     name: "basic-channel",
 *     location: "us-central1",
 *     description: "Description",
 *     destinationProject: "projects/24240755850",
 *     labels: {
 *         key: "some-value",
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * RestoreChannel can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/{{location}}/restoreChannels/{{name}}`
 * * `{{project}}/{{location}}/{{name}}`
 * * `{{location}}/{{name}}`
 *
 * When using the `pulumi import` command, RestoreChannel can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:gkebackup/restoreChannel:RestoreChannel default projects/{{project}}/locations/{{location}}/restoreChannels/{{name}}
 * $ pulumi import gcp:gkebackup/restoreChannel:RestoreChannel default {{project}}/{{location}}/{{name}}
 * $ pulumi import gcp:gkebackup/restoreChannel:RestoreChannel default {{location}}/{{name}}
 * ```
 */
export declare class RestoreChannel extends pulumi.CustomResource {
    /**
     * Get an existing RestoreChannel 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?: RestoreChannelState, opts?: pulumi.CustomResourceOptions): RestoreChannel;
    /**
     * Returns true if the given object is an instance of RestoreChannel.  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 RestoreChannel;
    /**
     * 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 specified descriptive string for this RestoreChannel.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The project where Backups will be restored.
     * The format is `projects/{project}`.
     * {project} can be project number or project id.
     */
    readonly destinationProject: pulumi.Output<string>;
    /**
     * The projectId where Backups will be restored.
     * Example Project ID: "my-project-id".
     */
    readonly destinationProjectId: 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;
    }>;
    /**
     * etag is used for optimistic concurrency control as a way to help prevent simultaneous
     * updates of a restore channel from overwriting each other. It is strongly suggested that
     * systems make use of the 'etag' in the read-modify-write cycle to perform RestoreChannel updates
     * in order to avoid race conditions: An etag is returned in the response to restoreChannels.get,
     * and systems are expected to put that etag in the request to restoreChannels.patch or
     * restoreChannels.delete to ensure that their change will be applied to the same version of the resource.
     */
    readonly etag: pulumi.Output<string>;
    /**
     * Description: A set of custom labels supplied by the user.
     * A list of key->value pairs.
     * Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
     *
     * **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>;
    /**
     * The region of the Restore Channel.
     */
    readonly location: pulumi.Output<string>;
    /**
     * The full name of the RestoreChannel Resource.
     */
    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 combination of labels configured directly on the resource
     *  and default labels configured on the provider.
     */
    readonly pulumiLabels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * Server generated, unique identifier of UUID format.
     */
    readonly uid: pulumi.Output<string>;
    /**
     * Create a RestoreChannel 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: RestoreChannelArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering RestoreChannel resources.
 */
export interface RestoreChannelState {
    /**
     * 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 specified descriptive string for this RestoreChannel.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * The project where Backups will be restored.
     * The format is `projects/{project}`.
     * {project} can be project number or project id.
     */
    destinationProject?: pulumi.Input<string | undefined>;
    /**
     * The projectId where Backups will be restored.
     * Example Project ID: "my-project-id".
     */
    destinationProjectId?: 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>;
    /**
     * etag is used for optimistic concurrency control as a way to help prevent simultaneous
     * updates of a restore channel from overwriting each other. It is strongly suggested that
     * systems make use of the 'etag' in the read-modify-write cycle to perform RestoreChannel updates
     * in order to avoid race conditions: An etag is returned in the response to restoreChannels.get,
     * and systems are expected to put that etag in the request to restoreChannels.patch or
     * restoreChannels.delete to ensure that their change will be applied to the same version of the resource.
     */
    etag?: pulumi.Input<string | undefined>;
    /**
     * Description: A set of custom labels supplied by the user.
     * A list of key->value pairs.
     * Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
     *
     * **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>;
    /**
     * The region of the Restore Channel.
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * The full name of the RestoreChannel Resource.
     */
    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 combination of labels configured directly on the resource
     *  and default labels configured on the provider.
     */
    pulumiLabels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * Server generated, unique identifier of UUID format.
     */
    uid?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a RestoreChannel resource.
 */
export interface RestoreChannelArgs {
    /**
     * 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 specified descriptive string for this RestoreChannel.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * The project where Backups will be restored.
     * The format is `projects/{project}`.
     * {project} can be project number or project id.
     */
    destinationProject: pulumi.Input<string>;
    /**
     * Description: A set of custom labels supplied by the user.
     * A list of key->value pairs.
     * Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
     *
     * **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>;
    /**
     * The region of the Restore Channel.
     */
    location: pulumi.Input<string>;
    /**
     * The full name of the RestoreChannel Resource.
     */
    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>;
}
//# sourceMappingURL=restoreChannel.d.ts.map