@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
169 lines • 6.77 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! ***
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Note = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* A Container Analysis note is a high-level piece of metadata that
* describes a type of analysis that can be done for a resource.
*
* To get more information about Note, see:
*
* * [API documentation](https://cloud.google.com/container-analysis/api/reference/rest/)
* * How-to Guides
* * [Creating Attestations (Occurrences)](https://cloud.google.com/binary-authorization/docs/making-attestations)
* * [Official Documentation](https://cloud.google.com/container-analysis/)
*
* ## Example Usage
*
* ### Container Analysis Note Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const note = new gcp.containeranalysis.Note("note", {
* name: "attestor-note",
* attestationAuthority: {
* hint: {
* humanReadableName: "Attestor Note",
* },
* },
* });
* ```
* ### Container Analysis Note Attestation Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const note = new gcp.containeranalysis.Note("note", {
* name: "attestor-note",
* shortDescription: "test note",
* longDescription: "a longer description of test note",
* expirationTime: "2120-10-02T15:01:23.045123456Z",
* relatedUrls: [
* {
* url: "some.url",
* label: "foo",
* },
* {
* url: "google.com",
* },
* ],
* attestationAuthority: {
* hint: {
* humanReadableName: "Attestor Note",
* },
* },
* });
* ```
*
* ## Import
*
* Note can be imported using any of these accepted formats:
*
* * `projects/{{project}}/notes/{{name}}`
* * `{{project}}/{{name}}`
* * `{{name}}`
*
* When using the `pulumi import` command, Note can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:containeranalysis/note:Note default projects/{{project}}/notes/{{name}}
* $ pulumi import gcp:containeranalysis/note:Note default {{project}}/{{name}}
* $ pulumi import gcp:containeranalysis/note:Note default {{name}}
* ```
*/
class Note extends pulumi.CustomResource {
/**
* Get an existing Note 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 Note(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'gcp:containeranalysis/note:Note';
/**
* Returns true if the given object is an instance of Note. 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'] === Note.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["attestationAuthority"] = state?.attestationAuthority;
resourceInputs["createTime"] = state?.createTime;
resourceInputs["deletionPolicy"] = state?.deletionPolicy;
resourceInputs["expirationTime"] = state?.expirationTime;
resourceInputs["kind"] = state?.kind;
resourceInputs["longDescription"] = state?.longDescription;
resourceInputs["name"] = state?.name;
resourceInputs["project"] = state?.project;
resourceInputs["relatedNoteNames"] = state?.relatedNoteNames;
resourceInputs["relatedUrls"] = state?.relatedUrls;
resourceInputs["shortDescription"] = state?.shortDescription;
resourceInputs["updateTime"] = state?.updateTime;
}
else {
const args = argsOrState;
if (args?.attestationAuthority === undefined && !opts.urn) {
throw new Error("Missing required property 'attestationAuthority'");
}
resourceInputs["attestationAuthority"] = args?.attestationAuthority;
resourceInputs["deletionPolicy"] = args?.deletionPolicy;
resourceInputs["expirationTime"] = args?.expirationTime;
resourceInputs["longDescription"] = args?.longDescription;
resourceInputs["name"] = args?.name;
resourceInputs["project"] = args?.project;
resourceInputs["relatedNoteNames"] = args?.relatedNoteNames;
resourceInputs["relatedUrls"] = args?.relatedUrls;
resourceInputs["shortDescription"] = args?.shortDescription;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["kind"] = undefined /*out*/;
resourceInputs["updateTime"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(Note.__pulumiType, name, resourceInputs, opts);
}
}
exports.Note = Note;
//# sourceMappingURL=note.js.map