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

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: "StringWithCharLimit256",
}

Defines which resources trigger an evaluation for an AWS 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.

Instance Attribute Summary collapse

Instance Attribute Details

#compliance_resource_idString

The IDs of the only AWS 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)


2286
2287
2288
2289
2290
2291
2292
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 2286

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

#compliance_resource_typesArray<String>

The resource types of only those AWS 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>)


2286
2287
2288
2289
2290
2291
2292
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 2286

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

#tag_keyString

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

Returns:

  • (String)


2286
2287
2288
2289
2290
2291
2292
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 2286

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

#tag_valueString

The tag value applied to only those AWS 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)


2286
2287
2288
2289
2290
2291
2292
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 2286

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