ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Update documentation for s3 use of region

Browse source
This commit is contained in:
Toshio Kuratomi 2014-09-08 15:48:09 -07:00
parent efbe655b80
commit 1064aa693b
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
library/cloud/s3
View file

@ -17,7 +17,7 @@
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: s3 module: s3
short_description: S3 module putting a file into S3. short_description: S3 module putting a file into S3.
description: description:
- This module allows the user to dictate the presence of a given file in an S3 bucket. If or once the key (file) exists in the bucket, it returns a time-expired download URL. This module has a dependency on python-boto. - This module allows the user to dictate the presence of a given file in an S3 bucket. If or once the key (file) exists in the bucket, it returns a time-expired download URL. This module has a dependency on python-boto.
version_added: "1.1" version_added: "1.1"
@ -89,6 +89,12 @@ options:
required: false required: false
default: null default: null
version_added: "1.6" version_added: "1.6"
region:
description:
- AWS region to create the bucket in. If not set then the value of the EC2_REGION and AWS_REGION environment variables are checked, followed by the aws_region and ec2_region settings in the Boto config file. If none of those are set the region defaults to the S3 Location: US Standard. Prior to ansible 1.8 this parameter could be specified but did nothing.
required: false
default: null
version_added: "1.8"
requirements: [ "boto" ] requirements: [ "boto" ]
author: Lester Wade, Ralph Tice author: Lester Wade, Ralph Tice
@ -117,6 +123,8 @@ EXAMPLES = '''
- s3: bucket=mybucket mode=create - s3: bucket=mybucket mode=create
# Create a bucket with key as directory # Create a bucket with key as directory
- s3: bucket=mybucket object=/my/directory/path mode=create - s3: bucket=mybucket object=/my/directory/path mode=create
# Create an empty bucket in the EU region
- s3: bucket=mybucket mode=create region=eu-west-1
# Delete a bucket and all contents # Delete a bucket and all contents
- s3: bucket=mybucket mode=delete - s3: bucket=mybucket mode=delete
''' '''