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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb

Overview

Defines a recommendation template created with the CreateRecommendationTemplate action.

Constant Summary collapse

SENSITIVE =
[:tags]

Instance Attribute Summary collapse

Instance Attribute Details

#app_arnString

The Amazon Resource Name (ARN) of the 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.

Returns:

  • (String)


2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 2782

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_arnString

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.

Returns:

  • (String)


2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 2782

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_timeTime

The end time for the action.

Returns:

  • (Time)


2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 2782

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

#formatString

The format of the recommendation template.

CfnJson

The template is CloudFormation JSON.

CfnYaml

The template is CloudFormation YAML.

Returns:

  • (String)


2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 2782

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

#messageString

The message for the recommendation template.

Returns:

  • (String)


2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 2782

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

#nameString

The name for the recommendation template.

Returns:

  • (String)


2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 2782

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_replacementsBoolean

Indicates if replacements are needed.

Returns:

  • (Boolean)


2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 2782

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_idsArray<String>

Identifiers for the recommendations used in the recommendation template.

Returns:

  • (Array<String>)


2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 2782

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_arnString

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

Returns:

  • (String)


2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 2782

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


2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 2782

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_timeTime

The start time for the action.

Returns:

  • (Time)


2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 2782

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

#statusString

The status of the action.

Returns:

  • (String)


2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 2782

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

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


2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 2782

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_locationTypes::S3Location

The file location of the template.

Returns:



2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 2782

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