Package software.amazon.awscdk.cfnpropertymixins.services.s3

Class CfnBucketMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.s3.CfnBucketMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnBucketMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnBucketMixinProps

@Stability(Stable)
@Internal
public static final class CfnBucketMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnBucketMixinProps

An implementation for CfnBucketMixinProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.s3.CfnBucketMixinProps

CfnBucketMixinProps.Builder, CfnBucketMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnBucketMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnBucketMixinProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getAbacStatus()	The ABAC status of the general purpose bucket.
final Object	getAccelerateConfiguration()	Configures the transfer acceleration state for an Amazon S3 bucket.
final String	getAccessControl()
final Object	getAnalyticsConfigurations()	Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
final Object	getBucketEncryption()	Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS).
final String	getBucketName()	A name for the bucket.
final Object	getCorsConfiguration()	Describes the cross-origin access configuration for objects in an Amazon S3 bucket.
final Object	getIntelligentTieringConfigurations()	Defines how Amazon S3 handles Intelligent-Tiering storage.
final Object	getInventoryConfigurations()	Specifies the S3 Inventory configuration for an Amazon S3 bucket.
final Object	getLifecycleConfiguration()	Specifies the lifecycle configuration for objects in an Amazon S3 bucket.
final Object	getLoggingConfiguration()	Settings that define where logs are stored.
final Object	getMetadataConfiguration()	The S3 Metadata configuration for a general purpose bucket.
final Object	getMetadataTableConfiguration()	The metadata table configuration of an Amazon S3 general purpose bucket.
final Object	getMetricsConfigurations()	Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket.
final Object	getNotificationConfiguration()	Configuration that defines how Amazon S3 handles bucket notifications.
final Object	getObjectLockConfiguration()
final Object	getObjectLockEnabled()	Indicates whether this bucket has an Object Lock configuration enabled.
final Object	getOwnershipControls()	Configuration that defines how Amazon S3 handles Object Ownership rules.
final Object	getPublicAccessBlockConfiguration()	Configuration that defines how Amazon S3 handles public access.
final Object	getReplicationConfiguration()	Configuration for replicating objects in an S3 bucket.
final List<CfnTag>	getTags()	An arbitrary set of tags (key-value pairs) for this S3 bucket.
final Object	getVersioningConfiguration()	Enables multiple versions of all objects in this bucket.
final Object	getWebsiteConfiguration()	Information used to configure the bucket as a static website.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnBucketMixinProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnBucketMixinProps.Builder.

Method Details

getAbacStatus

public final String getAbacStatus()

Description copied from interface: CfnBucketMixinProps

The ABAC status of the general purpose bucket.

When ABAC is enabled for the general purpose bucket, you can use tags to manage access to the general purpose buckets as well as for cost tracking purposes. When ABAC is disabled for the general purpose buckets, you can only use tags for cost tracking purposes. For more information, see Using tags with S3 general purpose buckets .

Specified by:

getAbacStatus in interface CfnBucketMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-abacstatus

getAccelerateConfiguration

public final Object getAccelerateConfiguration()

Description copied from interface: CfnBucketMixinProps

Configures the transfer acceleration state for an Amazon S3 bucket.

For more information, see Amazon S3 Transfer Acceleration in the Amazon S3 User Guide .

Returns union: either IResolvable or CfnBucketPropsMixin.AccelerateConfigurationProperty

Specified by:

getAccelerateConfiguration in interface CfnBucketMixinProps

See Also:

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

getAccessControl

public final String getAccessControl()

Description copied from interface: CfnBucketMixinProps

This is a legacy property, and it is not recommended for most use cases.

A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see Controlling object ownership in the Amazon S3 User Guide .

A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see Canned ACL in the Amazon S3 User Guide .

S3 buckets are created with ACLs disabled by default. Therefore, unless you explicitly set the AWS::S3::OwnershipControls property to enable ACLs, your resource will fail to deploy with any value other than Private. Use cases requiring ACLs are uncommon.

The majority of access control configurations can be successfully and more easily achieved with bucket policies. For more information, see AWS::S3::BucketPolicy . For examples of common policy configurations, including S3 Server Access Logs buckets and more, see Bucket policy examples in the Amazon S3 User Guide .

Specified by:

getAccessControl in interface CfnBucketMixinProps

See Also:

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

getAnalyticsConfigurations

public final Object getAnalyticsConfigurations()

Description copied from interface: CfnBucketMixinProps

Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnBucketPropsMixin.AnalyticsConfigurationProperty>

Specified by:

getAnalyticsConfigurations in interface CfnBucketMixinProps

See Also:

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

getBucketEncryption

public final Object getBucketEncryption()

Description copied from interface: CfnBucketMixinProps

Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS).

For information about the Amazon S3 default encryption feature, see Amazon S3 Default Encryption for S3 Buckets in the Amazon S3 User Guide .

Returns union: either IResolvable or CfnBucketPropsMixin.BucketEncryptionProperty

Specified by:

getBucketEncryption in interface CfnBucketMixinProps

See Also:

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

getBucketName

public final String getBucketName()

Description copied from interface: CfnBucketMixinProps

A name for the 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 Rules for naming Amazon S3 buckets in the Amazon S3 User Guide .

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.

Specified by:

getBucketName in interface CfnBucketMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-bucketname

getCorsConfiguration

public final Object getCorsConfiguration()

Description copied from interface: CfnBucketMixinProps

Describes the cross-origin access configuration for objects in an Amazon S3 bucket.

For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide .

Returns union: either IResolvable or CfnBucketPropsMixin.CorsConfigurationProperty

Specified by:

getCorsConfiguration in interface CfnBucketMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-corsconfiguration

getIntelligentTieringConfigurations

public final Object getIntelligentTieringConfigurations()

Description copied from interface: CfnBucketMixinProps

Defines how Amazon S3 handles Intelligent-Tiering storage.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnBucketPropsMixin.IntelligentTieringConfigurationProperty>

Specified by:

getIntelligentTieringConfigurations in interface CfnBucketMixinProps

See Also:

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

getInventoryConfigurations

public final Object getInventoryConfigurations()

Description copied from interface: CfnBucketMixinProps

Specifies the S3 Inventory configuration for an Amazon S3 bucket.

For more information, see GET Bucket inventory in the Amazon S3 API Reference .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnBucketPropsMixin.InventoryConfigurationProperty>

Specified by:

getInventoryConfigurations in interface CfnBucketMixinProps

See Also:

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

getLifecycleConfiguration

public final Object getLifecycleConfiguration()

Description copied from interface: CfnBucketMixinProps

Specifies the lifecycle configuration for objects in an Amazon S3 bucket.

For more information, see Object Lifecycle Management in the Amazon S3 User Guide .

Returns union: either IResolvable or CfnBucketPropsMixin.LifecycleConfigurationProperty

Specified by:

getLifecycleConfiguration in interface CfnBucketMixinProps

See Also:

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

getLoggingConfiguration

public final Object getLoggingConfiguration()

Description copied from interface: CfnBucketMixinProps

Settings that define where logs are stored.

Returns union: either IResolvable or CfnBucketPropsMixin.LoggingConfigurationProperty

Specified by:

getLoggingConfiguration in interface CfnBucketMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-loggingconfiguration

getMetadataConfiguration

public final Object getMetadataConfiguration()

Description copied from interface: CfnBucketMixinProps

The S3 Metadata configuration for a general purpose bucket.

Returns union: either IResolvable or CfnBucketPropsMixin.MetadataConfigurationProperty

Specified by:

getMetadataConfiguration in interface CfnBucketMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-metadataconfiguration

getMetadataTableConfiguration

public final Object getMetadataTableConfiguration()

Description copied from interface: CfnBucketMixinProps

The metadata table configuration of an Amazon S3 general purpose bucket.

Returns union: either IResolvable or CfnBucketPropsMixin.MetadataTableConfigurationProperty

Specified by:

getMetadataTableConfiguration in interface CfnBucketMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-metadatatableconfiguration

getMetricsConfigurations

public final Object getMetricsConfigurations()

Description copied from interface: CfnBucketMixinProps

Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket.

If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see PutBucketMetricsConfiguration .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnBucketPropsMixin.MetricsConfigurationProperty>

Specified by:

getMetricsConfigurations in interface CfnBucketMixinProps

See Also:

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

getNotificationConfiguration

public final Object getNotificationConfiguration()

Description copied from interface: CfnBucketMixinProps

Configuration that defines how Amazon S3 handles bucket notifications.

Returns union: either IResolvable or CfnBucketPropsMixin.NotificationConfigurationProperty

Specified by:

getNotificationConfiguration in interface CfnBucketMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-notificationconfiguration

getObjectLockConfiguration

public final Object getObjectLockConfiguration()

Description copied from interface: CfnBucketMixinProps

This operation is not supported for directory buckets.

Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects .

• The DefaultRetention settings require both a mode and a period.
• The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.
• You can enable Object Lock for new or existing buckets. For more information, see Configuring Object Lock . > You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt , containing two spaces after my , you must URL encode this value to my%20%20file.txt .

Returns union: either IResolvable or CfnBucketPropsMixin.ObjectLockConfigurationProperty

Specified by:

getObjectLockConfiguration in interface CfnBucketMixinProps

See Also:

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

getObjectLockEnabled

public final Object getObjectLockEnabled()

Description copied from interface: CfnBucketMixinProps

Indicates whether this bucket has an Object Lock configuration enabled.

Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

Returns union: either Boolean or IResolvable

Specified by:

getObjectLockEnabled in interface CfnBucketMixinProps

See Also:

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

getOwnershipControls

public final Object getOwnershipControls()

Description copied from interface: CfnBucketMixinProps

Configuration that defines how Amazon S3 handles Object Ownership rules.

Returns union: either IResolvable or CfnBucketPropsMixin.OwnershipControlsProperty

Specified by:

getOwnershipControls in interface CfnBucketMixinProps

See Also:

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

getPublicAccessBlockConfiguration

public final Object getPublicAccessBlockConfiguration()

Description copied from interface: CfnBucketMixinProps

Configuration that defines how Amazon S3 handles public access.

Returns union: either IResolvable or CfnBucketPropsMixin.PublicAccessBlockConfigurationProperty

Specified by:

getPublicAccessBlockConfiguration in interface CfnBucketMixinProps

See Also:

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

getReplicationConfiguration

public final Object getReplicationConfiguration()

Description copied from interface: CfnBucketMixinProps

Configuration for replicating objects in an S3 bucket.

To enable replication, you must also enable versioning by using the VersioningConfiguration property.

Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist.

Returns union: either IResolvable or CfnBucketPropsMixin.ReplicationConfigurationProperty

Specified by:

getReplicationConfiguration in interface CfnBucketMixinProps

See Also:

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

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnBucketMixinProps

An arbitrary set of tags (key-value pairs) for this S3 bucket.

Specified by:

getTags in interface CfnBucketMixinProps

See Also:

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

getVersioningConfiguration

public final Object getVersioningConfiguration()

Description copied from interface: CfnBucketMixinProps

Enables multiple versions of all objects in this bucket.

You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them.

When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations ( PUT or DELETE ) on objects in the bucket.

Returns union: either IResolvable or CfnBucketPropsMixin.VersioningConfigurationProperty

Specified by:

getVersioningConfiguration in interface CfnBucketMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-versioningconfiguration

getWebsiteConfiguration

public final Object getWebsiteConfiguration()

Description copied from interface: CfnBucketMixinProps

Information used to configure the bucket as a static website.

For more information, see Hosting Websites on Amazon S3 .

Returns union: either IResolvable or CfnBucketPropsMixin.WebsiteConfigurationProperty

Specified by:

getWebsiteConfiguration in interface CfnBucketMixinProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object