@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-22T19:35:41.540Z")
public interface BucketProps
Bucket sourceBucket = Bucket.Builder.create(this, "MyBucket") .versioned(true) .build(); Pipeline pipeline = new Pipeline(this, "MyPipeline"); Artifact sourceOutput = new Artifact(); S3SourceAction sourceAction = S3SourceAction.Builder.create() .actionName("S3Source") .bucket(sourceBucket) .bucketKey("path/to/file.zip") .output(sourceOutput) .build(); pipeline.addStage(StageOptions.builder() .stageName("Source") .actions(List.of(sourceAction)) .build());
Modifier and Type | Interface and Description |
---|---|
static class |
BucketProps.Builder
A builder for
BucketProps |
static class |
BucketProps.Jsii$Proxy
An implementation for
BucketProps |
Modifier and Type | Method and Description |
---|---|
static BucketProps.Builder |
builder() |
default BucketAccessControl |
getAccessControl()
Specifies a canned ACL that grants predefined permissions to the bucket.
|
default java.lang.Boolean |
getAutoDeleteObjects()
Whether all objects should be automatically deleted when the bucket is removed from the stack or when the stack is deleted.
|
default BlockPublicAccess |
getBlockPublicAccess()
The block public access configuration of this bucket.
|
default java.lang.Boolean |
getBucketKeyEnabled()
Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket.
|
default java.lang.String |
getBucketName()
Physical name of this bucket.
|
default java.util.List<CorsRule> |
getCors()
The CORS configuration of this bucket.
|
default BucketEncryption |
getEncryption()
The kind of server-side encryption to apply to this bucket.
|
default IKey |
getEncryptionKey()
External KMS key to use for bucket encryption.
|
default java.lang.Boolean |
getEnforceSSL()
Enforces SSL for requests.
|
default java.lang.Boolean |
getEventBridgeEnabled()
Whether this bucket should send notifications to Amazon EventBridge or not.
|
default java.util.List<IntelligentTieringConfiguration> |
getIntelligentTieringConfigurations()
Inteligent Tiering Configurations.
|
default java.util.List<Inventory> |
getInventories()
The inventory configuration of the bucket.
|
default java.util.List<LifecycleRule> |
getLifecycleRules()
Rules that define how Amazon S3 manages objects during their lifetime.
|
default java.util.List<BucketMetrics> |
getMetrics()
The metrics configuration of this bucket.
|
default IRole |
getNotificationsHandlerRole()
The role to be used by the notifications handler.
|
default ObjectOwnership |
getObjectOwnership()
The objectOwnership of the bucket.
|
default java.lang.Boolean |
getPublicReadAccess()
Grants public read access to all objects in the bucket.
|
default RemovalPolicy |
getRemovalPolicy()
Policy to apply when the bucket is removed from this stack.
|
default IBucket |
getServerAccessLogsBucket()
Destination bucket for the server access logs.
|
default java.lang.String |
getServerAccessLogsPrefix()
Optional log file prefix to use for the bucket's access logs.
|
default java.lang.Boolean |
getTransferAcceleration()
Whether this bucket should have transfer acceleration turned on or not.
|
default java.lang.Boolean |
getVersioned()
Whether this bucket should have versioning turned on or not.
|
default java.lang.String |
getWebsiteErrorDocument()
The name of the error document (e.g.
|
default java.lang.String |
getWebsiteIndexDocument()
The name of the index document (e.g.
|
default RedirectTarget |
getWebsiteRedirect()
Specifies the redirect behavior of all requests to a website endpoint of a bucket.
|
default java.util.List<RoutingRule> |
getWebsiteRoutingRules()
Rules that define when a redirect is applied and the redirect behavior.
|
default BucketAccessControl getAccessControl()
Default: BucketAccessControl.PRIVATE
default java.lang.Boolean getAutoDeleteObjects()
Requires the removalPolicy
to be set to RemovalPolicy.DESTROY
.
Warning if you have deployed a bucket with autoDeleteObjects: true
,
switching this to false
in a CDK version before 1.126.0
will lead to
all objects in the bucket being deleted. Be sure to update your bucket resources
by deploying with CDK version 1.126.0
or later before switching this value to false
.
Default: false
default BlockPublicAccess getBlockPublicAccess()
Default: - CloudFormation defaults will apply. New buckets and objects don't allow public access, but users can modify bucket policies or object permissions to allow public access
default java.lang.Boolean getBucketKeyEnabled()
Only relevant, when Encryption is set to {@link BucketEncryption.KMS}
Default: - false
default java.lang.String getBucketName()
Default: - Assigned by CloudFormation (recommended).
default java.util.List<CorsRule> getCors()
Default: - No CORS configuration.
default BucketEncryption getEncryption()
If you choose KMS, you can specify a KMS key via encryptionKey
. If
encryption key is not specified, a key will automatically be created.
Default: - `Kms` if `encryptionKey` is specified, or `Unencrypted` otherwise.
default IKey getEncryptionKey()
The 'encryption' property must be either not specified or set to "Kms". An error will be emitted if encryption is set to "Unencrypted" or "Managed".
Default: - If encryption is set to "Kms" and this property is undefined, a new KMS key will be created and associated with this bucket.
default java.lang.Boolean getEnforceSSL()
S3.5 of the AWS Foundational Security Best Practices Regarding S3.
Default: false
default java.lang.Boolean getEventBridgeEnabled()
Default: false
default java.util.List<IntelligentTieringConfiguration> getIntelligentTieringConfigurations()
Default: No Intelligent Tiiering Configurations.
default java.util.List<Inventory> getInventories()
Default: - No inventory configuration
default java.util.List<LifecycleRule> getLifecycleRules()
Default: - No lifecycle rules.
default java.util.List<BucketMetrics> getMetrics()
Default: - No metrics configuration.
default IRole getNotificationsHandlerRole()
Default: - a new role will be created.
default ObjectOwnership getObjectOwnership()
Default: - No ObjectOwnership configuration, uploading account will own the object.
default java.lang.Boolean getPublicReadAccess()
Similar to calling bucket.grantPublicAccess()
Default: false
default RemovalPolicy getRemovalPolicy()
Default: - The bucket will be orphaned.
default IBucket getServerAccessLogsBucket()
Default: - If "serverAccessLogsPrefix" undefined - access logs disabled, otherwise - log to current bucket.
default java.lang.String getServerAccessLogsPrefix()
If defined without "serverAccessLogsBucket", enables access logs to current bucket with this prefix.
Default: - No log file prefix
default java.lang.Boolean getTransferAcceleration()
Default: false
default java.lang.Boolean getVersioned()
Default: false
default java.lang.String getWebsiteErrorDocument()
Default: - No error document.
default java.lang.String getWebsiteIndexDocument()
Default: - No index document.
default RedirectTarget getWebsiteRedirect()
If you specify this property, you can't specify "websiteIndexDocument", "websiteErrorDocument" nor , "websiteRoutingRules".
Default: - No redirection.
default java.util.List<RoutingRule> getWebsiteRoutingRules()
Default: - No redirection rules.
static BucketProps.Builder builder()
BucketProps.Builder
of BucketProps