Construction properties for an S3 Bucket object.

Hierarchy

  • BucketProps

Properties

awsPrincipalAccesses?: {
    accessType: string;
    name: string;
    principal: string;
}[]

Optional

A list of AWS principals and access type the bucket to grant principal should be a valid AWS resource principal like for AWS Macie it should be macie.amazonaws.com accessType should be any of these possible values BucketAccessType.READONLY, BucketAccessType.WRITEONLY,BucketAccessType.READWRITE and BucketAccessType.NO_ACCESS

bucketPrefixProps?: BucketPrefixProps

Optional bucket prefix property

encryptionType: BucketEncryptionType

SSE encryption type for this bucket.

kmsAliasName?: string

The name of the alias.

kmsDescription?: string

A description of the key.

Use a description that helps your users decide whether the key is appropriate for a particular task.

kmsKey?: Key

The kms key for bucket encryption.

nagSuppressionPrefix?: string

Prefix for nag suppression

replicationProps?: BucketReplicationProps

Optional bucket replication property

s3BucketName?: string

Physical name of this bucket.

Default

  • Assigned by CloudFormation (recommended).
s3LifeCycleRules?: S3LifeCycleRule[]
s3RemovalPolicy?: RemovalPolicy

Policy to apply when the bucket is removed from this stack.

Default

  • The bucket will be orphaned.
serverAccessLogsBucket?: IBucket
serverAccessLogsBucketName?: string
serverAccessLogsPrefix?: string

Prefix to use in the target bucket for server access logs.

Default

  • name of this bucket

Generated using TypeDoc