API.md

API Reference

Classes

Name	Description
DeletableBucket	No description
EmptyBucket	No description

Structs

Name	Description
DeletableBucketProps	No description
EmptyBucketProps	No description

class DeletableBucket

Implements: IConstruct, IConstruct, IConstruct, IDependable, IResource, IConstruct, IDependable, IConstruct, IBucket, IConstruct, IDependable, IConstruct, IResource Extends: Bucket

Initializer

new DeletableBucket(scope: Construct, id: string, props?: DeletableBucketProps)

• scope (Construct) No description
• id (string) No description
• props (DeletableBucketProps) No description
  • accessControl (BucketAccessControl) Specifies a canned ACL that grants predefined permissions to the bucket. Default: BucketAccessControl.PRIVATE
  • autoDeleteObjects (boolean) Whether all objects should be automatically deleted when the bucket is removed from the stack or when the stack is deleted. Default: false
  • blockPublicAccess (BlockPublicAccess) The block public access configuration of this bucket. 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
  • bucketKeyEnabled (boolean) 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: false
  • bucketName (string) Physical name of this bucket. Default: Assigned by CloudFormation (recommended).
  • cors (Array<CorsRule>) The CORS configuration of this bucket. Default: No CORS configuration.
  • encryption (BucketEncryption) The kind of server-side encryption to apply to this bucket. Default: Kms if encryptionKey is specified, or Unencrypted otherwise.
  • encryptionKey (IKey) External KMS key to use for bucket encryption. Default: If encryption is set to "Kms" and this property is undefined, a new KMS key will be created and associated with this bucket.
  • enforceSSL (boolean) Enforces SSL for requests. Default: false
  • inventories (Array<Inventory>) The inventory configuration of the bucket. Default: No inventory configuration
  • lifecycleRules (Array<LifecycleRule>) Rules that define how Amazon S3 manages objects during their lifetime. Default: No lifecycle rules.
  • metrics (Array<BucketMetrics>) The metrics configuration of this bucket. Default: No metrics configuration.
  • objectOwnership (ObjectOwnership) The objectOwnership of the bucket. Default: No ObjectOwnership configuration, uploading account will own the object.
  • publicReadAccess (boolean) Grants public read access to all objects in the bucket. Default: false
  • removalPolicy (RemovalPolicy) Policy to apply when the bucket is removed from this stack. Default: The bucket will be orphaned.
  • serverAccessLogsBucket (IBucket) Destination bucket for the server access logs. Default: If "serverAccessLogsPrefix" undefined - access logs disabled, otherwise - log to current bucket.
  • serverAccessLogsPrefix (string) Optional log file prefix to use for the bucket's access logs. Default: No log file prefix
  • versioned (boolean) Whether this bucket should have versioning turned on or not. Default: false
  • websiteErrorDocument (string) The name of the error document (e.g. "404.html") for the website. websiteIndexDocument must also be set if this is set. Default: No error document.
  • websiteIndexDocument (string) The name of the index document (e.g. "index.html") for the website. Enables static website hosting for this bucket. Default: No index document.
  • websiteRedirect (RedirectTarget) Specifies the redirect behavior of all requests to a website endpoint of a bucket. Default: No redirection.
  • websiteRoutingRules (Array<RoutingRule>) Rules that define when a redirect is applied and the redirect behavior. Default: No redirection rules.
  • forceDelete (boolean) If the buckets contains objects, forces the deletion during stack deletion. Default: false

class EmptyBucket

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new EmptyBucket(scope: Construct, id: string, props: EmptyBucketProps)

• scope (Construct) No description
• id (string) No description
• props (EmptyBucketProps) No description
  • bucket (IBucket) No description

struct DeletableBucketProps

Name	Type	Description
accessControl?	BucketAccessControl	Specifies a canned ACL that grants predefined permissions to the bucket. Default: BucketAccessControl.PRIVATE
autoDeleteObjects?	boolean	Whether all objects should be automatically deleted when the bucket is removed from the stack or when the stack is deleted. Default: false
blockPublicAccess?	BlockPublicAccess	The block public access configuration of this bucket. 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
bucketKeyEnabled?	boolean	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: false
bucketName?	string	Physical name of this bucket. Default: Assigned by CloudFormation (recommended).
cors?	Array<CorsRule>	The CORS configuration of this bucket. Default: No CORS configuration.
encryption?	BucketEncryption	The kind of server-side encryption to apply to this bucket. Default: Kms if encryptionKey is specified, or Unencrypted otherwise.
encryptionKey?	IKey	External KMS key to use for bucket encryption. Default: If encryption is set to "Kms" and this property is undefined, a new KMS key will be created and associated with this bucket.
enforceSSL?	boolean	Enforces SSL for requests. Default: false
forceDelete?	boolean	If the buckets contains objects, forces the deletion during stack deletion. Default: false
inventories?	Array<Inventory>	The inventory configuration of the bucket. Default: No inventory configuration
lifecycleRules?	Array<LifecycleRule>	Rules that define how Amazon S3 manages objects during their lifetime. Default: No lifecycle rules.
metrics?	Array<BucketMetrics>	The metrics configuration of this bucket. Default: No metrics configuration.
objectOwnership?	ObjectOwnership	The objectOwnership of the bucket. Default: No ObjectOwnership configuration, uploading account will own the object.
publicReadAccess?	boolean	Grants public read access to all objects in the bucket. Default: false
removalPolicy?	RemovalPolicy	Policy to apply when the bucket is removed from this stack. Default: The bucket will be orphaned.
serverAccessLogsBucket?	IBucket	Destination bucket for the server access logs. Default: If "serverAccessLogsPrefix" undefined - access logs disabled, otherwise - log to current bucket.
serverAccessLogsPrefix?	string	Optional log file prefix to use for the bucket's access logs. Default: No log file prefix
versioned?	boolean	Whether this bucket should have versioning turned on or not. Default: false
websiteErrorDocument?	string	The name of the error document (e.g. "404.html") for the website. websiteIndexDocument must also be set if this is set. Default: No error document.
websiteIndexDocument?	string	The name of the index document (e.g. "index.html") for the website. Enables static website hosting for this bucket. Default: No index document.
websiteRedirect?	RedirectTarget	Specifies the redirect behavior of all requests to a website endpoint of a bucket. Default: No redirection.
websiteRoutingRules?	Array<RoutingRule>	Rules that define when a redirect is applied and the redirect behavior. Default: No redirection rules.

struct EmptyBucketProps

Name	Type	Description
bucket	IBucket