Skip to content

Creates a new recommendation template for the Resilience Hub application

Description

Creates a new recommendation template for the Resilience Hub application.

Usage

resiliencehub_create_recommendation_template(assessmentArn, bucketName,
  clientToken, format, name, recommendationIds, recommendationTypes, tags)

Arguments

  • assessmentArn

    [required] 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.

  • bucketName

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

  • clientToken

    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

    The format for the recommendation template.

    CfnJson

    The template is CloudFormation JSON.

    CfnYaml

    The template is CloudFormation YAML.

  • name

    [required] The name for the recommendation template.

  • recommendationIds

    Identifiers for the recommendations used to create a recommendation template.

  • recommendationTypes

    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.

  • tags

    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.

Value

A list with the following syntax:

list(
  recommendationTemplate = list(
    appArn = "string",
    assessmentArn = "string",
    endTime = as.POSIXct(
      "2015-01-01"
    ),
    format = "CfnYaml"|"CfnJson",
    message = "string",
    name = "string",
    needsReplacements = TRUE|FALSE,
    recommendationIds = list(
      "string"
    ),
    recommendationTemplateArn = "string",
    recommendationTypes = list(
      "Alarm"|"Sop"|"Test"
    ),
    startTime = as.POSIXct(
      "2015-01-01"
    ),
    status = "Pending"|"InProgress"|"Failed"|"Success",
    tags = list(
      "string"
    ),
    templatesLocation = list(
      bucket = "string",
      prefix = "string"
    )
  )
)

Request syntax

svc$create_recommendation_template(
  assessmentArn = "string",
  bucketName = "string",
  clientToken = "string",
  format = "CfnYaml"|"CfnJson",
  name = "string",
  recommendationIds = list(
    "string"
  ),
  recommendationTypes = list(
    "Alarm"|"Sop"|"Test"
  ),
  tags = list(
    "string"
  )
)