CfnBucket

class aws_cdk.aws_s3outposts.CfnBucket(scope, id, *, bucket_name, outpost_id, lifecycle_configuration=None, tags=None)

Bases: CfnResource

A CloudFormation AWS::S3Outposts::Bucket.

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 .

CloudformationResource:: AWS::S3Outposts::Bucket
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucket.html
ExampleMetadata:: fixture=_generated

Example:

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

# filter: Any

cfn_bucket = s3outposts.CfnBucket(self, "MyCfnBucket",
    bucket_name="bucketName",
    outpost_id="outpostId",

    # the properties below are optional
    lifecycle_configuration=s3outposts.CfnBucket.LifecycleConfigurationProperty(
        rules=[s3outposts.CfnBucket.RuleProperty(
            status="status",

            # the properties below are optional
            abort_incomplete_multipart_upload=s3outposts.CfnBucket.AbortIncompleteMultipartUploadProperty(
                days_after_initiation=123
            ),
            expiration_date="expirationDate",
            expiration_in_days=123,
            filter=filter,
            id="id"
        )]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::S3Outposts::Bucket.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
bucket_name (str) – A name for the S3 on Outposts bucket. 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 . .. epigraph:: 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.
outpost_id (str) – The ID of the Outpost of the specified bucket.
lifecycle_configuration (Union[IResolvable, LifecycleConfigurationProperty, Dict[str, Any], None]) – Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) –
Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts . 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 . .. epigraph:: 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

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:: attribute_name (str) – The name of the attribute.
Return type:: Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

tree inspector to collect and process attributes.

Return type:

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::S3Outposts::Bucket'

attr_arn

Returns the ARN of the specified bucket.

Example: arn:aws:s3Outposts:::DOC-EXAMPLE-BUCKET

CloudformationAttribute:: Arn

bucket_name

A name for the S3 on Outposts bucket.

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 . .. epigraph:

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-resource-s3outposts-bucket.html#cfn-s3outposts-bucket-bucketname

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

lifecycle_configuration

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

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

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The construct tree node associated with this construct.

outpost_id

The ID of the Outpost of the specified bucket.

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

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

//docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html>`_ .

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 . .. epigraph:

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 <https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html>`_ .

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 .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucket.html#cfn-s3outposts-bucket-tags
Type:: Sets the tags for an S3 on Outposts bucket. For more information, see `Using Amazon S3 on Outposts <https

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

AbortIncompleteMultipartUploadProperty

class CfnBucket.AbortIncompleteMultipartUploadProperty(*, days_after_initiation)

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]) – Specifies the number of days after initiation that Amazon S3 on Outposts aborts an incomplete multipart upload.
Link:: 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.
import aws_cdk.aws_s3outposts as s3outposts

abort_incomplete_multipart_upload_property = s3outposts.CfnBucket.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.

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

FilterAndOperatorProperty

class CfnBucket.FilterAndOperatorProperty(*, tags, prefix=None)

Bases: object

Parameters:

tags (Sequence[Union[FilterTagProperty, Dict[str, Any]]]) – CfnBucket.FilterAndOperatorProperty.Tags.
prefix (Optional[str]) – CfnBucket.FilterAndOperatorProperty.Prefix.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

filter_and_operator_property = s3outposts.CfnBucket.FilterAndOperatorProperty(
    tags=[s3outposts.CfnBucket.FilterTagProperty(
        key="key",
        value="value"
    )],

    # the properties below are optional
    prefix="prefix"
)

Attributes

prefix

CfnBucket.FilterAndOperatorProperty.Prefix.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filterandoperator.html#cfn-s3outposts-bucket-filterandoperator-prefix

tags

CfnBucket.FilterAndOperatorProperty.Tags.

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

FilterProperty

class CfnBucket.FilterProperty(*, and_operator=None, prefix=None, tag=None)

Bases: object

Parameters:

and_operator (Union[IResolvable, FilterAndOperatorProperty, Dict[str, Any], None]) – CfnBucket.FilterProperty.AndOperator.
prefix (Optional[str]) – CfnBucket.FilterProperty.Prefix.
tag (Union[IResolvable, FilterTagProperty, Dict[str, Any], None]) – CfnBucket.FilterProperty.Tag.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

filter_property = s3outposts.CfnBucket.FilterProperty(
    and_operator=s3outposts.CfnBucket.FilterAndOperatorProperty(
        tags=[s3outposts.CfnBucket.FilterTagProperty(
            key="key",
            value="value"
        )],

        # the properties below are optional
        prefix="prefix"
    ),
    prefix="prefix",
    tag=s3outposts.CfnBucket.FilterTagProperty(
        key="key",
        value="value"
    )
)

Attributes

and_operator

CfnBucket.FilterProperty.AndOperator.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filter.html#cfn-s3outposts-bucket-filter-andoperator

prefix

CfnBucket.FilterProperty.Prefix.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filter.html#cfn-s3outposts-bucket-filter-prefix

tag

CfnBucket.FilterProperty.Tag.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filter.html#cfn-s3outposts-bucket-filter-tag

FilterTagProperty

class CfnBucket.FilterTagProperty(*, key, value)

Bases: object

Parameters:

key (str) – CfnBucket.FilterTagProperty.Key.
value (str) – CfnBucket.FilterTagProperty.Value.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

filter_tag_property = s3outposts.CfnBucket.FilterTagProperty(
    key="key",
    value="value"
)

Attributes

key

CfnBucket.FilterTagProperty.Key.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filtertag.html#cfn-s3outposts-bucket-filtertag-key

value

CfnBucket.FilterTagProperty.Value.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filtertag.html#cfn-s3outposts-bucket-filtertag-value

LifecycleConfigurationProperty

class CfnBucket.LifecycleConfigurationProperty(*, rules)

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]]]]) – The container for the lifecycle configuration rules for the objects stored in the S3 on Outposts bucket.
Link:: 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.
import aws_cdk.aws_s3outposts as s3outposts

# filter: Any

lifecycle_configuration_property = s3outposts.CfnBucket.LifecycleConfigurationProperty(
    rules=[s3outposts.CfnBucket.RuleProperty(
        status="status",

        # the properties below are optional
        abort_incomplete_multipart_upload=s3outposts.CfnBucket.AbortIncompleteMultipartUploadProperty(
            days_after_initiation=123
        ),
        expiration_date="expirationDate",
        expiration_in_days=123,
        filter=filter,
        id="id"
    )]
)

Attributes

rules

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

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

RuleProperty

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

Bases: object

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

Parameters:

status (str) – If Enabled , the rule is currently being applied. If Disabled , the rule is not currently being applied.
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 (Optional[Any]) – The container for the filter of the lifecycle rule.
id (Optional[str]) – The unique identifier for the lifecycle rule. The value can’t be longer than 255 characters.

Link:

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.
import aws_cdk.aws_s3outposts as s3outposts

# filter: Any

rule_property = s3outposts.CfnBucket.RuleProperty(
    status="status",

    # the properties below are optional
    abort_incomplete_multipart_upload=s3outposts.CfnBucket.AbortIncompleteMultipartUploadProperty(
        days_after_initiation=123
    ),
    expiration_date="expirationDate",
    expiration_in_days=123,
    filter=filter,
    id="id"
)