Skip to content

Clarify Documentation for config_configuration_recorder  #16575

@sukoneck

Description

@sukoneck

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 other comments that do not add relevant new information or questions, 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

Description

There are 3 optional arguments within the recording_group argument of the config_configuration_recorder resource. To successfully use the resource_types argument, you must set all_supported to false; however, the documentation for all_supported says:

Conflicts with resource_types.

It would be nice if the documentation clarified that all_supported = false is required when using resource_types.

New or Affected Resource(s)

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/config_configuration_recorder
https://docs.aws.amazon.com/config/latest/APIReference/API_ResourceIdentifier.html#config-Type-ResourceIdentifier-resourceType

Potential Terraform Configuration

resource "aws_config_configuration_recorder" "foo" {
  name     = "example"
  role_arn = aws_iam_role.r.arn
  recording_group {
    all_supported  = false
    resource_types = [ "AWS::IAM::User" ]
  }
}

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationIntroduces or discusses updates to documentation.enhancementRequests to existing resources that expand the functionality or scope.good first issueCall to action for new contributors looking for a place to start. Smaller or straightforward issues.service/configserviceIssues and PRs that pertain to the configservice service.

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions