-
Notifications
You must be signed in to change notification settings - Fork 155
/
role.ts
291 lines (281 loc) · 11.3 KB
/
role.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
// *** 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 utilities from "../utilities";
import {PolicyDocument} from "./index";
/**
* Provides an IAM role.
*
* > *NOTE:* If policies are attached to the role via the `aws.iam.PolicyAttachment` resource and you are modifying the role `name` or `path`, the `forceDetachPolicies` argument must be set to `true` and applied before attempting the operation otherwise you will encounter a `DeleteConflict` error. The `aws.iam.RolePolicyAttachment` resource (recommended) does not have this requirement.
*
* ## Example Usage
*
*
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const testRole = new aws.iam.Role("test_role", {
* assumeRolePolicy: `{
* "Version": "2012-10-17",
* "Statement": [
* {
* "Action": "sts:AssumeRole",
* "Principal": {
* "Service": "ec2.amazonaws.com"
* },
* "Effect": "Allow",
* "Sid": ""
* }
* ]
* }
* `,
* tags: {
* "tag-key": "tag-value",
* },
* });
* ```
*
* ## Example of Using Data Source for Assume Role Policy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const instance_assume_role_policy = pulumi.output(aws.iam.getPolicyDocument({
* statements: [{
* actions: ["sts:AssumeRole"],
* principals: [{
* identifiers: ["ec2.amazonaws.com"],
* type: "Service",
* }],
* }],
* }, { async: true }));
* const instance = new aws.iam.Role("instance", {
* assumeRolePolicy: instance_assume_role_policy.json,
* path: "/system/",
* });
* ```
*/
export class Role extends pulumi.CustomResource {
/**
* Get an existing Role 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?: RoleState, opts?: pulumi.CustomResourceOptions): Role {
return new Role(name, <any>state, { ...opts, id: id });
}
/** @internal */
public static readonly __pulumiType = 'aws:iam/role:Role';
/**
* Returns true if the given object is an instance of Role. 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 Role {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Role.__pulumiType;
}
/**
* The Amazon Resource Name (ARN) specifying the role.
*/
public /*out*/ readonly arn!: pulumi.Output<string>;
/**
* The policy that grants an entity permission to assume the role.
*/
public readonly assumeRolePolicy!: pulumi.Output<string>;
/**
* The creation date of the IAM role.
*/
public /*out*/ readonly createDate!: pulumi.Output<string>;
/**
* The description of the role.
*/
public readonly description!: pulumi.Output<string | undefined>;
/**
* Specifies to force detaching any policies the role has before destroying it. Defaults to `false`.
*/
public readonly forceDetachPolicies!: pulumi.Output<boolean | undefined>;
/**
* The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours.
*/
public readonly maxSessionDuration!: pulumi.Output<number | undefined>;
/**
* The name of the role. If omitted, this provider will assign a random, unique name.
*/
public readonly name!: pulumi.Output<string>;
/**
* Creates a unique name beginning with the specified prefix. Conflicts with `name`.
*/
public readonly namePrefix!: pulumi.Output<string | undefined>;
/**
* The path to the role.
* See [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) for more information.
*/
public readonly path!: pulumi.Output<string | undefined>;
/**
* The ARN of the policy that is used to set the permissions boundary for the role.
*/
public readonly permissionsBoundary!: pulumi.Output<string | undefined>;
/**
* Key-value map of tags for the IAM role
*/
public readonly tags!: pulumi.Output<{[key: string]: any} | undefined>;
/**
* The stable and unique string identifying the role.
*/
public /*out*/ readonly uniqueId!: pulumi.Output<string>;
/**
* Create a Role 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: RoleArgs, opts?: pulumi.CustomResourceOptions)
constructor(name: string, argsOrState?: RoleArgs | RoleState, opts?: pulumi.CustomResourceOptions) {
let inputs: pulumi.Inputs = {};
if (opts && opts.id) {
const state = argsOrState as RoleState | undefined;
inputs["arn"] = state ? state.arn : undefined;
inputs["assumeRolePolicy"] = state ? state.assumeRolePolicy : undefined;
inputs["createDate"] = state ? state.createDate : undefined;
inputs["description"] = state ? state.description : undefined;
inputs["forceDetachPolicies"] = state ? state.forceDetachPolicies : undefined;
inputs["maxSessionDuration"] = state ? state.maxSessionDuration : undefined;
inputs["name"] = state ? state.name : undefined;
inputs["namePrefix"] = state ? state.namePrefix : undefined;
inputs["path"] = state ? state.path : undefined;
inputs["permissionsBoundary"] = state ? state.permissionsBoundary : undefined;
inputs["tags"] = state ? state.tags : undefined;
inputs["uniqueId"] = state ? state.uniqueId : undefined;
} else {
const args = argsOrState as RoleArgs | undefined;
if (!args || args.assumeRolePolicy === undefined) {
throw new Error("Missing required property 'assumeRolePolicy'");
}
inputs["assumeRolePolicy"] = args ? args.assumeRolePolicy : undefined;
inputs["description"] = args ? args.description : undefined;
inputs["forceDetachPolicies"] = args ? args.forceDetachPolicies : undefined;
inputs["maxSessionDuration"] = args ? args.maxSessionDuration : undefined;
inputs["name"] = args ? args.name : undefined;
inputs["namePrefix"] = args ? args.namePrefix : undefined;
inputs["path"] = args ? args.path : undefined;
inputs["permissionsBoundary"] = args ? args.permissionsBoundary : undefined;
inputs["tags"] = args ? args.tags : undefined;
inputs["arn"] = undefined /*out*/;
inputs["createDate"] = undefined /*out*/;
inputs["uniqueId"] = undefined /*out*/;
}
if (!opts) {
opts = {}
}
if (!opts.version) {
opts.version = utilities.getVersion();
}
super(Role.__pulumiType, name, inputs, opts);
}
}
/**
* Input properties used for looking up and filtering Role resources.
*/
export interface RoleState {
/**
* The Amazon Resource Name (ARN) specifying the role.
*/
readonly arn?: pulumi.Input<string>;
/**
* The policy that grants an entity permission to assume the role.
*/
readonly assumeRolePolicy?: pulumi.Input<string | PolicyDocument>;
/**
* The creation date of the IAM role.
*/
readonly createDate?: pulumi.Input<string>;
/**
* The description of the role.
*/
readonly description?: pulumi.Input<string>;
/**
* Specifies to force detaching any policies the role has before destroying it. Defaults to `false`.
*/
readonly forceDetachPolicies?: pulumi.Input<boolean>;
/**
* The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours.
*/
readonly maxSessionDuration?: pulumi.Input<number>;
/**
* The name of the role. If omitted, this provider will assign a random, unique name.
*/
readonly name?: pulumi.Input<string>;
/**
* Creates a unique name beginning with the specified prefix. Conflicts with `name`.
*/
readonly namePrefix?: pulumi.Input<string>;
/**
* The path to the role.
* See [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) for more information.
*/
readonly path?: pulumi.Input<string>;
/**
* The ARN of the policy that is used to set the permissions boundary for the role.
*/
readonly permissionsBoundary?: pulumi.Input<string>;
/**
* Key-value map of tags for the IAM role
*/
readonly tags?: pulumi.Input<{[key: string]: any}>;
/**
* The stable and unique string identifying the role.
*/
readonly uniqueId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Role resource.
*/
export interface RoleArgs {
/**
* The policy that grants an entity permission to assume the role.
*/
readonly assumeRolePolicy: pulumi.Input<string | PolicyDocument>;
/**
* The description of the role.
*/
readonly description?: pulumi.Input<string>;
/**
* Specifies to force detaching any policies the role has before destroying it. Defaults to `false`.
*/
readonly forceDetachPolicies?: pulumi.Input<boolean>;
/**
* The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours.
*/
readonly maxSessionDuration?: pulumi.Input<number>;
/**
* The name of the role. If omitted, this provider will assign a random, unique name.
*/
readonly name?: pulumi.Input<string>;
/**
* Creates a unique name beginning with the specified prefix. Conflicts with `name`.
*/
readonly namePrefix?: pulumi.Input<string>;
/**
* The path to the role.
* See [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) for more information.
*/
readonly path?: pulumi.Input<string>;
/**
* The ARN of the policy that is used to set the permissions boundary for the role.
*/
readonly permissionsBoundary?: pulumi.Input<string>;
/**
* Key-value map of tags for the IAM role
*/
readonly tags?: pulumi.Input<{[key: string]: any}>;
}