Class Scope
- All Implemented Interfaces:
Serializable
,Cloneable
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.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The IDs of the only AWS resource that you want to trigger an evaluation for the rule.The resource types of only those AWS resources that you want to trigger an evaluation for the rule.The tag key that is applied to only those AWS resources that you want you want to trigger an evaluation for the rule.The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule.int
hashCode()
void
setComplianceResourceId
(String complianceResourceId) The IDs of the only AWS resource that you want to trigger an evaluation for the rule.void
setComplianceResourceTypes
(Collection<String> complianceResourceTypes) The resource types of only those AWS resources that you want to trigger an evaluation for the rule.void
The tag key that is applied to only those AWS resources that you want you want to trigger an evaluation for the rule.void
setTagValue
(String tagValue) The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule.toString()
Returns a string representation of this object; useful for testing and debugging.withComplianceResourceId
(String complianceResourceId) The IDs of the only AWS resource that you want to trigger an evaluation for the rule.withComplianceResourceTypes
(String... complianceResourceTypes) The resource types of only those AWS resources that you want to trigger an evaluation for the rule.withComplianceResourceTypes
(Collection<String> complianceResourceTypes) The resource types of only those AWS resources that you want to trigger an evaluation for the rule.withTagKey
(String tagKey) The tag key that is applied to only those AWS resources that you want you want to trigger an evaluation for the rule.withTagValue
(String tagValue) The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule.
-
Constructor Details
-
Scope
public Scope()
-
-
Method Details
-
getComplianceResourceTypes
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:
- 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
.
-
setComplianceResourceTypes
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
.- Parameters:
complianceResourceTypes
- 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 forComplianceResourceId
.
-
withComplianceResourceTypes
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
.NOTE: This method appends the values to the existing list (if any). Use
setComplianceResourceTypes(java.util.Collection)
orwithComplianceResourceTypes(java.util.Collection)
if you want to override the existing values.- Parameters:
complianceResourceTypes
- 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 forComplianceResourceId
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withComplianceResourceTypes
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
.- Parameters:
complianceResourceTypes
- 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 forComplianceResourceId
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTagKey
The tag key that is applied to only those AWS resources that you want you want to trigger an evaluation for the rule.
- Parameters:
tagKey
- The tag key that is applied to only those AWS resources that you want you want to trigger an evaluation for the rule.
-
getTagKey
The tag key that is applied to only those AWS resources that you want you want to trigger an evaluation for the rule.
- Returns:
- The tag key that is applied to only those AWS resources that you want you want to trigger an evaluation for the rule.
-
withTagKey
The tag key that is applied to only those AWS resources that you want you want to trigger an evaluation for the rule.
- Parameters:
tagKey
- The tag key that is applied to only those AWS resources that you want you want to trigger an evaluation for the rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTagValue
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 forTagKey
.- Parameters:
tagValue
- The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value forTagValue
, you must also specify a value forTagKey
.
-
getTagValue
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 forTagKey
.- Returns:
- 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 forTagKey
.
-
withTagValue
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 forTagKey
.- Parameters:
tagValue
- The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value forTagValue
, you must also specify a value forTagKey
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setComplianceResourceId
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
.- Parameters:
complianceResourceId
- 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 forComplianceResourceTypes
.
-
getComplianceResourceId
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:
- 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
.
-
withComplianceResourceId
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
.- Parameters:
complianceResourceId
- 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 forComplianceResourceTypes
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-