Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Error creating SSM association: InvalidDocument: Invalid document provided #10004

Closed
hryamzik opened this issue Sep 5, 2019 · 3 comments · Fixed by #17582
Closed

Error creating SSM association: InvalidDocument: Invalid document provided #10004

hryamzik opened this issue Sep 5, 2019 · 3 comments · Fixed by #17582
Assignees
Labels
bug Addresses a defect in current functionality. service/s3 Issues and PRs that pertain to the s3 service. service/ssm Issues and PRs that pertain to the ssm service.
Milestone

Comments

@hryamzik
Copy link
Contributor

hryamzik commented Sep 5, 2019

Community Note

  • Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
  • Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
  • If you are interested in working on this issue or have submitted a pull request, please leave a comment

Terraform Version

Terraform v0.11.14

Affected Resource(s)

  • aws_ssm_association
  • aws_ssm_document

Terraform Configuration Files

variable scripts {
    default = [
        "myscript.sh"
    ]
}

resource "aws_s3_bucket_object" "scripts" {
  key    = "${var.scripts[count.index]}"
  bucket = "${aws_s3_bucket.scripts.bucket}"
  source = "${path.module}/scripts/${var.scripts[count.index]}"
  etag   = "${md5(file("${path.module}/scripts/${var.scripts[count.index]}"))}"
  acl    = "private"
  count  = "${length(var.scripts)}"
}

resource "aws_ssm_document" "run-remote-script" {
  name          = "RunRemoteScript-${element(aws_s3_bucket_object.scripts.*.etag, count.index)}"
  document_type = "Command"
  content = "${file("${path.module}/documents/RunRemoteScript.yaml")}"
  count = "${length(var.scripts)}"
  document_format = "YAML"
}

resource "aws_ssm_association" "script" {
  name             = "AWS-RunRemoteScript-${element(aws_s3_bucket_object.scripts.*.etag, index(var.scripts, "myscript.sh"))}"
  association_name = "s3-script"
  parameters {
      sourceType = "S3"
      sourceInfo = <<EOJ
      {
          "path": "https://s3.amazonaws.com/${aws_s3_bucket.scripts.bucket}/myscript.sh"
      }
      EOJ
      commandLine = "myscript.sh"
  }
}

Expected results

Works without errors

Actual results

First run is fine. terraform plan on script file change looks fine as well but fails to apply:

Error: Error applying plan:

2 errors occurred:
	* aws_ssm_document.run-remote-script: 1 error occurred:
	* aws_ssm_document.run-remote-script: Error updating SSM document: InvalidDocument: 
	status code: 400, request id: xxxxx


	* aws_ssm_association.script: 1 error occurred:
	* aws_ssm_association.script: Error creating SSM association: InvalidDocument: Invalid document provided
	status code: 400, request id: xxxxx

Terraform manages to apply changes after 2-3 retries.

Old versions of documents are not deleted.

References

@ghost ghost added service/s3 Issues and PRs that pertain to the s3 service. service/ssm Issues and PRs that pertain to the ssm service. labels Sep 5, 2019
@github-actions github-actions bot added the needs-triage Waiting for first response or review from a maintainer. label Sep 5, 2019
@bflad bflad added bug Addresses a defect in current functionality. and removed needs-triage Waiting for first response or review from a maintainer. labels Feb 12, 2021
@bflad bflad self-assigned this Feb 12, 2021
bflad added a commit that referenced this issue Feb 12, 2021
Reference: #7221
Reference: #10004
Reference: #13483
Reference: #14679

The name is the primary identifier for the resource, so calling `UpdateDocument` with a new name is invalid. This attempted in-place update behavior was additionally confusing because it would silently not do anything on just name updates.

Previously (just `aws_ssm_document` resource):

```
=== CONT  TestAccAWSSSMDocument_Name
    resource_aws_ssm_document_test.go:50: Step 3/3 error: After applying this test step and performing a `terraform refresh`, the plan was not empty.
        stdout

        An execution plan has been generated and is shown below.
        Resource actions are indicated with the following symbols:
          ~ update in-place

        Terraform will perform the following actions:

          # aws_ssm_document.test will be updated in-place
          ~ resource "aws_ssm_document" "test" {
                id               = "tf-acc-test-3858217851784081459"
              ~ name             = "tf-acc-test-3858217851784081459" -> "tf-acc-test-8266894063699649325"
                tags             = {}
                # (17 unchanged attributes hidden)
            }

        Plan: 0 to add, 1 to change, 0 to destroy.
--- FAIL: TestAccAWSSSMDocument_Name (25.03s)
```

Previously (temporarily adding `aws_ssm_association` resource in test):

```
=== CONT  TestAccAWSSSMDocument_Name
    resource_aws_ssm_document_test.go:50: Step 3/3 error: Error running apply: exit status 1

        Error: Error creating SSM association: InvalidDocument: Invalid document provided

    testing_new.go:63: Error running post-test destroy, there may be dangling resources: exit status 1

        Error: InvalidDocument: Document tf-acc-test-2434960888500369098 does not exist in your account

--- FAIL: TestAccAWSSSMDocument_Name (20.39s)
```

Output from acceptance testing in AWS Commercial:

```
--- PASS: TestAccAWSSSMDocument_params (32.31s)
--- PASS: TestAccAWSSSMDocument_session (32.42s)
--- PASS: TestAccAWSSSMDocument_permission_public (32.93s)
--- PASS: TestAccAWSSSMDocument_permission_batching (33.39s)
--- PASS: TestAccAWSSSMDocument_permission_private (34.12s)
--- PASS: TestAccAWSSSMDocument_basic (41.99s)
--- PASS: TestAccAWSSSMDocument_Name (46.45s)
--- PASS: TestAccAWSSSMDocument_target_type (50.60s)
--- PASS: TestAccAWSSSMDocument_SchemaVersion_1 (50.79s)
--- PASS: TestAccAWSSSMDocument_update (50.97s)
--- PASS: TestAccAWSSSMDocument_DocumentFormat_YAML (51.02s)
--- PASS: TestAccAWSSSMDocument_automation (51.41s)
--- PASS: TestAccAWSSSMDocument_VersionName (53.47s)
--- PASS: TestAccAWSSSMDocument_Tags (60.30s)
--- PASS: TestAccAWSSSMDocument_permission_change (63.56s)
--- PASS: TestAccAWSSSMDocument_package (76.31s)
```

Output from acceptance testing in AWS GovCloud (US):

```
--- PASS: TestAccAWSSSMDocument_session (34.91s)
--- PASS: TestAccAWSSSMDocument_permission_public (38.16s)
--- PASS: TestAccAWSSSMDocument_permission_batching (38.82s)
--- PASS: TestAccAWSSSMDocument_params (44.52s)
--- PASS: TestAccAWSSSMDocument_basic (48.72s)
--- PASS: TestAccAWSSSMDocument_permission_private (49.47s)
--- PASS: TestAccAWSSSMDocument_automation (50.99s)
--- PASS: TestAccAWSSSMDocument_target_type (52.10s)
--- PASS: TestAccAWSSSMDocument_SchemaVersion_1 (52.11s)
--- PASS: TestAccAWSSSMDocument_VersionName (54.82s)
--- PASS: TestAccAWSSSMDocument_DocumentFormat_YAML (55.16s)
--- PASS: TestAccAWSSSMDocument_Name (55.40s)
--- PASS: TestAccAWSSSMDocument_update (63.46s)
--- PASS: TestAccAWSSSMDocument_Tags (64.97s)
--- PASS: TestAccAWSSSMDocument_permission_change (67.99s)
--- PASS: TestAccAWSSSMDocument_package (78.07s)
```
bflad added a commit that referenced this issue Feb 18, 2021
Reference: #7221
Reference: #10004
Reference: #13483
Reference: #14679

The name is the primary identifier for the resource, so calling `UpdateDocument` with a new name is invalid. This attempted in-place update behavior was additionally confusing because it would silently not do anything on just name updates.

Previously (just `aws_ssm_document` resource):

```
=== CONT  TestAccAWSSSMDocument_Name
    resource_aws_ssm_document_test.go:50: Step 3/3 error: After applying this test step and performing a `terraform refresh`, the plan was not empty.
        stdout

        An execution plan has been generated and is shown below.
        Resource actions are indicated with the following symbols:
          ~ update in-place

        Terraform will perform the following actions:

          # aws_ssm_document.test will be updated in-place
          ~ resource "aws_ssm_document" "test" {
                id               = "tf-acc-test-3858217851784081459"
              ~ name             = "tf-acc-test-3858217851784081459" -> "tf-acc-test-8266894063699649325"
                tags             = {}
                # (17 unchanged attributes hidden)
            }

        Plan: 0 to add, 1 to change, 0 to destroy.
--- FAIL: TestAccAWSSSMDocument_Name (25.03s)
```

Previously (temporarily adding `aws_ssm_association` resource in test):

```
=== CONT  TestAccAWSSSMDocument_Name
    resource_aws_ssm_document_test.go:50: Step 3/3 error: Error running apply: exit status 1

        Error: Error creating SSM association: InvalidDocument: Invalid document provided

    testing_new.go:63: Error running post-test destroy, there may be dangling resources: exit status 1

        Error: InvalidDocument: Document tf-acc-test-2434960888500369098 does not exist in your account

--- FAIL: TestAccAWSSSMDocument_Name (20.39s)
```

Output from acceptance testing in AWS Commercial:

```
--- PASS: TestAccAWSSSMDocument_params (32.31s)
--- PASS: TestAccAWSSSMDocument_session (32.42s)
--- PASS: TestAccAWSSSMDocument_permission_public (32.93s)
--- PASS: TestAccAWSSSMDocument_permission_batching (33.39s)
--- PASS: TestAccAWSSSMDocument_permission_private (34.12s)
--- PASS: TestAccAWSSSMDocument_basic (41.99s)
--- PASS: TestAccAWSSSMDocument_Name (46.45s)
--- PASS: TestAccAWSSSMDocument_target_type (50.60s)
--- PASS: TestAccAWSSSMDocument_SchemaVersion_1 (50.79s)
--- PASS: TestAccAWSSSMDocument_update (50.97s)
--- PASS: TestAccAWSSSMDocument_DocumentFormat_YAML (51.02s)
--- PASS: TestAccAWSSSMDocument_automation (51.41s)
--- PASS: TestAccAWSSSMDocument_VersionName (53.47s)
--- PASS: TestAccAWSSSMDocument_Tags (60.30s)
--- PASS: TestAccAWSSSMDocument_permission_change (63.56s)
--- PASS: TestAccAWSSSMDocument_package (76.31s)
```

Output from acceptance testing in AWS GovCloud (US):

```
--- PASS: TestAccAWSSSMDocument_session (34.91s)
--- PASS: TestAccAWSSSMDocument_permission_public (38.16s)
--- PASS: TestAccAWSSSMDocument_permission_batching (38.82s)
--- PASS: TestAccAWSSSMDocument_params (44.52s)
--- PASS: TestAccAWSSSMDocument_basic (48.72s)
--- PASS: TestAccAWSSSMDocument_permission_private (49.47s)
--- PASS: TestAccAWSSSMDocument_automation (50.99s)
--- PASS: TestAccAWSSSMDocument_target_type (52.10s)
--- PASS: TestAccAWSSSMDocument_SchemaVersion_1 (52.11s)
--- PASS: TestAccAWSSSMDocument_VersionName (54.82s)
--- PASS: TestAccAWSSSMDocument_DocumentFormat_YAML (55.16s)
--- PASS: TestAccAWSSSMDocument_Name (55.40s)
--- PASS: TestAccAWSSSMDocument_update (63.46s)
--- PASS: TestAccAWSSSMDocument_Tags (64.97s)
--- PASS: TestAccAWSSSMDocument_permission_change (67.99s)
--- PASS: TestAccAWSSSMDocument_package (78.07s)
```
@github-actions github-actions bot added this to the v3.29.0 milestone Feb 18, 2021
@bflad
Copy link
Contributor

bflad commented Feb 18, 2021

The fix (requiring aws_ssm_document resource replacement when changing the name argument) has been merged and will release with version 3.29.0 of the Terraform AWS Provider, likely later today.

@ghost
Copy link

ghost commented Feb 19, 2021

This has been released in version 3.29.0 of the Terraform AWS provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template for triage. Thanks!

@ghost
Copy link

ghost commented Mar 21, 2021

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!

@ghost ghost locked as resolved and limited conversation to collaborators Mar 21, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Addresses a defect in current functionality. service/s3 Issues and PRs that pertain to the s3 service. service/ssm Issues and PRs that pertain to the ssm service.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants