Class CfnBucket
The AWS::S3Outposts::Bucket resource specifies a new Amazon S3 on Outposts bucket.
Inherited Members
Namespace: Amazon.CDK.AWS.S3Outposts
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnBucket : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnBucket
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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 .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucket.html
CloudformationResource: AWS::S3Outposts::Bucket
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(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 |
CfnBucket(Construct, String, ICfnBucketProps) |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | Sets the tags for an S3 on Outposts bucket. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
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
CfnBucket(Construct, String, ICfnBucketProps)
public CfnBucket(Construct scope, string id, ICfnBucketProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnBucketProps
Resource properties.
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
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
OutpostId
The ID of the Outpost of the specified bucket.
public virtual string OutpostId { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Sets the tags for an S3 on Outposts bucket.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Remarks
For more information, see Using Amazon S3 on Outposts .
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>