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

Inherits:

Struct

• Object
• Struct
• Aws::ResilienceHub::Types::CreateRecommendationTemplateRequest

Includes:

Structure

Defined in:

lib/aws-sdk-resiliencehub/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:tags]

Instance Attribute Summary

• #assessment_arn ⇒ String

  Amazon Resource Name (ARN) of the assessment.

• #bucket_name ⇒ String

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

• #client_token ⇒ String

  Used for an idempotency token.

• #format ⇒ String

  The format for the recommendation template.

• #name ⇒ String

  The name for the recommendation template.

• #recommendation_ids ⇒ Array<String>

  Identifiers for the recommendations used to create a recommendation template.

• #recommendation_types ⇒ Array<String>

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

• #tags ⇒ Hash<String,String>

  Tags assigned to the resource.

Instance Attribute Details

#assessment_arn ⇒ String

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.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

• (String)

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

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

#bucket_name ⇒ String

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

Returns:

• (String)

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

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

#client_token ⇒ String

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)

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

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

#format ⇒ String

The format for the recommendation template.

CfnJson

: The template is CloudFormation JSON.

CfnYaml

: The template is CloudFormation YAML.

Returns:

• (String)

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

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

#name ⇒ String

The name for the recommendation template.

Returns:

• (String)

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

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

#recommendation_ids ⇒ Array<String>

Identifiers for the recommendations used to create a recommendation template.

Returns:

• (Array<String>)

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

class CreateRecommendationTemplateRequest < Struct.new(
  :assessment_arn,
  :bucket_name,
  :client_token,
  :format,
  :name,
  :recommendation_ids,
  :recommendation_types,
  :tags)
  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 'lib/aws-sdk-resiliencehub/types.rb', line 1637

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

#tags ⇒ Hash<String,String>

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 'lib/aws-sdk-resiliencehub/types.rb', line 1637

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