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

#arn ⇒ String

The Amazon Resource Name (ARN) of the control.

Returns:

  • (String) 


325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/aws-sdk-controlcatalog/types.rb', line 325

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

#behavior ⇒ String

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

Returns:

  • (String) 


325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/aws-sdk-controlcatalog/types.rb', line 325

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

#description ⇒ String

A description of what the control does.

Returns:

  • (String) 


325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/aws-sdk-controlcatalog/types.rb', line 325

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



325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/aws-sdk-controlcatalog/types.rb', line 325

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

#name ⇒ String

The display name of the control.

Returns:

  • (String) 


325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/aws-sdk-controlcatalog/types.rb', line 325

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



325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/aws-sdk-controlcatalog/types.rb', line 325

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



325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/aws-sdk-controlcatalog/types.rb', line 325

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