Class: Aws::ControlCatalog::Types::GetControlResponse

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

Overview

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


529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/aws-sdk-controlcatalog/types.rb', line 529

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

#arn ⇒ String

The Amazon Resource Name (ARN) of the control.

Returns:

  • (String) 


529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/aws-sdk-controlcatalog/types.rb', line 529

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

#behavior ⇒ String

A term that identifies the control’s functional behavior. One of ‘Preventive`, `Detective`, `Proactive`

Returns:

  • (String) 


529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/aws-sdk-controlcatalog/types.rb', line 529

class GetControlResponse < Struct.new(
  :arn,
  :aliases,
  :name,
  :description,
  :behavior,
  :severity,
  :region_configuration,
  :implementation,
  :parameters,
  :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) 


529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/aws-sdk-controlcatalog/types.rb', line 529

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

#description ⇒ String

A description of what the control does.

Returns:

  • (String) 


529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/aws-sdk-controlcatalog/types.rb', line 529

class GetControlResponse < Struct.new(
  :arn,
  :aliases,
  :name,
  :description,
  :behavior,
  :severity,
  :region_configuration,
  :implementation,
  :parameters,
  :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>) 


529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/aws-sdk-controlcatalog/types.rb', line 529

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

#implementation ⇒ Types::ImplementationDetails

Returns information about the control, as an ‘ImplementationDetails` object that shows the underlying implementation type for a control.

Returns:



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/aws-sdk-controlcatalog/types.rb', line 529

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

#name ⇒ String

The display name of the control.

Returns:

  • (String) 


529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/aws-sdk-controlcatalog/types.rb', line 529

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

#parameters ⇒ Array<Types::ControlParameter>

Returns an array of ‘ControlParameter` objects that specify the parameters a control supports. An empty list is returned for controls that don’t support parameters.

Returns:



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/aws-sdk-controlcatalog/types.rb', line 529

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

#region_configuration ⇒ Types::RegionConfiguration

Returns information about the control, including the scope of the control, if enabled, and the Regions in which the control is available for deployment. For more information about scope, see [Global services].

If you are applying controls through an Amazon Web Services Control Tower landing zone environment, remember that the values returned in the ‘RegionConfiguration` API operation are not related to the governed Regions in your landing zone. For example, if you are governing Regions `A`,`B`,and `C` while the control is available in Regions `A`, `B`, C`,` and `D`, you’d see a response with ‘DeployableRegions` of `A`, `B`, `C`, and `D` for a control with `REGIONAL` scope, even though you may not intend to deploy the control in Region `D`, because you do not govern it through your landing zone.

[1]: docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/global-services.html

Returns:



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/aws-sdk-controlcatalog/types.rb', line 529

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

#severity ⇒ String

An enumerated type, with the following possible values:

Returns:

  • (String) 


529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/aws-sdk-controlcatalog/types.rb', line 529

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