Docs4dev
Docs
ansible / latest / collections / community / aws / aws_s3_bucket_info_module.html

community.aws.aws_s3_bucket_info – lists S3 buckets in AWS

Note

This plugin is part of the community.aws collection (version 1.5.0).

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 community.aws.

To use it in a playbook, specify: community.aws.aws_s3_bucket_info.

New in version 1.0.0: of community.aws

Synopsis

  • Lists S3 buckets and details about those buckets.
  • This module was called aws_s3_bucket_facts before Ansible 2.9, returning ansible_facts. Note that the community.aws.aws_s3_bucket_info module no longer returns ansible_facts!

Requirements

The below requirements are needed on the host that executes this module.

  • boto
  • boto3 >= 1.4.4
  • python >= 2.6

Parameters

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.
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
bucket_facts
dictionary
added in 1.4.0 of community.aws
Retrieve requested S3 bucket detailed information
Each bucket_X option executes one API call, hence many options being set to true will cause slower module execution.
You can limit buckets by using the name or name_filter option.
bucket_accelerate_configuration
boolean
    Choices:
  • no ←
  • yes
Retrive S3 accelerate configuration.
bucket_acl
boolean
    Choices:
  • no ←
  • yes
Retrive S3 bucket ACLs.
bucket_cors
boolean
    Choices:
  • no ←
  • yes
Retrive S3 bucket CORS configuration.
bucket_encryption
boolean
    Choices:
  • no ←
  • yes
Retrive S3 bucket encryption.
bucket_lifecycle_configuration
boolean
    Choices:
  • no ←
  • yes
Retrive S3 bucket lifecycle configuration.
bucket_location
boolean
    Choices:
  • no ←
  • yes
Retrive S3 bucket location.
bucket_logging
boolean
    Choices:
  • no ←
  • yes
Retrive S3 bucket logging.
bucket_notification_configuration
boolean
    Choices:
  • no ←
  • yes
Retrive S3 bucket notification configuration.
bucket_ownership_controls
boolean
    Choices:
  • no ←
  • yes
Retrive S3 ownership controls.
bucket_policy
boolean
    Choices:
  • no ←
  • yes
Retrive S3 bucket policy.
bucket_policy_status
boolean
    Choices:
  • no ←
  • yes
Retrive S3 bucket policy status.
bucket_replication
boolean
    Choices:
  • no ←
  • yes
Retrive S3 bucket replication.
bucket_request_payment
boolean
    Choices:
  • no ←
  • yes
Retrive S3 bucket request payment.
bucket_tagging
boolean
    Choices:
  • no ←
  • yes
Retrive S3 bucket tagging.
bucket_website
boolean
    Choices:
  • no ←
  • yes
Retrive S3 bucket website.
public_access_block
boolean
    Choices:
  • no ←
  • yes
Retrive S3 bucket public access block.
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
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.
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
name
string
added in 1.4.0 of community.aws
Default:
""
Name of bucket to query.
name_filter
string
added in 1.4.0 of community.aws
Default:
""
Limits buckets to only buckets who's name contain the string in name_filter.
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
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
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
transform_location
boolean
added in 1.4.0 of community.aws
    Choices:
  • no ←
  • yes
S3 bucket location for default us-east-1 is normally reported as null.
Setting this option to true will return us-east-1 instead.
Affects only queries with bucket_facts=true and bucket_location=true.
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence 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
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • 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

Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Note: Only AWS S3 is currently supported

# Lists all s3 buckets
- community.aws.aws_s3_bucket_info:
  register: result

# Retrieve detailed bucket information
- community.aws.aws_s3_bucket_info:
    # Show only buckets with name matching
    name_filter: your.testing
    # Choose facts to retrieve
    bucket_facts:
      # bucket_accelerate_configuration: true
      bucket_acl: true
      bucket_cors: true
      bucket_encryption: true
      # bucket_lifecycle_configuration: true
      bucket_location: true
      # bucket_logging: true
      # bucket_notification_configuration: true
      # bucket_ownership_controls: true
      # bucket_policy: true
      # bucket_policy_status: true
      # bucket_replication: true
      # bucket_request_payment: true
      # bucket_tagging: true
      # bucket_website: true
      # public_access_block: true
    transform_location: true
    register: result

# Print out result
- name: List buckets
  ansible.builtin.debug:
    msg: "{{ result['buckets'] }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
bucket_list
complex
always
List of buckets

bucket_acl
complex
when bucket_facts=true and bucket_acl=true
Bucket ACL configuration.

Grants
list / elements=string
success
List of ACL grants.

Owner
complex
success
Bucket owner information.

DisplayName
string
always
Bucket owner user display name.

Sample:
username
ID
string
always
Bucket owner user ID.

Sample:
123894e509349etc
bucket_cors
complex
when bucket_facts=true and bucket_cors=true
Bucket CORS configuration.

CORSRules
list / elements=string
when CORS rules are defined for the bucket
Bucket CORS configuration.

bucket_encryption
complex
when bucket_facts=true and bucket_encryption=true
Bucket encryption configuration.

ServerSideEncryptionConfiguration
complex
when encryption is enabled on the bucket
ServerSideEncryptionConfiguration configuration.

Rules
list / elements=string
when encryption is enabled on the bucket
List of applied encryptio rules.

Sample:
{'ApplyServerSideEncryptionByDefault': {'SSEAlgorithm': 'AES256'}, 'BucketKeyEnabled': False}
bucket_lifecycle_configuration
complex
when bucket_facts=true and bucket_lifecycle_configuration=true
Bucket lifecycle configuration settings.

Rules
list / elements=string
when lifecycle configuration is present
List of lifecycle management rules.

Sample:
[{'ID': 'example-rule', 'Status': 'Enabled'}]
bucket_location
complex
when bucket_facts=true and bucket_location=true
Bucket location.

LocationConstraint
string
always
AWS region.

Sample:
us-east-2
bucket_logging
complex
when bucket_facts=true and bucket_logging=true
Server access logging configuration.

LoggingEnabled
complex
when server access logging is defined for the bucket
Server access logging configuration.

TargetBucket
string
always
Target bucket name.

Sample:
logging-bucket-name
TargetPrefix
string
always
Prefix in target bucket.

bucket_name_filter
string
when name_filter is defined
String used to limit buckets. See name_filter.

Sample:
filter-by-this-string
bucket_notification_configuration
complex
when bucket_facts=true and bucket_notification_configuration=true
Bucket notification settings.

TopicConfigurations
list / elements=string
when at least one notification is configured
List of notification events configurations.

bucket_ownership_controls
complex
when bucket_facts=true and bucket_ownership_controls=true
Preffered object ownership settings.

OwnershipControls
complex
when ownership controls are defined for the bucket
Object ownership settings.

Rules
list / elements=string
when ownership rule is defined
List of ownership rules.

Sample:
[{'ObjectOwnership:': 'ObjectWriter'}]
bucket_policy
string
when bucket_facts=true and bucket_policy=true
Bucket policy contents.

Sample:
{"Version":"2012-10-17","Statement":[{"Sid":"AddCannedAcl","Effect":"Allow",..}}]}
bucket_policy_status
complex
when bucket_facts=true and bucket_policy_status=true
Status of bucket policy.

PolicyStatus
complex
when bucket policy is present
Status of bucket policy.

IsPublic
boolean
when bucket policy is present
Report bucket policy public status.

Sample:
True
bucket_replication
complex
when bucket_facts=true and bucket_replication=true
Replication configuration settings.

Role
string
when replication rule is defined
IAM role used for replication.

Sample:
arn:aws:iam::123:role/example-role
Rules
list / elements=string
when replication rule is defined
List of replication rules.

Sample:
[{'Filter': '{}', 'ID': 'rule-1'}]
bucket_request_payment
complex
when bucket_facts=true and bucket_request_payment=true
Requester pays setting.

Payer
string
always
Current payer.

Sample:
BucketOwner
bucket_tagging
dictionary
when bucket_facts=true and bucket_tagging=true
Bucket tags.

Sample:
{'Tag1': 'Value1', 'Tag2': 'Value2'}
bucket_website
complex
when bucket_facts=true and bucket_website=true
Static website hosting.

ErrorDocument
dictionary
when static website hosting is enabled
Object serving as HTTP error page.

Sample:
{'Key': 'error.html'}
IndexDocument
dictionary
when static website hosting is enabled
Object serving as HTTP index page.

Sample:
{'Suffix': 'error.html'}
RedirectAllRequestsTo
complex
when redirect requests is configured
Website redict settings.

HostName
string
always
Hostname to redirect.

Sample:
www.example.com
Protocol
string
always
Protocol used for redirect.

Sample:
https
creation_date
string
always
Bucket creation date timestamp.

Sample:
2021-01-21T12:44:10+00:00
name
string
always
Bucket name.

Sample:
a-testing-bucket-name
public_access_block
complex
when bucket_facts=true and public_access_block=true
Bucket public access block configuration.

PublicAccessBlockConfiguration
complex
when PublicAccessBlockConfiguration is defined for the bucket
PublicAccessBlockConfiguration data.

BlockPublicAcls
boolean
success
BlockPublicAcls setting value.

Sample:
True
BlockPublicPolicy
boolean
success
BlockPublicPolicy setting value.

Sample:
True
IgnorePublicAcls
boolean
success
IgnorePublicAcls setting value.

Sample:
True
RestrictPublicBuckets
boolean
success
RestrictPublicBuckets setting value.

Sample:
True


Authors

  • Gerben Geijteman (@hyperized)

© 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/community/aws/aws_s3_bucket_info_module.html