Class: Aws::ResilienceHub::Types::RecommendationTemplate

Inherits:

Struct

• Object
• Struct
• Aws::ResilienceHub::Types::RecommendationTemplate

Defined in:

gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb

Overview

Defines a recommendation template created with the CreateRecommendationTemplate action.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:tags]

Instance Attribute Summary

• #app_arn ⇒ String

  The Amazon Resource Name (ARN) of the Resilience Hub application.

• #assessment_arn ⇒ String

  The Amazon Resource Name (ARN) of the assessment.

• #end_time ⇒ Time

  The end time for the action.

• #format ⇒ String

  The format of the recommendation template.

• #message ⇒ String

  The message for the recommendation template.

• #name ⇒ String

  The name for the recommendation template.

• #needs_replacements ⇒ Boolean

  Indicates if replacements are needed.

• #recommendation_ids ⇒ Array<String>

  Identifiers for the recommendations used in the recommendation template.

• #recommendation_template_arn ⇒ String

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

• #recommendation_types ⇒ Array<String>

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

• #start_time ⇒ Time

  The start time for the action.

• #status ⇒ String

  The status of the action.

• #tags ⇒ Hash<String,String>

  The tags assigned to the resource.

• #templates_location ⇒ Types::S3Location

  The file location of the template.

Instance Attribute Details

#app_arn ⇒ String

The 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 AWS General Reference guide.

Returns:

• (String)

# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 4211

class RecommendationTemplate < Struct.new(
  :app_arn,
  :assessment_arn,
  :end_time,
  :format,
  :message,
  :name,
  :needs_replacements,
  :recommendation_ids,
  :recommendation_template_arn,
  :recommendation_types,
  :start_time,
  :status,
  :tags,
  :templates_location)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#assessment_arn ⇒ String

The 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 AWS General Reference guide.

Returns:

• (String)

# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 4211

class RecommendationTemplate < Struct.new(
  :app_arn,
  :assessment_arn,
  :end_time,
  :format,
  :message,
  :name,
  :needs_replacements,
  :recommendation_ids,
  :recommendation_template_arn,
  :recommendation_types,
  :start_time,
  :status,
  :tags,
  :templates_location)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#end_time ⇒ Time

The end time for the action.

Returns:

• (Time)

# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 4211

class RecommendationTemplate < Struct.new(
  :app_arn,
  :assessment_arn,
  :end_time,
  :format,
  :message,
  :name,
  :needs_replacements,
  :recommendation_ids,
  :recommendation_template_arn,
  :recommendation_types,
  :start_time,
  :status,
  :tags,
  :templates_location)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#format ⇒ String

The format of the recommendation template.

CfnJson

The template is CloudFormation JSON.

CfnYaml

The template is CloudFormation YAML.

Returns:

• (String)

# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 4211

class RecommendationTemplate < Struct.new(
  :app_arn,
  :assessment_arn,
  :end_time,
  :format,
  :message,
  :name,
  :needs_replacements,
  :recommendation_ids,
  :recommendation_template_arn,
  :recommendation_types,
  :start_time,
  :status,
  :tags,
  :templates_location)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#message ⇒ String

The message for the recommendation template.

Returns:

• (String)

# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 4211

class RecommendationTemplate < Struct.new(
  :app_arn,
  :assessment_arn,
  :end_time,
  :format,
  :message,
  :name,
  :needs_replacements,
  :recommendation_ids,
  :recommendation_template_arn,
  :recommendation_types,
  :start_time,
  :status,
  :tags,
  :templates_location)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#name ⇒ String

The name for the recommendation template.

Returns:

• (String)

# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 4211

class RecommendationTemplate < Struct.new(
  :app_arn,
  :assessment_arn,
  :end_time,
  :format,
  :message,
  :name,
  :needs_replacements,
  :recommendation_ids,
  :recommendation_template_arn,
  :recommendation_types,
  :start_time,
  :status,
  :tags,
  :templates_location)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#needs_replacements ⇒ Boolean

Indicates if replacements are needed.

Returns:

• (Boolean)

# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 4211

class RecommendationTemplate < Struct.new(
  :app_arn,
  :assessment_arn,
  :end_time,
  :format,
  :message,
  :name,
  :needs_replacements,
  :recommendation_ids,
  :recommendation_template_arn,
  :recommendation_types,
  :start_time,
  :status,
  :tags,
  :templates_location)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#recommendation_ids ⇒ Array<String>

Identifiers for the recommendations used in the recommendation template.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 4211

class RecommendationTemplate < Struct.new(
  :app_arn,
  :assessment_arn,
  :end_time,
  :format,
  :message,
  :name,
  :needs_replacements,
  :recommendation_ids,
  :recommendation_template_arn,
  :recommendation_types,
  :start_time,
  :status,
  :tags,
  :templates_location)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#recommendation_template_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 4211

class RecommendationTemplate < Struct.new(
  :app_arn,
  :assessment_arn,
  :end_time,
  :format,
  :message,
  :name,
  :needs_replacements,
  :recommendation_ids,
  :recommendation_template_arn,
  :recommendation_types,
  :start_time,
  :status,
  :tags,
  :templates_location)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#recommendation_types ⇒ Array<String>

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:

• (Array<String>)

# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 4211

class RecommendationTemplate < Struct.new(
  :app_arn,
  :assessment_arn,
  :end_time,
  :format,
  :message,
  :name,
  :needs_replacements,
  :recommendation_ids,
  :recommendation_template_arn,
  :recommendation_types,
  :start_time,
  :status,
  :tags,
  :templates_location)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#start_time ⇒ Time

The start time for the action.

Returns:

• (Time)

# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 4211

class RecommendationTemplate < Struct.new(
  :app_arn,
  :assessment_arn,
  :end_time,
  :format,
  :message,
  :name,
  :needs_replacements,
  :recommendation_ids,
  :recommendation_template_arn,
  :recommendation_types,
  :start_time,
  :status,
  :tags,
  :templates_location)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#status ⇒ String

The status of the action.

Returns:

• (String)

# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 4211

class RecommendationTemplate < Struct.new(
  :app_arn,
  :assessment_arn,
  :end_time,
  :format,
  :message,
  :name,
  :needs_replacements,
  :recommendation_ids,
  :recommendation_template_arn,
  :recommendation_types,
  :start_time,
  :status,
  :tags,
  :templates_location)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 4211

class RecommendationTemplate < Struct.new(
  :app_arn,
  :assessment_arn,
  :end_time,
  :format,
  :message,
  :name,
  :needs_replacements,
  :recommendation_ids,
  :recommendation_template_arn,
  :recommendation_types,
  :start_time,
  :status,
  :tags,
  :templates_location)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#templates_location ⇒ Types::S3Location

The file location of the template.

Returns:

• (Types::S3Location)

# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 4211

class RecommendationTemplate < Struct.new(
  :app_arn,
  :assessment_arn,
  :end_time,
  :format,
  :message,
  :name,
  :needs_replacements,
  :recommendation_ids,
  :recommendation_template_arn,
  :recommendation_types,
  :start_time,
  :status,
  :tags,
  :templates_location)
  SENSITIVE = [:tags]
  include Aws::Structure
end