CfnBucketPropsMixin

class aws_cdk.mixins_preview.aws_s3outposts.mixins.CfnBucketPropsMixin(props, *, strategy=None)

Bases: Mixin

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:

Tags
Lifecycle configuration rules for deleting expired objects

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
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_s3outposts import mixins as s3outposts_mixins

# filter: Any

cfn_bucket_props_mixin = s3outposts_mixins.CfnBucketPropsMixin(s3outposts_mixins.CfnBucketMixinProps(
    bucket_name="bucketName",
    lifecycle_configuration=s3outposts_mixins.CfnBucketPropsMixin.LifecycleConfigurationProperty(
        rules=[s3outposts_mixins.CfnBucketPropsMixin.RuleProperty(
            abort_incomplete_multipart_upload=s3outposts_mixins.CfnBucketPropsMixin.AbortIncompleteMultipartUploadProperty(
                days_after_initiation=123
            ),
            expiration_date="expirationDate",
            expiration_in_days=123,
            filter=filter,
            id="id",
            status="status"
        )]
    ),
    outpost_id="outpostId",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::S3Outposts::Bucket.

Parameters:

props (Union[CfnBucketMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['bucketName', 'lifecycleConfiguration', 'outpostId', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AbortIncompleteMultipartUploadProperty

class CfnBucketPropsMixin.AbortIncompleteMultipartUploadProperty(*, days_after_initiation=None)

Bases: object

Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 on Outposts waits before permanently removing all parts of the upload.

For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy .

Parameters:: days_after_initiation (Union[int, float, None]) – Specifies the number of days after initiation that Amazon S3 on Outposts aborts an incomplete multipart upload.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-abortincompletemultipartupload.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3outposts import mixins as s3outposts_mixins

abort_incomplete_multipart_upload_property = s3outposts_mixins.CfnBucketPropsMixin.AbortIncompleteMultipartUploadProperty(
    days_after_initiation=123
)

Attributes

days_after_initiation

Specifies the number of days after initiation that Amazon S3 on Outposts aborts an incomplete multipart upload.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-abortincompletemultipartupload.html#cfn-s3outposts-bucket-abortincompletemultipartupload-daysafterinitiation

LifecycleConfigurationProperty

class CfnBucketPropsMixin.LifecycleConfigurationProperty(*, rules=None)

Bases: object

The container for the lifecycle configuration for the objects stored in an S3 on Outposts bucket.

Parameters:: rules (Union[IResolvable, Sequence[Union[IResolvable, RuleProperty, Dict[str, Any]]], None]) – The container for the lifecycle configuration rules for the objects stored in the S3 on Outposts bucket.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-lifecycleconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3outposts import mixins as s3outposts_mixins

# filter: Any

lifecycle_configuration_property = s3outposts_mixins.CfnBucketPropsMixin.LifecycleConfigurationProperty(
    rules=[s3outposts_mixins.CfnBucketPropsMixin.RuleProperty(
        abort_incomplete_multipart_upload=s3outposts_mixins.CfnBucketPropsMixin.AbortIncompleteMultipartUploadProperty(
            days_after_initiation=123
        ),
        expiration_date="expirationDate",
        expiration_in_days=123,
        filter=filter,
        id="id",
        status="status"
    )]
)

Attributes

rules

The container for the lifecycle configuration rules for the objects stored in the S3 on Outposts bucket.

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

RuleProperty

class CfnBucketPropsMixin.RuleProperty(*, abort_incomplete_multipart_upload=None, expiration_date=None, expiration_in_days=None, filter=None, id=None, status=None)

Bases: object

A container for an Amazon S3 on Outposts bucket lifecycle rule.

Parameters:

abort_incomplete_multipart_upload (Union[IResolvable, AbortIncompleteMultipartUploadProperty, Dict[str, Any], None]) – The container for the abort incomplete multipart upload rule.
expiration_date (Optional[str]) – Specifies the expiration for the lifecycle of the object by specifying an expiry date.
expiration_in_days (Union[int, float, None]) – Specifies the expiration for the lifecycle of the object in the form of days that the object has been in the S3 on Outposts bucket.
filter (Any) – The container for the filter of the lifecycle rule.
id (Optional[str]) – Unique identifier for the lifecycle rule. The value can’t be longer than 255 characters.
status (Optional[str]) – If Enabled , the rule is currently being applied. If Disabled , the rule is not currently being applied.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-rule.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3outposts import mixins as s3outposts_mixins

# filter: Any

rule_property = s3outposts_mixins.CfnBucketPropsMixin.RuleProperty(
    abort_incomplete_multipart_upload=s3outposts_mixins.CfnBucketPropsMixin.AbortIncompleteMultipartUploadProperty(
        days_after_initiation=123
    ),
    expiration_date="expirationDate",
    expiration_in_days=123,
    filter=filter,
    id="id",
    status="status"
)