com.amazonaws.services.rds.model

Class DescribeDBSnapshotsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.DescribeDBSnapshotsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeDBSnapshotsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeDBSnapshotsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDBInstanceIdentifier() The ID of the DB instance to retrieve the list of DB snapshots for.
String	getDbiResourceId() A specific DB resource ID to describe.
String	getDBSnapshotIdentifier() A specific DB snapshot identifier to describe.
List<Filter>	getFilters() A filter that specifies one or more DB snapshots to describe.
Boolean	getIncludePublic() A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account.
Boolean	getIncludeShared() A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore.
String	getMarker() An optional pagination token provided by a previous DescribeDBSnapshots request.
Integer	getMaxRecords() The maximum number of records to include in the response.
String	getSnapshotType() The type of snapshots to be returned.
int	hashCode()
Boolean	isIncludePublic() A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account.
Boolean	isIncludeShared() A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore.
void	setDBInstanceIdentifier(String dBInstanceIdentifier) The ID of the DB instance to retrieve the list of DB snapshots for.
void	setDbiResourceId(String dbiResourceId) A specific DB resource ID to describe.
void	setDBSnapshotIdentifier(String dBSnapshotIdentifier) A specific DB snapshot identifier to describe.
void	setFilters(Collection<Filter> filters) A filter that specifies one or more DB snapshots to describe.
void	setIncludePublic(Boolean includePublic) A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account.
void	setIncludeShared(Boolean includeShared) A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore.
void	setMarker(String marker) An optional pagination token provided by a previous DescribeDBSnapshots request.
void	setMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
void	setSnapshotType(String snapshotType) The type of snapshots to be returned.
String	toString() Returns a string representation of this object.
DescribeDBSnapshotsRequest	withDBInstanceIdentifier(String dBInstanceIdentifier) The ID of the DB instance to retrieve the list of DB snapshots for.
DescribeDBSnapshotsRequest	withDbiResourceId(String dbiResourceId) A specific DB resource ID to describe.
DescribeDBSnapshotsRequest	withDBSnapshotIdentifier(String dBSnapshotIdentifier) A specific DB snapshot identifier to describe.
DescribeDBSnapshotsRequest	withFilters(Collection<Filter> filters) A filter that specifies one or more DB snapshots to describe.
DescribeDBSnapshotsRequest	withFilters(Filter... filters) A filter that specifies one or more DB snapshots to describe.
DescribeDBSnapshotsRequest	withIncludePublic(Boolean includePublic) A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account.
DescribeDBSnapshotsRequest	withIncludeShared(Boolean includeShared) A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore.
DescribeDBSnapshotsRequest	withMarker(String marker) An optional pagination token provided by a previous DescribeDBSnapshots request.
DescribeDBSnapshotsRequest	withMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
DescribeDBSnapshotsRequest	withSnapshotType(String snapshotType) The type of snapshots to be returned.

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

DescribeDBSnapshotsRequest

public DescribeDBSnapshotsRequest()

Method Detail

setDBInstanceIdentifier

public void setDBInstanceIdentifier(String dBInstanceIdentifier)

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with DBSnapshotIdentifier. This parameter isn't case-sensitive.

Constraints:

• If supplied, must match the identifier of an existing DBInstance.

Parameters:

dBInstanceIdentifier - The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with DBSnapshotIdentifier. This parameter isn't case-sensitive.

Constraints:

• If supplied, must match the identifier of an existing DBInstance.

getDBInstanceIdentifier

public String getDBInstanceIdentifier()

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with DBSnapshotIdentifier. This parameter isn't case-sensitive.

Constraints:

• If supplied, must match the identifier of an existing DBInstance.

Returns:

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with DBSnapshotIdentifier. This parameter isn't case-sensitive.

Constraints:

• If supplied, must match the identifier of an existing DBInstance.

withDBInstanceIdentifier

public DescribeDBSnapshotsRequest withDBInstanceIdentifier(String dBInstanceIdentifier)

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with DBSnapshotIdentifier. This parameter isn't case-sensitive.

Constraints:

• If supplied, must match the identifier of an existing DBInstance.

Parameters:

dBInstanceIdentifier - The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with DBSnapshotIdentifier. This parameter isn't case-sensitive.

Constraints:

• If supplied, must match the identifier of an existing DBInstance.

Returns:

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

setDBSnapshotIdentifier

public void setDBSnapshotIdentifier(String dBSnapshotIdentifier)

A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

• If supplied, must match the identifier of an existing DBSnapshot.

• If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

Parameters:

dBSnapshotIdentifier - A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

• If supplied, must match the identifier of an existing DBSnapshot.

• If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

getDBSnapshotIdentifier

public String getDBSnapshotIdentifier()

A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

• If supplied, must match the identifier of an existing DBSnapshot.

• If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

Returns:

A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

• If supplied, must match the identifier of an existing DBSnapshot.

• If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

withDBSnapshotIdentifier

public DescribeDBSnapshotsRequest withDBSnapshotIdentifier(String dBSnapshotIdentifier)

A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

• If supplied, must match the identifier of an existing DBSnapshot.

• If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

Parameters:

dBSnapshotIdentifier - A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

• If supplied, must match the identifier of an existing DBSnapshot.

• If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

Returns:

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

setSnapshotType

public void setSnapshotType(String snapshotType)

The type of snapshots to be returned. You can specify one of the following values:

• automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.

• manual - Return all DB snapshots that have been taken by my AWS account.

• shared - Return all manual DB snapshots that have been shared to my AWS account.

• public - Return all DB snapshots that have been marked as public.

• awsbackup - Return the DB snapshots managed by the AWS Backup service.

  For information about AWS Backup, see the AWS Backup Developer Guide.

  The awsbackup type does not apply to Aurora.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

Parameters:

snapshotType - The type of snapshots to be returned. You can specify one of the following values:

• automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.

• manual - Return all DB snapshots that have been taken by my AWS account.

• shared - Return all manual DB snapshots that have been shared to my AWS account.

• public - Return all DB snapshots that have been marked as public.

• awsbackup - Return the DB snapshots managed by the AWS Backup service.

  For information about AWS Backup, see the AWS Backup Developer Guide.

  The awsbackup type does not apply to Aurora.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

getSnapshotType

public String getSnapshotType()

The type of snapshots to be returned. You can specify one of the following values:

• automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.

• manual - Return all DB snapshots that have been taken by my AWS account.

• shared - Return all manual DB snapshots that have been shared to my AWS account.

• public - Return all DB snapshots that have been marked as public.

• awsbackup - Return the DB snapshots managed by the AWS Backup service.

  For information about AWS Backup, see the AWS Backup Developer Guide.

  The awsbackup type does not apply to Aurora.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

Returns:

The type of snapshots to be returned. You can specify one of the following values:

• automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.

• manual - Return all DB snapshots that have been taken by my AWS account.

• shared - Return all manual DB snapshots that have been shared to my AWS account.

• public - Return all DB snapshots that have been marked as public.

• awsbackup - Return the DB snapshots managed by the AWS Backup service.

  For information about AWS Backup, see the AWS Backup Developer Guide.

  The awsbackup type does not apply to Aurora.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

withSnapshotType

public DescribeDBSnapshotsRequest withSnapshotType(String snapshotType)

The type of snapshots to be returned. You can specify one of the following values:

• automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.

• manual - Return all DB snapshots that have been taken by my AWS account.

• shared - Return all manual DB snapshots that have been shared to my AWS account.

• public - Return all DB snapshots that have been marked as public.

• awsbackup - Return the DB snapshots managed by the AWS Backup service.

  For information about AWS Backup, see the AWS Backup Developer Guide.

  The awsbackup type does not apply to Aurora.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

Parameters:

snapshotType - The type of snapshots to be returned. You can specify one of the following values:

• automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.

• manual - Return all DB snapshots that have been taken by my AWS account.

• shared - Return all manual DB snapshots that have been shared to my AWS account.

• public - Return all DB snapshots that have been marked as public.

• awsbackup - Return the DB snapshots managed by the AWS Backup service.

  For information about AWS Backup, see the AWS Backup Developer Guide.

  The awsbackup type does not apply to Aurora.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

Returns:

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

getFilters

public List<Filter> getFilters()

A filter that specifies one or more DB snapshots to describe.

Supported filters:

• db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

• db-snapshot-id - Accepts DB snapshot identifiers.

• dbi-resource-id - Accepts identifiers of source DB instances.

• snapshot-type - Accepts types of DB snapshots.

• engine - Accepts names of database engines.

Returns:

A filter that specifies one or more DB snapshots to describe.

Supported filters:

• db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

• db-snapshot-id - Accepts DB snapshot identifiers.

• dbi-resource-id - Accepts identifiers of source DB instances.

• snapshot-type - Accepts types of DB snapshots.

• engine - Accepts names of database engines.

setFilters

public void setFilters(Collection<Filter> filters)

A filter that specifies one or more DB snapshots to describe.

Supported filters:

• db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

• db-snapshot-id - Accepts DB snapshot identifiers.

• dbi-resource-id - Accepts identifiers of source DB instances.

• snapshot-type - Accepts types of DB snapshots.

• engine - Accepts names of database engines.

Parameters:

filters - A filter that specifies one or more DB snapshots to describe.

Supported filters:

• db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

• db-snapshot-id - Accepts DB snapshot identifiers.

• dbi-resource-id - Accepts identifiers of source DB instances.

• snapshot-type - Accepts types of DB snapshots.

• engine - Accepts names of database engines.

withFilters

public DescribeDBSnapshotsRequest withFilters(Filter... filters)

A filter that specifies one or more DB snapshots to describe.

Supported filters:

• db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

• db-snapshot-id - Accepts DB snapshot identifiers.

• dbi-resource-id - Accepts identifiers of source DB instances.

• snapshot-type - Accepts types of DB snapshots.

• engine - Accepts names of database engines.

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 one or more DB snapshots to describe.

Supported filters:

• db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

• db-snapshot-id - Accepts DB snapshot identifiers.

• dbi-resource-id - Accepts identifiers of source DB instances.

• snapshot-type - Accepts types of DB snapshots.

• engine - Accepts names of database engines.

Returns:

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

withFilters

public DescribeDBSnapshotsRequest withFilters(Collection<Filter> filters)

A filter that specifies one or more DB snapshots to describe.

Supported filters:

• db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

• db-snapshot-id - Accepts DB snapshot identifiers.

• dbi-resource-id - Accepts identifiers of source DB instances.

• snapshot-type - Accepts types of DB snapshots.

• engine - Accepts names of database engines.

Parameters:

filters - A filter that specifies one or more DB snapshots to describe.

Supported filters:

• db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

• db-snapshot-id - Accepts DB snapshot identifiers.

• dbi-resource-id - Accepts identifiers of source DB instances.

• snapshot-type - Accepts types of DB snapshots.

• engine - Accepts names of database engines.

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.

Default: 100

Constraints: Minimum 20, maximum 100.

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.

Default: 100

Constraints: Minimum 20, maximum 100.

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.

Default: 100

Constraints: Minimum 20, maximum 100.

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.

Default: 100

Constraints: Minimum 20, maximum 100.

withMaxRecords

public DescribeDBSnapshotsRequest 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.

Default: 100

Constraints: Minimum 20, maximum 100.

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.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

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

setMarker

public void setMarker(String marker)

An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Parameters:

marker - An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

getMarker

public String getMarker()

An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

withMarker

public DescribeDBSnapshotsRequest withMarker(String marker)

An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Parameters:

marker - An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

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

setIncludeShared

public void setIncludeShared(Boolean includeShared)

A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

Parameters:

includeShared - A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

getIncludeShared

public Boolean getIncludeShared()

A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

Returns:

A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

withIncludeShared

public DescribeDBSnapshotsRequest withIncludeShared(Boolean includeShared)

A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

Parameters:

includeShared - A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

Returns:

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

isIncludeShared

public Boolean isIncludeShared()

A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

Returns:

A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

setIncludePublic

public void setIncludePublic(Boolean includePublic)

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

Parameters:

includePublic - A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

getIncludePublic

public Boolean getIncludePublic()

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

Returns:

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

withIncludePublic

public DescribeDBSnapshotsRequest withIncludePublic(Boolean includePublic)

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

Parameters:

includePublic - A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

Returns:

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

isIncludePublic

public Boolean isIncludePublic()

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

Returns:

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

setDbiResourceId

public void setDbiResourceId(String dbiResourceId)

A specific DB resource ID to describe.

Parameters:

dbiResourceId - A specific DB resource ID to describe.

getDbiResourceId

public String getDbiResourceId()

A specific DB resource ID to describe.

Returns:

A specific DB resource ID to describe.

withDbiResourceId

public DescribeDBSnapshotsRequest withDbiResourceId(String dbiResourceId)

A specific DB resource ID to describe.

Parameters:

dbiResourceId - A specific DB resource ID to describe.

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