Class: Aws::ControlCatalog::Types::ControlSummary

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

Overview

Overview of information about a control.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aliases ⇒ Array<String>

A list of alternative identifiers for the control. These are human-readable designators, such as SH.S3.1. Several aliases can refer to the same control across different Amazon Web Services services or compliance frameworks.

Returns:

  • (Array<String>) 


341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'gems/aws-sdk-controlcatalog/lib/aws-sdk-controlcatalog/types.rb', line 341

class ControlSummary < Struct.new(
  :arn,
  :aliases,
  :name,
  :description,
  :behavior,
  :severity,
  :implementation,
  :create_time,
  :governed_resources)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) of the control.

Returns:

  • (String) 


341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'gems/aws-sdk-controlcatalog/lib/aws-sdk-controlcatalog/types.rb', line 341

class ControlSummary < Struct.new(
  :arn,
  :aliases,
  :name,
  :description,
  :behavior,
  :severity,
  :implementation,
  :create_time,
  :governed_resources)
  SENSITIVE = []
  include Aws::Structure
end

#behavior ⇒ String

An enumerated type, with the following possible values:

Returns:

  • (String) 


341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'gems/aws-sdk-controlcatalog/lib/aws-sdk-controlcatalog/types.rb', line 341

class ControlSummary < Struct.new(
  :arn,
  :aliases,
  :name,
  :description,
  :behavior,
  :severity,
  :implementation,
  :create_time,
  :governed_resources)
  SENSITIVE = []
  include Aws::Structure
end

#create_time ⇒ Time

A timestamp that notes the time when the control was released (start of its life) as a governance capability in Amazon Web Services.

Returns:

  • (Time) 


341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'gems/aws-sdk-controlcatalog/lib/aws-sdk-controlcatalog/types.rb', line 341

class ControlSummary < Struct.new(
  :arn,
  :aliases,
  :name,
  :description,
  :behavior,
  :severity,
  :implementation,
  :create_time,
  :governed_resources)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the control, as it may appear in the console. Describes the functionality of the control.

Returns:

  • (String) 


341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'gems/aws-sdk-controlcatalog/lib/aws-sdk-controlcatalog/types.rb', line 341

class ControlSummary < Struct.new(
  :arn,
  :aliases,
  :name,
  :description,
  :behavior,
  :severity,
  :implementation,
  :create_time,
  :governed_resources)
  SENSITIVE = []
  include Aws::Structure
end

#governed_resources ⇒ Array<String>

A list of Amazon Web Services resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. The resources are represented as Amazon Web Services CloudFormation resource types. If GovernedResources cannot be represented by available CloudFormation resource types, it’s returned as an empty list.

Returns:

  • (Array<String>) 


341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'gems/aws-sdk-controlcatalog/lib/aws-sdk-controlcatalog/types.rb', line 341

class ControlSummary < Struct.new(
  :arn,
  :aliases,
  :name,
  :description,
  :behavior,
  :severity,
  :implementation,
  :create_time,
  :governed_resources)
  SENSITIVE = []
  include Aws::Structure
end

#implementation ⇒ Types::ImplementationSummary

An object of type ImplementationSummary that describes how the control is implemented.

Returns:



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'gems/aws-sdk-controlcatalog/lib/aws-sdk-controlcatalog/types.rb', line 341

class ControlSummary < Struct.new(
  :arn,
  :aliases,
  :name,
  :description,
  :behavior,
  :severity,
  :implementation,
  :create_time,
  :governed_resources)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The display name of the control.

Returns:

  • (String) 


341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'gems/aws-sdk-controlcatalog/lib/aws-sdk-controlcatalog/types.rb', line 341

class ControlSummary < Struct.new(
  :arn,
  :aliases,
  :name,
  :description,
  :behavior,
  :severity,
  :implementation,
  :create_time,
  :governed_resources)
  SENSITIVE = []
  include Aws::Structure
end

#severity ⇒ String

An enumerated type, with the following possible values:

Returns:

  • (String) 


341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'gems/aws-sdk-controlcatalog/lib/aws-sdk-controlcatalog/types.rb', line 341

class ControlSummary < Struct.new(
  :arn,
  :aliases,
  :name,
  :description,
  :behavior,
  :severity,
  :implementation,
  :create_time,
  :governed_resources)
  SENSITIVE = []
  include Aws::Structure
end