Skip to content

Commit

Permalink
allow adding tags to an SSM parameter if overwrite is specified
Browse files Browse the repository at this point in the history
  • Loading branch information
@anGie44
anGie44 committed Apr 7, 2021
1 parent 102e6da commit 3108b4b
Show file tree
Hide file tree
Showing 2 changed files with 208 additions and 108 deletions.
76 changes: 38 additions & 38 deletions aws/resource_aws_ssm_parameter.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ import (

"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/service/ssm"
"github.com/hashicorp/aws-sdk-go-base/tfawserr"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/customdiff"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
"github.com/terraform-providers/terraform-provider-aws/aws/internal/keyvaluetags"
"github.com/terraform-providers/terraform-provider-aws/aws/internal/tfresource"
)

const (
Expand Down Expand Up @@ -109,11 +111,9 @@ func resourceAwsSsmParameter() *schema.Resource {
}

func resourceAwsSsmParameterRead(d *schema.ResourceData, meta interface{}) error {
ssmconn := meta.(*AWSClient).ssmconn
conn := meta.(*AWSClient).ssmconn
ignoreTagsConfig := meta.(*AWSClient).IgnoreTagsConfig

log.Printf("[DEBUG] Reading SSM Parameter: %s", d.Id())

input := &ssm.GetParameterInput{
Name: aws.String(d.Id()),
WithDecryption: aws.Bool(true),
Expand All @@ -122,9 +122,9 @@ func resourceAwsSsmParameterRead(d *schema.ResourceData, meta interface{}) error
var resp *ssm.GetParameterOutput
err := resource.Retry(ssmParameterCreationValidationTimeout, func() *resource.RetryError {
var err error
resp, err = ssmconn.GetParameter(input)
resp, err = conn.GetParameter(input)

if isAWSErr(err, ssm.ErrCodeParameterNotFound, "") && d.IsNewResource() && d.Get("data_type").(string) == "aws:ec2:image" {
if tfawserr.ErrCodeEquals(err, ssm.ErrCodeParameterNotFound) && d.IsNewResource() && d.Get("data_type").(string) == "aws:ec2:image" {
return resource.RetryableError(fmt.Errorf("error reading SSM Parameter (%s) after creation: this can indicate that the provided parameter value could not be validated by SSM", d.Id()))
}

Expand All @@ -135,11 +135,11 @@ func resourceAwsSsmParameterRead(d *schema.ResourceData, meta interface{}) error
return nil
})

if isResourceTimeoutError(err) {
resp, err = ssmconn.GetParameter(input)
if tfresource.TimedOut(err) {
resp, err = conn.GetParameter(input)
}

if isAWSErr(err, ssm.ErrCodeParameterNotFound, "") && !d.IsNewResource() {
if tfawserr.ErrCodeEquals(err, ssm.ErrCodeParameterNotFound) && !d.IsNewResource() {
log.Printf("[WARN] SSM Parameter (%s) not found, removing from state", d.Id())
d.SetId("")
return nil
Expand All @@ -150,7 +150,7 @@ func resourceAwsSsmParameterRead(d *schema.ResourceData, meta interface{}) error
}

param := resp.Parameter
name := *param.Name
name := aws.StringValue(param.Name)
d.Set("name", name)
d.Set("type", param.Type)
d.Set("value", param.Value)
Expand All @@ -165,9 +165,9 @@ func resourceAwsSsmParameterRead(d *schema.ResourceData, meta interface{}) error
},
},
}
describeResp, err := ssmconn.DescribeParameters(describeParamsInput)
describeResp, err := conn.DescribeParameters(describeParamsInput)
if err != nil {
return fmt.Errorf("error describing SSM parameter: %w", err)
return fmt.Errorf("error describing SSM parameter (%s): %w", d.Id(), err)
}

if describeResp == nil || len(describeResp.Parameters) == 0 || describeResp.Parameters[0] == nil {
Expand All @@ -186,7 +186,7 @@ func resourceAwsSsmParameterRead(d *schema.ResourceData, meta interface{}) error
d.Set("allowed_pattern", detail.AllowedPattern)
d.Set("data_type", detail.DataType)

tags, err := keyvaluetags.SsmListTags(ssmconn, name, ssm.ResourceTypeForTaggingParameter)
tags, err := keyvaluetags.SsmListTags(conn, name, ssm.ResourceTypeForTaggingParameter)

if err != nil {
return fmt.Errorf("error listing tags for SSM Parameter (%s): %w", name, err)
Expand All @@ -202,13 +202,16 @@ func resourceAwsSsmParameterRead(d *schema.ResourceData, meta interface{}) error
}

func resourceAwsSsmParameterDelete(d *schema.ResourceData, meta interface{}) error {
ssmconn := meta.(*AWSClient).ssmconn

log.Printf("[INFO] Deleting SSM Parameter: %s", d.Id())
conn := meta.(*AWSClient).ssmconn

_, err := ssmconn.DeleteParameter(&ssm.DeleteParameterInput{
_, err := conn.DeleteParameter(&ssm.DeleteParameterInput{
Name: aws.String(d.Get("name").(string)),
})

if tfawserr.ErrCodeEquals(err, ssm.ErrCodeParameterNotFound) {
return nil
}

if err != nil {
return fmt.Errorf("error deleting SSM Parameter (%s): %s", d.Id(), err)
}
Expand All @@ -217,17 +220,15 @@ func resourceAwsSsmParameterDelete(d *schema.ResourceData, meta interface{}) err
}

func resourceAwsSsmParameterPut(d *schema.ResourceData, meta interface{}) error {
ssmconn := meta.(*AWSClient).ssmconn
conn := meta.(*AWSClient).ssmconn

name := d.Get("name").(string)
log.Printf("[INFO] Creating SSM Parameter: %s", name)

paramInput := &ssm.PutParameterInput{
Name: aws.String(name),
Type: aws.String(d.Get("type").(string)),
Tier: aws.String(d.Get("tier").(string)),
Value: aws.String(d.Get("value").(string)),
Overwrite: aws.Bool(shouldUpdateSsmParameter(d)),
AllowedPattern: aws.String(d.Get("allowed_pattern").(string)),
}

Expand All @@ -244,26 +245,36 @@ func resourceAwsSsmParameterPut(d *schema.ResourceData, meta interface{}) error
paramInput.SetKeyId(keyID.(string))
}

if v, ok := d.GetOk("tags"); ok && d.IsNewResource() {
if v, ok := d.GetOk("overwrite"); ok {
paramInput.Overwrite = aws.Bool(v.(bool))
}

// The AWS SSM Service only supports Tags in a PutParameter request
// if it is not accompanied with an Overwrite value
if v, ok := d.GetOk("tags"); ok && paramInput.Overwrite == nil {
paramInput.Tags = keyvaluetags.New(v.(map[string]interface{})).IgnoreAws().SsmTags()
}

log.Printf("[DEBUG] Waiting for SSM Parameter %v to be updated", d.Get("name"))
_, err := ssmconn.PutParameter(paramInput)
_, err := conn.PutParameter(paramInput)

if isAWSErr(err, "ValidationException", "Tier is not supported") {
if tfawserr.ErrMessageContains(err, "ValidationException", "Tier is not supported") {
paramInput.Tier = nil
_, err = ssmconn.PutParameter(paramInput)
_, err = conn.PutParameter(paramInput)
}

if err != nil {
return fmt.Errorf("error creating SSM parameter: %w", err)
if d.IsNewResource() {
return fmt.Errorf("error creating SSM parameter (%s): %w", name, err)
}
return fmt.Errorf("error updating SSM parameter (%s): %w", name, err)
}

if !d.IsNewResource() && d.HasChange("tags") {
// As the AWS SSM Service does not support adding Tags to a resource when Overwrite is configured,
// we make an additional API call to Update the resource Tags if necessary
if d.HasChange("tags") && paramInput.Tags == nil {
o, n := d.GetChange("tags")

if err := keyvaluetags.SsmUpdateTags(ssmconn, name, ssm.ResourceTypeForTaggingParameter, o, n); err != nil {
if err := keyvaluetags.SsmUpdateTags(conn, name, ssm.ResourceTypeForTaggingParameter, o, n); err != nil {
return fmt.Errorf("error updating SSM Parameter (%s) tags: %w", name, err)
}
}
Expand All @@ -272,14 +283,3 @@ func resourceAwsSsmParameterPut(d *schema.ResourceData, meta interface{}) error

return resourceAwsSsmParameterRead(d, meta)
}

func shouldUpdateSsmParameter(d *schema.ResourceData) bool {
// If the user has specified a preference, return their preference
if value, ok := d.GetOkExists("overwrite"); ok {
return value.(bool)
}

// Since the user has not specified a preference, obey lifecycle rules
// if it is not a new resource, otherwise overwrite should be set to false.
return !d.IsNewResource()
}
Loading

0 comments on commit 3108b4b

Please sign in to comment.