-
Notifications
You must be signed in to change notification settings - Fork 17
/
awss3_IBucket.go
649 lines (578 loc) · 18.7 KB
/
awss3_IBucket.go
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
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
package awss3
import (
_jsii_ "github.com/aws/jsii-runtime-go/runtime"
"github.com/aws/aws-cdk-go/awscdk"
"github.com/aws/aws-cdk-go/awscdk/awsevents"
"github.com/aws/aws-cdk-go/awscdk/awsiam"
"github.com/aws/aws-cdk-go/awscdk/awskms"
"github.com/aws/aws-cdk-go/awscdk/awss3/internal"
)
// Experimental.
type IBucket interface {
awscdk.IResource
// Adds a bucket notification event destination.
//
// Example:
// var myLambda function
//
// bucket := s3.NewBucket(this, jsii.String("MyBucket"))
// bucket.addEventNotification(s3.eventType_OBJECT_CREATED, s3n.NewLambdaDestination(myLambda), ¬ificationKeyFilter{
// prefix: jsii.String("home/myusername/*"),
// })
//
// See: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html
//
// Experimental.
AddEventNotification(event EventType, dest IBucketNotificationDestination, filters ...*NotificationKeyFilter)
// Subscribes a destination to receive notifications when an object is created in the bucket.
//
// This is identical to calling
// `onEvent(s3.EventType.OBJECT_CREATED)`.
// Experimental.
AddObjectCreatedNotification(dest IBucketNotificationDestination, filters ...*NotificationKeyFilter)
// Subscribes a destination to receive notifications when an object is removed from the bucket.
//
// This is identical to calling
// `onEvent(EventType.OBJECT_REMOVED)`.
// Experimental.
AddObjectRemovedNotification(dest IBucketNotificationDestination, filters ...*NotificationKeyFilter)
// Adds a statement to the resource policy for a principal (i.e. account/role/service) to perform actions on this bucket and/or its contents. Use `bucketArn` and `arnForObjects(keys)` to obtain ARNs for this bucket or objects.
//
// Note that the policy statement may or may not be added to the policy.
// For example, when an `IBucket` is created from an existing bucket,
// it's not possible to tell whether the bucket already has a policy
// attached, let alone to re-use that policy to add more statements to it.
// So it's safest to do nothing in these cases.
//
// Returns: metadata about the execution of this method. If the policy
// was not added, the value of `statementAdded` will be `false`. You
// should always check this value to make sure that the operation was
// actually carried out. Otherwise, synthesis and deploy will terminate
// silently, which may be confusing.
// Experimental.
AddToResourcePolicy(permission awsiam.PolicyStatement) *awsiam.AddToResourcePolicyResult
// Returns an ARN that represents all objects within the bucket that match the key pattern specified.
//
// To represent all keys, specify ``"*"``.
// Experimental.
ArnForObjects(keyPattern *string) *string
// Grants s3:DeleteObject* permission to an IAM principal for objects in this bucket.
// Experimental.
GrantDelete(identity awsiam.IGrantable, objectsKeyPattern interface{}) awsiam.Grant
// Allows unrestricted access to objects from this bucket.
//
// IMPORTANT: This permission allows anyone to perform actions on S3 objects
// in this bucket, which is useful for when you configure your bucket as a
// website and want everyone to be able to read objects in the bucket without
// needing to authenticate.
//
// Without arguments, this method will grant read ("s3:GetObject") access to
// all objects ("*") in the bucket.
//
// The method returns the `iam.Grant` object, which can then be modified
// as needed. For example, you can add a condition that will restrict access only
// to an IPv4 range like this:
//
// const grant = bucket.grantPublicAccess();
// grant.resourceStatement!.addCondition(‘IpAddress’, { “aws:SourceIp”: “54.240.143.0/24” });
//
// Returns: The `iam.PolicyStatement` object, which can be used to apply e.g. conditions.
// Experimental.
GrantPublicAccess(keyPrefix *string, allowedActions ...*string) awsiam.Grant
// Grants s3:PutObject* and s3:Abort* permissions for this bucket to an IAM principal.
//
// If encryption is used, permission to use the key to encrypt the contents
// of written files will also be granted to the same principal.
// Experimental.
GrantPut(identity awsiam.IGrantable, objectsKeyPattern interface{}) awsiam.Grant
// Grant the given IAM identity permissions to modify the ACLs of objects in the given Bucket.
//
// If your application has the '@aws-cdk/aws-s3:grantWriteWithoutAcl' feature flag set,
// calling {@link grantWrite} or {@link grantReadWrite} no longer grants permissions to modify the ACLs of the objects;
// in this case, if you need to modify object ACLs, call this method explicitly.
// Experimental.
GrantPutAcl(identity awsiam.IGrantable, objectsKeyPattern *string) awsiam.Grant
// Grant read permissions for this bucket and it's contents to an IAM principal (Role/Group/User).
//
// If encryption is used, permission to use the key to decrypt the contents
// of the bucket will also be granted to the same principal.
// Experimental.
GrantRead(identity awsiam.IGrantable, objectsKeyPattern interface{}) awsiam.Grant
// Grants read/write permissions for this bucket and it's contents to an IAM principal (Role/Group/User).
//
// If an encryption key is used, permission to use the key for
// encrypt/decrypt will also be granted.
//
// Before CDK version 1.85.0, this method granted the `s3:PutObject*` permission that included `s3:PutObjectAcl`,
// which could be used to grant read/write object access to IAM principals in other accounts.
// If you want to get rid of that behavior, update your CDK version to 1.85.0 or later,
// and make sure the `@aws-cdk/aws-s3:grantWriteWithoutAcl` feature flag is set to `true`
// in the `context` key of your cdk.json file.
// If you've already updated, but still need the principal to have permissions to modify the ACLs,
// use the {@link grantPutAcl} method.
// Experimental.
GrantReadWrite(identity awsiam.IGrantable, objectsKeyPattern interface{}) awsiam.Grant
// Grant write permissions to this bucket to an IAM principal.
//
// If encryption is used, permission to use the key to encrypt the contents
// of written files will also be granted to the same principal.
//
// Before CDK version 1.85.0, this method granted the `s3:PutObject*` permission that included `s3:PutObjectAcl`,
// which could be used to grant read/write object access to IAM principals in other accounts.
// If you want to get rid of that behavior, update your CDK version to 1.85.0 or later,
// and make sure the `@aws-cdk/aws-s3:grantWriteWithoutAcl` feature flag is set to `true`
// in the `context` key of your cdk.json file.
// If you've already updated, but still need the principal to have permissions to modify the ACLs,
// use the {@link grantPutAcl} method.
// Experimental.
GrantWrite(identity awsiam.IGrantable, objectsKeyPattern interface{}) awsiam.Grant
// Defines a CloudWatch event that triggers when something happens to this bucket.
//
// Requires that there exists at least one CloudTrail Trail in your account
// that captures the event. This method will not create the Trail.
// Experimental.
OnCloudTrailEvent(id *string, options *OnCloudTrailBucketEventOptions) awsevents.Rule
// Defines an AWS CloudWatch event that triggers when an object is uploaded to the specified paths (keys) in this bucket using the PutObject API call.
//
// Note that some tools like `aws s3 cp` will automatically use either
// PutObject or the multipart upload API depending on the file size,
// so using `onCloudTrailWriteObject` may be preferable.
//
// Requires that there exists at least one CloudTrail Trail in your account
// that captures the event. This method will not create the Trail.
// Experimental.
OnCloudTrailPutObject(id *string, options *OnCloudTrailBucketEventOptions) awsevents.Rule
// Defines an AWS CloudWatch event that triggers when an object at the specified paths (keys) in this bucket are written to.
//
// This includes
// the events PutObject, CopyObject, and CompleteMultipartUpload.
//
// Note that some tools like `aws s3 cp` will automatically use either
// PutObject or the multipart upload API depending on the file size,
// so using this method may be preferable to `onCloudTrailPutObject`.
//
// Requires that there exists at least one CloudTrail Trail in your account
// that captures the event. This method will not create the Trail.
// Experimental.
OnCloudTrailWriteObject(id *string, options *OnCloudTrailBucketEventOptions) awsevents.Rule
// The S3 URL of an S3 object.
//
// For example:
// - `s3://onlybucket`
// - `s3://bucket/key`.
//
// Returns: an ObjectS3Url token.
// Experimental.
S3UrlForObject(key *string) *string
// The https Transfer Acceleration URL of an S3 object.
//
// Specify `dualStack: true` at the options
// for dual-stack endpoint (connect to the bucket over IPv6). For example:
//
// - `https://bucket.s3-accelerate.amazonaws.com`
// - `https://bucket.s3-accelerate.amazonaws.com/key`
//
// Returns: an TransferAccelerationUrl token.
// Experimental.
TransferAccelerationUrlForObject(key *string, options *TransferAccelerationUrlOptions) *string
// The https URL of an S3 object. For example:.
//
// - `https://s3.us-west-1.amazonaws.com/onlybucket`
// - `https://s3.us-west-1.amazonaws.com/bucket/key`
// - `https://s3.cn-north-1.amazonaws.com.cn/china-bucket/mykey`
//
// Returns: an ObjectS3Url token.
// Experimental.
UrlForObject(key *string) *string
// The virtual hosted-style URL of an S3 object. Specify `regional: false` at the options for non-regional URL. For example:.
//
// - `https://only-bucket.s3.us-west-1.amazonaws.com`
// - `https://bucket.s3.us-west-1.amazonaws.com/key`
// - `https://bucket.s3.amazonaws.com/key`
// - `https://china-bucket.s3.cn-north-1.amazonaws.com.cn/mykey`
//
// Returns: an ObjectS3Url token.
// Experimental.
VirtualHostedUrlForObject(key *string, options *VirtualHostedStyleUrlOptions) *string
// The ARN of the bucket.
// Experimental.
BucketArn() *string
// The IPv4 DNS name of the specified bucket.
// Experimental.
BucketDomainName() *string
// The IPv6 DNS name of the specified bucket.
// Experimental.
BucketDualStackDomainName() *string
// The name of the bucket.
// Experimental.
BucketName() *string
// The regional domain name of the specified bucket.
// Experimental.
BucketRegionalDomainName() *string
// The Domain name of the static website.
// Experimental.
BucketWebsiteDomainName() *string
// The URL of the static website.
// Experimental.
BucketWebsiteUrl() *string
// Optional KMS encryption key associated with this bucket.
// Experimental.
EncryptionKey() awskms.IKey
// If this bucket has been configured for static website hosting.
// Experimental.
IsWebsite() *bool
// The resource policy associated with this bucket.
//
// If `autoCreatePolicy` is true, a `BucketPolicy` will be created upon the
// first call to addToResourcePolicy(s).
// Experimental.
Policy() BucketPolicy
// Experimental.
SetPolicy(p BucketPolicy)
}
// The jsii proxy for IBucket
type jsiiProxy_IBucket struct {
internal.Type__awscdkIResource
}
func (i *jsiiProxy_IBucket) AddEventNotification(event EventType, dest IBucketNotificationDestination, filters ...*NotificationKeyFilter) {
if err := i.validateAddEventNotificationParameters(event, dest, &filters); err != nil {
panic(err)
}
args := []interface{}{event, dest}
for _, a := range filters {
args = append(args, a)
}
_jsii_.InvokeVoid(
i,
"addEventNotification",
args,
)
}
func (i *jsiiProxy_IBucket) AddObjectCreatedNotification(dest IBucketNotificationDestination, filters ...*NotificationKeyFilter) {
if err := i.validateAddObjectCreatedNotificationParameters(dest, &filters); err != nil {
panic(err)
}
args := []interface{}{dest}
for _, a := range filters {
args = append(args, a)
}
_jsii_.InvokeVoid(
i,
"addObjectCreatedNotification",
args,
)
}
func (i *jsiiProxy_IBucket) AddObjectRemovedNotification(dest IBucketNotificationDestination, filters ...*NotificationKeyFilter) {
if err := i.validateAddObjectRemovedNotificationParameters(dest, &filters); err != nil {
panic(err)
}
args := []interface{}{dest}
for _, a := range filters {
args = append(args, a)
}
_jsii_.InvokeVoid(
i,
"addObjectRemovedNotification",
args,
)
}
func (i *jsiiProxy_IBucket) AddToResourcePolicy(permission awsiam.PolicyStatement) *awsiam.AddToResourcePolicyResult {
if err := i.validateAddToResourcePolicyParameters(permission); err != nil {
panic(err)
}
var returns *awsiam.AddToResourcePolicyResult
_jsii_.Invoke(
i,
"addToResourcePolicy",
[]interface{}{permission},
&returns,
)
return returns
}
func (i *jsiiProxy_IBucket) ArnForObjects(keyPattern *string) *string {
if err := i.validateArnForObjectsParameters(keyPattern); err != nil {
panic(err)
}
var returns *string
_jsii_.Invoke(
i,
"arnForObjects",
[]interface{}{keyPattern},
&returns,
)
return returns
}
func (i *jsiiProxy_IBucket) GrantDelete(identity awsiam.IGrantable, objectsKeyPattern interface{}) awsiam.Grant {
if err := i.validateGrantDeleteParameters(identity); err != nil {
panic(err)
}
var returns awsiam.Grant
_jsii_.Invoke(
i,
"grantDelete",
[]interface{}{identity, objectsKeyPattern},
&returns,
)
return returns
}
func (i *jsiiProxy_IBucket) GrantPublicAccess(keyPrefix *string, allowedActions ...*string) awsiam.Grant {
args := []interface{}{keyPrefix}
for _, a := range allowedActions {
args = append(args, a)
}
var returns awsiam.Grant
_jsii_.Invoke(
i,
"grantPublicAccess",
args,
&returns,
)
return returns
}
func (i *jsiiProxy_IBucket) GrantPut(identity awsiam.IGrantable, objectsKeyPattern interface{}) awsiam.Grant {
if err := i.validateGrantPutParameters(identity); err != nil {
panic(err)
}
var returns awsiam.Grant
_jsii_.Invoke(
i,
"grantPut",
[]interface{}{identity, objectsKeyPattern},
&returns,
)
return returns
}
func (i *jsiiProxy_IBucket) GrantPutAcl(identity awsiam.IGrantable, objectsKeyPattern *string) awsiam.Grant {
if err := i.validateGrantPutAclParameters(identity); err != nil {
panic(err)
}
var returns awsiam.Grant
_jsii_.Invoke(
i,
"grantPutAcl",
[]interface{}{identity, objectsKeyPattern},
&returns,
)
return returns
}
func (i *jsiiProxy_IBucket) GrantRead(identity awsiam.IGrantable, objectsKeyPattern interface{}) awsiam.Grant {
if err := i.validateGrantReadParameters(identity); err != nil {
panic(err)
}
var returns awsiam.Grant
_jsii_.Invoke(
i,
"grantRead",
[]interface{}{identity, objectsKeyPattern},
&returns,
)
return returns
}
func (i *jsiiProxy_IBucket) GrantReadWrite(identity awsiam.IGrantable, objectsKeyPattern interface{}) awsiam.Grant {
if err := i.validateGrantReadWriteParameters(identity); err != nil {
panic(err)
}
var returns awsiam.Grant
_jsii_.Invoke(
i,
"grantReadWrite",
[]interface{}{identity, objectsKeyPattern},
&returns,
)
return returns
}
func (i *jsiiProxy_IBucket) GrantWrite(identity awsiam.IGrantable, objectsKeyPattern interface{}) awsiam.Grant {
if err := i.validateGrantWriteParameters(identity); err != nil {
panic(err)
}
var returns awsiam.Grant
_jsii_.Invoke(
i,
"grantWrite",
[]interface{}{identity, objectsKeyPattern},
&returns,
)
return returns
}
func (i *jsiiProxy_IBucket) OnCloudTrailEvent(id *string, options *OnCloudTrailBucketEventOptions) awsevents.Rule {
if err := i.validateOnCloudTrailEventParameters(id, options); err != nil {
panic(err)
}
var returns awsevents.Rule
_jsii_.Invoke(
i,
"onCloudTrailEvent",
[]interface{}{id, options},
&returns,
)
return returns
}
func (i *jsiiProxy_IBucket) OnCloudTrailPutObject(id *string, options *OnCloudTrailBucketEventOptions) awsevents.Rule {
if err := i.validateOnCloudTrailPutObjectParameters(id, options); err != nil {
panic(err)
}
var returns awsevents.Rule
_jsii_.Invoke(
i,
"onCloudTrailPutObject",
[]interface{}{id, options},
&returns,
)
return returns
}
func (i *jsiiProxy_IBucket) OnCloudTrailWriteObject(id *string, options *OnCloudTrailBucketEventOptions) awsevents.Rule {
if err := i.validateOnCloudTrailWriteObjectParameters(id, options); err != nil {
panic(err)
}
var returns awsevents.Rule
_jsii_.Invoke(
i,
"onCloudTrailWriteObject",
[]interface{}{id, options},
&returns,
)
return returns
}
func (i *jsiiProxy_IBucket) S3UrlForObject(key *string) *string {
var returns *string
_jsii_.Invoke(
i,
"s3UrlForObject",
[]interface{}{key},
&returns,
)
return returns
}
func (i *jsiiProxy_IBucket) TransferAccelerationUrlForObject(key *string, options *TransferAccelerationUrlOptions) *string {
if err := i.validateTransferAccelerationUrlForObjectParameters(options); err != nil {
panic(err)
}
var returns *string
_jsii_.Invoke(
i,
"transferAccelerationUrlForObject",
[]interface{}{key, options},
&returns,
)
return returns
}
func (i *jsiiProxy_IBucket) UrlForObject(key *string) *string {
var returns *string
_jsii_.Invoke(
i,
"urlForObject",
[]interface{}{key},
&returns,
)
return returns
}
func (i *jsiiProxy_IBucket) VirtualHostedUrlForObject(key *string, options *VirtualHostedStyleUrlOptions) *string {
if err := i.validateVirtualHostedUrlForObjectParameters(options); err != nil {
panic(err)
}
var returns *string
_jsii_.Invoke(
i,
"virtualHostedUrlForObject",
[]interface{}{key, options},
&returns,
)
return returns
}
func (j *jsiiProxy_IBucket) BucketArn() *string {
var returns *string
_jsii_.Get(
j,
"bucketArn",
&returns,
)
return returns
}
func (j *jsiiProxy_IBucket) BucketDomainName() *string {
var returns *string
_jsii_.Get(
j,
"bucketDomainName",
&returns,
)
return returns
}
func (j *jsiiProxy_IBucket) BucketDualStackDomainName() *string {
var returns *string
_jsii_.Get(
j,
"bucketDualStackDomainName",
&returns,
)
return returns
}
func (j *jsiiProxy_IBucket) BucketName() *string {
var returns *string
_jsii_.Get(
j,
"bucketName",
&returns,
)
return returns
}
func (j *jsiiProxy_IBucket) BucketRegionalDomainName() *string {
var returns *string
_jsii_.Get(
j,
"bucketRegionalDomainName",
&returns,
)
return returns
}
func (j *jsiiProxy_IBucket) BucketWebsiteDomainName() *string {
var returns *string
_jsii_.Get(
j,
"bucketWebsiteDomainName",
&returns,
)
return returns
}
func (j *jsiiProxy_IBucket) BucketWebsiteUrl() *string {
var returns *string
_jsii_.Get(
j,
"bucketWebsiteUrl",
&returns,
)
return returns
}
func (j *jsiiProxy_IBucket) EncryptionKey() awskms.IKey {
var returns awskms.IKey
_jsii_.Get(
j,
"encryptionKey",
&returns,
)
return returns
}
func (j *jsiiProxy_IBucket) IsWebsite() *bool {
var returns *bool
_jsii_.Get(
j,
"isWebsite",
&returns,
)
return returns
}
func (j *jsiiProxy_IBucket) Policy() BucketPolicy {
var returns BucketPolicy
_jsii_.Get(
j,
"policy",
&returns,
)
return returns
}
func (j *jsiiProxy_IBucket)SetPolicy(val BucketPolicy) {
_jsii_.Set(
j,
"policy",
val,
)
}