com.amazonaws.services.config.model

Class ListDiscoveredResourcesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.config.model.ListDiscoveredResourcesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ListDiscoveredResourcesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ListDiscoveredResources operation.

Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.

NOTE:You can specify either resource IDs or a resource name but not both in the same request.

The response is paginated, and by default AWS Config lists 100 resource identifiers on each page. You can customize this number with the limit parameter. The response includes a nextToken string, and to get the next page of results, run the request again and enter this string for the nextToken parameter.

See Also:

AmazonConfig.listDiscoveredResources(ListDiscoveredResourcesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListDiscoveredResourcesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ListDiscoveredResourcesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Boolean	getIncludeDeletedResources() Specifies whether AWS Config includes deleted resources in the results.
Integer	getLimit() The maximum number of resource identifiers 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.
List<String>	getResourceIds() The IDs of only those resources that you want AWS Config to list in the response.
String	getResourceName() The custom name of only those resources that you want AWS Config to list in the response.
String	getResourceType() The type of resources that you want AWS Config to list in the response.
int	hashCode()
Boolean	isIncludeDeletedResources() Specifies whether AWS Config includes deleted resources in the results.
void	setIncludeDeletedResources(Boolean includeDeletedResources) Specifies whether AWS Config includes deleted resources in the results.
void	setLimit(Integer limit) The maximum number of resource identifiers 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.
void	setResourceIds(Collection<String> resourceIds) The IDs of only those resources that you want AWS Config to list in the response.
void	setResourceName(String resourceName) The custom name of only those resources that you want AWS Config to list in the response.
void	setResourceType(ResourceType resourceType) The type of resources that you want AWS Config to list in the response.
void	setResourceType(String resourceType) The type of resources that you want AWS Config to list in the response.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListDiscoveredResourcesRequest	withIncludeDeletedResources(Boolean includeDeletedResources) Specifies whether AWS Config includes deleted resources in the results.
ListDiscoveredResourcesRequest	withLimit(Integer limit) The maximum number of resource identifiers returned on each page.
ListDiscoveredResourcesRequest	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.
ListDiscoveredResourcesRequest	withResourceIds(Collection<String> resourceIds) The IDs of only those resources that you want AWS Config to list in the response.
ListDiscoveredResourcesRequest	withResourceIds(String... resourceIds) The IDs of only those resources that you want AWS Config to list in the response.
ListDiscoveredResourcesRequest	withResourceName(String resourceName) The custom name of only those resources that you want AWS Config to list in the response.
ListDiscoveredResourcesRequest	withResourceType(ResourceType resourceType) The type of resources that you want AWS Config to list in the response.
ListDiscoveredResourcesRequest	withResourceType(String resourceType) The type of resources that you want AWS Config to list in the response.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, 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

ListDiscoveredResourcesRequest

public ListDiscoveredResourcesRequest()

Method Detail

getResourceType

public String getResourceType()

The type of resources that you want AWS Config to list in the response.

Constraints:
Allowed Values: AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway

Returns:

The type of resources that you want AWS Config to list in the response.

See Also:

ResourceType

setResourceType

public void setResourceType(String resourceType)

The type of resources that you want AWS Config to list in the response.

Constraints:
Allowed Values: AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway

Parameters:

resourceType - The type of resources that you want AWS Config to list in the response.

See Also:

ResourceType

withResourceType

public ListDiscoveredResourcesRequest withResourceType(String resourceType)

The type of resources that you want AWS Config to list in the response.

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

Constraints:
Allowed Values: AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway

Parameters:

resourceType - The type of resources that you want AWS Config to list in the response.

Returns:

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

See Also:

ResourceType

setResourceType

public void setResourceType(ResourceType resourceType)

The type of resources that you want AWS Config to list in the response.

Constraints:
Allowed Values: AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway

Parameters:

resourceType - The type of resources that you want AWS Config to list in the response.

See Also:

ResourceType

withResourceType

public ListDiscoveredResourcesRequest withResourceType(ResourceType resourceType)

The type of resources that you want AWS Config to list in the response.

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

Constraints:
Allowed Values: AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway

Parameters:

resourceType - The type of resources that you want AWS Config to list in the response.

Returns:

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

See Also:

ResourceType

getResourceIds

public List<String> getResourceIds()

The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

Returns:

The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

setResourceIds

public void setResourceIds(Collection<String> resourceIds)

The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

Parameters:

resourceIds - The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

withResourceIds

public ListDiscoveredResourcesRequest withResourceIds(String... resourceIds)

The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

NOTE: This method appends the values to the existing list (if any). Use setResourceIds(java.util.Collection) or withResourceIds(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.

Parameters:

resourceIds - The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

Returns:

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

withResourceIds

public ListDiscoveredResourcesRequest withResourceIds(Collection<String> resourceIds)

The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

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

Parameters:

resourceIds - The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

Returns:

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

getResourceName

public String getResourceName()

The custom name of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

Returns:

The custom name of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

setResourceName

public void setResourceName(String resourceName)

The custom name of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

Parameters:

resourceName - The custom name of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

withResourceName

public ListDiscoveredResourcesRequest withResourceName(String resourceName)

The custom name of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

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

Parameters:

resourceName - The custom name of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

Returns:

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

getLimit

public Integer getLimit()

The maximum number of resource identifiers returned on each page. The default is 100. 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 resource identifiers returned on each page. The default is 100. 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 resource identifiers returned on each page. The default is 100. 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 resource identifiers returned on each page. The default is 100. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.

withLimit

public ListDiscoveredResourcesRequest withLimit(Integer limit)

The maximum number of resource identifiers returned on each page. The default is 100. 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 resource identifiers returned on each page. The default is 100. 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.

isIncludeDeletedResources

public Boolean isIncludeDeletedResources()

Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included.

Returns:

Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included.

setIncludeDeletedResources

public void setIncludeDeletedResources(Boolean includeDeletedResources)

Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included.

Parameters:

includeDeletedResources - Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included.

withIncludeDeletedResources

public ListDiscoveredResourcesRequest withIncludeDeletedResources(Boolean includeDeletedResources)

Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included.

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

Parameters:

includeDeletedResources - Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included.

Returns:

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

getIncludeDeletedResources

public Boolean getIncludeDeletedResources()

Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included.

Returns:

Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included.

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 ListDiscoveredResourcesRequest 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 ListDiscoveredResourcesRequest 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()