-
Notifications
You must be signed in to change notification settings - Fork 52
/
bucketIAMBinding.ts
457 lines (449 loc) · 19.9 KB
/
bucketIAMBinding.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
// *** 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! ***
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as utilities from "../utilities";
/**
* Three different resources help you manage your IAM policy for Cloud Storage Bucket. Each of these resources serves a different use case:
*
* * `gcp.storage.BucketIAMPolicy`: Authoritative. Sets the IAM policy for the bucket and replaces any existing policy already attached.
* * `gcp.storage.BucketIAMBinding`: 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 bucket are preserved.
* * `gcp.storage.BucketIAMMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the bucket are preserved.
*
* A data source can be used to retrieve policy data in advent you do not need creation
*
* * `gcp.storage.BucketIAMPolicy`: Retrieves the IAM policy for the bucket
*
* > **Note:** `gcp.storage.BucketIAMPolicy` **cannot** be used in conjunction with `gcp.storage.BucketIAMBinding` and `gcp.storage.BucketIAMMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.storage.BucketIAMBinding` resources **can be** used in conjunction with `gcp.storage.BucketIAMMember` 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.storage.BucketIAMPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/storage.admin",
* members: ["user:jane@example.com"],
* }],
* });
* const policy = new gcp.storage.BucketIAMPolicy("policy", {
* bucket: _default.name,
* 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/storage.admin",
* 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.storage.BucketIAMPolicy("policy", {
* bucket: _default.name,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
* ## gcp.storage.BucketIAMBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.storage.BucketIAMBinding("binding", {
* bucket: _default.name,
* role: "roles/storage.admin",
* 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.storage.BucketIAMBinding("binding", {
* bucket: _default.name,
* role: "roles/storage.admin",
* 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.storage.BucketIAMMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.storage.BucketIAMMember("member", {
* bucket: _default.name,
* role: "roles/storage.admin",
* 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.storage.BucketIAMMember("member", {
* bucket: _default.name,
* role: "roles/storage.admin",
* 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 Cloud Storage Bucket
* Three different resources help you manage your IAM policy for Cloud Storage Bucket. Each of these resources serves a different use case:
*
* * `gcp.storage.BucketIAMPolicy`: Authoritative. Sets the IAM policy for the bucket and replaces any existing policy already attached.
* * `gcp.storage.BucketIAMBinding`: 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 bucket are preserved.
* * `gcp.storage.BucketIAMMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the bucket are preserved.
*
* A data source can be used to retrieve policy data in advent you do not need creation
*
* * `gcp.storage.BucketIAMPolicy`: Retrieves the IAM policy for the bucket
*
* > **Note:** `gcp.storage.BucketIAMPolicy` **cannot** be used in conjunction with `gcp.storage.BucketIAMBinding` and `gcp.storage.BucketIAMMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.storage.BucketIAMBinding` resources **can be** used in conjunction with `gcp.storage.BucketIAMMember` 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.storage.BucketIAMPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/storage.admin",
* members: ["user:jane@example.com"],
* }],
* });
* const policy = new gcp.storage.BucketIAMPolicy("policy", {
* bucket: _default.name,
* 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/storage.admin",
* 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.storage.BucketIAMPolicy("policy", {
* bucket: _default.name,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
* ## gcp.storage.BucketIAMBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.storage.BucketIAMBinding("binding", {
* bucket: _default.name,
* role: "roles/storage.admin",
* 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.storage.BucketIAMBinding("binding", {
* bucket: _default.name,
* role: "roles/storage.admin",
* 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.storage.BucketIAMMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.storage.BucketIAMMember("member", {
* bucket: _default.name,
* role: "roles/storage.admin",
* 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.storage.BucketIAMMember("member", {
* bucket: _default.name,
* role: "roles/storage.admin",
* 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:
*
* * b/{{name}}
*
* * {{name}}
*
* Any variables not passed in the import command will be taken from the provider configuration.
*
* Cloud Storage bucket 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:storage/bucketIAMBinding:BucketIAMBinding editor "b/{{bucket}} roles/storage.objectViewer user:jane@example.com"
* ```
*
* IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.
*
* ```sh
* $ pulumi import gcp:storage/bucketIAMBinding:BucketIAMBinding editor "b/{{bucket}} roles/storage.objectViewer"
* ```
*
* IAM policy imports use the identifier of the resource in question, e.g.
*
* ```sh
* $ pulumi import gcp:storage/bucketIAMBinding:BucketIAMBinding editor b/{{bucket}}
* ```
*
* -> **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`.
*/
export class BucketIAMBinding extends pulumi.CustomResource {
/**
* Get an existing BucketIAMBinding 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.
*/
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BucketIAMBindingState, opts?: pulumi.CustomResourceOptions): BucketIAMBinding {
return new BucketIAMBinding(name, <any>state, { ...opts, id: id });
}
/** @internal */
public static readonly __pulumiType = 'gcp:storage/bucketIAMBinding:BucketIAMBinding';
/**
* Returns true if the given object is an instance of BucketIAMBinding. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
public static isInstance(obj: any): obj is BucketIAMBinding {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === BucketIAMBinding.__pulumiType;
}
/**
* Used to find the parent resource to bind the IAM policy to
*/
public readonly bucket!: pulumi.Output<string>;
/**
* An [IAM Condition](https://cloud.google.com/iam/docs/conditions-overview) for a given binding.
* Structure is documented below.
*/
public readonly condition!: pulumi.Output<outputs.storage.BucketIAMBindingCondition | undefined>;
/**
* (Computed) The etag of the IAM policy.
*/
public /*out*/ readonly etag!: pulumi.Output<string>;
/**
* Identities that will be granted the privilege in `role`.
* Each entry can have one of the following values:
* * **allUsers**: A special identifier that represents anyone who is on the internet; with or without a Google account.
* * **allAuthenticatedUsers**: A special identifier that represents anyone who is authenticated with a Google account or a service account.
* * **user:{emailid}**: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
* * **serviceAccount:{emailid}**: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
* * **group:{emailid}**: An email address that represents a Google group. For example, admins@example.com.
* * **domain:{domain}**: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
* * **projectOwner:projectid**: Owners of the given project. For example, "projectOwner:my-example-project"
* * **projectEditor:projectid**: Editors of the given project. For example, "projectEditor:my-example-project"
* * **projectViewer:projectid**: Viewers of the given project. For example, "projectViewer:my-example-project"
*/
public readonly members!: pulumi.Output<string[]>;
/**
* The role that should be applied. Only one
* `gcp.storage.BucketIAMBinding` can be used per role. Note that custom roles must be of the format
* `[projects|organizations]/{parent-name}/roles/{role-name}`.
*/
public readonly role!: pulumi.Output<string>;
/**
* Create a BucketIAMBinding resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: BucketIAMBindingArgs, opts?: pulumi.CustomResourceOptions)
constructor(name: string, argsOrState?: BucketIAMBindingArgs | BucketIAMBindingState, opts?: pulumi.CustomResourceOptions) {
let resourceInputs: pulumi.Inputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState as BucketIAMBindingState | undefined;
resourceInputs["bucket"] = state ? state.bucket : undefined;
resourceInputs["condition"] = state ? state.condition : undefined;
resourceInputs["etag"] = state ? state.etag : undefined;
resourceInputs["members"] = state ? state.members : undefined;
resourceInputs["role"] = state ? state.role : undefined;
} else {
const args = argsOrState as BucketIAMBindingArgs | undefined;
if ((!args || args.bucket === undefined) && !opts.urn) {
throw new Error("Missing required property 'bucket'");
}
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'");
}
resourceInputs["bucket"] = args ? args.bucket : undefined;
resourceInputs["condition"] = args ? args.condition : undefined;
resourceInputs["members"] = args ? args.members : undefined;
resourceInputs["role"] = args ? args.role : undefined;
resourceInputs["etag"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(BucketIAMBinding.__pulumiType, name, resourceInputs, opts);
}
}
/**
* Input properties used for looking up and filtering BucketIAMBinding resources.
*/
export interface BucketIAMBindingState {
/**
* Used to find the parent resource to bind the IAM policy to
*/
bucket?: pulumi.Input<string>;
/**
* An [IAM Condition](https://cloud.google.com/iam/docs/conditions-overview) for a given binding.
* Structure is documented below.
*/
condition?: pulumi.Input<inputs.storage.BucketIAMBindingCondition>;
/**
* (Computed) The etag of the IAM policy.
*/
etag?: pulumi.Input<string>;
/**
* Identities that will be granted the privilege in `role`.
* Each entry can have one of the following values:
* * **allUsers**: A special identifier that represents anyone who is on the internet; with or without a Google account.
* * **allAuthenticatedUsers**: A special identifier that represents anyone who is authenticated with a Google account or a service account.
* * **user:{emailid}**: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
* * **serviceAccount:{emailid}**: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
* * **group:{emailid}**: An email address that represents a Google group. For example, admins@example.com.
* * **domain:{domain}**: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
* * **projectOwner:projectid**: Owners of the given project. For example, "projectOwner:my-example-project"
* * **projectEditor:projectid**: Editors of the given project. For example, "projectEditor:my-example-project"
* * **projectViewer:projectid**: Viewers of the given project. For example, "projectViewer:my-example-project"
*/
members?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The role that should be applied. Only one
* `gcp.storage.BucketIAMBinding` can be used per role. Note that custom roles must be of the format
* `[projects|organizations]/{parent-name}/roles/{role-name}`.
*/
role?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a BucketIAMBinding resource.
*/
export interface BucketIAMBindingArgs {
/**
* Used to find the parent resource to bind the IAM policy to
*/
bucket: pulumi.Input<string>;
/**
* An [IAM Condition](https://cloud.google.com/iam/docs/conditions-overview) for a given binding.
* Structure is documented below.
*/
condition?: pulumi.Input<inputs.storage.BucketIAMBindingCondition>;
/**
* Identities that will be granted the privilege in `role`.
* Each entry can have one of the following values:
* * **allUsers**: A special identifier that represents anyone who is on the internet; with or without a Google account.
* * **allAuthenticatedUsers**: A special identifier that represents anyone who is authenticated with a Google account or a service account.
* * **user:{emailid}**: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
* * **serviceAccount:{emailid}**: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
* * **group:{emailid}**: An email address that represents a Google group. For example, admins@example.com.
* * **domain:{domain}**: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
* * **projectOwner:projectid**: Owners of the given project. For example, "projectOwner:my-example-project"
* * **projectEditor:projectid**: Editors of the given project. For example, "projectEditor:my-example-project"
* * **projectViewer:projectid**: Viewers of the given project. For example, "projectViewer:my-example-project"
*/
members: pulumi.Input<pulumi.Input<string>[]>;
/**
* The role that should be applied. Only one
* `gcp.storage.BucketIAMBinding` can be used per role. Note that custom roles must be of the format
* `[projects|organizations]/{parent-name}/roles/{role-name}`.
*/
role: pulumi.Input<string>;
}