> For the complete documentation index, see [llms.txt](https://docs.ionos.com/cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ionos.com/cloud/ansible/api/object-storage-management/modules/object_storage_access_key.md). # Access Key ## object\_storage\_access\_key This is a module that supports creating and destroying IONOS CLOUD Object Storage Access Keys ### Example Syntax ```yaml name: Create Access Key ionoscloudsdk.ionoscloud.object_storage_access_key: description: "{{ description }}" diff: true register: access_key_create_result name: Update Access Key ionoscloudsdk.ionoscloud.object_storage_access_key: description: "{{ description }}" access_key: "{{ access_key_create_result.access_key.id }}" state: update diff: true register: access_key_update_result name: Renew Access Key ionoscloudsdk.ionoscloud.object_storage_access_key: access_key: "{{ access_key_create_result.access_key.id }}" state: renew register: access_key_renew_result name: Delete an Access Key ionoscloudsdk.ionoscloud.object_storage_access_key: access_key: "{{ access_key_create_result.access_key.id }}" state: absent register: access_key_create_result ``` ### Returned object ```json { "changed": false, "failed": false, "action": "create", "access_key": { "id": "", "type": "accesskey", "href": "https://s3.ionos.com/accesskeys/", "metadata": { "created_date": "2025-12-11T14:24:16.707651+00:00", "created_by": "ionos:iam:cloud::users/", "created_by_user_id": "", "last_modified_date": "2025-12-11T14:24:22.196873+00:00", "last_modified_by": "ionos:iam:cloud::users/", "last_modified_by_user_id": "", "resource_urn": "ionos:s3:::accesskeys/", "status": "AVAILABLE", "status_message": null, "administrative": true, "supported_regions": [ "eu-central-2", "eu-south-2", "eu-central-3", "us-central-1", "de" ] }, "properties": { "description": "Test description", "access_key": "ACCESS_KEY", "secret_key": null, "canonical_user_id": "canonical_user_id", "contract_user_id": "contract_user_id" } } } ``` #### For more examples please check out the tests [here](https://github.com/ionos-cloud/module-ansible/tree/master/tests/object-storage-management). ***NOTE:*** **If you are using a versions 7.0.0 and up**: modules can replace resources if certain set parameters differ from the results found in the API! ### Parameters that can trigger a resource replacement: ## state: **present** ```yaml name: Create Access Key ionoscloudsdk.ionoscloud.object_storage_access_key: description: "{{ description }}" diff: true register: access_key_create_result ``` #### Available parameters for state **present**:

Name	Required	Description
description str	False	Description of the Access 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', 'renew']

## state: **absent** ```yaml name: Delete an Access Key ionoscloudsdk.ionoscloud.object_storage_access_key: access_key: "{{ access_key_create_result.access_key.id }}" state: absent register: access_key_create_result ``` #### Available parameters for state **absent**:

Name	Required	Description
access_key str	True	The UUID of an existing access key, not the access key field.
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', 'renew']

## state: **update** ```yaml name: Update Access Key ionoscloudsdk.ionoscloud.object_storage_access_key: description: "{{ description }}" access_key: "{{ access_key_create_result.access_key.id }}" state: update diff: true register: access_key_update_result ``` #### Available parameters for state **update**:

Name	Required	Description
access_key str	True	The UUID of an existing access key, not the access key field.
description str	False	Description of the Access 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', 'renew']

## state: **renew** ```yaml name: Renew Access Key ionoscloudsdk.ionoscloud.object_storage_access_key: access_key: "{{ access_key_create_result.access_key.id }}" state: renew register: access_key_renew_result ``` #### Available parameters for state **renew**:

Name	Required	Description
access_key str	True	The UUID of an existing access key, not the access key field.
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', 'renew']

--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.ionos.com/cloud/ansible/api/object-storage-management/modules/object_storage_access_key.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.