[ aws . devops-guru ]

update-resource-collection

Description

Updates the collection of resources that DevOps Guru analyzes. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key . You can specify up to 500 Amazon Web Services CloudFormation stacks. This method also creates the IAM role required for you to use DevOps Guru.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-resource-collection
--action <value>
--resource-collection <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--action (string)

Specifies if the resource collection in the request is added or deleted to the resource collection.

Possible values:

• ADD

• REMOVE

--resource-collection (structure)

Contains information used to update a collection of Amazon Web Services resources.

CloudFormation -> (structure)

A collection of Amazon Web Services CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

StackNames -> (list)

An array of the names of the Amazon Web Services CloudFormation stacks to update. You can specify up to 500 Amazon Web Services CloudFormation stacks.

(string)

Tags -> (list)

The updated Amazon Web Services tags used to filter the resources in the resource collection.

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

Each Amazon Web Services tag has two parts.

• A tag key (for example, CostCenter , Environment , Project , or Secret ). Tag keys are case-sensitive.

• An optional field known as a tag value (for example, 111122223333 , Production , or a team name). Omitting the tag value is the same as using an empty string. Like tag keys , tag values are case-sensitive.

Together these are known as key -value pairs.

Warning

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru- . The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application . While keys are case-sensitive, the case of key characters don’t matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .

(structure)

A new collection of Amazon Web Services resources that are defined by an Amazon Web Services tag or tag key /value pair.

AppBoundaryKey -> (string)

An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

Warning

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru- . The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application . While keys are case-sensitive, the case of key characters don’t matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS . Possible key /value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .

TagValues -> (list)

The values in an Amazon Web Services tag collection.

The tag’s value is an optional field used to associate a string with the tag key (for example, 111122223333 , Production , or a team name). The key and value are the tag’s key pair. Omitting the tag value is the same as using an empty string. Like tag keys , tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

(string)

JSON Syntax:

{
  "CloudFormation": {
    "StackNames": ["string", ...]
  },
  "Tags": [
    {
      "AppBoundaryKey": "string",
      "TagValues": ["string", ...]
    }
    ...
  ]
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

None