S3 Key

s3key

This is a simple module that supports creating or removing S3Keys.

Example Syntax

name: Create an s3key
ionoscloudsdk.ionoscloud.s3key:
  user: ''
register: s3key_create_result


name: Update an s3key no change
ionoscloudsdk.ionoscloud.s3key:
  user: ''
  key_id: ''
  active: true
  state: update
register: s3key_update_nochange_result


name: Remove an s3key 1
ionoscloudsdk.ionoscloud.s3key:
  user: ''
  key_id: ''
  state: absent

Returned object

{
    "changed": true,
    "failed": false,
    "action": "create",
    "s3key": {
        "href": "https://api.ionos.com/cloudapi/v6/um/users/<USER_ID>/s3keys/<ID>",
        "id": "<ID>",
        "metadata": {
            "created_date": "2023-05-31T13:49:52",
            "etag": "26c5aad97d5bb95cc0c1ed99addde9fe"
        },
        "properties": {
            "active": true,
            "secret_key": "<SECRET_KEY>"
        },
        "type": "s3key"
    }
}

For more examples please check out the tests here.

state: present

  
name: Create an s3key
ionoscloudsdk.ionoscloud.s3key:
  user: ''
register: s3key_create_result

Available parameters for state present:

Name	Required	Description
active bool	False	Denotes weather the Object storage key is active.
user str	True	The ID or email of the user
key_id str	False	The ID of the S3 key.
idempotency bool	False	Flag that dictates respecting idempotency. If an s3key already exists, returns with already existing key instead of creating more. Default: False Options: [True, False]
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update']

state: absent

  
name: Remove an s3key 1
ionoscloudsdk.ionoscloud.s3key:
  user: ''
  key_id: ''
  state: absent

Available parameters for state absent:

Name	Required	Description
user str	True	The ID or email of the user
key_id str	True	The ID of the S3 key.
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update']

state: update

  
name: Update an s3key no change
ionoscloudsdk.ionoscloud.s3key:
  user: ''
  key_id: ''
  active: true
  state: update
register: s3key_update_nochange_result

Available parameters for state update:

Name	Required	Description
active bool	False	Denotes weather the Object storage key is active.
user str	True	The ID or email of the user
key_id str	True	The ID of the S3 key.
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update']