space

Generated on 16 July 2024 from digitalocean.cloud version v0.6.0

Synopsis

Requirements

  • pydo >= 0.1.3
  • azure-core >= 1.26.1
  • boto3 >= 1.28.53

Parameters

Parameter Choices Default Comments
aws_access_key_id
(str)		 The AWS_ACCESS_KEY_ID to use for authentication. The AWS_ACCESS_KEY_ID environment variable will be used.
aws_secret_access_key
(str)		 The AWS_SECRET_ACCESS_KEY to use for authentication. The AWS_SECRET_ACCESS_KEY environment variable will be used.
client_override_options
(dict)		 Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options.
module_override_options
(dict)		 Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options.
name
(str)		 The short name of the Space to create or delete. For example, given name=my-do-space and region=nyc3, the managed Space will be https://my-do-space.nyc3.digitaloceanspace.com.
region
(str)		 The region in which to create or delete the Space. The SPACES_REGION environment variable will be used.
state
(str)
  • present
  • absent
 present State of the resource, present to create, absent to destroy.
timeout
(int)		 300 Polling timeout in seconds.
token
(str)		 DigitalOcean API token. There are several environment variables which can be used to provide this value. DIGITALOCEAN_ACCESS_TOKEN, DIGITALOCEAN_TOKEN, DO_API_TOKEN, DO_API_KEY, DO_OAUTH_TOKEN and OAUTH_TOKEN

Examples

- name: Create Space my-do-space in nyc3
  digitalocean.cloud.space:
    state: present
    name: my-do-space
    region: nyc3
    aws_access_key_id: "{{ aws_access_key_id}}"
    aws_secret_access_key: "{{ aws_secret_access_key}}"

Return Values

Key Returned Description
error
(dict)		 failure DigitalOcean Spaces boto response metadata.

Sample:

{
  "HTTPHeaders": "Header metadata key/values",
  "HTTPStatusCode": 400,
  "HostId": "Host ID data as a hash",
  "RequestId": "1234567890ABCDEF",
  "RetryAttempts\u0027": 0
}
msg
(str)		 always Space result information.

Sample:

[
  "Created Space named my-do-space in nyc3",
  "Failed to create Space named my-do-space in nyc3",
  "No Spaces named my-do-space in nyc3, would create",
  "Existing Space named my-do-space in nyc3, would create",
  "Deleted Space named my-do-space in nyc3",
  "Failed to delete Space named my-do-space in nyc3",
  "Existing Space named my-do-space in nyc3, would delete",
  "Failed to list Spaces in nyc3"
]
spaces
(dict)		 always Current spaces.

Sample:

{
  "endpoint_url": "https://nyc3.digitaloceanspaces.com",
  "name": "my-do-space",
  "region": "nyc3",
  "space_url": "https://my-do-space.nyc3.digitaloceanspaces.com"
}
Control Panel Blog Pricing Careers Terms Privacy Status API Docs Tutorials Support