Package software.amazon.awssdk.services.neptune.model

Interface DBClusterSnapshot.Builder

    • Method Detail

      • availabilityZones

        DBClusterSnapshot.Builder availabilityZones​(Collection<String> availabilityZones)

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

        Parameters:
        availabilityZones - Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • availabilityZones

        DBClusterSnapshot.Builder availabilityZones​(String... availabilityZones)

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

        Parameters:
        availabilityZones - Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbClusterSnapshotIdentifier

        DBClusterSnapshot.Builder dbClusterSnapshotIdentifier​(String dbClusterSnapshotIdentifier)

        Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

        After you restore a DB cluster using a DBClusterSnapshotIdentifier, you must specify the same DBClusterSnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

        However, if you don't specify the DBClusterSnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the DBClusterSnapshotIdentifier, and the original DB cluster is deleted.

        Parameters:
        dbClusterSnapshotIdentifier - Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

        After you restore a DB cluster using a DBClusterSnapshotIdentifier, you must specify the same DBClusterSnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

        However, if you don't specify the DBClusterSnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the DBClusterSnapshotIdentifier, and the original DB cluster is deleted.

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

      • dbClusterIdentifier

        DBClusterSnapshot.Builder dbClusterIdentifier​(String dbClusterIdentifier)

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

        Parameters:
        dbClusterIdentifier - Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snapshotCreateTime

        DBClusterSnapshot.Builder snapshotCreateTime​(Instant snapshotCreateTime)

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

        Parameters:
        snapshotCreateTime - Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engine

        DBClusterSnapshot.Builder engine​(String engine)

        Specifies the name of the database engine.

        Parameters:
        engine - Specifies the name of the database engine.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • allocatedStorage

        DBClusterSnapshot.Builder allocatedStorage​(Integer allocatedStorage)

        Specifies the allocated storage size in gibibytes (GiB).

        Parameters:
        allocatedStorage - Specifies the allocated storage size in gibibytes (GiB).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        DBClusterSnapshot.Builder status​(String status)

        Specifies the status of this DB cluster snapshot.

        Parameters:
        status - Specifies the status of this DB cluster snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • port

        DBClusterSnapshot.Builder port​(Integer port)

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

        Parameters:
        port - Specifies the port that the DB cluster was listening on at the time of the snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcId

        DBClusterSnapshot.Builder vpcId​(String vpcId)

        Provides the VPC ID associated with the DB cluster snapshot.

        Parameters:
        vpcId - Provides the VPC ID associated with the DB cluster snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clusterCreateTime

        DBClusterSnapshot.Builder clusterCreateTime​(Instant clusterCreateTime)

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

        Parameters:
        clusterCreateTime - Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • masterUsername

        DBClusterSnapshot.Builder masterUsername​(String masterUsername)

        Not supported by Neptune.

        Parameters:
        masterUsername - Not supported by Neptune.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engineVersion

        DBClusterSnapshot.Builder engineVersion​(String engineVersion)

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

        Parameters:
        engineVersion - Provides the version of the database engine for this DB cluster snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • licenseModel

        DBClusterSnapshot.Builder licenseModel​(String licenseModel)

        Provides the license model information for this DB cluster snapshot.

        Parameters:
        licenseModel - Provides the license model information for this DB cluster snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snapshotType

        DBClusterSnapshot.Builder snapshotType​(String snapshotType)

        Provides the type of the DB cluster snapshot.

        Parameters:
        snapshotType - Provides the type of the DB cluster snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • percentProgress

        DBClusterSnapshot.Builder percentProgress​(Integer percentProgress)

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

        Parameters:
        percentProgress - Specifies the percentage of the estimated data that has been transferred.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • storageEncrypted

        DBClusterSnapshot.Builder storageEncrypted​(Boolean storageEncrypted)

        Specifies whether the DB cluster snapshot is encrypted.

        Parameters:
        storageEncrypted - Specifies whether the DB cluster snapshot is encrypted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyId

        DBClusterSnapshot.Builder kmsKeyId​(String kmsKeyId)

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

        Parameters:
        kmsKeyId - If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbClusterSnapshotArn

        DBClusterSnapshot.Builder dbClusterSnapshotArn​(String dbClusterSnapshotArn)

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

        Parameters:
        dbClusterSnapshotArn - The Amazon Resource Name (ARN) for the DB cluster snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceDBClusterSnapshotArn

        DBClusterSnapshot.Builder sourceDBClusterSnapshotArn​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • iamDatabaseAuthenticationEnabled

        DBClusterSnapshot.Builder iamDatabaseAuthenticationEnabled​(Boolean iamDatabaseAuthenticationEnabled)

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

        Parameters:
        iamDatabaseAuthenticationEnabled - True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • storageType

        DBClusterSnapshot.Builder storageType​(String storageType)

        The storage type associated with the DB cluster snapshot.

        Parameters:
        storageType - The storage type associated with the DB cluster snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.