@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
372 lines • 16.3 kB
JavaScript
;
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.RegionalSecretIamBinding = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Three different resources help you manage your IAM policy for Secret Manager RegionalSecret. Each of these resources serves a different use case:
*
* * `gcp.secretmanager.RegionalSecretIamPolicy`: Authoritative. Sets the IAM policy for the regionalsecret and replaces any existing policy already attached.
* * `gcp.secretmanager.RegionalSecretIamBinding`: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the regionalsecret are preserved.
* * `gcp.secretmanager.RegionalSecretIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the regionalsecret are preserved.
*
* A data source can be used to retrieve policy data in advent you do not need creation
*
* * `gcp.secretmanager.RegionalSecretIamPolicy`: Retrieves the IAM policy for the regionalsecret
*
* > **Note:** `gcp.secretmanager.RegionalSecretIamPolicy` **cannot** be used in conjunction with `gcp.secretmanager.RegionalSecretIamBinding` and `gcp.secretmanager.RegionalSecretIamMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.secretmanager.RegionalSecretIamBinding` resources **can be** used in conjunction with `gcp.secretmanager.RegionalSecretIamMember` resources **only if** they do not grant privilege to the same role.
*
* > **Note:** This resource supports IAM Conditions but they have some known limitations which can be found [here](https://cloud.google.com/iam/docs/conditions-overview#limitations). Please review this article if you are having issues with IAM Conditions.
*
* ## gcp.secretmanager.RegionalSecretIamPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/secretmanager.secretAccessor",
* members: ["user:jane@example.com"],
* }],
* });
* const policy = new gcp.secretmanager.RegionalSecretIamPolicy("policy", {
* project: regional_secret_basic.project,
* location: regional_secret_basic.location,
* secretId: regional_secret_basic.secretId,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/secretmanager.secretAccessor",
* members: ["user:jane@example.com"],
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* }],
* });
* const policy = new gcp.secretmanager.RegionalSecretIamPolicy("policy", {
* project: regional_secret_basic.project,
* location: regional_secret_basic.location,
* secretId: regional_secret_basic.secretId,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
* ## gcp.secretmanager.RegionalSecretIamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.secretmanager.RegionalSecretIamBinding("binding", {
* project: regional_secret_basic.project,
* location: regional_secret_basic.location,
* secretId: regional_secret_basic.secretId,
* role: "roles/secretmanager.secretAccessor",
* members: ["user:jane@example.com"],
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.secretmanager.RegionalSecretIamBinding("binding", {
* project: regional_secret_basic.project,
* location: regional_secret_basic.location,
* secretId: regional_secret_basic.secretId,
* role: "roles/secretmanager.secretAccessor",
* members: ["user:jane@example.com"],
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* });
* ```
* ## gcp.secretmanager.RegionalSecretIamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.secretmanager.RegionalSecretIamMember("member", {
* project: regional_secret_basic.project,
* location: regional_secret_basic.location,
* secretId: regional_secret_basic.secretId,
* role: "roles/secretmanager.secretAccessor",
* member: "user:jane@example.com",
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.secretmanager.RegionalSecretIamMember("member", {
* project: regional_secret_basic.project,
* location: regional_secret_basic.location,
* secretId: regional_secret_basic.secretId,
* role: "roles/secretmanager.secretAccessor",
* member: "user:jane@example.com",
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* });
* ```
*
* ## This resource supports User Project Overrides.
*
* -
*
* # IAM policy for Secret Manager RegionalSecret
* Three different resources help you manage your IAM policy for Secret Manager RegionalSecret. Each of these resources serves a different use case:
*
* * `gcp.secretmanager.RegionalSecretIamPolicy`: Authoritative. Sets the IAM policy for the regionalsecret and replaces any existing policy already attached.
* * `gcp.secretmanager.RegionalSecretIamBinding`: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the regionalsecret are preserved.
* * `gcp.secretmanager.RegionalSecretIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the regionalsecret are preserved.
*
* A data source can be used to retrieve policy data in advent you do not need creation
*
* * `gcp.secretmanager.RegionalSecretIamPolicy`: Retrieves the IAM policy for the regionalsecret
*
* > **Note:** `gcp.secretmanager.RegionalSecretIamPolicy` **cannot** be used in conjunction with `gcp.secretmanager.RegionalSecretIamBinding` and `gcp.secretmanager.RegionalSecretIamMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.secretmanager.RegionalSecretIamBinding` resources **can be** used in conjunction with `gcp.secretmanager.RegionalSecretIamMember` resources **only if** they do not grant privilege to the same role.
*
* > **Note:** This resource supports IAM Conditions but they have some known limitations which can be found [here](https://cloud.google.com/iam/docs/conditions-overview#limitations). Please review this article if you are having issues with IAM Conditions.
*
* ## gcp.secretmanager.RegionalSecretIamPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/secretmanager.secretAccessor",
* members: ["user:jane@example.com"],
* }],
* });
* const policy = new gcp.secretmanager.RegionalSecretIamPolicy("policy", {
* project: regional_secret_basic.project,
* location: regional_secret_basic.location,
* secretId: regional_secret_basic.secretId,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/secretmanager.secretAccessor",
* members: ["user:jane@example.com"],
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* }],
* });
* const policy = new gcp.secretmanager.RegionalSecretIamPolicy("policy", {
* project: regional_secret_basic.project,
* location: regional_secret_basic.location,
* secretId: regional_secret_basic.secretId,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
* ## gcp.secretmanager.RegionalSecretIamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.secretmanager.RegionalSecretIamBinding("binding", {
* project: regional_secret_basic.project,
* location: regional_secret_basic.location,
* secretId: regional_secret_basic.secretId,
* role: "roles/secretmanager.secretAccessor",
* members: ["user:jane@example.com"],
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.secretmanager.RegionalSecretIamBinding("binding", {
* project: regional_secret_basic.project,
* location: regional_secret_basic.location,
* secretId: regional_secret_basic.secretId,
* role: "roles/secretmanager.secretAccessor",
* members: ["user:jane@example.com"],
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* });
* ```
* ## gcp.secretmanager.RegionalSecretIamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.secretmanager.RegionalSecretIamMember("member", {
* project: regional_secret_basic.project,
* location: regional_secret_basic.location,
* secretId: regional_secret_basic.secretId,
* role: "roles/secretmanager.secretAccessor",
* member: "user:jane@example.com",
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.secretmanager.RegionalSecretIamMember("member", {
* project: regional_secret_basic.project,
* location: regional_secret_basic.location,
* secretId: regional_secret_basic.secretId,
* role: "roles/secretmanager.secretAccessor",
* member: "user:jane@example.com",
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* });
* ```
*
* ## Import
*
* For all import syntaxes, the "resource in question" can take any of the following forms:
*
* * projects/{{project}}/locations/{{location}}/secrets/{{secret_id}}
*
* * {{project}}/{{location}}/{{secret_id}}
*
* * {{location}}/{{secret_id}}
*
* * {{secret_id}}
*
* Any variables not passed in the import command will be taken from the provider configuration.
*
* Secret Manager regionalsecret IAM resources can be imported using the resource identifiers, role, and member.
*
* IAM member imports use space-delimited identifiers: the resource in question, the role, and the member identity, e.g.
*
* ```sh
* $ pulumi import gcp:secretmanager/regionalSecretIamBinding:RegionalSecretIamBinding editor "projects/{{project}}/locations/{{location}}/secrets/{{secret_id}} roles/secretmanager.secretAccessor user:jane@example.com"
* ```
*
* IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.
*
* ```sh
* $ pulumi import gcp:secretmanager/regionalSecretIamBinding:RegionalSecretIamBinding editor "projects/{{project}}/locations/{{location}}/secrets/{{secret_id}} roles/secretmanager.secretAccessor"
* ```
*
* IAM policy imports use the identifier of the resource in question, e.g.
*
* ```sh
* $ pulumi import gcp:secretmanager/regionalSecretIamBinding:RegionalSecretIamBinding editor projects/{{project}}/locations/{{location}}/secrets/{{secret_id}}
* ```
*
* -> **Custom Roles** If you're importing a IAM resource with a custom role, make sure to use the
*
* full name of the custom role, e.g. `[projects/my-project|organizations/my-org]/roles/my-custom-role`.
*/
class RegionalSecretIamBinding extends pulumi.CustomResource {
/**
* Get an existing RegionalSecretIamBinding 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 RegionalSecretIamBinding(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of RegionalSecretIamBinding. 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'] === RegionalSecretIamBinding.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["condition"] = state ? state.condition : undefined;
resourceInputs["etag"] = state ? state.etag : undefined;
resourceInputs["location"] = state ? state.location : undefined;
resourceInputs["members"] = state ? state.members : undefined;
resourceInputs["project"] = state ? state.project : undefined;
resourceInputs["role"] = state ? state.role : undefined;
resourceInputs["secretId"] = state ? state.secretId : undefined;
}
else {
const args = argsOrState;
if ((!args || args.members === undefined) && !opts.urn) {
throw new Error("Missing required property 'members'");
}
if ((!args || args.role === undefined) && !opts.urn) {
throw new Error("Missing required property 'role'");
}
if ((!args || args.secretId === undefined) && !opts.urn) {
throw new Error("Missing required property 'secretId'");
}
resourceInputs["condition"] = args ? args.condition : undefined;
resourceInputs["location"] = args ? args.location : undefined;
resourceInputs["members"] = args ? args.members : undefined;
resourceInputs["project"] = args ? args.project : undefined;
resourceInputs["role"] = args ? args.role : undefined;
resourceInputs["secretId"] = args ? args.secretId : undefined;
resourceInputs["etag"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(RegionalSecretIamBinding.__pulumiType, name, resourceInputs, opts);
}
}
exports.RegionalSecretIamBinding = RegionalSecretIamBinding;
/** @internal */
RegionalSecretIamBinding.__pulumiType = 'gcp:secretmanager/regionalSecretIamBinding:RegionalSecretIamBinding';
//# sourceMappingURL=regionalSecretIamBinding.js.map