[ aws . resiliencehub ]

create-recommendation-template

Description

Creates a new recommendation template.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-recommendation-template
--assessment-arn <value>
[--bucket-name <value>]
[--client-token <value>]
[--format <value>]
--name <value>
[--recommendation-ids <value>]
[--recommendation-types <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--assessment-arn (string)

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition :dcps:region :account :app-assessment/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .

--bucket-name (string)

The name of the Amazon S3 bucket that will contain the recommendation template.

--client-token (string)

Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

--format (string)

The format for the recommendation template.

CfnJson

The template is CloudFormation JSON.

CfnYaml

The template is CloudFormation YAML.

Possible values:

• CfnYaml

• CfnJson

--name (string)

The name for the recommendation template.

--recommendation-ids (list)

Identifiers for the recommendations used to create a recommendation template.

(string)

Syntax:

"string" "string" ...

--recommendation-types (list)

An array of strings that specify the recommendation template type or types.

Alarm

The template is an AlarmRecommendation template.

Sop

The template is a SopRecommendation template.

Test

The template is a TestRecommendation template.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  Alarm
  Sop
  Test

--tags (map)

The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "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

recommendationTemplate -> (structure)

The newly created recommendation template, returned as an object. This object includes the template’s name, format, status, tags, Amazon S3 bucket location, and more.

appArn -> (string)

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition :dcps:region :account :app/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .

assessmentArn -> (string)

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition :dcps:region :account :app-assessment/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .

endTime -> (timestamp)

The end time for the action.

format -> (string)

The format of the recommendation template.

CfnJson

The template is CloudFormation JSON.

CfnYaml

The template is CloudFormation YAML.

message -> (string)

The message for the recommendation template.

name -> (string)

The name for the recommendation template.

needsReplacements -> (boolean)

Indicates if replacements are needed.

recommendationIds -> (list)

Identifiers for the recommendations used in the recommendation template.

(string)

recommendationTemplateArn -> (string)

The Amazon Resource Name (ARN) for the recommendation template.

recommendationTypes -> (list)

An array of strings that specify the recommendation template type or types.

Alarm

The template is an AlarmRecommendation template.

Sop

The template is a SopRecommendation template.

Test

The template is a TestRecommendation template.

(string)

startTime -> (timestamp)

The start time for the action.

status -> (string)

The status of the action.

tags -> (map)

The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

key -> (string)

value -> (string)

templatesLocation -> (structure)

The file location of the template.

bucket -> (string)

The name of the Amazon S3 bucket.

prefix -> (string)

The prefix for the Amazon S3 bucket.