community.aws.secretsmanager_secret module – Manage secrets stored in AWS Secrets Manager
Note
This module is part of the community.aws collection (version 9.0.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.aws.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.secretsmanager_secret.
New in community.aws 1.0.0
Synopsis
Create, update, and delete secrets stored in AWS Secrets Manager.
Prior to release 5.0.0 this module was called
community.aws.aws_secret. The usage did not change.
Aliases: aws_secret
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0
Parameters
Parameter |
Comments |
|---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
Use a The Choices:
|
|
Specifies a user-provided description of the secret. Default: |
|
URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Specifies JSON-formatted data that you want to encrypt and store in the new version of the secret. Mutually exclusive with the secret option. |
|
Specifies the ARN or alias of the AWS KMS customer master key (CMK) to be used to encrypt the secret values in the versions stored in this secret. |
|
Friendly name for the secret you are creating. |
|
Whether to overwrite an existing secret with the same name. If set to If set to Choices:
|
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
If If the Tag keys beginning with Choices:
|
|
Only used if state is absent. Specifies the number of days that Secrets Manager waits before it can delete the secret. If set to 0, the deletion is forced without recovery. Default: |
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
Specifies a list of regions and kms_key_ids (optional) to replicate the secret to |
|
Specifies the ARN or alias of the AWS KMS customer master key (CMK) in the destination region to be used (alias/aws/secretsmanager is assumed if not specified) |
|
Region to replicate secret to. |
|
Specifies JSON-formatted resource policy to attach to the secret. Useful when granting cross-account access to secrets. |
|
Specifies the number of days between automatic scheduled rotations of the secret. Default: |
|
Specifies the ARN of the Lambda function that can rotate the secret. |
|
Specifies string or binary data that you want to encrypt and store in the new version of the secret. Mutually exclusive with the json_secret option. Default: |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Specifies the type of data that you want to encrypt. Choices:
|
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Whether the secret should be exist or not. Choices:
|
|
A dictionary representing the tags to be applied to the resource. If the |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
Notes
Note
Support for purge_tags was added in release 4.0.0.
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
- name: Add string to AWS Secrets Manager
community.aws.secretsmanager_secret:
name: 'test_secret_string'
state: present
secret_type: 'string'
secret: "{{ super_secret_string }}"
- name: Add a secret with resource policy attached
community.aws.secretsmanager_secret:
name: 'test_secret_string'
state: present
secret_type: 'string'
secret: "{{ super_secret_string }}"
resource_policy: "{{ lookup('template', 'templates/resource_policy.json.j2', convert_data=False) | string }}"
- name: remove string from AWS Secrets Manager
community.aws.secretsmanager_secret:
name: 'test_secret_string'
state: absent
secret_type: 'string'
secret: "{{ super_secret_string }}"
- name: Only create a new secret, but do not update if alredy exists by name
community.aws.secretsmanager_secret:
name: 'random_string'
state: present
secret_type: 'string'
secret: "{{ lookup('community.general.random_string', length=16, special=false) }}"
overwrite: false
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The secret information Returned: always |
|
The ARN of the secret. Returned: always Sample: |
|
A description of the secret. Returned: when the secret has a description Sample: |
|
The date the secret was last accessed. Returned: always Sample: |
|
The date the secret was last modified. Returned: always Sample: |
|
The secret name. Returned: always Sample: |
|
The secret rotation status. Returned: always Sample: |
|
A list of dictionaries representing the tags associated with the secret in the standard boto3 format. Returned: when the secret has tags |
|
The name or key of the tag. Returned: success Sample: |
|
The value of the tag. Returned: success Sample: |
|
A dictionary representing the tags associated with the secret. Returned: when the secret has tags Sample: |
|
Provide the secret version ids and the associated secret stage. Returned: always Sample: |