AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ConfigService::Types::Scope

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

Overview

Note:

When making an API call, you may pass Scope data as a hash:

{
  compliance_resource_types: ["StringWithCharLimit256"],
  tag_key: "StringWithCharLimit128",
  tag_value: "StringWithCharLimit256",
  compliance_resource_id: "BaseResourceId",
}

Defines which resources trigger an evaluation for an Config rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#compliance_resource_idString

The ID of the only Amazon Web Services resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.

Returns:

  • (String)


7930
7931
7932
7933
7934
7935
7936
7937
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7930

class Scope < Struct.new(
  :compliance_resource_types,
  :tag_key,
  :tag_value,
  :compliance_resource_id)
  SENSITIVE = []
  include Aws::Structure
end

#compliance_resource_typesArray<String>

The resource types of only those Amazon Web Services resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ComplianceResourceId.

Returns:

  • (Array<String>)


7930
7931
7932
7933
7934
7935
7936
7937
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7930

class Scope < Struct.new(
  :compliance_resource_types,
  :tag_key,
  :tag_value,
  :compliance_resource_id)
  SENSITIVE = []
  include Aws::Structure
end

#tag_keyString

The tag key that is applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule.

Returns:

  • (String)


7930
7931
7932
7933
7934
7935
7936
7937
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7930

class Scope < Struct.new(
  :compliance_resource_types,
  :tag_key,
  :tag_value,
  :compliance_resource_id)
  SENSITIVE = []
  include Aws::Structure
end

#tag_valueString

The tag value applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue, you must also specify a value for TagKey.

Returns:

  • (String)


7930
7931
7932
7933
7934
7935
7936
7937
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7930

class Scope < Struct.new(
  :compliance_resource_types,
  :tag_key,
  :tag_value,
  :compliance_resource_id)
  SENSITIVE = []
  include Aws::Structure
end