terraform-provider-aws icon indicating copy to clipboard operation
terraform-provider-aws copied to clipboard

docs: add argument description to resource aws_ami_copy

Open stefanfreitag opened this issue 4 months ago • 1 comments

Description

The example in resource aws_ami_copy contains a description field that is not documented in the Arguments section.

resource "aws_ami_copy" "example" {
  name              = "terraform-example"
  description       = "A copy of ami-xxxxxxxx"
  source_ami_id     = "ami-xxxxxxxx"
  source_ami_region = "us-west-1"

  tags = {
    Name = "HelloWorld"
  }
}

This PR added the missing field.

Please note: The resource documentation contains the statement below

This resource also exposes the full set of arguments from the aws_ami resource.

So, it may be the case that adding the description field is not required, but it helps readers as they to not need to open another documentation page for getting details on description .

Relations

Closes #39794

References

Output from Acceptance Testing

Not required. Only documentation is updated.

stefanfreitag avatar Oct 18 '24 20:10 stefanfreitag