CfnBucket

class aws_cdk.aws_s3.CfnBucket(scope, id, *, accelerate_configuration=None, access_control=None, analytics_configurations=None, bucket_encryption=None, bucket_name=None, cors_configuration=None, intelligent_tiering_configurations=None, inventory_configurations=None, lifecycle_configuration=None, logging_configuration=None, metrics_configurations=None, notification_configuration=None, object_lock_configuration=None, object_lock_enabled=None, ownership_controls=None, public_access_block_configuration=None, replication_configuration=None, tags=None, versioning_configuration=None, website_configuration=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::S3::Bucket.

CloudformationResource

AWS::S3::Bucket

Link

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

Create a new AWS::S3::Bucket.

Parameters

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

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.

Return type

None

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:

# Example automatically generated. See https://github.com/aws/jsii/issues/826
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"
       ...
     },
   ]
   ...
}
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.

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

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.

Return type

Any

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

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::S3::Bucket'
accelerate_configuration

AWS::S3::Bucket.AccelerateConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-accelerateconfiguration

Return type

Union[AccelerateConfigurationProperty, IResolvable, None]

access_control

AWS::S3::Bucket.AccessControl.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-accesscontrol

Return type

Optional[str]

analytics_configurations

AWS::S3::Bucket.AnalyticsConfigurations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-analyticsconfigurations

Return type

Union[IResolvable, List[Union[IResolvable, AnalyticsConfigurationProperty]], None]

attr_arn

Arn

Type

cloudformationAttribute

Return type

str

attr_domain_name

DomainName

Type

cloudformationAttribute

Return type

str

attr_dual_stack_domain_name

DualStackDomainName

Type

cloudformationAttribute

Return type

str

attr_regional_domain_name

RegionalDomainName

Type

cloudformationAttribute

Return type

str

attr_website_url

WebsiteURL

Type

cloudformationAttribute

Return type

str

bucket_encryption

AWS::S3::Bucket.BucketEncryption.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-bucketencryption

Return type

Union[IResolvable, BucketEncryptionProperty, None]

bucket_name

AWS::S3::Bucket.BucketName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-name

Return type

Optional[str]

cfn_options

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

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

cors_configuration

AWS::S3::Bucket.CorsConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-crossoriginconfig

Return type

Union[IResolvable, CorsConfigurationProperty, None]

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.

Return type

List[str]

intelligent_tiering_configurations

AWS::S3::Bucket.IntelligentTieringConfigurations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-intelligenttieringconfigurations

Return type

Union[IResolvable, List[Union[IResolvable, IntelligentTieringConfigurationProperty]], None]

inventory_configurations

AWS::S3::Bucket.InventoryConfigurations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-inventoryconfigurations

Return type

Union[IResolvable, List[Union[IResolvable, InventoryConfigurationProperty]], None]

lifecycle_configuration

AWS::S3::Bucket.LifecycleConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-lifecycleconfig

Return type

Union[IResolvable, LifecycleConfigurationProperty, None]

logging_configuration

AWS::S3::Bucket.LoggingConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-loggingconfig

Return type

Union[IResolvable, LoggingConfigurationProperty, None]

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).

Return type

str

Returns

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

metrics_configurations

AWS::S3::Bucket.MetricsConfigurations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-metricsconfigurations

Return type

Union[IResolvable, List[Union[IResolvable, MetricsConfigurationProperty]], None]

node

The construct tree node associated with this construct.

Return type

ConstructNode

notification_configuration

AWS::S3::Bucket.NotificationConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-notification

Return type

Union[IResolvable, NotificationConfigurationProperty, None]

object_lock_configuration

AWS::S3::Bucket.ObjectLockConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-objectlockconfiguration

Return type

Union[IResolvable, ObjectLockConfigurationProperty, None]

object_lock_enabled

AWS::S3::Bucket.ObjectLockEnabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-objectlockenabled

Return type

Union[bool, IResolvable, None]

ownership_controls

AWS::S3::Bucket.OwnershipControls.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-ownershipcontrols

Return type

Union[IResolvable, OwnershipControlsProperty, None]

public_access_block_configuration

AWS::S3::Bucket.PublicAccessBlockConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-publicaccessblockconfiguration

Return type

Union[IResolvable, PublicAccessBlockConfigurationProperty, None]

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 }).

Return type

str

replication_configuration

AWS::S3::Bucket.ReplicationConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-replicationconfiguration

Return type

Union[IResolvable, ReplicationConfigurationProperty, None]

stack

The stack in which this element is defined.

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

Return type

Stack

tags

AWS::S3::Bucket.Tags.

Link

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

Return type

TagManager

versioning_configuration

AWS::S3::Bucket.VersioningConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-versioning

Return type

Union[IResolvable, VersioningConfigurationProperty, None]

website_configuration

AWS::S3::Bucket.WebsiteConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-websiteconfiguration

Return type

Union[IResolvable, WebsiteConfigurationProperty, None]

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

Parameters

days_after_initiation (Union[int, float]) – CfnBucket.AbortIncompleteMultipartUploadProperty.DaysAfterInitiation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-abortincompletemultipartupload.html

Attributes

days_after_initiation

CfnBucket.AbortIncompleteMultipartUploadProperty.DaysAfterInitiation.

Link

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

Return type

Union[int, float]

AccelerateConfigurationProperty

class CfnBucket.AccelerateConfigurationProperty(*, acceleration_status)

Bases: object

Parameters

acceleration_status (str) – CfnBucket.AccelerateConfigurationProperty.AccelerationStatus.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accelerateconfiguration.html

Attributes

acceleration_status

CfnBucket.AccelerateConfigurationProperty.AccelerationStatus.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accelerateconfiguration.html#cfn-s3-bucket-accelerateconfiguration-accelerationstatus

Return type

str

AccessControlTranslationProperty

class CfnBucket.AccessControlTranslationProperty(*, owner)

Bases: object

Parameters

owner (str) – CfnBucket.AccessControlTranslationProperty.Owner.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accesscontroltranslation.html

Attributes

owner

CfnBucket.AccessControlTranslationProperty.Owner.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accesscontroltranslation.html#cfn-s3-bucket-accesscontroltranslation-owner

Return type

str

AnalyticsConfigurationProperty

class CfnBucket.AnalyticsConfigurationProperty(*, id, storage_class_analysis, prefix=None, tag_filters=None)

Bases: object

Parameters
  • id (str) – CfnBucket.AnalyticsConfigurationProperty.Id.

  • storage_class_analysis (Union[IResolvable, StorageClassAnalysisProperty]) – CfnBucket.AnalyticsConfigurationProperty.StorageClassAnalysis.

  • prefix (Optional[str]) – CfnBucket.AnalyticsConfigurationProperty.Prefix.

  • tag_filters (Union[IResolvable, List[Union[IResolvable, TagFilterProperty]], None]) – CfnBucket.AnalyticsConfigurationProperty.TagFilters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html

Attributes

id

CfnBucket.AnalyticsConfigurationProperty.Id.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-id

Return type

str

prefix

CfnBucket.AnalyticsConfigurationProperty.Prefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-prefix

Return type

Optional[str]

storage_class_analysis

CfnBucket.AnalyticsConfigurationProperty.StorageClassAnalysis.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-storageclassanalysis

Return type

Union[IResolvable, StorageClassAnalysisProperty]

tag_filters

CfnBucket.AnalyticsConfigurationProperty.TagFilters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-tagfilters

Return type

Union[IResolvable, List[Union[IResolvable, TagFilterProperty]], None]

BucketEncryptionProperty

class CfnBucket.BucketEncryptionProperty(*, server_side_encryption_configuration)

Bases: object

Parameters

server_side_encryption_configuration (Union[IResolvable, List[Union[IResolvable, ServerSideEncryptionRuleProperty]]]) – CfnBucket.BucketEncryptionProperty.ServerSideEncryptionConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-bucketencryption.html

Attributes

server_side_encryption_configuration

CfnBucket.BucketEncryptionProperty.ServerSideEncryptionConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-bucketencryption.html#cfn-s3-bucket-bucketencryption-serversideencryptionconfiguration

Return type

Union[IResolvable, List[Union[IResolvable, ServerSideEncryptionRuleProperty]]]

CorsConfigurationProperty

class CfnBucket.CorsConfigurationProperty(*, cors_rules)

Bases: object

Parameters

cors_rules (Union[IResolvable, List[Union[IResolvable, CorsRuleProperty]]]) – CfnBucket.CorsConfigurationProperty.CorsRules.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors.html

Attributes

cors_rules

CfnBucket.CorsConfigurationProperty.CorsRules.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors.html#cfn-s3-bucket-cors-corsrule

Return type

Union[IResolvable, List[Union[IResolvable, CorsRuleProperty]]]

CorsRuleProperty

class CfnBucket.CorsRuleProperty(*, allowed_methods, allowed_origins, allowed_headers=None, exposed_headers=None, id=None, max_age=None)

Bases: object

Parameters
  • allowed_methods (List[str]) – CfnBucket.CorsRuleProperty.AllowedMethods.

  • allowed_origins (List[str]) – CfnBucket.CorsRuleProperty.AllowedOrigins.

  • allowed_headers (Optional[List[str]]) – CfnBucket.CorsRuleProperty.AllowedHeaders.

  • exposed_headers (Optional[List[str]]) – CfnBucket.CorsRuleProperty.ExposedHeaders.

  • id (Optional[str]) – CfnBucket.CorsRuleProperty.Id.

  • max_age (Union[int, float, None]) – CfnBucket.CorsRuleProperty.MaxAge.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html

Attributes

allowed_headers

CfnBucket.CorsRuleProperty.AllowedHeaders.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-allowedheaders

Return type

Optional[List[str]]

allowed_methods

CfnBucket.CorsRuleProperty.AllowedMethods.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-allowedmethods

Return type

List[str]

allowed_origins

CfnBucket.CorsRuleProperty.AllowedOrigins.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-allowedorigins

Return type

List[str]

exposed_headers

CfnBucket.CorsRuleProperty.ExposedHeaders.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-exposedheaders

Return type

Optional[List[str]]

id

CfnBucket.CorsRuleProperty.Id.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-id

Return type

Optional[str]

max_age

CfnBucket.CorsRuleProperty.MaxAge.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-maxage

Return type

Union[int, float, None]

DataExportProperty

class CfnBucket.DataExportProperty(*, destination, output_schema_version)

Bases: object

Parameters
  • destination (Union[IResolvable, DestinationProperty]) – CfnBucket.DataExportProperty.Destination.

  • output_schema_version (str) – CfnBucket.DataExportProperty.OutputSchemaVersion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-dataexport.html

Attributes

destination

CfnBucket.DataExportProperty.Destination.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-dataexport.html#cfn-s3-bucket-dataexport-destination

Return type

Union[IResolvable, DestinationProperty]

output_schema_version

CfnBucket.DataExportProperty.OutputSchemaVersion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-dataexport.html#cfn-s3-bucket-dataexport-outputschemaversion

Return type

str

DefaultRetentionProperty

class CfnBucket.DefaultRetentionProperty(*, days=None, mode=None, years=None)

Bases: object

Parameters
  • days (Union[int, float, None]) – CfnBucket.DefaultRetentionProperty.Days.

  • mode (Optional[str]) – CfnBucket.DefaultRetentionProperty.Mode.

  • years (Union[int, float, None]) – CfnBucket.DefaultRetentionProperty.Years.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html

Attributes

days

CfnBucket.DefaultRetentionProperty.Days.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html#cfn-s3-bucket-defaultretention-days

Return type

Union[int, float, None]

mode

CfnBucket.DefaultRetentionProperty.Mode.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html#cfn-s3-bucket-defaultretention-mode

Return type

Optional[str]

years

CfnBucket.DefaultRetentionProperty.Years.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html#cfn-s3-bucket-defaultretention-years

Return type

Union[int, float, None]

DeleteMarkerReplicationProperty

class CfnBucket.DeleteMarkerReplicationProperty(*, status=None)

Bases: object

Parameters

status (Optional[str]) – CfnBucket.DeleteMarkerReplicationProperty.Status.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-deletemarkerreplication.html

Attributes

status

CfnBucket.DeleteMarkerReplicationProperty.Status.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-deletemarkerreplication.html#cfn-s3-bucket-deletemarkerreplication-status

Return type

Optional[str]

DestinationProperty

class CfnBucket.DestinationProperty(*, bucket_arn, format, bucket_account_id=None, prefix=None)

Bases: object

Parameters
  • bucket_arn (str) – CfnBucket.DestinationProperty.BucketArn.

  • format (str) – CfnBucket.DestinationProperty.Format.

  • bucket_account_id (Optional[str]) – CfnBucket.DestinationProperty.BucketAccountId.

  • prefix (Optional[str]) – CfnBucket.DestinationProperty.Prefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html

Attributes

bucket_account_id

CfnBucket.DestinationProperty.BucketAccountId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-bucketaccountid

Return type

Optional[str]

bucket_arn

CfnBucket.DestinationProperty.BucketArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-bucketarn

Return type

str

format

CfnBucket.DestinationProperty.Format.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-format

Return type

str

prefix

CfnBucket.DestinationProperty.Prefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-prefix

Return type

Optional[str]

EncryptionConfigurationProperty

class CfnBucket.EncryptionConfigurationProperty(*, replica_kms_key_id)

Bases: object

Parameters

replica_kms_key_id (str) – CfnBucket.EncryptionConfigurationProperty.ReplicaKmsKeyID.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-encryptionconfiguration.html

Attributes

replica_kms_key_id

CfnBucket.EncryptionConfigurationProperty.ReplicaKmsKeyID.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-encryptionconfiguration.html#cfn-s3-bucket-encryptionconfiguration-replicakmskeyid

Return type

str

IntelligentTieringConfigurationProperty

class CfnBucket.IntelligentTieringConfigurationProperty(*, id, status, tierings, prefix=None, tag_filters=None)

Bases: object

Parameters
  • id (str) – CfnBucket.IntelligentTieringConfigurationProperty.Id.

  • status (str) – CfnBucket.IntelligentTieringConfigurationProperty.Status.

  • tierings (Union[IResolvable, List[Union[IResolvable, TieringProperty]]]) – CfnBucket.IntelligentTieringConfigurationProperty.Tierings.

  • prefix (Optional[str]) – CfnBucket.IntelligentTieringConfigurationProperty.Prefix.

  • tag_filters (Union[IResolvable, List[Union[IResolvable, TagFilterProperty]], None]) – CfnBucket.IntelligentTieringConfigurationProperty.TagFilters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-intelligenttieringconfiguration.html

Attributes

id

CfnBucket.IntelligentTieringConfigurationProperty.Id.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-intelligenttieringconfiguration.html#cfn-s3-bucket-intelligenttieringconfiguration-id

Return type

str

prefix

CfnBucket.IntelligentTieringConfigurationProperty.Prefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-intelligenttieringconfiguration.html#cfn-s3-bucket-intelligenttieringconfiguration-prefix

Return type

Optional[str]

status

CfnBucket.IntelligentTieringConfigurationProperty.Status.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-intelligenttieringconfiguration.html#cfn-s3-bucket-intelligenttieringconfiguration-status

Return type

str

tag_filters

CfnBucket.IntelligentTieringConfigurationProperty.TagFilters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-intelligenttieringconfiguration.html#cfn-s3-bucket-intelligenttieringconfiguration-tagfilters

Return type

Union[IResolvable, List[Union[IResolvable, TagFilterProperty]], None]

tierings

CfnBucket.IntelligentTieringConfigurationProperty.Tierings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-intelligenttieringconfiguration.html#cfn-s3-bucket-intelligenttieringconfiguration-tierings

Return type

Union[IResolvable, List[Union[IResolvable, TieringProperty]]]

InventoryConfigurationProperty

class CfnBucket.InventoryConfigurationProperty(*, destination, enabled, id, included_object_versions, schedule_frequency, optional_fields=None, prefix=None)

Bases: object

Parameters
  • destination (Union[IResolvable, DestinationProperty]) – CfnBucket.InventoryConfigurationProperty.Destination.

  • enabled (Union[bool, IResolvable]) – CfnBucket.InventoryConfigurationProperty.Enabled.

  • id (str) – CfnBucket.InventoryConfigurationProperty.Id.

  • included_object_versions (str) – CfnBucket.InventoryConfigurationProperty.IncludedObjectVersions.

  • schedule_frequency (str) – CfnBucket.InventoryConfigurationProperty.ScheduleFrequency.

  • optional_fields (Optional[List[str]]) – CfnBucket.InventoryConfigurationProperty.OptionalFields.

  • prefix (Optional[str]) – CfnBucket.InventoryConfigurationProperty.Prefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html

Attributes

destination

CfnBucket.InventoryConfigurationProperty.Destination.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-destination

Return type

Union[IResolvable, DestinationProperty]

enabled

CfnBucket.InventoryConfigurationProperty.Enabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-enabled

Return type

Union[bool, IResolvable]

id

CfnBucket.InventoryConfigurationProperty.Id.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-id

Return type

str

included_object_versions

CfnBucket.InventoryConfigurationProperty.IncludedObjectVersions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-includedobjectversions

Return type

str

optional_fields

CfnBucket.InventoryConfigurationProperty.OptionalFields.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-optionalfields

Return type

Optional[List[str]]

prefix

CfnBucket.InventoryConfigurationProperty.Prefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-prefix

Return type

Optional[str]

schedule_frequency

CfnBucket.InventoryConfigurationProperty.ScheduleFrequency.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-schedulefrequency

Return type

str

LambdaConfigurationProperty

class CfnBucket.LambdaConfigurationProperty(*, event, function, filter=None)

Bases: object

Parameters
  • event (str) – CfnBucket.LambdaConfigurationProperty.Event.

  • function (str) – CfnBucket.LambdaConfigurationProperty.Function.

  • filter (Union[IResolvable, NotificationFilterProperty, None]) – CfnBucket.LambdaConfigurationProperty.Filter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html

Attributes

event

CfnBucket.LambdaConfigurationProperty.Event.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig-event

Return type

str

filter

CfnBucket.LambdaConfigurationProperty.Filter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig-filter

Return type

Union[IResolvable, NotificationFilterProperty, None]

function

CfnBucket.LambdaConfigurationProperty.Function.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig-function

Return type

str

LifecycleConfigurationProperty

class CfnBucket.LifecycleConfigurationProperty(*, rules)

Bases: object

Parameters

rules (Union[IResolvable, List[Union[IResolvable, RuleProperty]]]) – CfnBucket.LifecycleConfigurationProperty.Rules.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig.html

Attributes

rules

CfnBucket.LifecycleConfigurationProperty.Rules.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig.html#cfn-s3-bucket-lifecycleconfig-rules

Return type

Union[IResolvable, List[Union[IResolvable, RuleProperty]]]

LoggingConfigurationProperty

class CfnBucket.LoggingConfigurationProperty(*, destination_bucket_name=None, log_file_prefix=None)

Bases: object

Parameters
  • destination_bucket_name (Optional[str]) – CfnBucket.LoggingConfigurationProperty.DestinationBucketName.

  • log_file_prefix (Optional[str]) – CfnBucket.LoggingConfigurationProperty.LogFilePrefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-loggingconfig.html

Attributes

destination_bucket_name

CfnBucket.LoggingConfigurationProperty.DestinationBucketName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-loggingconfig.html#cfn-s3-bucket-loggingconfig-destinationbucketname

Return type

Optional[str]

log_file_prefix

CfnBucket.LoggingConfigurationProperty.LogFilePrefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-loggingconfig.html#cfn-s3-bucket-loggingconfig-logfileprefix

Return type

Optional[str]

MetricsConfigurationProperty

class CfnBucket.MetricsConfigurationProperty(*, id, prefix=None, tag_filters=None)

Bases: object

Parameters
  • id (str) – CfnBucket.MetricsConfigurationProperty.Id.

  • prefix (Optional[str]) – CfnBucket.MetricsConfigurationProperty.Prefix.

  • tag_filters (Union[IResolvable, List[Union[IResolvable, TagFilterProperty]], None]) – CfnBucket.MetricsConfigurationProperty.TagFilters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html

Attributes

id

CfnBucket.MetricsConfigurationProperty.Id.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html#cfn-s3-bucket-metricsconfiguration-id

Return type

str

prefix

CfnBucket.MetricsConfigurationProperty.Prefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html#cfn-s3-bucket-metricsconfiguration-prefix

Return type

Optional[str]

tag_filters

CfnBucket.MetricsConfigurationProperty.TagFilters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html#cfn-s3-bucket-metricsconfiguration-tagfilters

Return type

Union[IResolvable, List[Union[IResolvable, TagFilterProperty]], None]

MetricsProperty

class CfnBucket.MetricsProperty(*, status, event_threshold=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metrics.html

Attributes

event_threshold

CfnBucket.MetricsProperty.EventThreshold.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metrics.html#cfn-s3-bucket-metrics-eventthreshold

Return type

Union[IResolvable, ReplicationTimeValueProperty, None]

status

CfnBucket.MetricsProperty.Status.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metrics.html#cfn-s3-bucket-metrics-status

Return type

str

NoncurrentVersionTransitionProperty

class CfnBucket.NoncurrentVersionTransitionProperty(*, storage_class, transition_in_days)

Bases: object

Parameters
  • storage_class (str) – CfnBucket.NoncurrentVersionTransitionProperty.StorageClass.

  • transition_in_days (Union[int, float]) – CfnBucket.NoncurrentVersionTransitionProperty.TransitionInDays.

Link

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

Attributes

storage_class

CfnBucket.NoncurrentVersionTransitionProperty.StorageClass.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition-storageclass

Return type

str

transition_in_days

CfnBucket.NoncurrentVersionTransitionProperty.TransitionInDays.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition-transitionindays

Return type

Union[int, float]

NotificationConfigurationProperty

class CfnBucket.NotificationConfigurationProperty(*, lambda_configurations=None, queue_configurations=None, topic_configurations=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig.html

Attributes

lambda_configurations

CfnBucket.NotificationConfigurationProperty.LambdaConfigurations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig

Return type

Union[IResolvable, List[Union[IResolvable, LambdaConfigurationProperty]], None]

queue_configurations

CfnBucket.NotificationConfigurationProperty.QueueConfigurations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig.html#cfn-s3-bucket-notificationconfig-queueconfig

Return type

Union[IResolvable, List[Union[IResolvable, QueueConfigurationProperty]], None]

topic_configurations

CfnBucket.NotificationConfigurationProperty.TopicConfigurations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig.html#cfn-s3-bucket-notificationconfig-topicconfig

Return type

Union[IResolvable, List[Union[IResolvable, TopicConfigurationProperty]], None]

NotificationFilterProperty

class CfnBucket.NotificationFilterProperty(*, s3_key)

Bases: object

Parameters

s3_key (Union[IResolvable, S3KeyFilterProperty]) – CfnBucket.NotificationFilterProperty.S3Key.

Link

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

Attributes

s3_key

CfnBucket.NotificationFilterProperty.S3Key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html#cfn-s3-bucket-notificationconfiguraiton-config-filter-s3key

Return type

Union[IResolvable, S3KeyFilterProperty]

ObjectLockConfigurationProperty

class CfnBucket.ObjectLockConfigurationProperty(*, object_lock_enabled=None, rule=None)

Bases: object

Parameters
  • object_lock_enabled (Optional[str]) – CfnBucket.ObjectLockConfigurationProperty.ObjectLockEnabled.

  • rule (Union[IResolvable, ObjectLockRuleProperty, None]) – CfnBucket.ObjectLockConfigurationProperty.Rule.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockconfiguration.html

Attributes

object_lock_enabled

CfnBucket.ObjectLockConfigurationProperty.ObjectLockEnabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockconfiguration.html#cfn-s3-bucket-objectlockconfiguration-objectlockenabled

Return type

Optional[str]

rule

CfnBucket.ObjectLockConfigurationProperty.Rule.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockconfiguration.html#cfn-s3-bucket-objectlockconfiguration-rule

Return type

Union[IResolvable, ObjectLockRuleProperty, None]

ObjectLockRuleProperty

class CfnBucket.ObjectLockRuleProperty(*, default_retention=None)

Bases: object

Parameters

default_retention (Union[IResolvable, DefaultRetentionProperty, None]) – CfnBucket.ObjectLockRuleProperty.DefaultRetention.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html

Attributes

default_retention

CfnBucket.ObjectLockRuleProperty.DefaultRetention.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html#cfn-s3-bucket-objectlockrule-defaultretention

Return type

Union[IResolvable, DefaultRetentionProperty, None]

OwnershipControlsProperty

class CfnBucket.OwnershipControlsProperty(*, rules)

Bases: object

Parameters

rules (Union[IResolvable, List[Union[IResolvable, OwnershipControlsRuleProperty]]]) – CfnBucket.OwnershipControlsProperty.Rules.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html

Attributes

rules

CfnBucket.OwnershipControlsProperty.Rules.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html#cfn-s3-bucket-ownershipcontrols-rules

Return type

Union[IResolvable, List[Union[IResolvable, OwnershipControlsRuleProperty]]]

OwnershipControlsRuleProperty

class CfnBucket.OwnershipControlsRuleProperty(*, object_ownership=None)

Bases: object

Parameters

object_ownership (Optional[str]) – CfnBucket.OwnershipControlsRuleProperty.ObjectOwnership.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrolsrule.html

Attributes

object_ownership

CfnBucket.OwnershipControlsRuleProperty.ObjectOwnership.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrolsrule.html#cfn-s3-bucket-ownershipcontrolsrule-objectownership

Return type

Optional[str]

PublicAccessBlockConfigurationProperty

class CfnBucket.PublicAccessBlockConfigurationProperty(*, block_public_acls=None, block_public_policy=None, ignore_public_acls=None, restrict_public_buckets=None)

Bases: object

Parameters
  • block_public_acls (Union[bool, IResolvable, None]) – CfnBucket.PublicAccessBlockConfigurationProperty.BlockPublicAcls.

  • block_public_policy (Union[bool, IResolvable, None]) – CfnBucket.PublicAccessBlockConfigurationProperty.BlockPublicPolicy.

  • ignore_public_acls (Union[bool, IResolvable, None]) – CfnBucket.PublicAccessBlockConfigurationProperty.IgnorePublicAcls.

  • restrict_public_buckets (Union[bool, IResolvable, None]) – CfnBucket.PublicAccessBlockConfigurationProperty.RestrictPublicBuckets.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html

Attributes

block_public_acls

CfnBucket.PublicAccessBlockConfigurationProperty.BlockPublicAcls.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html#cfn-s3-bucket-publicaccessblockconfiguration-blockpublicacls

Return type

Union[bool, IResolvable, None]

block_public_policy

CfnBucket.PublicAccessBlockConfigurationProperty.BlockPublicPolicy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html#cfn-s3-bucket-publicaccessblockconfiguration-blockpublicpolicy

Return type

Union[bool, IResolvable, None]

ignore_public_acls

CfnBucket.PublicAccessBlockConfigurationProperty.IgnorePublicAcls.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html#cfn-s3-bucket-publicaccessblockconfiguration-ignorepublicacls

Return type

Union[bool, IResolvable, None]

restrict_public_buckets

CfnBucket.PublicAccessBlockConfigurationProperty.RestrictPublicBuckets.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html#cfn-s3-bucket-publicaccessblockconfiguration-restrictpublicbuckets

Return type

Union[bool, IResolvable, None]

QueueConfigurationProperty

class CfnBucket.QueueConfigurationProperty(*, event, queue, filter=None)

Bases: object

Parameters
  • event (str) – CfnBucket.QueueConfigurationProperty.Event.

  • queue (str) – CfnBucket.QueueConfigurationProperty.Queue.

  • filter (Union[IResolvable, NotificationFilterProperty, None]) – CfnBucket.QueueConfigurationProperty.Filter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-queueconfig.html

Attributes

event

CfnBucket.QueueConfigurationProperty.Event.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-queueconfig.html#cfn-s3-bucket-notificationconfig-queueconfig-event

Return type

str

filter

CfnBucket.QueueConfigurationProperty.Filter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-queueconfig.html#cfn-s3-bucket-notificationconfig-queueconfig-filter

Return type

Union[IResolvable, NotificationFilterProperty, None]

queue

CfnBucket.QueueConfigurationProperty.Queue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-queueconfig.html#cfn-s3-bucket-notificationconfig-queueconfig-queue

Return type

str

RedirectAllRequestsToProperty

class CfnBucket.RedirectAllRequestsToProperty(*, host_name, protocol=None)

Bases: object

Parameters
  • host_name (str) – CfnBucket.RedirectAllRequestsToProperty.HostName.

  • protocol (Optional[str]) – CfnBucket.RedirectAllRequestsToProperty.Protocol.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-redirectallrequeststo.html

Attributes

host_name

CfnBucket.RedirectAllRequestsToProperty.HostName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-redirectallrequeststo.html#cfn-s3-websiteconfiguration-redirectallrequeststo-hostname

Return type

str

protocol

CfnBucket.RedirectAllRequestsToProperty.Protocol.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-redirectallrequeststo.html#cfn-s3-websiteconfiguration-redirectallrequeststo-protocol

Return type

Optional[str]

RedirectRuleProperty

class CfnBucket.RedirectRuleProperty(*, host_name=None, http_redirect_code=None, protocol=None, replace_key_prefix_with=None, replace_key_with=None)

Bases: object

Parameters
  • host_name (Optional[str]) – CfnBucket.RedirectRuleProperty.HostName.

  • http_redirect_code (Optional[str]) – CfnBucket.RedirectRuleProperty.HttpRedirectCode.

  • protocol (Optional[str]) – CfnBucket.RedirectRuleProperty.Protocol.

  • replace_key_prefix_with (Optional[str]) – CfnBucket.RedirectRuleProperty.ReplaceKeyPrefixWith.

  • replace_key_with (Optional[str]) – CfnBucket.RedirectRuleProperty.ReplaceKeyWith.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html

Attributes

host_name

CfnBucket.RedirectRuleProperty.HostName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-hostname

Return type

Optional[str]

http_redirect_code

CfnBucket.RedirectRuleProperty.HttpRedirectCode.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-httpredirectcode

Return type

Optional[str]

protocol

CfnBucket.RedirectRuleProperty.Protocol.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-protocol

Return type

Optional[str]

replace_key_prefix_with

CfnBucket.RedirectRuleProperty.ReplaceKeyPrefixWith.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-replacekeyprefixwith

Return type

Optional[str]

replace_key_with

CfnBucket.RedirectRuleProperty.ReplaceKeyWith.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-replacekeywith

Return type

Optional[str]

ReplicaModificationsProperty

class CfnBucket.ReplicaModificationsProperty(*, status)

Bases: object

Parameters

status (str) – CfnBucket.ReplicaModificationsProperty.Status.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicamodifications.html

Attributes

status

CfnBucket.ReplicaModificationsProperty.Status.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicamodifications.html#cfn-s3-bucket-replicamodifications-status

Return type

str

ReplicationConfigurationProperty

class CfnBucket.ReplicationConfigurationProperty(*, role, rules)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration.html

Attributes

role

CfnBucket.ReplicationConfigurationProperty.Role.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration.html#cfn-s3-bucket-replicationconfiguration-role

Return type

str

rules

CfnBucket.ReplicationConfigurationProperty.Rules.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration.html#cfn-s3-bucket-replicationconfiguration-rules

Return type

Union[IResolvable, List[Union[IResolvable, ReplicationRuleProperty]]]

ReplicationDestinationProperty

class CfnBucket.ReplicationDestinationProperty(*, bucket, access_control_translation=None, account=None, encryption_configuration=None, metrics=None, replication_time=None, storage_class=None)

Bases: object

Parameters
  • bucket (str) – CfnBucket.ReplicationDestinationProperty.Bucket.

  • access_control_translation (Union[IResolvable, AccessControlTranslationProperty, None]) – CfnBucket.ReplicationDestinationProperty.AccessControlTranslation.

  • account (Optional[str]) – CfnBucket.ReplicationDestinationProperty.Account.

  • encryption_configuration (Union[IResolvable, EncryptionConfigurationProperty, None]) – CfnBucket.ReplicationDestinationProperty.EncryptionConfiguration.

  • metrics (Union[IResolvable, MetricsProperty, None]) – CfnBucket.ReplicationDestinationProperty.Metrics.

  • replication_time (Union[IResolvable, ReplicationTimeProperty, None]) – CfnBucket.ReplicationDestinationProperty.ReplicationTime.

  • storage_class (Optional[str]) – CfnBucket.ReplicationDestinationProperty.StorageClass.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html

Attributes

access_control_translation

CfnBucket.ReplicationDestinationProperty.AccessControlTranslation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationdestination-accesscontroltranslation

Return type

Union[IResolvable, AccessControlTranslationProperty, None]

account

CfnBucket.ReplicationDestinationProperty.Account.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationdestination-account

Return type

Optional[str]

bucket

CfnBucket.ReplicationDestinationProperty.Bucket.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationconfiguration-rules-destination-bucket

Return type

str

encryption_configuration

CfnBucket.ReplicationDestinationProperty.EncryptionConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationdestination-encryptionconfiguration

Return type

Union[IResolvable, EncryptionConfigurationProperty, None]

metrics

CfnBucket.ReplicationDestinationProperty.Metrics.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationdestination-metrics

Return type

Union[IResolvable, MetricsProperty, None]

replication_time

CfnBucket.ReplicationDestinationProperty.ReplicationTime.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationdestination-replicationtime

Return type

Union[IResolvable, ReplicationTimeProperty, None]

storage_class

CfnBucket.ReplicationDestinationProperty.StorageClass.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationconfiguration-rules-destination-storageclass

Return type

Optional[str]

ReplicationRuleAndOperatorProperty

class CfnBucket.ReplicationRuleAndOperatorProperty(*, prefix=None, tag_filters=None)

Bases: object

Parameters
  • prefix (Optional[str]) – CfnBucket.ReplicationRuleAndOperatorProperty.Prefix.

  • tag_filters (Union[IResolvable, List[Union[IResolvable, TagFilterProperty]], None]) – CfnBucket.ReplicationRuleAndOperatorProperty.TagFilters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationruleandoperator.html

Attributes

prefix

CfnBucket.ReplicationRuleAndOperatorProperty.Prefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationruleandoperator.html#cfn-s3-bucket-replicationruleandoperator-prefix

Return type

Optional[str]

tag_filters

CfnBucket.ReplicationRuleAndOperatorProperty.TagFilters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationruleandoperator.html#cfn-s3-bucket-replicationruleandoperator-tagfilters

Return type

Union[IResolvable, List[Union[IResolvable, TagFilterProperty]], None]

ReplicationRuleFilterProperty

class CfnBucket.ReplicationRuleFilterProperty(*, and_=None, prefix=None, tag_filter=None)

Bases: object

Parameters
  • andCfnBucket.ReplicationRuleFilterProperty.And.

  • prefix (Optional[str]) – CfnBucket.ReplicationRuleFilterProperty.Prefix.

  • tag_filter (Union[IResolvable, TagFilterProperty, None]) – CfnBucket.ReplicationRuleFilterProperty.TagFilter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html

Attributes

and_

CfnBucket.ReplicationRuleFilterProperty.And.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html#cfn-s3-bucket-replicationrulefilter-and

Return type

Union[IResolvable, ReplicationRuleAndOperatorProperty, None]

prefix

CfnBucket.ReplicationRuleFilterProperty.Prefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html#cfn-s3-bucket-replicationrulefilter-prefix

Return type

Optional[str]

tag_filter

CfnBucket.ReplicationRuleFilterProperty.TagFilter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html#cfn-s3-bucket-replicationrulefilter-tagfilter

Return type

Union[IResolvable, TagFilterProperty, None]

ReplicationRuleProperty

class CfnBucket.ReplicationRuleProperty(*, destination, status, delete_marker_replication=None, filter=None, id=None, prefix=None, priority=None, source_selection_criteria=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html

Attributes

delete_marker_replication

CfnBucket.ReplicationRuleProperty.DeleteMarkerReplication.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationrule-deletemarkerreplication

Return type

Union[IResolvable, DeleteMarkerReplicationProperty, None]

destination

CfnBucket.ReplicationRuleProperty.Destination.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationconfiguration-rules-destination

Return type

Union[IResolvable, ReplicationDestinationProperty]

filter

CfnBucket.ReplicationRuleProperty.Filter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationrule-filter

Return type

Union[IResolvable, ReplicationRuleFilterProperty, None]

id

CfnBucket.ReplicationRuleProperty.Id.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationconfiguration-rules-id

Return type

Optional[str]

prefix

CfnBucket.ReplicationRuleProperty.Prefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationconfiguration-rules-prefix

Return type

Optional[str]

priority

CfnBucket.ReplicationRuleProperty.Priority.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationrule-priority

Return type

Union[int, float, None]

source_selection_criteria

CfnBucket.ReplicationRuleProperty.SourceSelectionCriteria.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationrule-sourceselectioncriteria

Return type

Union[IResolvable, SourceSelectionCriteriaProperty, None]

status

CfnBucket.ReplicationRuleProperty.Status.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationconfiguration-rules-status

Return type

str

ReplicationTimeProperty

class CfnBucket.ReplicationTimeProperty(*, status, time)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationtime.html

Attributes

status

CfnBucket.ReplicationTimeProperty.Status.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationtime.html#cfn-s3-bucket-replicationtime-status

Return type

str

time

CfnBucket.ReplicationTimeProperty.Time.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationtime.html#cfn-s3-bucket-replicationtime-time

Return type

Union[IResolvable, ReplicationTimeValueProperty]

ReplicationTimeValueProperty

class CfnBucket.ReplicationTimeValueProperty(*, minutes)

Bases: object

Parameters

minutes (Union[int, float]) – CfnBucket.ReplicationTimeValueProperty.Minutes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationtimevalue.html

Attributes

minutes

CfnBucket.ReplicationTimeValueProperty.Minutes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationtimevalue.html#cfn-s3-bucket-replicationtimevalue-minutes

Return type

Union[int, float]

RoutingRuleConditionProperty

class CfnBucket.RoutingRuleConditionProperty(*, http_error_code_returned_equals=None, key_prefix_equals=None)

Bases: object

Parameters
  • http_error_code_returned_equals (Optional[str]) – CfnBucket.RoutingRuleConditionProperty.HttpErrorCodeReturnedEquals.

  • key_prefix_equals (Optional[str]) – CfnBucket.RoutingRuleConditionProperty.KeyPrefixEquals.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-routingrulecondition.html

Attributes

http_error_code_returned_equals

CfnBucket.RoutingRuleConditionProperty.HttpErrorCodeReturnedEquals.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-routingrulecondition.html#cfn-s3-websiteconfiguration-routingrules-routingrulecondition-httperrorcodereturnedequals

Return type

Optional[str]

key_prefix_equals

CfnBucket.RoutingRuleConditionProperty.KeyPrefixEquals.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-routingrulecondition.html#cfn-s3-websiteconfiguration-routingrules-routingrulecondition-keyprefixequals

Return type

Optional[str]

RoutingRuleProperty

class CfnBucket.RoutingRuleProperty(*, redirect_rule, routing_rule_condition=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules.html

Attributes

redirect_rule

CfnBucket.RoutingRuleProperty.RedirectRule.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules.html#cfn-s3-websiteconfiguration-routingrules-redirectrule

Return type

Union[IResolvable, RedirectRuleProperty]

routing_rule_condition

CfnBucket.RoutingRuleProperty.RoutingRuleCondition.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules.html#cfn-s3-websiteconfiguration-routingrules-routingrulecondition

Return type

Union[IResolvable, RoutingRuleConditionProperty, None]

RuleProperty

class CfnBucket.RuleProperty(*, status, abort_incomplete_multipart_upload=None, expiration_date=None, expiration_in_days=None, id=None, noncurrent_version_expiration_in_days=None, noncurrent_version_transition=None, noncurrent_version_transitions=None, prefix=None, tag_filters=None, transition=None, transitions=None)

Bases: object

Parameters
Link

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

Attributes

abort_incomplete_multipart_upload

CfnBucket.RuleProperty.AbortIncompleteMultipartUpload.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-rule-abortincompletemultipartupload

Return type

Union[IResolvable, AbortIncompleteMultipartUploadProperty, None]

expiration_date

CfnBucket.RuleProperty.ExpirationDate.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-expirationdate

Return type

Union[IResolvable, datetime, None]

expiration_in_days

CfnBucket.RuleProperty.ExpirationInDays.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-expirationindays

Return type

Union[int, float, None]

id

CfnBucket.RuleProperty.Id.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-id

Return type

Optional[str]

noncurrent_version_expiration_in_days

CfnBucket.RuleProperty.NoncurrentVersionExpirationInDays.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversionexpirationindays

Return type

Union[int, float, None]

noncurrent_version_transition

CfnBucket.RuleProperty.NoncurrentVersionTransition.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition

Return type

Union[IResolvable, NoncurrentVersionTransitionProperty, None]

noncurrent_version_transitions

CfnBucket.RuleProperty.NoncurrentVersionTransitions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversiontransitions

Return type

Union[IResolvable, List[Union[IResolvable, NoncurrentVersionTransitionProperty]], None]

prefix

CfnBucket.RuleProperty.Prefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-prefix

Return type

Optional[str]

status

CfnBucket.RuleProperty.Status.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-status

Return type

str

tag_filters

CfnBucket.RuleProperty.TagFilters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-rule-tagfilters

Return type

Union[IResolvable, List[Union[IResolvable, TagFilterProperty]], None]

transition

CfnBucket.RuleProperty.Transition.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-transition

Return type

Union[IResolvable, TransitionProperty, None]

transitions

CfnBucket.RuleProperty.Transitions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-transitions

Return type

Union[IResolvable, List[Union[IResolvable, TransitionProperty]], None]

ServerSideEncryptionByDefaultProperty

class CfnBucket.ServerSideEncryptionByDefaultProperty(*, sse_algorithm, kms_master_key_id=None)

Bases: object

Parameters
  • sse_algorithm (str) – CfnBucket.ServerSideEncryptionByDefaultProperty.SSEAlgorithm.

  • kms_master_key_id (Optional[str]) – CfnBucket.ServerSideEncryptionByDefaultProperty.KMSMasterKeyID.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html

Attributes

kms_master_key_id

CfnBucket.ServerSideEncryptionByDefaultProperty.KMSMasterKeyID.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html#cfn-s3-bucket-serversideencryptionbydefault-kmsmasterkeyid

Return type

Optional[str]

sse_algorithm

CfnBucket.ServerSideEncryptionByDefaultProperty.SSEAlgorithm.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html#cfn-s3-bucket-serversideencryptionbydefault-ssealgorithm

Return type

str

ServerSideEncryptionRuleProperty

class CfnBucket.ServerSideEncryptionRuleProperty(*, bucket_key_enabled=None, server_side_encryption_by_default=None)

Bases: object

Parameters
  • bucket_key_enabled (Union[bool, IResolvable, None]) – CfnBucket.ServerSideEncryptionRuleProperty.BucketKeyEnabled.

  • server_side_encryption_by_default (Union[IResolvable, ServerSideEncryptionByDefaultProperty, None]) – CfnBucket.ServerSideEncryptionRuleProperty.ServerSideEncryptionByDefault.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionrule.html

Attributes

bucket_key_enabled

CfnBucket.ServerSideEncryptionRuleProperty.BucketKeyEnabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionrule.html#cfn-s3-bucket-serversideencryptionrule-bucketkeyenabled

Return type

Union[bool, IResolvable, None]

server_side_encryption_by_default

CfnBucket.ServerSideEncryptionRuleProperty.ServerSideEncryptionByDefault.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionrule.html#cfn-s3-bucket-serversideencryptionrule-serversideencryptionbydefault

Return type

Union[IResolvable, ServerSideEncryptionByDefaultProperty, None]

SourceSelectionCriteriaProperty

class CfnBucket.SourceSelectionCriteriaProperty(*, replica_modifications=None, sse_kms_encrypted_objects=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-sourceselectioncriteria.html

Attributes

replica_modifications

CfnBucket.SourceSelectionCriteriaProperty.ReplicaModifications.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-sourceselectioncriteria.html#cfn-s3-bucket-sourceselectioncriteria-replicamodifications

Return type

Union[IResolvable, ReplicaModificationsProperty, None]

sse_kms_encrypted_objects

CfnBucket.SourceSelectionCriteriaProperty.SseKmsEncryptedObjects.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-sourceselectioncriteria.html#cfn-s3-bucket-sourceselectioncriteria-ssekmsencryptedobjects

Return type

Union[IResolvable, SseKmsEncryptedObjectsProperty, None]

SseKmsEncryptedObjectsProperty

class CfnBucket.SseKmsEncryptedObjectsProperty(*, status)

Bases: object

Parameters

status (str) – CfnBucket.SseKmsEncryptedObjectsProperty.Status.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ssekmsencryptedobjects.html

Attributes

status

CfnBucket.SseKmsEncryptedObjectsProperty.Status.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ssekmsencryptedobjects.html#cfn-s3-bucket-ssekmsencryptedobjects-status

Return type

str

StorageClassAnalysisProperty

class CfnBucket.StorageClassAnalysisProperty(*, data_export=None)

Bases: object

Parameters

data_export (Union[IResolvable, DataExportProperty, None]) – CfnBucket.StorageClassAnalysisProperty.DataExport.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-storageclassanalysis.html

Attributes

data_export

CfnBucket.StorageClassAnalysisProperty.DataExport.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-storageclassanalysis.html#cfn-s3-bucket-storageclassanalysis-dataexport

Return type

Union[IResolvable, DataExportProperty, None]

TagFilterProperty

class CfnBucket.TagFilterProperty(*, key, value)

Bases: object

Parameters
  • key (str) – CfnBucket.TagFilterProperty.Key.

  • value (str) – CfnBucket.TagFilterProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tagfilter.html

Attributes

key

CfnBucket.TagFilterProperty.Key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tagfilter.html#cfn-s3-bucket-tagfilter-key

Return type

str

value

CfnBucket.TagFilterProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tagfilter.html#cfn-s3-bucket-tagfilter-value

Return type

str

TieringProperty

class CfnBucket.TieringProperty(*, access_tier, days)

Bases: object

Parameters
  • access_tier (str) – CfnBucket.TieringProperty.AccessTier.

  • days (Union[int, float]) – CfnBucket.TieringProperty.Days.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tiering.html

Attributes

access_tier

CfnBucket.TieringProperty.AccessTier.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tiering.html#cfn-s3-bucket-tiering-accesstier

Return type

str

days

CfnBucket.TieringProperty.Days.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tiering.html#cfn-s3-bucket-tiering-days

Return type

Union[int, float]

TopicConfigurationProperty

class CfnBucket.TopicConfigurationProperty(*, event, topic, filter=None)

Bases: object

Parameters
  • event (str) – CfnBucket.TopicConfigurationProperty.Event.

  • topic (str) – CfnBucket.TopicConfigurationProperty.Topic.

  • filter (Union[IResolvable, NotificationFilterProperty, None]) – CfnBucket.TopicConfigurationProperty.Filter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-topicconfig.html

Attributes

event

CfnBucket.TopicConfigurationProperty.Event.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-topicconfig.html#cfn-s3-bucket-notificationconfig-topicconfig-event

Return type

str

filter

CfnBucket.TopicConfigurationProperty.Filter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-topicconfig.html#cfn-s3-bucket-notificationconfig-topicconfig-filter

Return type

Union[IResolvable, NotificationFilterProperty, None]

topic

CfnBucket.TopicConfigurationProperty.Topic.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-topicconfig.html#cfn-s3-bucket-notificationconfig-topicconfig-topic

Return type

str

TransitionProperty

class CfnBucket.TransitionProperty(*, storage_class, transition_date=None, transition_in_days=None)

Bases: object

Parameters
  • storage_class (str) – CfnBucket.TransitionProperty.StorageClass.

  • transition_date (Union[IResolvable, datetime, None]) – CfnBucket.TransitionProperty.TransitionDate.

  • transition_in_days (Union[int, float, None]) – CfnBucket.TransitionProperty.TransitionInDays.

Link

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

Attributes

storage_class

CfnBucket.TransitionProperty.StorageClass.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-transition.html#cfn-s3-bucket-lifecycleconfig-rule-transition-storageclass

Return type

str

transition_date

CfnBucket.TransitionProperty.TransitionDate.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-transition.html#cfn-s3-bucket-lifecycleconfig-rule-transition-transitiondate

Return type

Union[IResolvable, datetime, None]

transition_in_days

CfnBucket.TransitionProperty.TransitionInDays.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-transition.html#cfn-s3-bucket-lifecycleconfig-rule-transition-transitionindays

Return type

Union[int, float, None]

VersioningConfigurationProperty

class CfnBucket.VersioningConfigurationProperty(*, status)

Bases: object

Parameters

status (str) – CfnBucket.VersioningConfigurationProperty.Status.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-versioningconfig.html

Attributes

status

CfnBucket.VersioningConfigurationProperty.Status.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-versioningconfig.html#cfn-s3-bucket-versioningconfig-status

Return type

str

WebsiteConfigurationProperty

class CfnBucket.WebsiteConfigurationProperty(*, error_document=None, index_document=None, redirect_all_requests_to=None, routing_rules=None)

Bases: object

Parameters
  • error_document (Optional[str]) – CfnBucket.WebsiteConfigurationProperty.ErrorDocument.

  • index_document (Optional[str]) – CfnBucket.WebsiteConfigurationProperty.IndexDocument.

  • redirect_all_requests_to (Union[IResolvable, RedirectAllRequestsToProperty, None]) – CfnBucket.WebsiteConfigurationProperty.RedirectAllRequestsTo.

  • routing_rules (Union[IResolvable, List[Union[IResolvable, RoutingRuleProperty]], None]) – CfnBucket.WebsiteConfigurationProperty.RoutingRules.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration.html

Attributes

error_document

CfnBucket.WebsiteConfigurationProperty.ErrorDocument.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration.html#cfn-s3-websiteconfiguration-errordocument

Return type

Optional[str]

index_document

CfnBucket.WebsiteConfigurationProperty.IndexDocument.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration.html#cfn-s3-websiteconfiguration-indexdocument

Return type

Optional[str]

redirect_all_requests_to

CfnBucket.WebsiteConfigurationProperty.RedirectAllRequestsTo.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration.html#cfn-s3-websiteconfiguration-redirectallrequeststo

Return type

Union[IResolvable, RedirectAllRequestsToProperty, None]

routing_rules

CfnBucket.WebsiteConfigurationProperty.RoutingRules.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration.html#cfn-s3-websiteconfiguration-routingrules

Return type

Union[IResolvable, List[Union[IResolvable, RoutingRuleProperty]], None]