New in version 2.5.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
---|---|---|
aws_access_key
|
Default:
None
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
aliases: ec2_access_key, access_key |
aws_secret_key
|
Default:
None
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
aliases: ec2_secret_key, secret_key |
decryption
|
Default:
yes
|
Work with SecureString type to get plain text secrets
Boolean
|
description
|
|
parameter key desciption.
|
ec2_url
|
Default:
None
|
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
|
key_id
|
Default:
aws/ssm (this key is automatically generated at the first parameter created).
|
aws KMS key to decrypt the secrets.
|
name
required |
|
parameter key name.
|
overwrite
|
Default:
yes
|
Overwrite the value when create or update parameter
Boolean
|
profile
(added in 1.6) |
Default:
None
|
Uses a boto profile. Only works with boto >= 2.24.0.
|
region
|
|
region.
|
security_token
(added in 1.6) |
Default:
None
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
aliases: access_token |
state
|
|
Creates or modifies an existing parameter
Deletes a parameter
|
string_type
|
|
Parameter String type
|
validate_certs
(added in 1.5) |
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
value
|
|
Parameter value.
|
Note
- name: Create or update key/value pair in aws parameter store
aws_ssm_parameter_store:
name: "Hello"
description: "This is your first key"
value: "World"
- name: Delete the key
aws_ssm_parameter_store:
name: "Hello"
state: absent
- name: Create or update secure key/value pair with default kms key (aws/ssm)
aws_ssm_parameter_store:
name: "Hello"
description: "This is your first key"
string_type: "SecureString"
value: "World"
- name: Create or update secure key/value pair with nominated kms key
aws_ssm_parameter_store:
name: "Hello"
description: "This is your first key"
string_type: "SecureString"
key_id: "alias/demo"
value: "World"
- name: recommend to use with ssm lookup plugin
debug: msg="{{ lookup('ssm', 'hello') }}"
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
---|---|---|
delete_parameter
dictionary
|
success |
Delete a parameter from the system.
|
put_parameter
dictionary
|
success |
Add one or more paramaters to the system.
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.