Interface ICfnBucketProps

Properties for defining a CfnBucket.

Namespace: Amazon.CDK.AWS.S3
Assembly: Amazon.CDK.AWS.S3.dll
Syntax (csharp)
public interface ICfnBucketProps
Syntax (vb)
Public Interface ICfnBucketProps
Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html

ExampleMetadata: infused

Examples
var rawBucket = new CfnBucket(this, "Bucket", new CfnBucketProps { });
// -or-
var rawBucketAlt = (CfnBucket)myBucket.Node.DefaultChild;

// then
rawBucket.CfnOptions.Condition = new CfnCondition(this, "EnableBucket", new CfnConditionProps { });
rawBucket.CfnOptions.Metadata = new Dictionary<string, object> {
    { "metadataKey", "MetadataValue" }
};

Synopsis

Properties

AccelerateConfiguration

Configures the transfer acceleration state for an Amazon S3 bucket.
AccessControl

A canned access control list (ACL) that grants predefined permissions to the bucket.
AnalyticsConfigurations

Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
BucketEncryption

Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3) or AWS KMS-managed keys (SSE-KMS) bucket.
BucketName

A name for the bucket.
CorsConfiguration

Describes the cross-origin access configuration for objects in an Amazon S3 bucket.
IntelligentTieringConfigurations

Defines how Amazon S3 handles Intelligent-Tiering storage.
InventoryConfigurations

Specifies the inventory configuration for an Amazon S3 bucket.
LifecycleConfiguration

Specifies the lifecycle configuration for objects in an Amazon S3 bucket.
LoggingConfiguration

Settings that define where logs are stored.
MetricsConfigurations

Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket.
NotificationConfiguration

Configuration that defines how Amazon S3 handles bucket notifications.
ObjectLockConfiguration

Places an Object Lock configuration on the specified bucket.
ObjectLockEnabled

Indicates whether this bucket has an Object Lock configuration enabled.
OwnershipControls

Configuration that defines how Amazon S3 handles Object Ownership rules.
PublicAccessBlockConfiguration

Configuration that defines how Amazon S3 handles public access.
ReplicationConfiguration

Configuration for replicating objects in an S3 bucket.
Tags

An arbitrary set of tags (key-value pairs) for this S3 bucket.
VersioningConfiguration

Enables multiple versions of all objects in this bucket.
WebsiteConfiguration

Information used to configure the bucket as a static website.

Properties

AccelerateConfiguration

Configures the transfer acceleration state for an Amazon S3 bucket.

virtual object AccelerateConfiguration { get; }
Property Value

System.Object

Remarks

For more information, see Amazon S3 Transfer Acceleration in the Amazon S3 User Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-accelerateconfiguration

AccessControl

A canned access control list (ACL) that grants predefined permissions to the bucket.

virtual string AccessControl { get; }
Property Value

System.String

Remarks

For more information about canned ACLs, see Canned ACL in the Amazon S3 User Guide .

Be aware that the syntax for this property differs from the information provided in the Amazon S3 User Guide . The AccessControl property is case-sensitive and must be one of the following values: Private, PublicRead, PublicReadWrite, AuthenticatedRead, LogDeliveryWrite, BucketOwnerRead, BucketOwnerFullControl, or AwsExecRead.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-accesscontrol

AnalyticsConfigurations

Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.

virtual object AnalyticsConfigurations { get; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-analyticsconfigurations

BucketEncryption

Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3) or AWS KMS-managed keys (SSE-KMS) bucket.

virtual object BucketEncryption { get; }
Property Value

System.Object

Remarks

For information about the Amazon S3 default encryption feature, see Amazon S3 Default Encryption for S3 Buckets in the Amazon S3 User Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-bucketencryption

BucketName

A name for the bucket.

virtual string BucketName { get; }
Property Value

System.String

Remarks

If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow Amazon S3 bucket restrictions and limitations . For more information, see Rules for naming Amazon S3 buckets in the Amazon S3 User Guide .

If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-name

CorsConfiguration

Describes the cross-origin access configuration for objects in an Amazon S3 bucket.

virtual object CorsConfiguration { get; }
Property Value

System.Object

Remarks

For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-crossoriginconfig

IntelligentTieringConfigurations

Defines how Amazon S3 handles Intelligent-Tiering storage.

virtual object IntelligentTieringConfigurations { get; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-intelligenttieringconfigurations

InventoryConfigurations

Specifies the inventory configuration for an Amazon S3 bucket.

virtual object InventoryConfigurations { get; }
Property Value

System.Object

Remarks

For more information, see GET Bucket inventory in the Amazon S3 API Reference .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-inventoryconfigurations

LifecycleConfiguration

Specifies the lifecycle configuration for objects in an Amazon S3 bucket.

virtual object LifecycleConfiguration { get; }
Property Value

System.Object

Remarks

For more information, see Object Lifecycle Management in the Amazon S3 User Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-lifecycleconfig

LoggingConfiguration

Settings that define where logs are stored.

virtual object LoggingConfiguration { get; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-loggingconfig

MetricsConfigurations

Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket.

virtual object MetricsConfigurations { get; }
Property Value

System.Object

Remarks

If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see PutBucketMetricsConfiguration .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-metricsconfigurations

NotificationConfiguration

Configuration that defines how Amazon S3 handles bucket notifications.

virtual object NotificationConfiguration { get; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-notification

ObjectLockConfiguration

Places an Object Lock configuration on the specified bucket.

virtual object ObjectLockConfiguration { get; }
Property Value

System.Object

Remarks

The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects .

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-objectlockconfiguration

    ObjectLockEnabled

    Indicates whether this bucket has an Object Lock configuration enabled.

    virtual object ObjectLockEnabled { get; }
    Property Value

    System.Object

    Remarks

    Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-objectlockenabled

    OwnershipControls

    Configuration that defines how Amazon S3 handles Object Ownership rules.

    virtual object OwnershipControls { get; }
    Property Value

    System.Object

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-ownershipcontrols

    PublicAccessBlockConfiguration

    Configuration that defines how Amazon S3 handles public access.

    virtual object PublicAccessBlockConfiguration { get; }
    Property Value

    System.Object

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-publicaccessblockconfiguration

    ReplicationConfiguration

    Configuration for replicating objects in an S3 bucket.

    virtual object ReplicationConfiguration { get; }
    Property Value

    System.Object

    Remarks

    To enable replication, you must also enable versioning by using the VersioningConfiguration property.

    Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist.

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-replicationconfiguration

    Tags

    An arbitrary set of tags (key-value pairs) for this S3 bucket.

    virtual ICfnTag[] Tags { get; }
    Property Value

    ICfnTag[]

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-tags

    VersioningConfiguration

    Enables multiple versions of all objects in this bucket.

    virtual object VersioningConfiguration { get; }
    Property Value

    System.Object

    Remarks

    You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them.

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-versioning

    WebsiteConfiguration

    Information used to configure the bucket as a static website.

    virtual object WebsiteConfiguration { get; }
    Property Value

    System.Object

    Remarks

    For more information, see Hosting Websites on Amazon S3 .

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-websiteconfiguration