Interface RecommendationTemplate.Builder

  • Method Details

    • appArn

      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.

      Parameters:
      appArn - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • assessmentArn

      RecommendationTemplate.Builder assessmentArn(String assessmentArn)

      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.

      Parameters:
      assessmentArn - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • endTime

      The end time for the action.

      Parameters:
      endTime - The end time for the action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • format

      Format of the recommendation template.

      CfnJson

      The template is CloudFormation JSON.

      CfnYaml

      The template is CloudFormation YAML.

      Parameters:
      format - Format of the recommendation template.

      CfnJson

      The template is CloudFormation JSON.

      CfnYaml

      The template is CloudFormation YAML.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • format

      Format of the recommendation template.

      CfnJson

      The template is CloudFormation JSON.

      CfnYaml

      The template is CloudFormation YAML.

      Parameters:
      format - Format of the recommendation template.

      CfnJson

      The template is CloudFormation JSON.

      CfnYaml

      The template is CloudFormation YAML.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • message

      Message for the recommendation template.

      Parameters:
      message - Message for the recommendation template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • name

      Name for the recommendation template.

      Parameters:
      name - Name for the recommendation template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • needsReplacements

      RecommendationTemplate.Builder needsReplacements(Boolean needsReplacements)

      Indicates if replacements are needed.

      Parameters:
      needsReplacements - Indicates if replacements are needed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • recommendationIds

      RecommendationTemplate.Builder recommendationIds(Collection<String> recommendationIds)

      Identifiers for the recommendations used in the recommendation template.

      Parameters:
      recommendationIds - Identifiers for the recommendations used in the recommendation template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • recommendationIds

      RecommendationTemplate.Builder recommendationIds(String... recommendationIds)

      Identifiers for the recommendations used in the recommendation template.

      Parameters:
      recommendationIds - Identifiers for the recommendations used in the recommendation template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • recommendationTemplateArn

      RecommendationTemplate.Builder recommendationTemplateArn(String recommendationTemplateArn)

      Amazon Resource Name (ARN) for the recommendation template.

      Parameters:
      recommendationTemplateArn - Amazon Resource Name (ARN) for the recommendation template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • recommendationTypesWithStrings

      RecommendationTemplate.Builder recommendationTypesWithStrings(Collection<String> 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • recommendationTypesWithStrings

      RecommendationTemplate.Builder recommendationTypesWithStrings(String... 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • recommendationTypes

      RecommendationTemplate.Builder recommendationTypes(Collection<RenderRecommendationType> 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • recommendationTypes

      RecommendationTemplate.Builder recommendationTypes(RenderRecommendationType... 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • startTime

      The start time for the action.

      Parameters:
      startTime - The start time for the action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • status

      Status of the action.

      Parameters:
      status - Status of the action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • status

      Status of the action.

      Parameters:
      status - Status of the action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • templatesLocation

      RecommendationTemplate.Builder templatesLocation(S3Location templatesLocation)

      The file location of the template.

      Parameters:
      templatesLocation - The file location of the template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • templatesLocation

      default RecommendationTemplate.Builder templatesLocation(Consumer<S3Location.Builder> templatesLocation)

      The file location of the template.

      This is a convenience method that creates an instance of the S3Location.Builder avoiding the need to create one manually via S3Location.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to templatesLocation(S3Location).

      Parameters:
      templatesLocation - a consumer that will call methods on S3Location.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: