Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . resiliencehub ]

create-recommendation-template

Description

Creates a new recommendation template for the Resilience Hub application.

See also: AWS API Documentation

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 <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--assessment-arn (string)

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

--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)

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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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)

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

assessmentArn -> (string)

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

endTime -> (timestamp)

The end time for the action.

format -> (string)

Format of the recommendation template.

CfnJson

The template is CloudFormation JSON.

CfnYaml

The template is CloudFormation YAML.

message -> (string)

Message for the recommendation template.

name -> (string)

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)

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)

Status of the action.

tags -> (map)

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.