com.amazonaws.services.config.model

Class Scope

java.lang.Object

com.amazonaws.services.config.model.Scope

All Implemented Interfaces:

Serializable, Cloneable

public class Scope
extends Object
implements Serializable, Cloneable

Defines which resources AWS Config evaluates against a 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 or more resource IDs. Specify a scope to constrain the resources to be evaluated. If you do not specify a scope, all resources in your recording group are evaluated against the rule.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Scope()

Method Summary

Methods

Modifier and Type	Method and Description
Scope	clone()
boolean	equals(Object obj)
String	getComplianceResourceId() The IDs of only those AWS resources that you want AWS Config to evaluate against the rule.
List<String>	getComplianceResourceTypes() The resource types of only those AWS resources that you want AWS Config to evaluate against the rule.
String	getTagKey() The tag key that is applied to only those AWS resources that you want AWS Config to evaluate against the rule.
String	getTagValue() The tag value applied to only those AWS resources that you want AWS Config to evaluate against the rule.
int	hashCode()
void	setComplianceResourceId(String complianceResourceId) The IDs of only those AWS resources that you want AWS Config to evaluate against the rule.
void	setComplianceResourceTypes(Collection<String> complianceResourceTypes) The resource types of only those AWS resources that you want AWS Config to evaluate against the rule.
void	setTagKey(String tagKey) The tag key that is applied to only those AWS resources that you want AWS Config to evaluate against the rule.
void	setTagValue(String tagValue) The tag value applied to only those AWS resources that you want AWS Config to evaluate against the rule.
String	toString() Returns a string representation of this object; useful for testing and debugging.
Scope	withComplianceResourceId(String complianceResourceId) The IDs of only those AWS resources that you want AWS Config to evaluate against the rule.
Scope	withComplianceResourceTypes(Collection<String> complianceResourceTypes) The resource types of only those AWS resources that you want AWS Config to evaluate against the rule.
Scope	withComplianceResourceTypes(String... complianceResourceTypes) The resource types of only those AWS resources that you want AWS Config to evaluate against the rule.
Scope	withTagKey(String tagKey) The tag key that is applied to only those AWS resources that you want AWS Config to evaluate against the rule.
Scope	withTagValue(String tagValue) The tag value applied to only those AWS resources that you want AWS Config to evaluate against the rule.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Scope

public Scope()

Method Detail

getComplianceResourceTypes

public List<String> getComplianceResourceTypes()

The resource types of only those AWS resources that you want AWS Config to evaluate against the rule. You can specify only one type if you also specify resource IDs for ComplianceResourceId.

Returns:

The resource types of only those AWS resources that you want AWS Config to evaluate against the rule. You can specify only one type if you also specify resource IDs for ComplianceResourceId.

setComplianceResourceTypes

public void setComplianceResourceTypes(Collection<String> complianceResourceTypes)

The resource types of only those AWS resources that you want AWS Config to evaluate against the rule. You can specify only one type if you also specify resource IDs for ComplianceResourceId.

Parameters:

complianceResourceTypes - The resource types of only those AWS resources that you want AWS Config to evaluate against the rule. You can specify only one type if you also specify resource IDs for ComplianceResourceId.

withComplianceResourceTypes

public Scope withComplianceResourceTypes(String... complianceResourceTypes)

The resource types of only those AWS resources that you want AWS Config to evaluate against the rule. You can specify only one type if you also specify resource IDs for ComplianceResourceId.

NOTE: This method appends the values to the existing list (if any). Use setComplianceResourceTypes(java.util.Collection) or withComplianceResourceTypes(java.util.Collection) if you want to override the existing values.

Parameters:

complianceResourceTypes - The resource types of only those AWS resources that you want AWS Config to evaluate against the rule. You can specify only one type if you also specify resource IDs for ComplianceResourceId.

Returns:

Returns a reference to this object so that method calls can be chained together.

withComplianceResourceTypes

public Scope withComplianceResourceTypes(Collection<String> complianceResourceTypes)

The resource types of only those AWS resources that you want AWS Config to evaluate against the rule. You can specify only one type if you also specify resource IDs for ComplianceResourceId.

Parameters:

complianceResourceTypes - The resource types of only those AWS resources that you want AWS Config to evaluate against the rule. You can specify only one type if you also specify resource IDs for ComplianceResourceId.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTagKey

public void setTagKey(String tagKey)

The tag key that is applied to only those AWS resources that you want AWS Config to evaluate against the rule.

Parameters:

tagKey - The tag key that is applied to only those AWS resources that you want AWS Config to evaluate against the rule.

getTagKey

public String getTagKey()

The tag key that is applied to only those AWS resources that you want AWS Config to evaluate against the rule.

Returns:

The tag key that is applied to only those AWS resources that you want AWS Config to evaluate against the rule.

withTagKey

public Scope withTagKey(String tagKey)

The tag key that is applied to only those AWS resources that you want AWS Config to evaluate against the rule.

Parameters:

tagKey - The tag key that is applied to only those AWS resources that you want AWS Config to evaluate against the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTagValue

public void setTagValue(String tagValue)

The tag value applied to only those AWS resources that you want AWS Config to evaluate against the rule. If you specify a value for TagValue, you must also specify a value for TagKey.

Parameters:

tagValue - The tag value applied to only those AWS resources that you want AWS Config to evaluate against the rule. If you specify a value for TagValue, you must also specify a value for TagKey.

getTagValue

public String getTagValue()

The tag value applied to only those AWS resources that you want AWS Config to evaluate against the rule. If you specify a value for TagValue, you must also specify a value for TagKey.

Returns:

The tag value applied to only those AWS resources that you want AWS Config to evaluate against the rule. If you specify a value for TagValue, you must also specify a value for TagKey.

withTagValue

public Scope withTagValue(String tagValue)

The tag value applied to only those AWS resources that you want AWS Config to evaluate against the rule. If you specify a value for TagValue, you must also specify a value for TagKey.

Parameters:

tagValue - The tag value applied to only those AWS resources that you want AWS Config to evaluate against the rule. If you specify a value for TagValue, you must also specify a value for TagKey.

Returns:

Returns a reference to this object so that method calls can be chained together.

setComplianceResourceId

public void setComplianceResourceId(String complianceResourceId)

The IDs of only those AWS resources that you want AWS Config to evaluate against the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.

Parameters:

complianceResourceId - The IDs of only those AWS resources that you want AWS Config to evaluate against the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes .

getComplianceResourceId

public String getComplianceResourceId()

The IDs of only those AWS resources that you want AWS Config to evaluate against the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.

Returns:

The IDs of only those AWS resources that you want AWS Config to evaluate against the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.

withComplianceResourceId

public Scope withComplianceResourceId(String complianceResourceId)

The IDs of only those AWS resources that you want AWS Config to evaluate against the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.

Parameters:

complianceResourceId - The IDs of only those AWS resources that you want AWS Config to evaluate against the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes .

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Scope clone()

Overrides:

clone in class Object