Note
This plugin is part of the amazon.aws collection (version 1.5.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
.
To use it in a playbook, specify: amazon.aws.s3_bucket
.
New in version 1.0.0: of amazon.aws
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
aws_access_key string | AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. If profile is set this parameter is ignored. Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: ec2_access_key, access_key | ||
aws_ca_bundle path | The location of a CA Bundle to use when validating SSL certificates. Only used for boto3 based modules. Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally. | ||
aws_config dictionary | A dictionary to modify the botocore configuration. Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration. | ||
aws_secret_key string | AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. If profile is set this parameter is ignored. Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: ec2_secret_key, secret_key | ||
ceph boolean |
| Enable API compatibility with Ceph. It takes into account the S3 API subset working with Ceph in order to provide the same module behaviour where possible. | |
debug_botocore_endpoint_logs boolean |
| Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used. | |
delete_public_access boolean added in 1.3.0 of amazon.aws |
| Delete public access block configuration from bucket. This option cannot be used together with a public_access definition. | |
ec2_url string | Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. aliases: aws_endpoint_url, endpoint_url | ||
encryption string |
| 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. | |
encryption_key_id string | KMS master key ID to use for the default encryption. This parameter is allowed if encryption is aws:kms . If not specified then it will default to the AWS provided KMS key. | ||
force boolean |
| 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). | |
name string / required | Name of the S3 bucket. | ||
policy json | The JSON policy as a string. | ||
profile string | Uses a boto profile. Only works with boto >= 2.24.0. Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01. aliases: aws_profile | ||
public_access dictionary added in 1.3.0 of amazon.aws | Configure public access block for S3 bucket. This option cannot be used together with delete_public_access. | ||
block_public_acls boolean |
| Sets BlockPublicAcls value. | |
block_public_policy boolean |
| Sets BlockPublicPolicy value. | |
ignore_public_acls boolean |
| Sets IgnorePublicAcls value. | |
restrict_public_buckets boolean |
| Sets RestrictPublicAcls value. | |
purge_tags boolean |
| Whether to remove tags that aren't present in the tags parameter. | |
region string | The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
aliases: aws_region, ec2_region | ||
requester_pays boolean |
| With Requester Pays buckets, the requester instead of the bucket owner pays the cost of the request and the data download from the bucket. | |
s3_url string | S3 URL endpoint for usage with DigitalOcean, Ceph, Eucalyptus and FakeS3 etc. Assumes AWS if not specified. For Walrus, use FQDN of the endpoint without scheme nor path. aliases: S3_URL | ||
security_token string | AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. If profile is set this parameter is ignored. Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: aws_security_token, access_token | ||
state string |
| Create or remove the S3 bucket. | |
tags dictionary | Tags dict to apply to bucket. | ||
validate_certs boolean |
| When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. | |
versioning boolean |
| Whether versioning is enabled or disabled (note that once versioning is enabled, it can only be suspended). |
Note
requestPayment
, policy
, tagging
or versioning
operations/API aren’t implemented by the endpoint, module doesn’t fail if each parameter satisfies the following condition. requester_pays is False
, policy, tags, and versioning are None
.AWS_URL
or EC2_URL
, AWS_PROFILE
or AWS_DEFAULT_PROFILE
, AWS_ACCESS_KEY_ID
or AWS_ACCESS_KEY
or EC2_ACCESS_KEY
, AWS_SECRET_ACCESS_KEY
or AWS_SECRET_KEY
or EC2_SECRET_KEY
, AWS_SECURITY_TOKEN
or EC2_SECURITY_TOKEN
, AWS_REGION
or EC2_REGION
, AWS_CA_BUNDLE
AWS_REGION
or EC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file# 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 s3_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: yes # 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: yes versioning: yes tags: example: tag1 another: tag2 # Create a simple DigitalOcean Spaces bucket using their provided regional endpoint - amazon.aws.s3_bucket: name: mydobucket s3_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, 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 ommited, 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
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/s3_bucket_module.html