Class CfnBucket
A CloudFormation AWS::S3Outposts::Bucket
.
Inherited Members
Namespace: Amazon.CDK.AWS.S3Outposts
Assembly: Amazon.CDK.AWS.S3Outposts.dll
Syntax (csharp)
public class CfnBucket : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnBucket
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::S3Outposts::Bucket resource specifies a new Amazon S3 on Outposts bucket. To create an S3 on Outposts bucket, you must have S3 on Outposts capacity provisioned on your Outpost. For more information, see Using Amazon S3 on Outposts .
S3 on Outposts buckets support the following:
For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and Limitations .
CloudformationResource: AWS::S3Outposts::Bucket
Link: 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 cfnBucket = new CfnBucket(this, "MyCfnBucket", 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
Constructors
CfnBucket(Construct, String, ICfnBucketProps) | Create a new |
CfnBucket(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnBucket(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | Returns the ARN of the specified bucket. |
BucketName | A name for the S3 on Outposts bucket. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 . |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnBucket(Construct, String, ICfnBucketProps)
Create a new AWS::S3Outposts::Bucket
.
public CfnBucket(Construct scope, string id, ICfnBucketProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnBucketProps
- resource properties.
CfnBucket(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnBucket(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnBucket(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnBucket(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
Returns the ARN of the specified bucket.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
Example: arn:aws:s3Outposts:::DOC-EXAMPLE-BUCKET
CloudformationAttribute: Arn
BucketName
A name for the S3 on Outposts bucket.
public virtual string BucketName { get; set; }
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.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
LifecycleConfiguration
Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration.
public virtual object LifecycleConfiguration { get; set; }
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.
OutpostId
The ID of the Outpost of the specified bucket.
public virtual string OutpostId { get; set; }
Property Value
System.String
Remarks
Tags
Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts .
public virtual TagManager Tags { get; }
Property Value
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 .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>