ssm_parameter

Manage key-value pairs in AWS Systems Manager Parameter Store

Collection: community.aws

Full Name: community.aws.ssm_parameter

Synopsis

Manage key-value pairs in AWS Systems Manager Parameter Store

Parameters

Name	Type	Required	Default
access_key	str
aws_ca_bundle	path
aws_config	dict
debug_botocore_endpoint_logs	bool		`false`
decryption	bool		`true`
description	str
endpoint_url	str
key_id	str		`alias/aws/ssm`
name	str	yes
overwrite_value	str		`changed`
profile	str
purge_tags	bool		`true`
region	str
secret_key	str
session_token	str
state	str		`present`
string_type	str		`String`
tags	dict
tier	str		`Standard`
validate_certs	bool		`true`
value	str

Example

yaml

- name: Create or update key/value pair in AWS SSM parameter store
  community.aws.ssm_parameter:
    name: "Hello"
    description: "This is your first key"
    value: "World"

- name: Delete the key
  community.aws.ssm_parameter:
    name: "Hello"
    state: absent

- name: Create or update secure key/value pair with default KMS key (aws/ssm)
  community.aws.ssm_parameter:
    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_parameter:
    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_parameter:
    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_parameter:
    name: "Hello"
    description: "This is your first key"
    value: "World"
    tier: "Advanced"

- name: Create or update key/value pair in AWS SSM parameter store w/ tags
  community.aws.ssm_parameter:
    name: "Hello"
    description: "This is your first key"
    value: "World"
    tags:
        Environment: "dev"
        Version: "1.0"
        Confidentiality: "low"
        Tag With Space: "foo bar"

- name: Add or update a tag on an existing parameter w/o removing existing tags
  community.aws.ssm_parameter:
    name: "Hello"
    purge_tags: false
    tags:
        Contact: "person1"

- name: Delete all tags on an existing parameter
  community.aws.ssm_parameter:
    name: "Hello"
    tags: {}