@pulumi/gcp/gkehub/rolloutSequence.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";
/**
 * RolloutSequence defines the desired order of upgrades.
 *
 * To get more information about RolloutSequence, see:
 *
 * * [API documentation](https://docs.cloud.google.com/kubernetes-engine/fleet-management/docs/reference/rest/v1beta/projects.locations.rolloutSequences)
 * * How-to Guides
 *     * [Rollout Sequencing Overview](https://cloud.google.com/kubernetes-engine/docs/concepts/rollout-sequencing-custom-stages/about-rollout-sequencing)
 *
 * ## Example Usage
 *
 * ### Gke Hub Rollout Sequence Create
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const rolloutSequence = new gcp.gkehub.RolloutSequence("rollout_sequence", {
 *     rolloutSequenceId: "rs-basic",
 *     displayName: "Basic Rollout Sequence",
 *     ignoredClustersSelector: {
 *         labelSelector: "resource.labels.ignored == 'true'",
 *     },
 *     stages: [{
 *         fleetProjects: ["projects/my-project-name"],
 *         soakDuration: "1h",
 *     }],
 *     autoUpgradeConfig: {
 *         rolloutCreationScope: {
 *             upgradeTypes: [
 *                 "CONTROL_PLANE_MINOR",
 *                 "CONTROL_PLANE_PATCH",
 *                 "NODE_MINOR",
 *                 "NODE_PATCH",
 *             ],
 *         },
 *     },
 * });
 * ```
 * ### Gke Hub Rollout Sequence Update
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const rolloutSequence = new gcp.gkehub.RolloutSequence("rollout_sequence", {
 *     rolloutSequenceId: "rs-basic",
 *     displayName: "Modified Rollout Sequence",
 *     ignoredClustersSelector: {
 *         labelSelector: "resource.labels.ignored == 'super_true'",
 *     },
 *     stages: [
 *         {
 *             fleetProjects: ["projects/my-project-name"],
 *             clusterSelector: {
 *                 labelSelector: "resource.labels.canary=='true'",
 *             },
 *             soakDuration: "2h",
 *         },
 *         {
 *             fleetProjects: ["projects/my-project-name"],
 *             soakDuration: "1d",
 *         },
 *     ],
 *     autoUpgradeConfig: {
 *         rolloutCreationScope: {
 *             upgradeTypes: [
 *                 "CONTROL_PLANE_PATCH",
 *                 "NODE_PATCH",
 *             ],
 *         },
 *     },
 *     labels: {
 *         some_key: "some_value",
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * RolloutSequence can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/global/rolloutSequences/{{rollout_sequence_id}}`
 * * `{{project}}/{{rollout_sequence_id}}`
 * * `{{rollout_sequence_id}}`
 *
 * When using the `pulumi import` command, RolloutSequence can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:gkehub/rolloutSequence:RolloutSequence default projects/{{project}}/locations/global/rolloutSequences/{{rollout_sequence_id}}
 * $ pulumi import gcp:gkehub/rolloutSequence:RolloutSequence default {{project}}/{{rollout_sequence_id}}
 * $ pulumi import gcp:gkehub/rolloutSequence:RolloutSequence default {{rollout_sequence_id}}
 * ```
 */
export declare class RolloutSequence extends pulumi.CustomResource {
    /**
     * Get an existing RolloutSequence 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?: RolloutSequenceState, opts?: pulumi.CustomResourceOptions): RolloutSequence;
    /**
     * Returns true if the given object is an instance of RolloutSequence.  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 RolloutSequence;
    /**
     * Configuration for automatic upgrades.
     * If not specified, the system applies default behavior.
     * Structure is documented below.
     */
    readonly autoUpgradeConfig: pulumi.Output<outputs.gkehub.RolloutSequenceAutoUpgradeConfig | undefined>;
    /**
     * The timestamp at which the Rollout Sequence was created.
     */
    readonly createTime: pulumi.Output<string>;
    /**
     * The timestamp at the Rollout Sequence was deleted.
     */
    readonly deleteTime: 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>;
    /**
     * Human readable display name of the Rollout Sequence.
     */
    readonly displayName: pulumi.Output<string | undefined>;
    /**
     * 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 of the Rollout Sequence.
     */
    readonly etag: pulumi.Output<string>;
    /**
     * Selector for clusters to exclude from the Rollout Sequence.
     * Structure is documented below.
     */
    readonly ignoredClustersSelector: pulumi.Output<outputs.gkehub.RolloutSequenceIgnoredClustersSelector | undefined>;
    /**
     * Labels for this Rollout Sequence.
     *
     * **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 full resource name of the RolloutSequence.
     */
    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;
    }>;
    /**
     * The user-provided identifier of the RolloutSequence.
     */
    readonly rolloutSequenceId: pulumi.Output<string>;
    /**
     * Ordered list of stages that constitute this Rollout Sequence.
     * Structure is documented below.
     */
    readonly stages: pulumi.Output<outputs.gkehub.RolloutSequenceStage[]>;
    /**
     * Google-generated UUID for this resource.
     */
    readonly uid: pulumi.Output<string>;
    /**
     * The timestamp at which the Rollout Sequence was last updated.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * Create a RolloutSequence 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: RolloutSequenceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering RolloutSequence resources.
 */
export interface RolloutSequenceState {
    /**
     * Configuration for automatic upgrades.
     * If not specified, the system applies default behavior.
     * Structure is documented below.
     */
    autoUpgradeConfig?: pulumi.Input<inputs.gkehub.RolloutSequenceAutoUpgradeConfig | undefined>;
    /**
     * The timestamp at which the Rollout Sequence was created.
     */
    createTime?: pulumi.Input<string | undefined>;
    /**
     * The timestamp at the Rollout Sequence was deleted.
     */
    deleteTime?: 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>;
    /**
     * Human readable display name of the Rollout Sequence.
     */
    displayName?: 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 of the Rollout Sequence.
     */
    etag?: pulumi.Input<string | undefined>;
    /**
     * Selector for clusters to exclude from the Rollout Sequence.
     * Structure is documented below.
     */
    ignoredClustersSelector?: pulumi.Input<inputs.gkehub.RolloutSequenceIgnoredClustersSelector | undefined>;
    /**
     * Labels for this Rollout Sequence.
     *
     * **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 full resource name of the RolloutSequence.
     */
    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>;
    /**
     * The user-provided identifier of the RolloutSequence.
     */
    rolloutSequenceId?: pulumi.Input<string | undefined>;
    /**
     * Ordered list of stages that constitute this Rollout Sequence.
     * Structure is documented below.
     */
    stages?: pulumi.Input<pulumi.Input<inputs.gkehub.RolloutSequenceStage>[] | undefined>;
    /**
     * Google-generated UUID for this resource.
     */
    uid?: pulumi.Input<string | undefined>;
    /**
     * The timestamp at which the Rollout Sequence was last updated.
     */
    updateTime?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a RolloutSequence resource.
 */
export interface RolloutSequenceArgs {
    /**
     * Configuration for automatic upgrades.
     * If not specified, the system applies default behavior.
     * Structure is documented below.
     */
    autoUpgradeConfig?: pulumi.Input<inputs.gkehub.RolloutSequenceAutoUpgradeConfig | 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>;
    /**
     * Human readable display name of the Rollout Sequence.
     */
    displayName?: pulumi.Input<string | undefined>;
    /**
     * Selector for clusters to exclude from the Rollout Sequence.
     * Structure is documented below.
     */
    ignoredClustersSelector?: pulumi.Input<inputs.gkehub.RolloutSequenceIgnoredClustersSelector | undefined>;
    /**
     * Labels for this Rollout Sequence.
     *
     * **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 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 user-provided identifier of the RolloutSequence.
     */
    rolloutSequenceId: pulumi.Input<string>;
    /**
     * Ordered list of stages that constitute this Rollout Sequence.
     * Structure is documented below.
     */
    stages: pulumi.Input<pulumi.Input<inputs.gkehub.RolloutSequenceStage>[]>;
}
//# sourceMappingURL=rolloutSequence.d.ts.map