Package software.amazon.awssdk.services.rds.model

Class DBClusterSnapshot

java.lang.Object

software.amazon.awssdk.services.rds.model.DBClusterSnapshot

All Implemented Interfaces:

ToCopyableBuilder<DBClusterSnapshot.Builder,DBClusterSnapshot>

@Generated("software.amazon.awssdk:codegen")
public class DBClusterSnapshot
extends Object
implements ToCopyableBuilder<DBClusterSnapshot.Builder,DBClusterSnapshot>

Contains the result of a successful invocation of the following actions:

• CreateDBClusterSnapshot

• DeleteDBClusterSnapshot

This data type is used as a response element in the DescribeDBClusterSnapshots action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DBClusterSnapshot.Builder

Method Summary

Modifier and Type	Method	Description
Integer	allocatedStorage()	Specifies the allocated storage size in gigabytes (GB).
List<String>	availabilityZones()	Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
static DBClusterSnapshot.Builder	builder()
Date	clusterCreateTime()	Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
String	dbClusterIdentifier()	Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
String	dbClusterSnapshotArn()	The Amazon Resource Name (ARN) for the DB cluster snapshot.
String	dbClusterSnapshotIdentifier()	Specifies the identifier for the DB cluster snapshot.
String	engine()	Specifies the name of the database engine.
String	engineVersion()	Provides the version of the database engine for this DB cluster snapshot.
boolean	equals(Object obj)
int	hashCode()
Boolean	iamDatabaseAuthenticationEnabled()	True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.
String	kmsKeyId()	If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster snapshot.
String	licenseModel()	Provides the license model information for this DB cluster snapshot.
String	masterUsername()	Provides the master username for the DB cluster snapshot.
Integer	percentProgress()	Specifies the percentage of the estimated data that has been transferred.
Integer	port()	Specifies the port that the DB cluster was listening on at the time of the snapshot.
static Class<? extends DBClusterSnapshot.Builder>	serializableBuilderClass()
Date	snapshotCreateTime()	Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
String	snapshotType()	Provides the type of the DB cluster snapshot.
String	sourceDBClusterSnapshotArn()	If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot; otherwise, a null value.
String	status()	Specifies the status of this DB cluster snapshot.
Boolean	storageEncrypted()	Specifies whether the DB cluster snapshot is encrypted.
DBClusterSnapshot.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	vpcId()	Provides the VPC ID associated with the DB cluster snapshot.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

availabilityZones

public List<String> availabilityZones()

Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

Returns:

Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

dbClusterSnapshotIdentifier

public String dbClusterSnapshotIdentifier()

Specifies the identifier for the DB cluster snapshot.

Returns:

Specifies the identifier for the DB cluster snapshot.

dbClusterIdentifier

public String dbClusterIdentifier()

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

Returns:

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

snapshotCreateTime

public Date snapshotCreateTime()

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

Returns:

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

engine

public String engine()

Specifies the name of the database engine.

Returns:

Specifies the name of the database engine.

allocatedStorage

public Integer allocatedStorage()

Specifies the allocated storage size in gigabytes (GB).

Returns:

Specifies the allocated storage size in gigabytes (GB).

status

public String status()

Specifies the status of this DB cluster snapshot.

Returns:

Specifies the status of this DB cluster snapshot.

port

public Integer port()

Specifies the port that the DB cluster was listening on at the time of the snapshot.

Returns:

Specifies the port that the DB cluster was listening on at the time of the snapshot.

vpcId

public String vpcId()

Provides the VPC ID associated with the DB cluster snapshot.

Returns:

Provides the VPC ID associated with the DB cluster snapshot.

clusterCreateTime

public Date clusterCreateTime()

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

Returns:

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

masterUsername

public String masterUsername()

Provides the master username for the DB cluster snapshot.

Returns:

Provides the master username for the DB cluster snapshot.

engineVersion

public String engineVersion()

Provides the version of the database engine for this DB cluster snapshot.

Returns:

Provides the version of the database engine for this DB cluster snapshot.

licenseModel

public String licenseModel()

Provides the license model information for this DB cluster snapshot.

Returns:

Provides the license model information for this DB cluster snapshot.

snapshotType

public String snapshotType()

Provides the type of the DB cluster snapshot.

Returns:

Provides the type of the DB cluster snapshot.

percentProgress

public Integer percentProgress()

Specifies the percentage of the estimated data that has been transferred.

Returns:

Specifies the percentage of the estimated data that has been transferred.

storageEncrypted

public Boolean storageEncrypted()

Specifies whether the DB cluster snapshot is encrypted.

Returns:

Specifies whether the DB cluster snapshot is encrypted.

kmsKeyId

public String kmsKeyId()

If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster snapshot.

Returns:

If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster snapshot.

dbClusterSnapshotArn

public String dbClusterSnapshotArn()

The Amazon Resource Name (ARN) for the DB cluster snapshot.

Returns:

The Amazon Resource Name (ARN) for the DB cluster snapshot.

sourceDBClusterSnapshotArn

public String sourceDBClusterSnapshotArn()

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot; otherwise, a null value.

Returns:

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot; otherwise, a null value.

iamDatabaseAuthenticationEnabled

public Boolean iamDatabaseAuthenticationEnabled()

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

Returns:

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

toBuilder

public DBClusterSnapshot.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DBClusterSnapshot.Builder,DBClusterSnapshot>

Returns:

a builder for type T

builder

public static DBClusterSnapshot.Builder builder()

serializableBuilderClass

public static Class<? extends DBClusterSnapshot.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object