@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
147 lines • 6.95 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.ServicePerimeterResource = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* Allows configuring a single GCP resource that should be inside the `status` block of a service perimeter.
* This resource is intended to be used in cases where it is not possible to compile a full list
* of projects to include in a `gcp.accesscontextmanager.ServicePerimeter` resource,
* to enable them to be added separately.
* If your perimeter is in dry-run mode use `gcp.accesscontextmanager.ServicePerimeterDryRunResource` instead.
*
* > **Note:** If this resource is used alongside a `gcp.accesscontextmanager.ServicePerimeter` resource,
* the service perimeter resource must have a `lifecycle` block with `ignoreChanges = [status[0].resources]` so
* they don't fight over which resources should be in the policy.
*
* To get more information about ServicePerimeterResource, see:
*
* * [API documentation](https://cloud.google.com/access-context-manager/docs/reference/rest/v1/accessPolicies.servicePerimeters)
* * How-to Guides
* * [Service Perimeter Quickstart](https://cloud.google.com/vpc-service-controls/docs/quickstart)
*
* > **Warning:** If you are using User ADCs (Application Default Credentials) with this resource,
* you must specify a `billingProject` and set `userProjectOverride` to true
* in the provider configuration. Otherwise the ACM API will return a 403 error.
* Your account must have the `serviceusage.services.use` permission on the
* `billingProject` you defined.
*
* ## Example Usage
*
* ### Access Context Manager Service Perimeter Resource Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const access_policy = new gcp.accesscontextmanager.AccessPolicy("access-policy", {
* parent: "organizations/123456789",
* title: "my policy",
* });
* const service_perimeter_resourceServicePerimeter = new gcp.accesscontextmanager.ServicePerimeter("service-perimeter-resource", {
* parent: pulumi.interpolate`accessPolicies/${access_policy.name}`,
* name: pulumi.interpolate`accessPolicies/${access_policy.name}/servicePerimeters/restrict_all`,
* title: "restrict_all",
* status: {
* restrictedServices: ["storage.googleapis.com"],
* },
* });
* const service_perimeter_resource = new gcp.accesscontextmanager.ServicePerimeterResource("service-perimeter-resource", {
* perimeterName: service_perimeter_resourceServicePerimeter.name,
* resource: "projects/987654321",
* });
* ```
*
* ## Import
*
* ServicePerimeterResource can be imported using any of these accepted formats:
*
* * `{{perimeter_name}}/{{resource}}`
*
* When using the `pulumi import` command, ServicePerimeterResource can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:accesscontextmanager/servicePerimeterResource:ServicePerimeterResource default {{perimeter_name}}/{{resource}}
* ```
*/
class ServicePerimeterResource extends pulumi.CustomResource {
/**
* Get an existing ServicePerimeterResource 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 ServicePerimeterResource(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'gcp:accesscontextmanager/servicePerimeterResource:ServicePerimeterResource';
/**
* Returns true if the given object is an instance of ServicePerimeterResource. 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'] === ServicePerimeterResource.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["accessPolicyId"] = state?.accessPolicyId;
resourceInputs["deletionPolicy"] = state?.deletionPolicy;
resourceInputs["etag"] = state?.etag;
resourceInputs["perimeterName"] = state?.perimeterName;
resourceInputs["resource"] = state?.resource;
}
else {
const args = argsOrState;
if (args?.perimeterName === undefined && !opts.urn) {
throw new Error("Missing required property 'perimeterName'");
}
if (args?.resource === undefined && !opts.urn) {
throw new Error("Missing required property 'resource'");
}
resourceInputs["deletionPolicy"] = args?.deletionPolicy;
resourceInputs["perimeterName"] = args?.perimeterName;
resourceInputs["resource"] = args?.resource;
resourceInputs["accessPolicyId"] = undefined /*out*/;
resourceInputs["etag"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(ServicePerimeterResource.__pulumiType, name, resourceInputs, opts);
}
}
exports.ServicePerimeterResource = ServicePerimeterResource;
//# sourceMappingURL=servicePerimeterResource.js.map