Class: Aws::WellArchitected::Types::Answer

Inherits:

Struct

• Object
• Struct
• Aws::WellArchitected::Types::Answer

Includes:

Structure

Defined in:

lib/aws-sdk-wellarchitected/types.rb

Overview

An answer of the question.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #choice_answers ⇒ Array<Types::ChoiceAnswer>

  A list of selected choices to a question in your workload.

• #choices ⇒ Array<Types::Choice>

  List of choices available for a question.

• #helpful_resource_display_text ⇒ String

  The helpful resource text to be displayed for a custom lens.

• #helpful_resource_url ⇒ String

  The helpful resource URL.

• #improvement_plan_url ⇒ String

  The improvement plan URL for a question in an Amazon Web Services official lenses.

• #is_applicable ⇒ Boolean

  Defines whether this question is applicable to a lens review.

• #jira_configuration ⇒ Types::JiraConfiguration

  Configuration of the Jira integration.

• #notes ⇒ String

  The notes associated with the workload.

• #pillar_id ⇒ String

  The ID used to identify a pillar, for example, ‘security`.

• #question_description ⇒ String

  The description of the question.

• #question_id ⇒ String

  The ID of the question.

• #question_title ⇒ String

  The title of the question.

• #reason ⇒ String

  The reason why the question is not applicable to your workload.

• #risk ⇒ String

  The risk for a given workload, lens review, pillar, or question.

• #selected_choices ⇒ Array<String>

  List of selected choice IDs in a question answer.

Instance Attribute Details

#choice_answers ⇒ Array<Types::ChoiceAnswer>

A list of selected choices to a question in your workload.

Returns:

• (Array<Types::ChoiceAnswer>)

# File 'lib/aws-sdk-wellarchitected/types.rb', line 204

class Answer < Struct.new(
  :question_id,
  :pillar_id,
  :question_title,
  :question_description,
  :improvement_plan_url,
  :helpful_resource_url,
  :helpful_resource_display_text,
  :choices,
  :selected_choices,
  :choice_answers,
  :is_applicable,
  :risk,
  :notes,
  :reason,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#choices ⇒ Array<Types::Choice>

List of choices available for a question.

Returns:

• (Array<Types::Choice>)

# File 'lib/aws-sdk-wellarchitected/types.rb', line 204

class Answer < Struct.new(
  :question_id,
  :pillar_id,
  :question_title,
  :question_description,
  :improvement_plan_url,
  :helpful_resource_url,
  :helpful_resource_display_text,
  :choices,
  :selected_choices,
  :choice_answers,
  :is_applicable,
  :risk,
  :notes,
  :reason,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#helpful_resource_display_text ⇒ String

The helpful resource text to be displayed for a custom lens.

This field does not apply to Amazon Web Services official lenses.

Returns:

• (String)

# File 'lib/aws-sdk-wellarchitected/types.rb', line 204

class Answer < Struct.new(
  :question_id,
  :pillar_id,
  :question_title,
  :question_description,
  :improvement_plan_url,
  :helpful_resource_url,
  :helpful_resource_display_text,
  :choices,
  :selected_choices,
  :choice_answers,
  :is_applicable,
  :risk,
  :notes,
  :reason,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#helpful_resource_url ⇒ String

The helpful resource URL.

For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.

For custom lenses, this is the helpful resource URL for a question and is only provided if ‘HelpfulResourceDisplayText` was specified for the question.

Returns:

• (String)

# File 'lib/aws-sdk-wellarchitected/types.rb', line 204

class Answer < Struct.new(
  :question_id,
  :pillar_id,
  :question_title,
  :question_description,
  :improvement_plan_url,
  :helpful_resource_url,
  :helpful_resource_display_text,
  :choices,
  :selected_choices,
  :choice_answers,
  :is_applicable,
  :risk,
  :notes,
  :reason,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#improvement_plan_url ⇒ String

The improvement plan URL for a question in an Amazon Web Services official lenses.

This value is only available if the question has been answered.

This value does not apply to custom lenses.

Returns:

• (String)

# File 'lib/aws-sdk-wellarchitected/types.rb', line 204

class Answer < Struct.new(
  :question_id,
  :pillar_id,
  :question_title,
  :question_description,
  :improvement_plan_url,
  :helpful_resource_url,
  :helpful_resource_display_text,
  :choices,
  :selected_choices,
  :choice_answers,
  :is_applicable,
  :risk,
  :notes,
  :reason,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#is_applicable ⇒ Boolean

Defines whether this question is applicable to a lens review.

Returns:

• (Boolean)

# File 'lib/aws-sdk-wellarchitected/types.rb', line 204

class Answer < Struct.new(
  :question_id,
  :pillar_id,
  :question_title,
  :question_description,
  :improvement_plan_url,
  :helpful_resource_url,
  :helpful_resource_display_text,
  :choices,
  :selected_choices,
  :choice_answers,
  :is_applicable,
  :risk,
  :notes,
  :reason,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#jira_configuration ⇒ Types::JiraConfiguration

Configuration of the Jira integration.

Returns:

• (Types::JiraConfiguration)

# File 'lib/aws-sdk-wellarchitected/types.rb', line 204

class Answer < Struct.new(
  :question_id,
  :pillar_id,
  :question_title,
  :question_description,
  :improvement_plan_url,
  :helpful_resource_url,
  :helpful_resource_display_text,
  :choices,
  :selected_choices,
  :choice_answers,
  :is_applicable,
  :risk,
  :notes,
  :reason,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#notes ⇒ String

The notes associated with the workload.

For a review template, these are the notes that will be associated with the workload when the template is applied.

Returns:

• (String)

# File 'lib/aws-sdk-wellarchitected/types.rb', line 204

class Answer < Struct.new(
  :question_id,
  :pillar_id,
  :question_title,
  :question_description,
  :improvement_plan_url,
  :helpful_resource_url,
  :helpful_resource_display_text,
  :choices,
  :selected_choices,
  :choice_answers,
  :is_applicable,
  :risk,
  :notes,
  :reason,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#pillar_id ⇒ String

The ID used to identify a pillar, for example, ‘security`.

A pillar is identified by its PillarReviewSummary$PillarId.

Returns:

• (String)

# File 'lib/aws-sdk-wellarchitected/types.rb', line 204

class Answer < Struct.new(
  :question_id,
  :pillar_id,
  :question_title,
  :question_description,
  :improvement_plan_url,
  :helpful_resource_url,
  :helpful_resource_display_text,
  :choices,
  :selected_choices,
  :choice_answers,
  :is_applicable,
  :risk,
  :notes,
  :reason,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#question_description ⇒ String

The description of the question.

Returns:

• (String)

# File 'lib/aws-sdk-wellarchitected/types.rb', line 204

class Answer < Struct.new(
  :question_id,
  :pillar_id,
  :question_title,
  :question_description,
  :improvement_plan_url,
  :helpful_resource_url,
  :helpful_resource_display_text,
  :choices,
  :selected_choices,
  :choice_answers,
  :is_applicable,
  :risk,
  :notes,
  :reason,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#question_id ⇒ String

The ID of the question.

Returns:

• (String)

# File 'lib/aws-sdk-wellarchitected/types.rb', line 204

class Answer < Struct.new(
  :question_id,
  :pillar_id,
  :question_title,
  :question_description,
  :improvement_plan_url,
  :helpful_resource_url,
  :helpful_resource_display_text,
  :choices,
  :selected_choices,
  :choice_answers,
  :is_applicable,
  :risk,
  :notes,
  :reason,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#question_title ⇒ String

The title of the question.

Returns:

• (String)

# File 'lib/aws-sdk-wellarchitected/types.rb', line 204

class Answer < Struct.new(
  :question_id,
  :pillar_id,
  :question_title,
  :question_description,
  :improvement_plan_url,
  :helpful_resource_url,
  :helpful_resource_display_text,
  :choices,
  :selected_choices,
  :choice_answers,
  :is_applicable,
  :risk,
  :notes,
  :reason,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#reason ⇒ String

The reason why the question is not applicable to your workload.

Returns:

• (String)

# File 'lib/aws-sdk-wellarchitected/types.rb', line 204

class Answer < Struct.new(
  :question_id,
  :pillar_id,
  :question_title,
  :question_description,
  :improvement_plan_url,
  :helpful_resource_url,
  :helpful_resource_display_text,
  :choices,
  :selected_choices,
  :choice_answers,
  :is_applicable,
  :risk,
  :notes,
  :reason,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#risk ⇒ String

The risk for a given workload, lens review, pillar, or question.

Returns:

• (String)

# File 'lib/aws-sdk-wellarchitected/types.rb', line 204

class Answer < Struct.new(
  :question_id,
  :pillar_id,
  :question_title,
  :question_description,
  :improvement_plan_url,
  :helpful_resource_url,
  :helpful_resource_display_text,
  :choices,
  :selected_choices,
  :choice_answers,
  :is_applicable,
  :risk,
  :notes,
  :reason,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#selected_choices ⇒ Array<String>

List of selected choice IDs in a question answer.

The values entered replace the previously selected choices.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-wellarchitected/types.rb', line 204

class Answer < Struct.new(
  :question_id,
  :pillar_id,
  :question_title,
  :question_description,
  :improvement_plan_url,
  :helpful_resource_url,
  :helpful_resource_display_text,
  :choices,
  :selected_choices,
  :choice_answers,
  :is_applicable,
  :risk,
  :notes,
  :reason,
  :jira_configuration)
  SENSITIVE = []
  include Aws::Structure
end