steampunk.aws.s3_bucket_info (0.9.0) — module

Install collection

Install with ansible-galaxy collection install steampunk.aws:==0.9.0

Add to requirements.yml

  collections:
    - name: steampunk.aws
      version: 0.9.0

Description

Retrieve information about AWS S3 Buckets.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: List all accessible buckets
  s3_bucket_info:
  register: result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- debug:
    var: result.objects

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Retrieve a specific S3 bucket
  s3_bucket_info:
    names: steamybucket
  register: result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- debug:
    var: result.objects

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Retrieve a specific S3 buckets
  s3_bucket_info:
    names:
      - xbucket
      - lbucket
      - abucket
      - bbucket

Inputs

    
auth:
    description:
    - Parameters for authenticating with the AWS service. Each of them may be defined
      via environment variables.
    suboptions:
      access_key:
        description:
        - The AWS access key ID. If not set, the value of the AWS_ACCESS_KEY environment
          variable will be checked.
        - Mutually exclusive with I(profile).
        required: false
        type: str
      profile:
        description:
        - The name of the AWS profile configured with C(aws configure).
        - Can be used instead of explicitly specifying your access credentials and region.
        - Use C(default) to use the default profile.
        - Mutually exclusive with I(access_key) and I(secret_key).
        required: false
        type: str
      region:
        description:
        - The name of the AWS region.
        - If not set, the value of the AWS_REGION environment variable will be checked.
        - If you set a I(profile) that specifies a default region, that region is used
          and you can omit this parameter. Use this parameter to override the profile's
          default region.
        type: str
      secret_key:
        description:
        - The AWS secret access key. If not set, the value of the AWS_SECRET_KEY environment
          variable will be checked.
        - Mutually exclusive with I(profile).
        required: false
        type: str
      url:
        description:
        - The URL to the AWS service related to the resource. By default, this is automatically
          determined through the region parameter.
        - If not set explicitly, the value of the AWS_<SERVICE>_URL environment variable
          will be used.
        - The services currently supported are EC2 and S3.
        required: false
        type: str
    type: dict

names:
    description: Limit results to the specified S3 Buckets only
    elements: str
    type: list

Outputs

object:
  contains:
    access_logging:
      description: If records for the requests are enabled.
      returned: always
      sample: false
      type: bool
    name:
      description: Name of S3 bucket.
      returned: always
      sample: steamybucket
      type: str
    public_access:
      description: If public access to your S3 buckets and objects is blocked.
      returned: always
      sample: false
      type: bool
    tags:
      description: Tags associated with the S3 Bucket.
      returned: always
      sample:
        Name: my-s3-bucket
      type: dict
    versioning:
      description: If there are multiple versions of an object in the same bucket.
      returned: always
      sample: false
      type: bool
  description:
  - An object representing an S3 Bucket.
  returned: success
  type: complex

See also

• s3_bucket