Interface DBSnapshot.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DBSnapshot.Builder,
,DBSnapshot> SdkBuilder<DBSnapshot.Builder,
,DBSnapshot> SdkPojo
- Enclosing class:
DBSnapshot
-
Method Summary
Modifier and TypeMethodDescriptionallocatedStorage
(Integer allocatedStorage) Specifies the allocated storage size in gibibytes (GiB).availabilityZone
(String availabilityZone) Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.dbInstanceIdentifier
(String dbInstanceIdentifier) Specifies the DB instance identifier of the DB instance this DB snapshot was created from.dbiResourceId
(String dbiResourceId) The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.dbSnapshotArn
(String dbSnapshotArn) The Amazon Resource Name (ARN) for the DB snapshot.dbSnapshotIdentifier
(String dbSnapshotIdentifier) Specifies the identifier for the DB snapshot.dbSystemId
(String dbSystemId) The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files.dedicatedLogVolume
(Boolean dedicatedLogVolume) Indicates whether the DB instance has a dedicated log volume (DLV) enabled.Indicates whether the DB snapshot is encrypted.Specifies the name of the database engine.engineVersion
(String engineVersion) Specifies the version of the database engine.iamDatabaseAuthenticationEnabled
(Boolean iamDatabaseAuthenticationEnabled) Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.instanceCreateTime
(Instant instanceCreateTime) Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.IfEncrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.licenseModel
(String licenseModel) License model information for the restored DB instance.masterUsername
(String masterUsername) Provides the master username for the DB snapshot.multiTenant
(Boolean multiTenant) Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).optionGroupName
(String optionGroupName) Provides the option group name for the DB snapshot.originalSnapshotCreateTime
(Instant originalSnapshotCreateTime) Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC).percentProgress
(Integer percentProgress) The percentage of the estimated data that has been transferred.Specifies the port that the database engine was listening on at the time of the snapshot.processorFeatures
(Collection<ProcessorFeature> processorFeatures) The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.processorFeatures
(Consumer<ProcessorFeature.Builder>... processorFeatures) The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.processorFeatures
(ProcessorFeature... processorFeatures) The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.snapshotCreateTime
(Instant snapshotCreateTime) Specifies when the snapshot was taken in Coordinated Universal Time (UTC).snapshotDatabaseTime
(Instant snapshotDatabaseTime) The timestamp of the most recent transaction applied to the database that you're backing up.snapshotTarget
(String snapshotTarget) Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.snapshotType
(String snapshotType) Provides the type of the DB snapshot.sourceDBSnapshotIdentifier
(String sourceDBSnapshotIdentifier) The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from.sourceRegion
(String sourceRegion) The Amazon Web Services Region that the DB snapshot was created in or copied from.Specifies the status of this DB snapshot.storageThroughput
(Integer storageThroughput) Specifies the storage throughput for the DB snapshot.storageType
(String storageType) Specifies the storage type associated with DB snapshot.tagList
(Collection<Tag> tagList) Sets the value of the TagList property for this object.tagList
(Consumer<Tag.Builder>... tagList) Sets the value of the TagList property for this object.Sets the value of the TagList property for this object.tdeCredentialArn
(String tdeCredentialArn) The ARN from the key store with which to associate the instance for TDE encryption.The time zone of the DB snapshot.Provides the VPC ID associated with the DB snapshot.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
dbSnapshotIdentifier
Specifies the identifier for the DB snapshot.
- Parameters:
dbSnapshotIdentifier
- Specifies the identifier for the DB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbInstanceIdentifier
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
- Parameters:
dbInstanceIdentifier
- Specifies the DB instance identifier of the DB instance this DB snapshot was created from.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotCreateTime
Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
- Parameters:
snapshotCreateTime
- Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
Specifies the status of this DB snapshot.
- Parameters:
status
- Specifies the status of this DB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
port
Specifies the port that the database engine was listening on at the time of the snapshot.
- Parameters:
port
- Specifies the port that the database engine was listening on at the time of the snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
availabilityZone
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
- Parameters:
availabilityZone
- Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcId
Provides the VPC ID associated with the DB snapshot.
- Parameters:
vpcId
- Provides the VPC ID associated with the DB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceCreateTime
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
- Parameters:
instanceCreateTime
- Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
masterUsername
Provides the master username for the DB snapshot.
- Parameters:
masterUsername
- Provides the master username for the DB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engineVersion
Specifies the version of the database engine.
- Parameters:
engineVersion
- Specifies the version of the database engine.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
licenseModel
License model information for the restored DB instance.
- Parameters:
licenseModel
- License model information for the restored DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotType
Provides the type of the DB snapshot.
- Parameters:
snapshotType
- Provides the type of the DB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iops
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
- Parameters:
iops
- Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
optionGroupName
Provides the option group name for the DB snapshot.
- Parameters:
optionGroupName
- Provides the option group name for the DB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
percentProgress
The percentage of the estimated data that has been transferred.
- Parameters:
percentProgress
- 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.
-
sourceRegion
The Amazon Web Services Region that the DB snapshot was created in or copied from.
- Parameters:
sourceRegion
- The Amazon Web Services Region that the DB snapshot was created in or copied from.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceDBSnapshotIdentifier
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
- Parameters:
sourceDBSnapshotIdentifier
- The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
storageType
Specifies the storage type associated with DB snapshot.
- Parameters:
storageType
- Specifies the storage type associated with DB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tdeCredentialArn
The ARN from the key store with which to associate the instance for TDE encryption.
- Parameters:
tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE encryption.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encrypted
Indicates whether the DB snapshot is encrypted.
- Parameters:
encrypted
- Indicates whether the DB snapshot is encrypted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyId
If
Encrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
- Parameters:
kmsKeyId
- IfEncrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbSnapshotArn
The Amazon Resource Name (ARN) for the DB snapshot.
- Parameters:
dbSnapshotArn
- The Amazon Resource Name (ARN) for the DB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timezone
The time zone of the DB snapshot. In most cases, the
Timezone
element is empty.Timezone
content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.- Parameters:
timezone
- The time zone of the DB snapshot. In most cases, theTimezone
element is empty.Timezone
content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iamDatabaseAuthenticationEnabled
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
- Parameters:
iamDatabaseAuthenticationEnabled
- Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
- Parameters:
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
- Parameters:
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
This is a convenience method that creates an instance of theProcessorFeature.Builder
avoiding the need to create one manually viaProcessorFeature.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprocessorFeatures(List<ProcessorFeature>)
.- Parameters:
processorFeatures
- a consumer that will call methods onProcessorFeature.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
dbiResourceId
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
- Parameters:
dbiResourceId
- The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagList
Sets the value of the TagList property for this object.- Parameters:
tagList
- The new value for the TagList property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagList
Sets the value of the TagList property for this object.- Parameters:
tagList
- The new value for the TagList property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagList
Sets the value of the TagList property for this object. This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totagList(List<Tag>)
.- Parameters:
tagList
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
originalSnapshotCreateTime
Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
- Parameters:
originalSnapshotCreateTime
- Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotDatabaseTime
The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.
If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.
- Parameters:
snapshotDatabaseTime
- The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotTarget
Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
- Parameters:
snapshotTarget
- Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
storageThroughput
Specifies the storage throughput for the DB snapshot.
- Parameters:
storageThroughput
- Specifies the storage throughput for the DB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbSystemId
The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.
- Parameters:
dbSystemId
- The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dedicatedLogVolume
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- Parameters:
dedicatedLogVolume
- Indicates whether the DB instance has a dedicated log volume (DLV) enabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
multiTenant
Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
- Parameters:
multiTenant
- Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-