Class: Aws::ResilienceHub::Types::CreateRecommendationTemplateRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[:tags]

Instance Attribute Summary collapse

Instance Attribute Details

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


829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 829

class CreateRecommendationTemplateRequest < Struct.new(
  :assessment_arn,
  :bucket_name,
  :client_token,
  :format,
  :name,
  :recommendation_ids,
  :recommendation_types,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#bucket_nameString

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

Returns:

  • (String)


829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 829

class CreateRecommendationTemplateRequest < Struct.new(
  :assessment_arn,
  :bucket_name,
  :client_token,
  :format,
  :name,
  :recommendation_ids,
  :recommendation_types,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#client_tokenString

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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 829

class CreateRecommendationTemplateRequest < Struct.new(
  :assessment_arn,
  :bucket_name,
  :client_token,
  :format,
  :name,
  :recommendation_ids,
  :recommendation_types,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#formatString

The format for the recommendation template.

CfnJson

The template is CloudFormation JSON.

CfnYaml

The template is CloudFormation YAML.

Returns:

  • (String)


829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 829

class CreateRecommendationTemplateRequest < Struct.new(
  :assessment_arn,
  :bucket_name,
  :client_token,
  :format,
  :name,
  :recommendation_ids,
  :recommendation_types,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#nameString

The name for the recommendation template.

Returns:

  • (String)


829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 829

class CreateRecommendationTemplateRequest < Struct.new(
  :assessment_arn,
  :bucket_name,
  :client_token,
  :format,
  :name,
  :recommendation_ids,
  :recommendation_types,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#recommendation_idsArray<String>

Identifiers for the recommendations used to create a recommendation template.

Returns:

  • (Array<String>)


829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 829

class CreateRecommendationTemplateRequest < Struct.new(
  :assessment_arn,
  :bucket_name,
  :client_token,
  :format,
  :name,
  :recommendation_ids,
  :recommendation_types,
  :tags)
  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>)


829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 829

class CreateRecommendationTemplateRequest < Struct.new(
  :assessment_arn,
  :bucket_name,
  :client_token,
  :format,
  :name,
  :recommendation_ids,
  :recommendation_types,
  :tags)
  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>)


829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb', line 829

class CreateRecommendationTemplateRequest < Struct.new(
  :assessment_arn,
  :bucket_name,
  :client_token,
  :format,
  :name,
  :recommendation_ids,
  :recommendation_types,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end