com.amazonaws.services.config.model

Class GetComplianceDetailsByConfigRuleRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.config.model.GetComplianceDetailsByConfigRuleRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class GetComplianceDetailsByConfigRuleRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the GetComplianceDetailsByConfigRule operation.

Returns the evaluation results for the specified AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.

See Also:

AmazonConfig.getComplianceDetailsByConfigRule(GetComplianceDetailsByConfigRuleRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetComplianceDetailsByConfigRuleRequest()

Method Summary

Methods

Modifier and Type	Method and Description
GetComplianceDetailsByConfigRuleRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<String>	getComplianceTypes() Specify to filter the results by compliance.
String	getConfigRuleName() The name of the AWS Config rule for which you want compliance information.
Integer	getLimit() The maximum number of evaluation results returned on each page.
String	getNextToken() The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
int	hashCode()
void	setComplianceTypes(Collection<String> complianceTypes) Specify to filter the results by compliance.
void	setConfigRuleName(String configRuleName) The name of the AWS Config rule for which you want compliance information.
void	setLimit(Integer limit) The maximum number of evaluation results returned on each page.
void	setNextToken(String nextToken) The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetComplianceDetailsByConfigRuleRequest	withComplianceTypes(Collection<String> complianceTypes) Specify to filter the results by compliance.
GetComplianceDetailsByConfigRuleRequest	withComplianceTypes(ComplianceType... complianceTypes) Specify to filter the results by compliance.
GetComplianceDetailsByConfigRuleRequest	withComplianceTypes(String... complianceTypes) Specify to filter the results by compliance.
GetComplianceDetailsByConfigRuleRequest	withConfigRuleName(String configRuleName) The name of the AWS Config rule for which you want compliance information.
GetComplianceDetailsByConfigRuleRequest	withLimit(Integer limit) The maximum number of evaluation results returned on each page.
GetComplianceDetailsByConfigRuleRequest	withNextToken(String nextToken) The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

GetComplianceDetailsByConfigRuleRequest

public GetComplianceDetailsByConfigRuleRequest()

Method Detail

getConfigRuleName

public String getConfigRuleName()

The name of the AWS Config rule for which you want compliance information.

Constraints:
Length: 1 - 64

Returns:

The name of the AWS Config rule for which you want compliance information.

setConfigRuleName

public void setConfigRuleName(String configRuleName)

The name of the AWS Config rule for which you want compliance information.

Constraints:
Length: 1 - 64

Parameters:

configRuleName - The name of the AWS Config rule for which you want compliance information.

withConfigRuleName

public GetComplianceDetailsByConfigRuleRequest withConfigRuleName(String configRuleName)

The name of the AWS Config rule for which you want compliance information.

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

Constraints:
Length: 1 - 64

Parameters:

configRuleName - The name of the AWS Config rule for which you want compliance information.

Returns:

A reference to this updated object so that method calls can be chained together.

getComplianceTypes

public List<String> getComplianceTypes()

Specify to filter the results by compliance. The valid values are Compliant, NonCompliant, and NotApplicable.

Constraints:
Length: 0 - 3

Returns:

Specify to filter the results by compliance. The valid values are Compliant, NonCompliant, and NotApplicable.

setComplianceTypes

public void setComplianceTypes(Collection<String> complianceTypes)

Specify to filter the results by compliance. The valid values are Compliant, NonCompliant, and NotApplicable.

Constraints:
Length: 0 - 3

Parameters:

complianceTypes - Specify to filter the results by compliance. The valid values are Compliant, NonCompliant, and NotApplicable.

withComplianceTypes

public GetComplianceDetailsByConfigRuleRequest withComplianceTypes(String... complianceTypes)

Specify to filter the results by compliance. The valid values are Compliant, NonCompliant, and NotApplicable.

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

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

Constraints:
Length: 0 - 3

Parameters:

complianceTypes - Specify to filter the results by compliance. The valid values are Compliant, NonCompliant, and NotApplicable.

Returns:

A reference to this updated object so that method calls can be chained together.

withComplianceTypes

public GetComplianceDetailsByConfigRuleRequest withComplianceTypes(Collection<String> complianceTypes)

Specify to filter the results by compliance. The valid values are Compliant, NonCompliant, and NotApplicable.

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

Constraints:
Length: 0 - 3

Parameters:

complianceTypes - Specify to filter the results by compliance. The valid values are Compliant, NonCompliant, and NotApplicable.

Returns:

A reference to this updated object so that method calls can be chained together.

withComplianceTypes

public GetComplianceDetailsByConfigRuleRequest withComplianceTypes(ComplianceType... complianceTypes)

Specify to filter the results by compliance. The valid values are Compliant, NonCompliant, and NotApplicable.

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

Constraints:
Length: 0 - 3

Parameters:

complianceTypes - Specify to filter the results by compliance. The valid values are Compliant, NonCompliant, and NotApplicable.

Returns:

A reference to this updated object so that method calls can be chained together.

getLimit

public Integer getLimit()

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.

Constraints:
Range: 0 - 100

Returns:

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.

setLimit

public void setLimit(Integer limit)

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.

Constraints:
Range: 0 - 100

Parameters:

limit - The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.

withLimit

public GetComplianceDetailsByConfigRuleRequest withLimit(Integer limit)

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.

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

Constraints:
Range: 0 - 100

Parameters:

limit - The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

setNextToken

public void setNextToken(String nextToken)

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Parameters:

nextToken - The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

withNextToken

public GetComplianceDetailsByConfigRuleRequest withNextToken(String nextToken)

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

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

Parameters:

nextToken - The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public GetComplianceDetailsByConfigRuleRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()