amazon.aws.s3_bucket module – Manage S3 buckets in AWS, DigitalOcean, Ceph, Walrus, FakeS3 and StorageGRID
Note
This module is part of the amazon.aws collection (version 8.2.1).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install amazon.aws.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: amazon.aws.s3_bucket.
New in amazon.aws 1.0.0
Synopsis
Manage S3 buckets.
Compatible with AWS, DigitalOcean, Ceph, Walrus, FakeS3 and StorageGRID.
When using non-AWS services,
endpoint_urlshould be specified.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0
Parameters
Parameter |
Comments |
|---|---|
Enables Amazon S3 Transfer Acceleration, sent data will be routed to Amazon S3 over an optimized network path. Transfer Acceleration is not available in AWS GovCloud (US). See https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-s3.html#govcloud-S3-diffs. Choices:
|
|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The canned ACL to apply to the bucket. If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Choices:
|
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
Enable S3 Bucket Keys for SSE-KMS on new objects. See the AWS documentation for more information https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html. Bucket Key encryption is only supported if Choices:
|
|
Enable API compatibility with Ceph RGW. It takes into account the S3 API subset working with Ceph in order to provide the same module behaviour where possible. Requires Choices:
|
|
Use a The Choices:
|
|
Delete bucket’s ownership controls. This option cannot be used together with a Choices:
|
|
Delete public access block configuration from bucket. This option cannot be used together with a Choices:
|
|
Enables Amazon S3 Dual-Stack Endpoints, allowing S3 communications using both IPv4 and IPv6. Mutually exclusive with Choices:
|
|
Describes the default server-side encryption to apply to new objects in the bucket. In order to remove the server-side encryption, the encryption needs to be set to ‘none’ explicitly. Note: Since January 2023 Amazon S3 doesn’t support disabling encryption on S3 buckets. Choices:
|
|
KMS master key ID to use for the default encryption. If not specified then it will default to the AWS provided KMS key. This parameter is only supported if |
|
URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
When trying to delete a bucket, delete all keys (including versions and delete markers) in the bucket first (an S3 bucket must be empty for a successful deletion). Choices:
|
|
Enable S3 Inventory, saving list of the objects and their corresponding metadata on a daily or weekly basis for an S3 bucket. |
|
Contains information about where to publish the inventory results. |
|
The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data. |
|
The Amazon Resource Name (ARN) of the bucket where inventory results will be published. |
|
Specifies the output format of the inventory results. Choices:
|
|
The prefix that is prepended to all inventory results. |
|
The prefix that an object must have to be included in the inventory results. |
|
The ID used to identify the inventory configuration. |
|
Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields. Choices:
|
|
Contains the optional fields that are included in the inventory results. Choices:
|
|
Specifies the schedule for generating inventory results. Choices:
|
|
Name of the S3 bucket. |
|
Default Object Lock configuration that will be applied by default to every new object placed in the specified bucket.
Object lock retention policy can’t be removed. |
|
The number of days that you want to specify for the default retention period. Mutually exclusive with |
|
Type of retention modes. Choices:
|
|
The number of years that you want to specify for the default retention period. Mutually exclusive with |
|
Whether S3 Object Lock to be enabled. Defaults to Choices:
|
|
Allow bucket’s ownership controls.
This option cannot be used together with a
Note: At the end of April 2023 Amazon updated the default setting to Choices:
|
|
The JSON policy as a string. Set to the string |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
Configure public access block for S3 bucket. This option cannot be used together with Note: At the end of April 2023 Amazon updated the default settings to block public access by
default. While the defaults for this module remain unchanged, it is necessary to explicitly
pass the |
|
Sets BlockPublicAcls value. Choices:
|
|
Sets BlockPublicPolicy value. Choices:
|
|
Sets IgnorePublicAcls value. Choices:
|
|
Sets RestrictPublicAcls value. Choices:
|
|
If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified, even if purge_tags=True. Tag keys beginning with Choices:
|
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
With Requester Pays buckets, the requester instead of the bucket owner pays the cost of the request and the data download from the bucket. Choices:
|
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Create or remove the S3 bucket. Choices:
|
|
A dictionary representing the tags to be applied to the resource. If the tags parameter is not set then tags will not be modified. |
|
Whether the bucket name should be validated to conform to AWS S3 naming rules. On by default, this may be disabled for S3 backends that do not enforce these rules. See https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html. Choices:
|
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
|
Whether versioning is enabled or disabled (note that once versioning is enabled, it can only be suspended). Choices:
|
Notes
Note
If
requestPayment,policy,taggingorversioningoperations/API aren’t implemented by the endpoint, module doesn’t fail if each parameter satisfies the following condition.requester_paysisfalse,policy,tags, andversioningareNone.In release 5.0.0 the
s3_urlparameter was merged into theendpoint_urlparameter,s3_urlremains as an alias forendpoint_url.For Walrus
endpoint_urlshould be set to the FQDN of the endpoint with neither scheme nor path.Support for the
S3_URLenvironment variable has been deprecated and will be removed in a release after 2024-12-01, please use theendpoint_urlparameter or theAWS_URLenvironment variable.Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Create a simple S3 bucket
- amazon.aws.s3_bucket:
name: mys3bucket
state: present
# Create a simple S3 bucket on Ceph Rados Gateway
- amazon.aws.s3_bucket:
name: mys3bucket
endpoint_url: http://your-ceph-rados-gateway-server.xxx
ceph: true
# Remove an S3 bucket and any keys it contains
- amazon.aws.s3_bucket:
name: mys3bucket
state: absent
force: true
# Create a bucket, add a policy from a file, enable requester pays, enable versioning and tag
- amazon.aws.s3_bucket:
name: mys3bucket
policy: "{{ lookup('file','policy.json') }}"
requester_pays: true
versioning: true
tags:
example: tag1
another: tag2
# Create a simple DigitalOcean Spaces bucket using their provided regional endpoint
- amazon.aws.s3_bucket:
name: mydobucket
endpoint_url: 'https://nyc3.digitaloceanspaces.com'
# Create a bucket with AES256 encryption
- amazon.aws.s3_bucket:
name: mys3bucket
state: present
encryption: "AES256"
# Create a bucket with aws:kms encryption, KMS key
- amazon.aws.s3_bucket:
name: mys3bucket
state: present
encryption: "aws:kms"
encryption_key_id: "arn:aws:kms:us-east-1:1234/5678example"
# Create a bucket with aws:kms encryption, Bucket key
- amazon.aws.s3_bucket:
name: mys3bucket
bucket_key_enabled: true
encryption: "aws:kms"
# Create a bucket with aws:kms encryption, default key
- amazon.aws.s3_bucket:
name: mys3bucket
state: present
encryption: "aws:kms"
# Create a bucket with public policy block configuration
- amazon.aws.s3_bucket:
name: mys3bucket
state: present
public_access:
block_public_acls: true
ignore_public_acls: true
## keys == 'false' can be omitted, undefined keys defaults to 'false'
# block_public_policy: false
# restrict_public_buckets: false
# Delete public policy block from bucket
- amazon.aws.s3_bucket:
name: mys3bucket
state: present
delete_public_access: true
# Create a bucket with object ownership controls set to ObjectWriter
- amazon.aws.s3_bucket:
name: mys3bucket
state: present
object_ownership: ObjectWriter
# Delete onwership controls from bucket
- amazon.aws.s3_bucket:
name: mys3bucket
state: present
delete_object_ownership: true
# Delete a bucket policy from bucket
- amazon.aws.s3_bucket:
name: mys3bucket
state: present
policy: "null"
# This example grants public-read to everyone on bucket using ACL
- amazon.aws.s3_bucket:
name: mys3bucket
state: present
acl: public-read
# Enable transfer acceleration
- amazon.aws.s3_bucket:
name: mys3bucket
state: present
accelerate_enabled: true
# Default Object Lock retention
- amazon.aws.s3_bucket:
name: mys3bucket
state: present
object_lock_enabled: true
object_lock_default_retention:
mode: governance
days: 1
# Bucket with inventory configuration:
- amazon.aws.s3_bucket:
name: mys3bucket
state: present
inventory:
- id: mys3bucket-inventory-id
destination:
bucket: "arn:aws:s3:::mys3inventorybucket"
optional_fields:
- "Size"
included_object_versions: "All"
schedule: "Weekly"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
S3 bucket inventory configuration. Returned: when Sample: |
|
Server-side encryption of the objects in the S3 bucket. Returned: when Sample: |
|
S3 bucket’s object lock retention policy. Returned: when Sample: |
|
S3 bucket’s policy. Returned: when Sample: |
|
Bucket public access block configuration. Returned: when Sample: |
|
The PublicAccessBlock configuration currently in effect for this Amazon S3 bucket. Returned: success |
|
Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Returned: success |
|
Specifies whether Amazon S3 should block public bucket policies for this bucket. Returned: success |
|
Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Returned: success |
|
Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Returned: success |
|
Indicates that the requester was successfully charged for the request. Returned: when Sample: |
|
S3 bucket’s versioning configuration. Returned: when Sample: |
|
Specifies whether MFA delete is enabled in the bucket versioning configuration. Returned: when |
|
The versioning state of the bucket. Returned: always |