Try SpotterManage key-value pairs in AWS Systems Manager Parameter Store
| "added in version" 1.0.0 of community.aws"
Authors: Davinder Pal (@116davinder) <dpsangwal@gmail.com>, Nathan Webster (@nathanwebsterdotme), Bill Wang (@ozbillwang) <ozbillwang@gmail.com>, Michael De La Rue (@mikedlr)
Install with ansible-galaxy collection install community.aws:==5.1.0
collections:
- name: community.aws
version: 5.1.0Manage key-value pairs in AWS Systems Manager (SSM) Parameter Store.
Prior to release 5.0.0 this module was called C(community.aws.aws_ssm_parameter_store). The usage did not change.
- name: Create or update key/value pair in AWS SSM parameter store
community.aws.ssm_paramater:
name: "Hello"
description: "This is your first key"
value: "World"
- name: Delete the key
community.aws.ssm_paramater:
name: "Hello"
state: absent
- name: Create or update secure key/value pair with default KMS key (aws/ssm)
community.aws.ssm_paramater:
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
community.aws.ssm_paramater:
name: "Hello"
description: "This is your first key"
string_type: "SecureString"
key_id: "alias/demo"
value: "World"
- name: Always update a parameter store value and create a new version
community.aws.ssm_paramater:
name: "overwrite_example"
description: "This example will always overwrite the value"
string_type: "String"
value: "Test1234"
overwrite_value: "always"
- name: Create or update key/value pair in AWS SSM parameter store with tier
community.aws.ssm_paramater:
name: "Hello"
description: "This is your first key"
value: "World"
tier: "Advanced"
- name: recommend to use with aws_ssm lookup plugin
ansible.builtin.debug:
msg: "{{ lookup('amazon.aws.aws_ssm', 'Hello') }}"
name:
description:
- Parameter key name.
required: true
type: str
tier:
choices:
- Standard
- Advanced
- Intelligent-Tiering
default: Standard
description:
- Parameter store tier type.
required: false
type: str
version_added: 1.5.0
version_added_collection: community.aws
state:
choices:
- present
- absent
default: present
description:
- Creates or modifies an existing parameter.
- Deletes a parameter.
required: false
type: str
value:
description:
- Parameter value.
required: false
type: str
key_id:
default: alias/aws/ssm
description:
- AWS KMS key to decrypt the secrets.
- The default key (C(alias/aws/ssm)) is automatically generated the first time it's
requested.
required: false
type: str
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use.
- For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
- The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
- See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
- The C(ec2_region) alias has been deprecated and will be removed in a release after
2024-12-01
- Support for the C(EC2_REGION) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
profile:
aliases:
- aws_profile
description:
- A named AWS profile to use for authentication.
- See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
- The C(AWS_PROFILE) environment variable may also be used.
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
access_key:
aliases:
- aws_access_key_id
- aws_access_key
- ec2_access_key
description:
- AWS access key ID.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
may also be used in decreasing order of preference.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
- The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
AWS botocore SDK.
- The I(ec2_access_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
decryption:
default: true
description:
- Work with SecureString type to get plain text secrets
required: false
type: bool
secret_key:
aliases:
- aws_secret_access_key
- aws_secret_key
- ec2_secret_key
description:
- AWS secret access key.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
variables may also be used in decreasing order of preference.
- The I(secret_key) and I(profile) options are mutually exclusive.
- The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
the AWS botocore SDK.
- The I(ec2_secret_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
description:
description:
- Parameter key description.
required: false
type: str
string_type:
aliases:
- type
choices:
- String
- StringList
- SecureString
default: String
description:
- Parameter String type.
required: false
type: str
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- 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 C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
order of preference.
- The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
a release after 2024-12-01.
- Support for the C(EC2_URL) environment variable has been deprecated and will be
removed in a release after 2024-12-01.
type: str
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- The C(AWS_CA_BUNDLE) environment variable may also be used.
type: path
session_token:
aliases:
- aws_session_token
- security_token
- aws_security_token
- access_token
description:
- AWS STS session token for use with temporary credentials.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
variables may also be used in decreasing order of preference.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
the parameter being renamed from I(security_token) to I(session_token) in release
6.0.0.
- The I(security_token), I(aws_security_token), and I(access_token) aliases have been
deprecated and will be removed in a release after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
has been deprecated and will be removed in a release after 2024-12-01.
type: str
validate_certs:
default: true
description:
- When set to C(false), SSL certificates will not be validated for communication with
the AWS APIs.
- Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
setting I(aws_ca_bundle) instead.
type: bool
overwrite_value:
choices:
- never
- changed
- always
default: changed
description:
- Option to overwrite an existing value if it already exists.
required: false
type: str
debug_botocore_endpoint_logs:
default: false
description:
- Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the C(aws_resource_action) callback to output to total list made
during a playbook.
- The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used.
type: bool
parameter_metadata:
contains:
data_type:
description: Parameter Data type.
example: text
returned: success
type: str
description:
description: Parameter key description.
example: This is your first key
returned: success
type: str
last_modified_date:
description: Time and date that the parameter was last modified.
example: '2022-06-20T09:56:58.573000+00:00'
returned: success
type: str
last_modified_user:
description: ARN of the last user to modify the parameter.
example: arn:aws:sts::123456789012:assumed-role/example-role/session=example
returned: success
type: str
name:
description: Parameter key name.
example: Hello
returned: success
type: str
policies:
contains:
policy_status:
description: The status of the policy.
example: Pending
returned: success
type: str
policy_text:
description: The JSON text of the policy.
returned: success
type: str
policy_type:
description: The type of policy.
example: Expiration
returned: success
type: str
description: A list of policies associated with a parameter.
elements: dict
returned: success
type: list
tier:
description: Parameter tier.
example: Standard
returned: success
type: str
type:
description: Parameter type
example: String
returned: success
type: str
version:
description: Parameter version number
example: 3
returned: success
type: int
description:
- Information about a parameter.
- Does not include the value of the parameter as this can be sensitive information.
returned: success
type: dict