You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Support::Types::TrustedAdvisorCheckDescription

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

Overview

The description and metadata for a Trusted Advisor check.

Instance Attribute Summary collapse

Instance Attribute Details

#categoryString

The category of the Trusted Advisor check.

Returns:

  • (String)


1046
1047
1048
1049
1050
1051
1052
1053
# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 1046

class TrustedAdvisorCheckDescription < Struct.new(
  :id,
  :name,
  :description,
  :category,
  :metadata)
  include Aws::Structure
end

#descriptionString

The description of the Trusted Advisor check, which includes the alert criteria and recommended actions (contains HTML markup).

Returns:

  • (String)


1046
1047
1048
1049
1050
1051
1052
1053
# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 1046

class TrustedAdvisorCheckDescription < Struct.new(
  :id,
  :name,
  :description,
  :category,
  :metadata)
  include Aws::Structure
end

#idString

The unique identifier for the Trusted Advisor check.

Returns:

  • (String)


1046
1047
1048
1049
1050
1051
1052
1053
# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 1046

class TrustedAdvisorCheckDescription < Struct.new(
  :id,
  :name,
  :description,
  :category,
  :metadata)
  include Aws::Structure
end

#metadataArray<String>

The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.

Returns:

  • (Array<String>)


1046
1047
1048
1049
1050
1051
1052
1053
# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 1046

class TrustedAdvisorCheckDescription < Struct.new(
  :id,
  :name,
  :description,
  :category,
  :metadata)
  include Aws::Structure
end

#nameString

The display name for the Trusted Advisor check.

Returns:

  • (String)


1046
1047
1048
1049
1050
1051
1052
1053
# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 1046

class TrustedAdvisorCheckDescription < Struct.new(
  :id,
  :name,
  :description,
  :category,
  :metadata)
  include Aws::Structure
end