Bucket class

The set of arguments for constructing a Bucket resource.

Constructors

Bucket({Input<String?>? accelerationStatus, Input<String?>? acl, Input<String?>? bucket, Input<String?>? bucketNamespace, Input<String?>? bucketPrefix, Input<List<BucketCorsRule>?>? corsRules, Input<bool?>? forceDestroy, Input<List<BucketGrant>?>? grants, Input<List<BucketLifecycleRule>?>? lifecycleRules, Input<BucketLogging?>? logging, Input<BucketObjectLockConfiguration?>? objectLockConfiguration, Input<bool?>? objectLockEnabled, Input<String?>? policy, Input<String?>? region, Input<BucketReplicationConfiguration?>? replicationConfiguration, Input<String?>? requestPayer, Input<BucketServerSideEncryptionConfiguration?>? serverSideEncryptionConfiguration, Input<Map<String, String>?>? tags, Input<BucketVersioning?>? versioning, Input<BucketWebsite?>? website})
Creates a new Bucket. accelerationStatus Sets the accelerate configuration of an existing bucket. Can be Enabled or Suspended. Cannot be used in cn-north-1 or us-gov-west-1. This provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketAccelerateConfiguration instead. acl Canned ACL to apply. Valid values are private, public-read, public-read-write, aws-exec-read, authenticated-read, and log-delivery-write. Defaults to private. Conflicts with grant. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketAcl instead. bucket Name of the bucket. If omitted, the provider will assign a random, unique name. Must be lowercase and less than or equal to 63 characters in length. A full list of bucket naming rules may be found here. The name must not be in the format [bucketName]--[azid]--x-s3. Use the aws.s3.DirectoryBucket resource to manage S3 Express buckets. bucketNamespace Namespace for the bucket. Determines bucket naming scope. Valid values: account-regional, global. Defaults to global (AWS). bucketPrefix Creates a unique bucket name beginning with the specified prefix. Conflicts with bucket. Must be lowercase and less than or equal to 37 characters in length. A full list of bucket naming rules may be found here. corsRules Rule of Cross-Origin Resource Sharing. See corsRule Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketCorsConfiguration instead. forceDestroy Boolean that indicates all objects (including any locked objects) should be deleted from the bucket when the bucket is destroyed so that the bucket can be destroyed without error. These objects are not recoverable. This only deletes objects when the bucket is destroyed, not when setting this parameter to true. Once this parameter is set to true, there must be a successful pulumi up run before a destroy is required to update this value in the resource state. Without a successful pulumi up after this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the bucket or destroying the bucket, this flag will not work. Additionally when importing a bucket, a successful pulumi up is required to set this value in state before it will take effect on a destroy operation. grants ACL policy grant. See grant Block below for details. Conflicts with acl. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketAcl instead. lifecycleRules Configuration of object lifecycle management. See lifecycleRule Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketLifecycleConfiguration instead. logging Configuration of S3 bucket logging parameters. See logging Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketLogging instead. objectLockConfiguration Configuration of S3 object locking. See objectLockConfiguration Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the objectLockEnabled parameter and the resource aws.s3.BucketObjectLockConfiguration instead. objectLockEnabled Whether this bucket has an Object Lock configuration enabled. Valid values are true or false. This argument is not supported in all regions or partitions. policy Valid bucket policy JSON document. Note that if the policy document is not specific enough (but still valid), this provider may view the policy as constantly changing. In this case, please make sure you use the verbose/specific version of the policy. For more information about building AWS IAM policy documents with this provider, see the AWS IAM Policy Document Guide. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketPolicy instead. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. replicationConfiguration Configuration of replication configuration. See replicationConfiguration Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketReplicationConfig instead. requestPayer Who should bear the cost of Amazon S3 data transfer. Can be either BucketOwner or Requester. By default, the owner of the S3 bucket would incur the costs of any data transfer. See Requester Pays Buckets developer guide for more information. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketRequestPaymentConfiguration instead. serverSideEncryptionConfiguration Configuration of server-side encryption configuration. See serverSideEncryptionConfiguration Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketServerSideEncryptionConfiguration instead. tags Map of tags to assign to the bucket. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. versioning Configuration of the S3 bucket versioning state. See versioning Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketVersioning instead. website Configuration of the S3 bucket website. See website Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketWebsiteConfiguration instead.
const
Bucket.fromMap(Map<String, dynamic> map)
factory

Properties

accelerationStatus → Input<String?>?
Sets the accelerate configuration of an existing bucket. Can be Enabled or Suspended. Cannot be used in cn-north-1 or us-gov-west-1. This provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketAccelerateConfiguration instead.
final
acl → Input<String?>?
Canned ACL to apply. Valid values are private, public-read, public-read-write, aws-exec-read, authenticated-read, and log-delivery-write. Defaults to private. Conflicts with grant. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketAcl instead.
final
bucket → Input<String?>?
Name of the bucket. If omitted, the provider will assign a random, unique name. Must be lowercase and less than or equal to 63 characters in length. A full list of bucket naming rules may be found here. The name must not be in the format [bucketName]--[azid]--x-s3. Use the aws.s3.DirectoryBucket resource to manage S3 Express buckets.
final
bucketNamespace → Input<String?>?
Namespace for the bucket. Determines bucket naming scope. Valid values: account-regional, global. Defaults to global (AWS).
final
bucketPrefix → Input<String?>?
Creates a unique bucket name beginning with the specified prefix. Conflicts with bucket. Must be lowercase and less than or equal to 37 characters in length. A full list of bucket naming rules may be found here.
final
corsRules → Input<List<BucketCorsRule>?>?
Rule of Cross-Origin Resource Sharing. See corsRule Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketCorsConfiguration instead.
final
forceDestroy → Input<bool?>?
Boolean that indicates all objects (including any locked objects) should be deleted from the bucket when the bucket is destroyed so that the bucket can be destroyed without error. These objects are not recoverable. This only deletes objects when the bucket is destroyed, not when setting this parameter to true. Once this parameter is set to true, there must be a successful pulumi up run before a destroy is required to update this value in the resource state. Without a successful pulumi up after this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the bucket or destroying the bucket, this flag will not work. Additionally when importing a bucket, a successful pulumi up is required to set this value in state before it will take effect on a destroy operation.
final
grants → Input<List<BucketGrant>?>?
ACL policy grant. See grant Block below for details. Conflicts with acl. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketAcl instead.
final
hashCode → int
The hash code for this object.
no setterinherited
lifecycleRules → Input<List<BucketLifecycleRule>?>?
Configuration of object lifecycle management. See lifecycleRule Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketLifecycleConfiguration instead.
final
logging → Input<BucketLogging?>?
Configuration of S3 bucket logging parameters. See logging Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketLogging instead.
final
objectLockConfiguration → Input<BucketObjectLockConfiguration?>?
Configuration of S3 object locking. See objectLockConfiguration Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the objectLockEnabled parameter and the resource aws.s3.BucketObjectLockConfiguration instead.
final
objectLockEnabled → Input<bool?>?
Whether this bucket has an Object Lock configuration enabled. Valid values are true or false. This argument is not supported in all regions or partitions.
final
policy → Input<String?>?
Valid bucket policy JSON document. Note that if the policy document is not specific enough (but still valid), this provider may view the policy as constantly changing. In this case, please make sure you use the verbose/specific version of the policy. For more information about building AWS IAM policy documents with this provider, see the AWS IAM Policy Document Guide. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketPolicy instead.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
replicationConfiguration → Input<BucketReplicationConfiguration?>?
Configuration of replication configuration. See replicationConfiguration Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketReplicationConfig instead.
final
requestPayer → Input<String?>?
Who should bear the cost of Amazon S3 data transfer. Can be either BucketOwner or Requester. By default, the owner of the S3 bucket would incur the costs of any data transfer. See Requester Pays Buckets developer guide for more information. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketRequestPaymentConfiguration instead.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serverSideEncryptionConfiguration → Input<BucketServerSideEncryptionConfiguration?>?
Configuration of server-side encryption configuration. See serverSideEncryptionConfiguration Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketServerSideEncryptionConfiguration instead.
final
tags → Input<Map<String, String>?>?
Map of tags to assign to the bucket. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
versioning → Input<BucketVersioning?>?
Configuration of the S3 bucket versioning state. See versioning Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketVersioning instead.
final
website → Input<BucketWebsite?>?
Configuration of the S3 bucket website. See website Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource aws.s3.BucketWebsiteConfiguration instead.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited