com.amazonaws.services.rds.model

Class DescribeDBInstanceAutomatedBackupsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.DescribeDBInstanceAutomatedBackupsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeDBInstanceAutomatedBackupsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Parameter input for DescribeDBInstanceAutomatedBackups.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeDBInstanceAutomatedBackupsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeDBInstanceAutomatedBackupsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDBInstanceAutomatedBackupsArn() The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
String	getDBInstanceIdentifier() (Optional) The user-supplied instance identifier.
String	getDbiResourceId() The resource ID of the DB instance that is the source of the automated backup.
List<Filter>	getFilters() A filter that specifies which resources to return based on status.
String	getMarker() The pagination token provided in the previous request.
Integer	getMaxRecords() The maximum number of records to include in the response.
int	hashCode()
void	setDBInstanceAutomatedBackupsArn(String dBInstanceAutomatedBackupsArn) The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
void	setDBInstanceIdentifier(String dBInstanceIdentifier) (Optional) The user-supplied instance identifier.
void	setDbiResourceId(String dbiResourceId) The resource ID of the DB instance that is the source of the automated backup.
void	setFilters(Collection<Filter> filters) A filter that specifies which resources to return based on status.
void	setMarker(String marker) The pagination token provided in the previous request.
void	setMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
String	toString() Returns a string representation of this object.
DescribeDBInstanceAutomatedBackupsRequest	withDBInstanceAutomatedBackupsArn(String dBInstanceAutomatedBackupsArn) The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
DescribeDBInstanceAutomatedBackupsRequest	withDBInstanceIdentifier(String dBInstanceIdentifier) (Optional) The user-supplied instance identifier.
DescribeDBInstanceAutomatedBackupsRequest	withDbiResourceId(String dbiResourceId) The resource ID of the DB instance that is the source of the automated backup.
DescribeDBInstanceAutomatedBackupsRequest	withFilters(Collection<Filter> filters) A filter that specifies which resources to return based on status.
DescribeDBInstanceAutomatedBackupsRequest	withFilters(Filter... filters) A filter that specifies which resources to return based on status.
DescribeDBInstanceAutomatedBackupsRequest	withMarker(String marker) The pagination token provided in the previous request.
DescribeDBInstanceAutomatedBackupsRequest	withMaxRecords(Integer maxRecords) The maximum number of records to include in the response.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeDBInstanceAutomatedBackupsRequest

public DescribeDBInstanceAutomatedBackupsRequest()

Method Detail

setDbiResourceId

public void setDbiResourceId(String dbiResourceId)

The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.

Parameters:

dbiResourceId - The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.

getDbiResourceId

public String getDbiResourceId()

The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.

Returns:

The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.

withDbiResourceId

public DescribeDBInstanceAutomatedBackupsRequest withDbiResourceId(String dbiResourceId)

The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.

Parameters:

dbiResourceId - The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.

Returns:

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

setDBInstanceIdentifier

public void setDBInstanceIdentifier(String dBInstanceIdentifier)

(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance's automated backup. This parameter isn't case-sensitive.

Parameters:

dBInstanceIdentifier - (Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance's automated backup. This parameter isn't case-sensitive.

getDBInstanceIdentifier

public String getDBInstanceIdentifier()

(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance's automated backup. This parameter isn't case-sensitive.

Returns:

(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance's automated backup. This parameter isn't case-sensitive.

withDBInstanceIdentifier

public DescribeDBInstanceAutomatedBackupsRequest withDBInstanceIdentifier(String dBInstanceIdentifier)

(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance's automated backup. This parameter isn't case-sensitive.

Parameters:

dBInstanceIdentifier - (Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance's automated backup. This parameter isn't case-sensitive.

Returns:

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

getFilters

public List<Filter> getFilters()

A filter that specifies which resources to return based on status.

Supported filters are the following:

• status

  • active - Automated backups for current instances.

  • creating - Automated backups that are waiting for the first automated snapshot to be available.

  • retained - Automated backups for deleted instances and after backup replication is stopped.

• db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.

• dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

Returns:

A filter that specifies which resources to return based on status.

Supported filters are the following:

• status

  • active - Automated backups for current instances.

  • creating - Automated backups that are waiting for the first automated snapshot to be available.

  • retained - Automated backups for deleted instances and after backup replication is stopped.

• db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.

• dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

setFilters

public void setFilters(Collection<Filter> filters)

A filter that specifies which resources to return based on status.

Supported filters are the following:

• status

  • active - Automated backups for current instances.

  • creating - Automated backups that are waiting for the first automated snapshot to be available.

  • retained - Automated backups for deleted instances and after backup replication is stopped.

• db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.

• dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

Parameters:

filters - A filter that specifies which resources to return based on status.

Supported filters are the following:

• status

  • active - Automated backups for current instances.

  • creating - Automated backups that are waiting for the first automated snapshot to be available.

  • retained - Automated backups for deleted instances and after backup replication is stopped.

• db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.

• dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

withFilters

public DescribeDBInstanceAutomatedBackupsRequest withFilters(Filter... filters)

A filter that specifies which resources to return based on status.

Supported filters are the following:

• status

  • active - Automated backups for current instances.

  • creating - Automated backups that are waiting for the first automated snapshot to be available.

  • retained - Automated backups for deleted instances and after backup replication is stopped.

• db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.

• dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

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

Parameters:

filters - A filter that specifies which resources to return based on status.

Supported filters are the following:

• status

  • active - Automated backups for current instances.

  • creating - Automated backups that are waiting for the first automated snapshot to be available.

  • retained - Automated backups for deleted instances and after backup replication is stopped.

• db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.

• dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

Returns:

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

withFilters

public DescribeDBInstanceAutomatedBackupsRequest withFilters(Collection<Filter> filters)

A filter that specifies which resources to return based on status.

Supported filters are the following:

• status

  • active - Automated backups for current instances.

  • creating - Automated backups that are waiting for the first automated snapshot to be available.

  • retained - Automated backups for deleted instances and after backup replication is stopped.

• db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.

• dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

Parameters:

filters - A filter that specifies which resources to return based on status.

Supported filters are the following:

• status

  • active - Automated backups for current instances.

  • creating - Automated backups that are waiting for the first automated snapshot to be available.

  • retained - Automated backups for deleted instances and after backup replication is stopped.

• db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.

• dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

Returns:

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

setMaxRecords

public void setMaxRecords(Integer maxRecords)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Parameters:

maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

getMaxRecords

public Integer getMaxRecords()

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Returns:

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

withMaxRecords

public DescribeDBInstanceAutomatedBackupsRequest withMaxRecords(Integer maxRecords)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Parameters:

maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Returns:

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

setMarker

public void setMarker(String marker)

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

Parameters:

marker - The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

getMarker

public String getMarker()

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

Returns:

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

withMarker

public DescribeDBInstanceAutomatedBackupsRequest withMarker(String marker)

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

Parameters:

marker - The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

Returns:

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

setDBInstanceAutomatedBackupsArn

public void setDBInstanceAutomatedBackupsArn(String dBInstanceAutomatedBackupsArn)

The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

This setting doesn't apply to RDS Custom.

Parameters:

dBInstanceAutomatedBackupsArn - The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

This setting doesn't apply to RDS Custom.

getDBInstanceAutomatedBackupsArn

public String getDBInstanceAutomatedBackupsArn()

The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

This setting doesn't apply to RDS Custom.

Returns:

The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

This setting doesn't apply to RDS Custom.

withDBInstanceAutomatedBackupsArn

public DescribeDBInstanceAutomatedBackupsRequest withDBInstanceAutomatedBackupsArn(String dBInstanceAutomatedBackupsArn)

The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

This setting doesn't apply to RDS Custom.

Parameters:

dBInstanceAutomatedBackupsArn - The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

This setting doesn't apply to RDS Custom.

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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 DescribeDBInstanceAutomatedBackupsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()