diff --git a/docs/_index.md b/docs/_index.md index 915059cfc83..f5411ed87d3 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -19,7 +19,7 @@ The AWS provider must be configured with credentials to deploy and update resour ```typescript const aws = require("@pulumi/aws"); -const bucket = new aws.s3.BucketV2("mybucket"); +const bucket = new aws.s3.Bucket("mybucket"); ``` {{% /choosable %}} @@ -30,7 +30,7 @@ const bucket = new aws.s3.BucketV2("mybucket"); import pulumi import pulumi_aws as aws -bucket = aws.s3.BucketV2("bucket") +bucket = aws.s3.Bucket("bucket") ``` {{% /choosable %}} @@ -47,7 +47,7 @@ import ( func main() { pulumi.Run(func(ctx *pulumi.Context) error { - _, err := s3.NewBucketV2(ctx, "bucket", &s3.BucketV2Args{}) + _, err := s3.NewBucket(ctx, "bucket", &s3.BucketArgs{}) if err != nil { return err } @@ -67,7 +67,7 @@ using Aws = Pulumi.Aws; await Deployment.RunAsync(() => { - var bucket = new Aws.S3.BucketV2("bucket"); + var bucket = new Aws.S3.Bucket("bucket"); }); ``` @@ -86,7 +86,7 @@ public class App { } private static void stack(Context ctx) { - final var bucket = new BucketV2("my-bucket"); + final var bucket = new Bucket("my-bucket"); ctx.export("bucketName", bucket.name()); } } @@ -99,7 +99,7 @@ public class App { ```yaml resources: mybucket: - type: aws:s3:BucketV2 + type: aws:s3:Bucket outputs: bucketName: ${mybucket.name} ``` diff --git a/docs/resource/aws_s3_bucket_legacy.md b/docs/resource/aws_s3_bucket_legacy.md deleted file mode 100644 index 022b34023ac..00000000000 --- a/docs/resource/aws_s3_bucket_legacy.md +++ /dev/null @@ -1,578 +0,0 @@ ---- -subcategory: "S3" -layout: "aws" -page_title: "AWS: aws_s3_bucket" -description: |- -Provides a S3 bucket resource. ---- - -# Resource: aws.s3.Bucket - -Provides a S3 bucket resource. - --> **NOTE:** Please use [aws.s3.BucketV2](https://www.pulumi.com/registry/packages/aws/api-docs/s3/bucketv2) instead. -This resource is maintained for backwards compatibility only. Please see [BucketV2 Migration -Guide](https://www.pulumi.com/registry/packages/aws/how-to-guides/bucketv2-migration/) for instructions on migrating -existing Bucket resources to BucketV2. - -## Example Usage - -### Private Bucket w/ Tags - -```terraform -resource "aws_s3_bucket_legacy" "b" { - bucket = "my-tf-test-bucket" - acl = "private" - - tags = { - Name = "My bucket" - Environment = "Dev" - } -} -``` - -### Static Website Hosting - -```terraform -resource "aws_s3_bucket_legacy" "b" { - bucket = "s3-website-test.mydomain.com" - acl = "public-read" - policy = file("policy.json") - - website { - index_document = "index.html" - error_document = "error.html" - - routing_rules = < **NOTE:** See the `aws_s3_bucket_replication_configuration` resource to support bi-directional replication configuration and additional features. - -```terraform -provider "aws" { - region = "eu-west-1" -} - -provider "aws" { - alias = "central" - region = "eu-central-1" -} - -resource "aws_iam_role" "replication" { - name = "tf-iam-role-replication-12345" - - assume_role_policy = < **NOTE:** You cannot use `acceleration_status` in `cn-north-1` or `us-gov-west-1` - -The `website` object supports the following: - -* `index_document` - (Required, unless using `redirect_all_requests_to`) Amazon S3 returns this index document when requests are made to the root domain or any of the subfolders. -* `error_document` - (Optional) An absolute path to the document to return in case of a 4XX error. -* `redirect_all_requests_to` - (Optional) A hostname to redirect all website requests for this bucket to. Hostname can optionally be prefixed with a protocol (`http://` or `https://`) to use when redirecting requests. The default is the protocol that is used in the original request. -* `routing_rules` - (Optional) A json array containing [routing rules](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules.html) - describing redirect behavior and when redirects are applied. - -The `CORS` object supports the following: - -* `allowed_headers` (Optional) Specifies which headers are allowed. -* `allowed_methods` (Required) Specifies which methods are allowed. Can be `GET`, `PUT`, `POST`, `DELETE` or `HEAD`. -* `allowed_origins` (Required) Specifies which origins are allowed. -* `expose_headers` (Optional) Specifies expose header in the response. -* `max_age_seconds` (Optional) Specifies time in seconds that browser can cache the response for a preflight request. - -The `versioning` object supports the following: - -* `enabled` - (Optional) Enable versioning. Once you version-enable a bucket, it can never return to an unversioned state. You can, however, suspend versioning on that bucket. -* `mfa_delete` - (Optional) Enable MFA delete for either `Change the versioning state of your bucket` or `Permanently delete an object version`. Default is `false`. This cannot be used to toggle this setting but is available to allow managed buckets to reflect the state in AWS - -The `logging` object supports the following: - -* `target_bucket` - (Required) The name of the bucket that will receive the log objects. -* `target_prefix` - (Optional) To specify a key prefix for log objects. - -The `lifecycle_rule` object supports the following: - -* `id` - (Optional) Unique identifier for the rule. Must be less than or equal to 255 characters in length. -* `prefix` - (Optional) Object key prefix identifying one or more objects to which the rule applies. -* `tags` - (Optional) Specifies object tags key and value. -* `enabled` - (Required) Specifies lifecycle rule status. -* `abort_incomplete_multipart_upload_days` (Optional) Specifies the number of days after initiating a multipart upload when the multipart upload must be completed. -* `expiration` - (Optional) Specifies a period in the object's expire (documented below). -* `transition` - (Optional) Specifies a period in the object's transitions (documented below). -* `noncurrent_version_expiration` - (Optional) Specifies when noncurrent object versions expire (documented below). -* `noncurrent_version_transition` - (Optional) Specifies when noncurrent object versions transitions (documented below). - -At least one of `abort_incomplete_multipart_upload_days`, `expiration`, `transition`, `noncurrent_version_expiration`, `noncurrent_version_transition` must be specified. - -The `expiration` object supports the following - -* `date` (Optional) Specifies the date after which you want the corresponding action to take effect. -* `days` (Optional) Specifies the number of days after object creation when the specific rule action takes effect. -* `expired_object_delete_marker` (Optional) On a versioned bucket (versioning-enabled or versioning-suspended bucket), you can add this element in the lifecycle configuration to direct Amazon S3 to delete expired object delete markers. This cannot be specified with Days or Date in a Lifecycle Expiration Policy. - -The `transition` object supports the following - -* `date` (Optional) Specifies the date after which you want the corresponding action to take effect. -* `days` (Optional) Specifies the number of days after object creation when the specific rule action takes effect. -* `storage_class` (Required) Specifies the Amazon S3 [storage class](https://docs.aws.amazon.com/AmazonS3/latest/API/API_Transition.html#AmazonS3-Type-Transition-StorageClass) to which you want the object to transition. - -The `noncurrent_version_expiration` object supports the following - -* `days` (Required) Specifies the number of days noncurrent object versions expire. - -The `noncurrent_version_transition` object supports the following - -* `days` (Required) Specifies the number of days noncurrent object versions transition. -* `storage_class` (Required) Specifies the Amazon S3 [storage class](https://docs.aws.amazon.com/AmazonS3/latest/API/API_Transition.html#AmazonS3-Type-Transition-StorageClass) to which you want the object to transition. - -The `replication_configuration` object supports the following: - -~> **NOTE:** See the `aws_s3_bucket_replication_configuration` resource documentation to avoid conflicts. Replication configuration can only be defined in one resource not both. When using the independent replication configuration resource the following lifecycle rule is needed on the `aws_s3_bucket_legacy` resource. - -``` -lifecycle { - ignore_changes = [ - replication_configuration - ] -} -``` - -* `role` - (Required) The ARN of the IAM role for Amazon S3 to assume when replicating the objects. -* `rules` - (Required) Specifies the rules managing the replication (documented below). - -The `rules` object supports the following: - -~> **NOTE:** Amazon S3's latest version of the replication configuration is V2, which includes the `filter` attribute for replication rules. -With the `filter` attribute, you can specify object filters based on the object key prefix, tags, or both to scope the objects that the rule applies to. -Replication configuration V1 supports filtering based on only the `prefix` attribute. For backwards compatibility, Amazon S3 continues to support the V1 configuration. - -* `delete_marker_replication_status` - (Optional) Whether delete markers are replicated. The only valid value is `Enabled`. To disable, omit this argument. This argument is only valid with V2 replication configurations (i.e., when `filter` is used). -* `destination` - (Required) Specifies the destination for the rule (documented below). -* `filter` - (Optional, Conflicts with `prefix`) Filter that identifies subset of objects to which the replication rule applies (documented below). -* `id` - (Optional) Unique identifier for the rule. Must be less than or equal to 255 characters in length. -* `prefix` - (Optional, Conflicts with `filter`) Object keyname prefix identifying one or more objects to which the rule applies. Must be less than or equal to 1024 characters in length. -* `priority` - (Optional) The priority associated with the rule. Priority should only be set if `filter` is configured. If not provided, defaults to `0`. Priority must be unique between multiple rules. -* `source_selection_criteria` - (Optional) Specifies special object selection criteria (documented below). -* `status` - (Required) The status of the rule. Either `Enabled` or `Disabled`. The rule is ignored if status is not Enabled. - -~> **NOTE:** Replication to multiple destination buckets requires that `priority` is specified in the `rules` object. If the corresponding rule requires no filter, an empty configuration block `filter {}` must be specified. - -The `destination` object supports the following: - -* `bucket` - (Required) The ARN of the S3 bucket where you want Amazon S3 to store replicas of the object identified by the rule. -* `storage_class` - (Optional) The [storage class](https://docs.aws.amazon.com/AmazonS3/latest/API/API_Destination.html#AmazonS3-Type-Destination-StorageClass) used to store the object. By default, Amazon S3 uses the storage class of the source object to create the object replica. -* `replica_kms_key_id` - (Optional) Destination KMS encryption key ARN for SSE-KMS replication. Must be used in conjunction with - `sse_kms_encrypted_objects` source selection criteria. -* `access_control_translation` - (Optional) Specifies the overrides to use for object owners on replication. Must be used in conjunction with `account_id` owner override configuration. -* `account_id` - (Optional) The Account ID to use for overriding the object owner on replication. Must be used in conjunction with `access_control_translation` override configuration. -* `replication_time` - (Optional) Enables S3 Replication Time Control (S3 RTC) (documented below). -* `metrics` - (Optional) Enables replication metrics (required for S3 RTC) (documented below). - -The `replication_time` object supports the following: - -* `status` - (Optional) The status of RTC. Either `Enabled` or `Disabled`. -* `minutes` - (Optional) Threshold within which objects are to be replicated. The only valid value is `15`. - -The `metrics` object supports the following: - -* `status` - (Optional) The status of replication metrics. Either `Enabled` or `Disabled`. -* `minutes` - (Optional) Threshold within which objects are to be replicated. The only valid value is `15`. - -The `source_selection_criteria` object supports the following: - -* `sse_kms_encrypted_objects` - (Optional) Match SSE-KMS encrypted objects (documented below). If specified, `replica_kms_key_id` - in `destination` must be specified as well. - -The `sse_kms_encrypted_objects` object supports the following: - -* `enabled` - (Required) Boolean which indicates if this criteria is enabled. - -The `filter` object supports the following: - -* `prefix` - (Optional) Object keyname prefix that identifies subset of objects to which the rule applies. Must be less than or equal to 1024 characters in length. -* `tags` - (Optional) A map of tags that identifies subset of objects to which the rule applies. - The rule applies only to objects having all the tags in its tagset. - -The `server_side_encryption_configuration` object supports the following: - -* `rule` - (required) A single object for server-side encryption by default configuration. (documented below) - -The `rule` object supports the following: - -* `apply_server_side_encryption_by_default` - (required) A single object for setting server-side encryption by default. (documented below) -* `bucket_key_enabled` - (Optional) Whether or not to use [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) for SSE-KMS. - -The `apply_server_side_encryption_by_default` object supports the following: - -* `sse_algorithm` - (required) The server-side encryption algorithm to use. Valid values are `AES256` and `aws:kms` -* `kms_master_key_id` - (optional) The AWS KMS master key ID used for the SSE-KMS encryption. This can only be used when you set the value of `sse_algorithm` as `aws:kms`. The default `aws/s3` AWS KMS master key is used if this element is absent while the `sse_algorithm` is `aws:kms`. - -The `grant` object supports the following: - -* `id` - (optional) Canonical user id to grant for. Used only when `type` is `CanonicalUser`. -* `type` - (required) - Type of grantee to apply for. Valid values are `CanonicalUser` and `Group`. `AmazonCustomerByEmail` is not supported. -* `permissions` - (required) List of permissions to apply for grantee. Valid values are `READ`, `WRITE`, `READ_ACP`, `WRITE_ACP`, `FULL_CONTROL`. -* `uri` - (optional) Uri address to grant for. Used only when `type` is `Group`. - -The `access_control_translation` object supports the following: - -* `owner` - (Required) The override value for the owner on replicated objects. Currently only `Destination` is supported. - -The `object_lock_configuration` object supports the following: - -* `object_lock_enabled` - (Required) Indicates whether this bucket has an Object Lock configuration enabled. Valid value is `Enabled`. -* `rule` - (Optional) The Object Lock rule in place for this bucket. - -The `rule` object supports the following: - -* `default_retention` - (Required) The default retention period that you want to apply to new objects placed in this bucket. - -The `default_retention` object supports the following: - -* `mode` - (Required) The default Object Lock retention mode you want to apply to new objects placed in this bucket. Valid values are `GOVERNANCE` and `COMPLIANCE`. -* `days` - (Optional) The number of days that you want to specify for the default retention period. -* `years` - (Optional) The number of years that you want to specify for the default retention period. - -Either `days` or `years` must be specified, but not both. - -~> **NOTE on `object_lock_configuration`:** You can only enable S3 Object Lock for new buckets. If you need to turn on S3 Object Lock for an existing bucket, please contact AWS Support. -When you create a bucket with S3 Object Lock enabled, Amazon S3 automatically enables versioning for the bucket. -Once you create a bucket with S3 Object Lock enabled, you can't disable Object Lock or suspend versioning for the bucket. - -## Attributes Reference - -In addition to all arguments above, the following attributes are exported: - -* `id` - The name of the bucket. -* `arn` - The ARN of the bucket. Will be of format `arn:aws:s3:::bucketname`. -* `bucket_domain_name` - The bucket domain name. Will be of format `bucketname.s3.amazonaws.com`. -* `bucket_regional_domain_name` - The bucket region-specific domain name. The bucket domain name including the region name, please refer [here](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) for format. Note: The AWS CloudFront allows specifying S3 region-specific endpoint when creating S3 origin, it will prevent [redirect issues](https://forums.aws.amazon.com/thread.jspa?threadID=216814) from CloudFront to S3 Origin URL. -* `hosted_zone_id` - The [Route 53 Hosted Zone ID](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_website_region_endpoints) for this bucket's region. -* `region` - The AWS region this bucket resides in. -* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block. -* `website_endpoint` - The website endpoint, if the bucket is configured with a website. If not, this will be an empty string. -* `website_domain` - The domain of the website endpoint, if the bucket is configured with a website. If not, this will be an empty string. This is used to create Route 53 alias records. - -## Import - -S3 bucket can be imported using the `bucket`, e.g., - -``` -$ terraform import aws_s3_bucket_legacy.bucket bucket-name -``` - -The `policy` argument is not imported and will be deprecated in a future version of the provider. Use the `aws_s3_bucket_policy` resource to manage the S3 Bucket Policy instead.