@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
288 lines • 10.9 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.Automation = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* An `Automation` enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion amongst Targets, Rollout repair and Rollout deployment strategy advancement.
*
* To get more information about Automation, see:
*
* * [API documentation](https://cloud.google.com/deploy/docs/api/reference/rest/v1/projects.locations.deliveryPipelines.automations)
* * How-to Guides
* * [Automate your deployment](https://cloud.google.com/deploy/docs/automation)
*
* ## Example Usage
*
* ### Clouddeploy Automation Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const pipeline = new gcp.clouddeploy.DeliveryPipeline("pipeline", {
* name: "cd-pipeline",
* location: "us-central1",
* serialPipeline: {
* stages: [{
* targetId: "test",
* profiles: [],
* }],
* },
* });
* const b_automation = new gcp.clouddeploy.Automation("b-automation", {
* name: "cd-automation",
* project: pipeline.project,
* location: pipeline.location,
* deliveryPipeline: pipeline.name,
* serviceAccount: "my@service-account.com",
* selector: {
* targets: [{
* id: "*",
* }],
* },
* rules: [
* {
* promoteReleaseRule: {
* id: "promote-release",
* },
* },
* {
* advanceRolloutRule: {
* id: "advance-rollout",
* },
* },
* {
* repairRolloutRule: {
* id: "repair-rollout",
* repairPhases: [
* {
* retry: {
* attempts: "1",
* },
* },
* {
* rollback: {},
* },
* ],
* },
* },
* {
* timedPromoteReleaseRule: {
* id: "timed-promote-release",
* schedule: "0 9 * * 1",
* timeZone: "America/New_York",
* },
* },
* ],
* });
* ```
* ### Clouddeploy Automation Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const pipeline = new gcp.clouddeploy.DeliveryPipeline("pipeline", {
* name: "cd-pipeline",
* location: "us-central1",
* serialPipeline: {
* stages: [{
* targetId: "test",
* profiles: ["test-profile"],
* }],
* },
* });
* const f_automation = new gcp.clouddeploy.Automation("f-automation", {
* name: "cd-automation",
* location: "us-central1",
* deliveryPipeline: pipeline.name,
* serviceAccount: "my@service-account.com",
* annotations: {
* my_first_annotation: "example-annotation-1",
* my_second_annotation: "example-annotation-2",
* },
* labels: {
* my_first_label: "example-label-1",
* my_second_label: "example-label-2",
* },
* description: "automation resource",
* selector: {
* targets: [{
* id: "test",
* labels: {
* foo: "bar",
* },
* }],
* },
* suspended: true,
* rules: [
* {
* promoteReleaseRule: {
* id: "promote-release",
* wait: "200s",
* destinationTargetId: "@next",
* destinationPhase: "stable",
* },
* },
* {
* advanceRolloutRule: {
* id: "advance-rollout",
* sourcePhases: ["canary"],
* wait: "200s",
* },
* },
* {
* repairRolloutRule: {
* id: "repair-rollout",
* phases: ["stable"],
* jobs: ["deploy"],
* repairPhases: [
* {
* retry: {
* attempts: "1",
* wait: "200s",
* backoffMode: "BACKOFF_MODE_LINEAR",
* },
* },
* {
* rollback: {
* destinationPhase: "stable",
* disableRollbackIfRolloutPending: true,
* },
* },
* ],
* },
* },
* {
* timedPromoteReleaseRule: {
* id: "timed-promote-release",
* destinationTargetId: "@next",
* schedule: "0 9 * * 1",
* timeZone: "America/New_York",
* destinationPhase: "stable",
* },
* },
* ],
* });
* ```
*
* ## Import
*
* Automation can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/deliveryPipelines/{{delivery_pipeline}}/automations/{{name}}`
*
* * `{{project}}/{{location}}/{{delivery_pipeline}}/{{name}}`
*
* * `{{location}}/{{delivery_pipeline}}/{{name}}`
*
* When using the `pulumi import` command, Automation can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:clouddeploy/automation:Automation default projects/{{project}}/locations/{{location}}/deliveryPipelines/{{delivery_pipeline}}/automations/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:clouddeploy/automation:Automation default {{project}}/{{location}}/{{delivery_pipeline}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:clouddeploy/automation:Automation default {{location}}/{{delivery_pipeline}}/{{name}}
* ```
*/
class Automation extends pulumi.CustomResource {
/**
* Get an existing Automation 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, id, state, opts) {
return new Automation(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of Automation. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Automation.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["annotations"] = state?.annotations;
resourceInputs["createTime"] = state?.createTime;
resourceInputs["deliveryPipeline"] = state?.deliveryPipeline;
resourceInputs["description"] = state?.description;
resourceInputs["effectiveAnnotations"] = state?.effectiveAnnotations;
resourceInputs["effectiveLabels"] = state?.effectiveLabels;
resourceInputs["etag"] = state?.etag;
resourceInputs["labels"] = state?.labels;
resourceInputs["location"] = state?.location;
resourceInputs["name"] = state?.name;
resourceInputs["project"] = state?.project;
resourceInputs["pulumiLabels"] = state?.pulumiLabels;
resourceInputs["rules"] = state?.rules;
resourceInputs["selector"] = state?.selector;
resourceInputs["serviceAccount"] = state?.serviceAccount;
resourceInputs["suspended"] = state?.suspended;
resourceInputs["uid"] = state?.uid;
resourceInputs["updateTime"] = state?.updateTime;
}
else {
const args = argsOrState;
if (args?.deliveryPipeline === undefined && !opts.urn) {
throw new Error("Missing required property 'deliveryPipeline'");
}
if (args?.location === undefined && !opts.urn) {
throw new Error("Missing required property 'location'");
}
if (args?.rules === undefined && !opts.urn) {
throw new Error("Missing required property 'rules'");
}
if (args?.selector === undefined && !opts.urn) {
throw new Error("Missing required property 'selector'");
}
if (args?.serviceAccount === undefined && !opts.urn) {
throw new Error("Missing required property 'serviceAccount'");
}
resourceInputs["annotations"] = args?.annotations;
resourceInputs["deliveryPipeline"] = args?.deliveryPipeline;
resourceInputs["description"] = args?.description;
resourceInputs["labels"] = args?.labels;
resourceInputs["location"] = args?.location;
resourceInputs["name"] = args?.name;
resourceInputs["project"] = args?.project;
resourceInputs["rules"] = args?.rules;
resourceInputs["selector"] = args?.selector;
resourceInputs["serviceAccount"] = args?.serviceAccount;
resourceInputs["suspended"] = args?.suspended;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["effectiveAnnotations"] = undefined /*out*/;
resourceInputs["effectiveLabels"] = undefined /*out*/;
resourceInputs["etag"] = undefined /*out*/;
resourceInputs["pulumiLabels"] = undefined /*out*/;
resourceInputs["uid"] = undefined /*out*/;
resourceInputs["updateTime"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["effectiveLabels", "pulumiLabels"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(Automation.__pulumiType, name, resourceInputs, opts);
}
}
exports.Automation = Automation;
/** @internal */
Automation.__pulumiType = 'gcp:clouddeploy/automation:Automation';
//# sourceMappingURL=automation.js.map