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< ? corsRules, Input<BucketCorsRule> ?>bool?> ? forceDestroy, Input<List< ? grants, Input<BucketGrant> ?>List< ? lifecycleRules, Input<BucketLifecycleRule> ?>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< ? tags, Input<String, String> ?>BucketVersioning?> ? versioning, Input<BucketWebsite?> ? website}) -
Creates a new Bucket.
accelerationStatusSets the accelerate configuration of an existing bucket. Can beEnabledorSuspended. Cannot be used incn-north-1orus-gov-west-1. This provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketAccelerateConfigurationinstead. acl Canned ACL to apply. Valid values areprivate,public-read,public-read-write,aws-exec-read,authenticated-read, andlog-delivery-write. Defaults toprivate. Conflicts withgrant. The provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketAclinstead.bucketName 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 theaws.s3.DirectoryBucketresource to manage S3 Express buckets.bucketNamespaceNamespace for the bucket. Determines bucket naming scope. Valid values:account-regional,global. Defaults toglobal(AWS).bucketPrefixCreates a unique bucket name beginning with the specified prefix. Conflicts withbucket. Must be lowercase and less than or equal to 37 characters in length. A full list of bucket naming rules may be found here.corsRulesRule of Cross-Origin Resource Sharing. SeecorsRuleBlock below for details. The provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketCorsConfigurationinstead.forceDestroyBoolean 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 totrue. Once this parameter is set totrue, there must be a successfulpulumi uprun before a destroy is required to update this value in the resource state. Without a successfulpulumi upafter 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 successfulpulumi upis required to set this value in state before it will take effect on a destroy operation. grants ACL policy grant. SeegrantBlock below for details. Conflicts withacl. The provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketAclinstead.lifecycleRulesConfiguration of object lifecycle management. SeelifecycleRuleBlock below for details. The provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketLifecycleConfigurationinstead.loggingConfiguration of S3 bucket logging parameters. SeeloggingBlock below for details. The provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketLogginginstead.objectLockConfigurationConfiguration of S3 object locking. SeeobjectLockConfigurationBlock below for details. The provider will only perform drift detection if a configuration value is provided. Use theobjectLockEnabledparameter and the resourceaws.s3.BucketObjectLockConfigurationinstead.objectLockEnabledWhether this bucket has an Object Lock configuration enabled. Valid values aretrueorfalse. This argument is not supported in all regions or partitions.policyValid 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 resourceaws.s3.BucketPolicyinstead.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.replicationConfigurationConfiguration of replication configuration. SeereplicationConfigurationBlock below for details. The provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketReplicationConfiginstead.requestPayerWho should bear the cost of Amazon S3 data transfer. Can be eitherBucketOwnerorRequester. 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 resourceaws.s3.BucketRequestPaymentConfigurationinstead.serverSideEncryptionConfigurationConfiguration of server-side encryption configuration. SeeserverSideEncryptionConfigurationBlock below for details. The provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketServerSideEncryptionConfigurationinstead.tagsMap of tags to assign to the bucket. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.versioningConfiguration of the S3 bucket versioning state. SeeversioningBlock below for details. The provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketVersioninginstead.websiteConfiguration of the S3 bucket website. SeewebsiteBlock below for details. The provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketWebsiteConfigurationinstead.const -
Bucket.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
accelerationStatus
→ Input<
String?> ? -
Sets the accelerate configuration of an existing bucket. Can be
EnabledorSuspended. Cannot be used incn-north-1orus-gov-west-1. This provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketAccelerateConfigurationinstead.final -
acl
→ Input<
String?> ? -
Canned ACL to apply. Valid values are
private,public-read,public-read-write,aws-exec-read,authenticated-read, andlog-delivery-write. Defaults toprivate. Conflicts withgrant. The provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketAclinstead.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 theaws.s3.DirectoryBucketresource to manage S3 Express buckets.final -
bucketNamespace
→ Input<
String?> ? -
Namespace for the bucket. Determines bucket naming scope. Valid values:
account-regional,global. Defaults toglobal(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
corsRuleBlock below for details. The provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketCorsConfigurationinstead.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 totrue, there must be a successfulpulumi uprun before a destroy is required to update this value in the resource state. Without a successfulpulumi upafter 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 successfulpulumi upis 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
grantBlock below for details. Conflicts withacl. The provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketAclinstead.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
lifecycleRules
→ Input<
List< ?BucketLifecycleRule> ?> -
Configuration of object lifecycle management. See
lifecycleRuleBlock below for details. The provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketLifecycleConfigurationinstead.final -
logging
→ Input<
BucketLogging?> ? -
Configuration of S3 bucket logging parameters. See
loggingBlock below for details. The provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketLogginginstead.final -
objectLockConfiguration
→ Input<
BucketObjectLockConfiguration?> ? -
Configuration of S3 object locking. See
objectLockConfigurationBlock below for details. The provider will only perform drift detection if a configuration value is provided. Use theobjectLockEnabledparameter and the resourceaws.s3.BucketObjectLockConfigurationinstead.final -
objectLockEnabled
→ Input<
bool?> ? -
Whether this bucket has an Object Lock configuration enabled. Valid values are
trueorfalse. 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.BucketPolicyinstead.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
replicationConfigurationBlock below for details. The provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketReplicationConfiginstead.final -
requestPayer
→ Input<
String?> ? -
Who should bear the cost of Amazon S3 data transfer. Can be either
BucketOwnerorRequester. 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 resourceaws.s3.BucketRequestPaymentConfigurationinstead.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
serverSideEncryptionConfiguration
→ Input<
BucketServerSideEncryptionConfiguration?> ? -
Configuration of server-side encryption configuration. See
serverSideEncryptionConfigurationBlock below for details. The provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketServerSideEncryptionConfigurationinstead.final -
Map of tags to assign to the bucket. If configured with a provider
defaultTagsconfiguration 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
versioningBlock below for details. The provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketVersioninginstead.final -
website
→ Input<
BucketWebsite?> ? -
Configuration of the S3 bucket website. See
websiteBlock below for details. The provider will only perform drift detection if a configuration value is provided. Use the resourceaws.s3.BucketWebsiteConfigurationinstead.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