@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
641 lines • 26.3 kB
JavaScript
"use strict";
// *** 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.FrameworkDeployment = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* Framework deployments represent the assignment of a framework to a target resource. Supported target resources are organizations, folders, and projects.
*
* To get more information about FrameworkDeployment, see:
*
* * [API documentation](https://docs.cloud.google.com/security-command-center/docs/reference/cloudsecuritycompliance/rest/v1/organizations.locations.frameworkDeployments)
*
* ## Example Usage
*
* ### Cloudsecuritycompliance Framework Deployment Org Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = new gcp.cloudsecuritycompliance.Framework("example", {
* parent: "organizations/123456789",
* location: "global",
* frameworkId: "example-framework",
* displayName: "Terraform Framework Name",
* description: "An Terraform description for the framework",
* cloudControlDetails: [{
* name: "organizations/123456789/locations/global/cloudControls/builtin-detective-policy-for-vertex-ai-runtime-template-idle-shutdown",
* majorRevisionId: "2",
* parameters: [
* {
* name: "location",
* parameterValue: {
* stringValue: "us-central1",
* },
* },
* {
* name: "oneof-parameter",
* parameterValue: {
* oneofValue: {
* name: "test-oneof",
* parameterValue: {
* stringValue: "test-value",
* },
* },
* },
* },
* {
* name: "bool-parameter",
* parameterValue: {
* oneofValue: {
* name: "bool-oneof",
* parameterValue: {
* boolValue: true,
* },
* },
* },
* },
* {
* name: "number-parameter",
* parameterValue: {
* oneofValue: {
* name: "number-oneof",
* parameterValue: {
* numberValue: 123.45,
* },
* },
* },
* },
* {
* name: "string-list-parameter",
* parameterValue: {
* oneofValue: {
* name: "string-list-oneof",
* parameterValue: {
* stringListValue: {
* values: [
* "value1",
* "value2",
* ],
* },
* },
* },
* },
* },
* ],
* }],
* });
* const exampleFrameworkDeployment = new gcp.cloudsecuritycompliance.FrameworkDeployment("example", {
* parent: "organizations/123456789",
* location: "global",
* frameworkDeploymentId: "example-deployment",
* description: "A framework deployment for cloud security compliance",
* framework: {
* framework: example.name,
* majorRevisionId: "1",
* },
* targetResourceConfig: {
* existingTargetResource: "organizations/123456789",
* },
* cloudControlMetadatas: [{
* enforcementMode: "DETECTIVE",
* cloudControlDetails: {
* name: "organizations/123456789/locations/global/cloudControls/builtin-detective-policy-for-vertex-ai-runtime-template-idle-shutdown",
* majorRevisionId: "2",
* parameters: [
* {
* name: "enabled",
* parameterValue: {
* boolValue: true,
* },
* },
* {
* name: "regions",
* parameterValue: {
* stringListValue: {
* values: [
* "us-central1",
* "us-west1",
* "us-east1",
* ],
* },
* },
* },
* {
* name: "location",
* parameterValue: {
* stringValue: "us-central1",
* },
* },
* {
* name: "oneof-parameter",
* parameterValue: {
* oneofValue: {
* name: "test-oneof",
* parameterValue: {
* stringValue: "test-value",
* },
* },
* },
* },
* {
* name: "bool-parameter",
* parameterValue: {
* oneofValue: {
* name: "bool-oneof",
* parameterValue: {
* boolValue: true,
* },
* },
* },
* },
* {
* name: "number-parameter",
* parameterValue: {
* oneofValue: {
* name: "number-oneof",
* parameterValue: {
* numberValue: 123.45,
* },
* },
* },
* },
* {
* name: "string-list-parameter",
* parameterValue: {
* oneofValue: {
* name: "string-list-oneof",
* parameterValue: {
* stringListValue: {
* values: [
* "value1",
* "value2",
* ],
* },
* },
* },
* },
* },
* ],
* },
* }],
* });
* ```
* ### Cloudsecuritycompliance Framework Deployment Project Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const project = gcp.organizations.getProject({});
* const example = new gcp.cloudsecuritycompliance.Framework("example", {
* parent: project.then(project => `projects/${project.number}`),
* location: "global",
* frameworkId: "example-framework",
* displayName: "Terraform Framework Name",
* description: "An Terraform description for the framework",
* cloudControlDetails: [{
* name: project.then(project => `projects/${project.number}/locations/global/cloudControls/builtin-detective-policy-for-vertex-ai-runtime-template-idle-shutdown`),
* majorRevisionId: "2",
* parameters: [
* {
* name: "location",
* parameterValue: {
* stringValue: "us-central1",
* },
* },
* {
* name: "oneof-parameter",
* parameterValue: {
* oneofValue: {
* name: "test-oneof",
* parameterValue: {
* stringValue: "test-value",
* },
* },
* },
* },
* {
* name: "bool-parameter",
* parameterValue: {
* oneofValue: {
* name: "bool-oneof",
* parameterValue: {
* boolValue: true,
* },
* },
* },
* },
* {
* name: "number-parameter",
* parameterValue: {
* oneofValue: {
* name: "number-oneof",
* parameterValue: {
* numberValue: 123.45,
* },
* },
* },
* },
* {
* name: "string-list-parameter",
* parameterValue: {
* oneofValue: {
* name: "string-list-oneof",
* parameterValue: {
* stringListValue: {
* values: [
* "value1",
* "value2",
* ],
* },
* },
* },
* },
* },
* ],
* }],
* });
* const exampleFrameworkDeployment = new gcp.cloudsecuritycompliance.FrameworkDeployment("example", {
* parent: project.then(project => `projects/${project.number}`),
* location: "global",
* frameworkDeploymentId: "example-deployment",
* description: "A framework deployment for cloud security compliance",
* framework: {
* framework: example.name,
* majorRevisionId: "1",
* },
* targetResourceConfig: {
* existingTargetResource: project.then(project => `projects/${project.projectId}`),
* },
* cloudControlMetadatas: [{
* enforcementMode: "DETECTIVE",
* cloudControlDetails: {
* name: project.then(project => `projects/${project.number}/locations/global/cloudControls/builtin-detective-policy-for-vertex-ai-runtime-template-idle-shutdown`),
* majorRevisionId: "2",
* parameters: [
* {
* name: "enabled",
* parameterValue: {
* boolValue: true,
* },
* },
* {
* name: "regions",
* parameterValue: {
* stringListValue: {
* values: [
* "us-central1",
* "us-west1",
* "us-east1",
* ],
* },
* },
* },
* {
* name: "location",
* parameterValue: {
* stringValue: "us-central1",
* },
* },
* {
* name: "oneof-parameter",
* parameterValue: {
* oneofValue: {
* name: "test-oneof",
* parameterValue: {
* stringValue: "test-value",
* },
* },
* },
* },
* {
* name: "bool-parameter",
* parameterValue: {
* oneofValue: {
* name: "bool-oneof",
* parameterValue: {
* boolValue: true,
* },
* },
* },
* },
* {
* name: "number-parameter",
* parameterValue: {
* oneofValue: {
* name: "number-oneof",
* parameterValue: {
* numberValue: 123.45,
* },
* },
* },
* },
* {
* name: "string-list-parameter",
* parameterValue: {
* oneofValue: {
* name: "string-list-oneof",
* parameterValue: {
* stringListValue: {
* values: [
* "value1",
* "value2",
* ],
* },
* },
* },
* },
* },
* ],
* },
* }],
* });
* ```
* ### Cloudsecuritycompliance Framework Deployment Org Project Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const project = gcp.organizations.getProject({});
* const example = new gcp.cloudsecuritycompliance.Framework("example", {
* parent: "organizations/123456789",
* location: "global",
* frameworkId: "example-framework",
* displayName: "Terraform Framework Name",
* description: "A Terraform description for the framework",
* cloudControlDetails: [{
* name: "organizations/123456789/locations/global/cloudControls/builtin-require-cmek-on-bigquery-datasets",
* majorRevisionId: "2",
* parameters: [{
* name: "location",
* parameterValue: {
* numberValue: 1,
* },
* }],
* }],
* });
* const exampleFrameworkDeployment = new gcp.cloudsecuritycompliance.FrameworkDeployment("example", {
* parent: "organizations/123456789",
* location: "global",
* frameworkDeploymentId: "example-deployment",
* description: "A framework deployment with org parent targeting a project",
* framework: {
* framework: example.name,
* majorRevisionId: "1",
* },
* targetResourceConfig: {
* existingTargetResource: project.then(project => `projects/${project.projectId}`),
* },
* cloudControlMetadatas: [{
* enforcementMode: "DETECTIVE",
* cloudControlDetails: {
* name: "organizations/123456789/locations/global/cloudControls/builtin-require-cmek-on-bigquery-datasets",
* majorRevisionId: "2",
* parameters: [{
* name: "location",
* parameterValue: {
* numberValue: 1,
* },
* }],
* },
* }],
* });
* ```
* ### Cloudsecuritycompliance Framework Deployment Project Application Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const project = gcp.organizations.getProject({});
* // App Hub Application resource to act as the target
* const application = new gcp.apphub.Application("application", {
* location: "us-central1",
* applicationId: "example-app",
* scope: {
* type: "REGIONAL",
* },
* });
* const example = new gcp.cloudsecuritycompliance.Framework("example", {
* parent: project.then(project => `projects/${project.number}`),
* location: "global",
* frameworkId: "example-framework",
* displayName: "Terraform Framework Name",
* description: "A Terraform description for the framework",
* cloudControlDetails: [{
* name: project.then(project => `projects/${project.number}/locations/global/cloudControls/builtin-require-cmek-on-bigquery-datasets`),
* majorRevisionId: "2",
* parameters: [{
* name: "location",
* parameterValue: {
* numberValue: 1,
* },
* }],
* }],
* });
* const exampleFrameworkDeployment = new gcp.cloudsecuritycompliance.FrameworkDeployment("example", {
* parent: project.then(project => `projects/${project.number}`),
* location: "global",
* frameworkDeploymentId: "example-deployment",
* description: "A framework deployment with project parent targeting an application",
* framework: {
* framework: example.name,
* majorRevisionId: "1",
* },
* targetResourceConfig: {
* existingTargetResource: pulumi.all([project, application.applicationId]).apply(([project, applicationId]) => `projects/${project.number}/locations/us-central1/applications/${applicationId}`),
* },
* cloudControlMetadatas: [{
* enforcementMode: "DETECTIVE",
* cloudControlDetails: {
* name: project.then(project => `projects/${project.number}/locations/global/cloudControls/builtin-require-cmek-on-bigquery-datasets`),
* majorRevisionId: "2",
* parameters: [{
* name: "location",
* parameterValue: {
* numberValue: 1,
* },
* }],
* },
* }],
* });
* ```
* ### Cloudsecuritycompliance Framework Deployment Org Basic Backward
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = new gcp.cloudsecuritycompliance.Framework("example", {
* organization: "123456789",
* location: "global",
* frameworkId: "example-framework",
* displayName: "Terraform Framework Name",
* description: "An Terraform description for the framework",
* cloudControlDetails: [{
* name: "organizations/123456789/locations/global/cloudControls/builtin-detective-policy-for-vertex-ai-runtime-template-idle-shutdown",
* majorRevisionId: "2",
* parameters: [{
* name: "location",
* parameterValue: {
* stringValue: "us-central1",
* },
* }],
* }],
* });
* const exampleFrameworkDeployment = new gcp.cloudsecuritycompliance.FrameworkDeployment("example", {
* organization: "123456789",
* location: "global",
* frameworkDeploymentId: "example-deployment",
* description: "A framework deployment for cloud security compliance",
* framework: {
* framework: example.name,
* majorRevisionId: "1",
* },
* targetResourceConfig: {
* existingTargetResource: "organizations/123456789",
* },
* cloudControlMetadatas: [{
* enforcementMode: "DETECTIVE",
* cloudControlDetails: {
* name: "organizations/123456789/locations/global/cloudControls/builtin-detective-policy-for-vertex-ai-runtime-template-idle-shutdown",
* majorRevisionId: "2",
* parameters: [{
* name: "enabled",
* parameterValue: {
* boolValue: true,
* },
* }],
* },
* }],
* });
* ```
*
* ## Import
*
* FrameworkDeployment can be imported using any of these accepted formats:
*
* * `organizations/{{organization}}/locations/{{location}}/frameworkDeployments/{{framework_deployment_id}}`
* * `{{parent}}/locations/{{location}}/frameworkDeployments/{{framework_deployment_id}}`
*
* When using the `pulumi import` command, FrameworkDeployment can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:cloudsecuritycompliance/frameworkDeployment:FrameworkDeployment default organizations/{{organization}}/locations/{{location}}/frameworkDeployments/{{framework_deployment_id}}
* $ pulumi import gcp:cloudsecuritycompliance/frameworkDeployment:FrameworkDeployment default {{parent}}/locations/{{location}}/frameworkDeployments/{{framework_deployment_id}}
* ```
*/
class FrameworkDeployment extends pulumi.CustomResource {
/**
* Get an existing FrameworkDeployment 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 FrameworkDeployment(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'gcp:cloudsecuritycompliance/frameworkDeployment:FrameworkDeployment';
/**
* Returns true if the given object is an instance of FrameworkDeployment. 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'] === FrameworkDeployment.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["cloudControlDeploymentReferences"] = state?.cloudControlDeploymentReferences;
resourceInputs["cloudControlMetadatas"] = state?.cloudControlMetadatas;
resourceInputs["computedTargetResource"] = state?.computedTargetResource;
resourceInputs["createTime"] = state?.createTime;
resourceInputs["deletionPolicy"] = state?.deletionPolicy;
resourceInputs["deploymentState"] = state?.deploymentState;
resourceInputs["description"] = state?.description;
resourceInputs["etag"] = state?.etag;
resourceInputs["framework"] = state?.framework;
resourceInputs["frameworkDeploymentId"] = state?.frameworkDeploymentId;
resourceInputs["location"] = state?.location;
resourceInputs["name"] = state?.name;
resourceInputs["organization"] = state?.organization;
resourceInputs["parent"] = state?.parent;
resourceInputs["targetResourceConfig"] = state?.targetResourceConfig;
resourceInputs["targetResourceDisplayName"] = state?.targetResourceDisplayName;
resourceInputs["updateTime"] = state?.updateTime;
}
else {
const args = argsOrState;
if (args?.cloudControlMetadatas === undefined && !opts.urn) {
throw new Error("Missing required property 'cloudControlMetadatas'");
}
if (args?.framework === undefined && !opts.urn) {
throw new Error("Missing required property 'framework'");
}
if (args?.frameworkDeploymentId === undefined && !opts.urn) {
throw new Error("Missing required property 'frameworkDeploymentId'");
}
if (args?.targetResourceConfig === undefined && !opts.urn) {
throw new Error("Missing required property 'targetResourceConfig'");
}
resourceInputs["cloudControlMetadatas"] = args?.cloudControlMetadatas;
resourceInputs["deletionPolicy"] = args?.deletionPolicy;
resourceInputs["description"] = args?.description;
resourceInputs["framework"] = args?.framework;
resourceInputs["frameworkDeploymentId"] = args?.frameworkDeploymentId;
resourceInputs["location"] = args?.location;
resourceInputs["organization"] = args?.organization;
resourceInputs["parent"] = args?.parent;
resourceInputs["targetResourceConfig"] = args?.targetResourceConfig;
resourceInputs["cloudControlDeploymentReferences"] = undefined /*out*/;
resourceInputs["computedTargetResource"] = undefined /*out*/;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["deploymentState"] = undefined /*out*/;
resourceInputs["etag"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["targetResourceDisplayName"] = undefined /*out*/;
resourceInputs["updateTime"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(FrameworkDeployment.__pulumiType, name, resourceInputs, opts);
}
}
exports.FrameworkDeployment = FrameworkDeployment;
//# sourceMappingURL=frameworkDeployment.js.map