community.digitalocean.digital_ocean_spaces_info (1.26.0) — module

Install collection

Install with ansible-galaxy collection install community.digitalocean:==1.26.0

Add to requirements.yml

  collections:
    - name: community.digitalocean
      version: 1.26.0

Description

List DigitalOcean Spaces.

Requirements

• boto3

Usage examples

Scanned by Steampunk Spotter

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

- name: List all Spaces in nyc3
  community.digitalocean.digital_ocean_spaces_info:
    state: present
    region: nyc3

Inputs

    
state:
    choices:
    - present
    default: present
    description:
    - Only present is supported.
    type: str

region:
    aliases:
    - region_id
    description:
    - The region from which to list Spaces.
    required: true
    type: str

baseurl:
    default: https://api.digitalocean.com/v2
    description:
    - DigitalOcean API base url.
    type: str

timeout:
    default: 30
    description:
    - The timeout in seconds used for polling DigitalOcean's API.
    type: int

oauth_token:
    aliases:
    - api_token
    description:
    - DigitalOcean OAuth token.
    - There are several other environment variables which can be used to provide this
      value.
    - i.e., - C(DO_API_TOKEN), C(DO_API_KEY), C(DO_OAUTH_TOKEN) and C(OAUTH_TOKEN).
    type: str

validate_certs:
    default: true
    description:
    - If set to C(no), the SSL certificates will not be validated.
    - This should only set to C(no) used on personally controlled sites using self-signed
      certificates.
    type: bool

aws_access_key_id:
    aliases:
    - AWS_ACCESS_KEY_ID
    description:
    - The AWS_ACCESS_KEY_ID to use.
    required: true
    type: str

aws_secret_access_key:
    aliases:
    - AWS_SECRET_ACCESS_KEY
    description:
    - The AWS_SECRET_ACCESS_KEY to use.
    required: true
    type: str

Outputs

data:
  description: List of DigitalOcean Spaces
  returned: always
  sample:
    spaces:
    - endpoint_url: https://nyc3.digitaloceanspaces.com
      name: gh-ci-space
      region: nyc3
      space_url: https://gh-ci-space.nyc3.digitaloceanspaces.com
  type: dict