Interface ICfnBucketProps

Properties for defining a CfnBucket.

Namespace: Amazon.CDK.AWS.S3Outposts

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnBucketProps

Syntax (vb)

Public Interface ICfnBucketProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucket.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.S3Outposts;

var filter;

var cfnBucketProps = new CfnBucketProps {
    BucketName = "bucketName",
    OutpostId = "outpostId",

    // the properties below are optional
    LifecycleConfiguration = new LifecycleConfigurationProperty {
        Rules = new [] { new RuleProperty {
            Status = "status",

            // the properties below are optional
            AbortIncompleteMultipartUpload = new AbortIncompleteMultipartUploadProperty {
                DaysAfterInitiation = 123
            },
            ExpirationDate = "expirationDate",
            ExpirationInDays = 123,
            Filter = filter,
            Id = "id"
        } }
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};

Synopsis

Properties

BucketName	A name for the S3 on Outposts bucket.
LifecycleConfiguration	Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration.
OutpostId	The ID of the Outpost of the specified bucket.
Tags	Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts .

Properties

BucketName

A name for the S3 on Outposts bucket.

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 Bucket naming rules .

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucket.html#cfn-s3outposts-bucket-bucketname

LifecycleConfiguration

Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration.

virtual object LifecycleConfiguration { get; }

Property Value

System.Object

Remarks

Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucket.html#cfn-s3outposts-bucket-lifecycleconfiguration

OutpostId

The ID of the Outpost of the specified bucket.

string OutpostId { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucket.html#cfn-s3outposts-bucket-outpostid

Tags

Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts .

virtual ICfnTag[] Tags { get; }

Property Value

ICfnTag[]

Remarks

Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost allocation and tags .

Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using cost allocation and bucket tags .

To use this resource, you must have permissions to perform the s3-outposts:PutBucketTagging . The S3 on Outposts bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing access permissions to your Amazon S3 resources .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucket.html#cfn-s3outposts-bucket-tags