mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
aws_ssm_parameter_store - Make the module idempotent (#36252)
* Make the module idempotent * pep8 fixes. * Made required changes for overwrite_value for idempotency. * Fix missing error definition * Add in missing documentation variable.
This commit is contained in:
parent
6051ef4041
commit
ce6595b567
1 changed files with 64 additions and 11 deletions
|
@ -50,17 +50,20 @@ options:
|
|||
- aws KMS key to decrypt the secrets.
|
||||
required: false
|
||||
default: aws/ssm (this key is automatically generated at the first parameter created).
|
||||
overwrite:
|
||||
overwrite_value:
|
||||
description:
|
||||
- Overwrite the value when create or update parameter
|
||||
- Boolean
|
||||
- Option to overwrite an existing value if it already exists.
|
||||
- String
|
||||
required: false
|
||||
default: True
|
||||
version_added: "2.6"
|
||||
choices: ['never', 'changed', 'always']
|
||||
default: changed
|
||||
region:
|
||||
description:
|
||||
- region.
|
||||
required: false
|
||||
author:
|
||||
- Nathan Webster (@nathanwebsterdotme)
|
||||
- Bill Wang (ozbillwang@gmail.com)
|
||||
- Michael De La Rue (@mikedlr)
|
||||
extends_documentation_fragment: aws
|
||||
|
@ -94,6 +97,14 @@ EXAMPLES = '''
|
|||
key_id: "alias/demo"
|
||||
value: "World"
|
||||
|
||||
- name: Always update a parameter store value and create a new version
|
||||
aws_ssm_parameter_store:
|
||||
name: "overwrite_example"
|
||||
description: "This example will always overwrite the value"
|
||||
string_type: "String"
|
||||
value: "Test1234"
|
||||
overwrite_value: "always"
|
||||
|
||||
- name: recommend to use with ssm lookup plugin
|
||||
debug: msg="{{ lookup('ssm', 'hello') }}"
|
||||
'''
|
||||
|
@ -118,17 +129,35 @@ except ImportError:
|
|||
pass # will be captured by imported HAS_BOTO3
|
||||
|
||||
|
||||
def update_parameter(client, module, args):
|
||||
changed = False
|
||||
response = {}
|
||||
|
||||
try:
|
||||
response = client.put_parameter(**args)
|
||||
changed = True
|
||||
except ClientError as e:
|
||||
module.fail_json_aws(e, msg="setting parameter")
|
||||
|
||||
return changed, response
|
||||
|
||||
|
||||
def create_update_parameter(client, module):
|
||||
changed = False
|
||||
existing_parameter = None
|
||||
response = {}
|
||||
|
||||
args = dict(
|
||||
Name=module.params.get('name'),
|
||||
Value=module.params.get('value'),
|
||||
Type=module.params.get('string_type'),
|
||||
Overwrite=module.params.get('overwrite')
|
||||
Type=module.params.get('string_type')
|
||||
)
|
||||
|
||||
if (module.params.get('overwrite_value') == "always" or "changed"):
|
||||
args.update(Overwrite=True)
|
||||
else:
|
||||
args.update(Overwrite=False)
|
||||
|
||||
if module.params.get('description'):
|
||||
args.update(Description=module.params.get('description'))
|
||||
|
||||
|
@ -136,10 +165,34 @@ def create_update_parameter(client, module):
|
|||
args.update(KeyId=module.params.get('key_id'))
|
||||
|
||||
try:
|
||||
response = client.put_parameter(**args)
|
||||
changed = True
|
||||
except ClientError as e:
|
||||
module.fail_json_aws(e, msg="setting parameter")
|
||||
existing_parameter = client.get_parameter(Name=args['Name'], WithDecryption=True)
|
||||
except:
|
||||
pass
|
||||
|
||||
if existing_parameter:
|
||||
if (module.params.get('overwrite_value') == 'always'):
|
||||
|
||||
(changed, response) = update_parameter(client, module, args)
|
||||
|
||||
elif (module.params.get('overwrite_value') == 'changed'):
|
||||
if existing_parameter['Parameter']['Type'] != args['Type']:
|
||||
(changed, response) = update_parameter(client, module, args)
|
||||
|
||||
if existing_parameter['Parameter']['Value'] != args['Value']:
|
||||
(changed, response) = update_parameter(client, module, args)
|
||||
|
||||
if args['Description']:
|
||||
# Description field not available from get_parameter function so get it from describe_parameters
|
||||
describe_existing_parameter = None
|
||||
try:
|
||||
describe_existing_parameter = client.describe_parameters(Filters=[{"Key": "Name", "Values": [args['Name']]}])
|
||||
except ClientError as e:
|
||||
module.fail_json_aws(e, msg="getting description value")
|
||||
|
||||
if describe_existing_parameter['Parameters'][0]['Description'] != args['Description']:
|
||||
(changed, response) = update_parameter(client, module, args)
|
||||
else:
|
||||
(changed, response) = update_parameter(client, module, args)
|
||||
|
||||
return changed, response
|
||||
|
||||
|
@ -174,7 +227,7 @@ def setup_module_object():
|
|||
string_type=dict(default='String', choices=['String', 'StringList', 'SecureString']),
|
||||
decryption=dict(default=True, type='bool'),
|
||||
key_id=dict(default="alias/aws/ssm"),
|
||||
overwrite=dict(default=True, type='bool'),
|
||||
overwrite_value=dict(default='changed', choices=['never', 'changed', 'always']),
|
||||
region=dict(required=False),
|
||||
)
|
||||
|
||||
|
|
Loading…
Reference in a new issue