Interface AwsRdsDbSnapshotDetails.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<AwsRdsDbSnapshotDetails.Builder,AwsRdsDbSnapshotDetails>,SdkBuilder<AwsRdsDbSnapshotDetails.Builder,AwsRdsDbSnapshotDetails>,SdkPojo
- Enclosing class:
- AwsRdsDbSnapshotDetails
public static interface AwsRdsDbSnapshotDetails.Builder extends SdkPojo, CopyableBuilder<AwsRdsDbSnapshotDetails.Builder,AwsRdsDbSnapshotDetails>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AwsRdsDbSnapshotDetails.BuilderallocatedStorage(Integer allocatedStorage)The amount of storage (in gigabytes) to be initially allocated for the database instance.AwsRdsDbSnapshotDetails.BuilderavailabilityZone(String availabilityZone)Specifies the name of the Availability Zone in which the DB instance was located at the time of the DB snapshot.AwsRdsDbSnapshotDetails.BuilderdbInstanceIdentifier(String dbInstanceIdentifier)A name for the DB instance.AwsRdsDbSnapshotDetails.BuilderdbiResourceId(String dbiResourceId)The identifier for the source DB instance.AwsRdsDbSnapshotDetails.BuilderdbSnapshotIdentifier(String dbSnapshotIdentifier)The name or ARN of the DB snapshot that is used to restore the DB instance.AwsRdsDbSnapshotDetails.Builderencrypted(Boolean encrypted)Whether the DB snapshot is encrypted.AwsRdsDbSnapshotDetails.Builderengine(String engine)The name of the database engine to use for this DB instance.AwsRdsDbSnapshotDetails.BuilderengineVersion(String engineVersion)The version of the database engine.AwsRdsDbSnapshotDetails.BuilderiamDatabaseAuthenticationEnabled(Boolean iamDatabaseAuthenticationEnabled)Whether mapping of IAM accounts to database accounts is enabled.AwsRdsDbSnapshotDetails.BuilderinstanceCreateTime(String instanceCreateTime)Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.AwsRdsDbSnapshotDetails.Builderiops(Integer iops)The provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.AwsRdsDbSnapshotDetails.BuilderkmsKeyId(String kmsKeyId)IfEncryptedistrue, the KMS key identifier for the encrypted DB snapshot.AwsRdsDbSnapshotDetails.BuilderlicenseModel(String licenseModel)License model information for the restored DB instance.AwsRdsDbSnapshotDetails.BuildermasterUsername(String masterUsername)The master user name for the DB snapshot.AwsRdsDbSnapshotDetails.BuilderoptionGroupName(String optionGroupName)The option group name for the DB snapshot.AwsRdsDbSnapshotDetails.BuilderpercentProgress(Integer percentProgress)The percentage of the estimated data that has been transferred.AwsRdsDbSnapshotDetails.Builderport(Integer port)The port that the database engine was listening on at the time of the snapshot.AwsRdsDbSnapshotDetails.BuilderprocessorFeatures(Collection<AwsRdsDbProcessorFeature> processorFeatures)The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.AwsRdsDbSnapshotDetails.BuilderprocessorFeatures(Consumer<AwsRdsDbProcessorFeature.Builder>... processorFeatures)The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.AwsRdsDbSnapshotDetails.BuilderprocessorFeatures(AwsRdsDbProcessorFeature... processorFeatures)The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.AwsRdsDbSnapshotDetails.BuildersnapshotCreateTime(String snapshotCreateTime)When the snapshot was taken in Coordinated Universal Time (UTC).AwsRdsDbSnapshotDetails.BuildersnapshotType(String snapshotType)The type of the DB snapshot.AwsRdsDbSnapshotDetails.BuildersourceDbSnapshotIdentifier(String sourceDbSnapshotIdentifier)The DB snapshot ARN that the DB snapshot was copied from.AwsRdsDbSnapshotDetails.BuildersourceRegion(String sourceRegion)The Amazon Web Services Region that the DB snapshot was created in or copied from.AwsRdsDbSnapshotDetails.Builderstatus(String status)The status of this DB snapshot.AwsRdsDbSnapshotDetails.BuilderstorageType(String storageType)The storage type associated with the DB snapshot.AwsRdsDbSnapshotDetails.BuildertdeCredentialArn(String tdeCredentialArn)The ARN from the key store with which to associate the instance for TDE encryption.AwsRdsDbSnapshotDetails.Buildertimezone(String timezone)The time zone of the DB snapshot.AwsRdsDbSnapshotDetails.BuildervpcId(String vpcId)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, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
dbSnapshotIdentifier
AwsRdsDbSnapshotDetails.Builder dbSnapshotIdentifier(String dbSnapshotIdentifier)
The name or ARN of the DB snapshot that is used to restore the DB instance.
- Parameters:
dbSnapshotIdentifier- The name or ARN of the DB snapshot that is used to restore the DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbInstanceIdentifier
AwsRdsDbSnapshotDetails.Builder dbInstanceIdentifier(String dbInstanceIdentifier)
A name for the DB instance.
- Parameters:
dbInstanceIdentifier- A name for the DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotCreateTime
AwsRdsDbSnapshotDetails.Builder snapshotCreateTime(String snapshotCreateTime)
When the snapshot was taken in Coordinated Universal Time (UTC).
- Parameters:
snapshotCreateTime- When the snapshot was taken in Coordinated Universal Time (UTC).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engine
AwsRdsDbSnapshotDetails.Builder engine(String engine)
The name of the database engine to use for this DB instance. Valid values are as follows:
-
aurora -
aurora-mysql -
aurora-postgresql -
c -
mariadb -
mysql -
oracle-ee -
oracle-se -
oracle-se1 -
oracle-se2 -
sqlserver-ee -
sqlserver-ex -
sqlserver-se -
sqlserver-web
- Parameters:
engine- The name of the database engine to use for this DB instance. Valid values are as follows:-
aurora -
aurora-mysql -
aurora-postgresql -
c -
mariadb -
mysql -
oracle-ee -
oracle-se -
oracle-se1 -
oracle-se2 -
sqlserver-ee -
sqlserver-ex -
sqlserver-se -
sqlserver-web
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
allocatedStorage
AwsRdsDbSnapshotDetails.Builder allocatedStorage(Integer allocatedStorage)
The amount of storage (in gigabytes) to be initially allocated for the database instance.
- Parameters:
allocatedStorage- The amount of storage (in gigabytes) to be initially allocated for the database instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
AwsRdsDbSnapshotDetails.Builder status(String status)
The status of this DB snapshot.
- Parameters:
status- The status of this DB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
port
AwsRdsDbSnapshotDetails.Builder port(Integer port)
The port that the database engine was listening on at the time of the snapshot.
- Parameters:
port- 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
AwsRdsDbSnapshotDetails.Builder availabilityZone(String availabilityZone)
Specifies the name of the Availability Zone in which the DB instance was located at the time of the DB snapshot.
- Parameters:
availabilityZone- Specifies the name of the Availability Zone in which the DB instance was located at the time of the DB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcId
AwsRdsDbSnapshotDetails.Builder vpcId(String vpcId)
The VPC ID associated with the DB snapshot.
- Parameters:
vpcId- The VPC ID associated with the DB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceCreateTime
AwsRdsDbSnapshotDetails.Builder instanceCreateTime(String 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
AwsRdsDbSnapshotDetails.Builder masterUsername(String masterUsername)
The master user name for the DB snapshot.
- Parameters:
masterUsername- The master user name for the DB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engineVersion
AwsRdsDbSnapshotDetails.Builder engineVersion(String engineVersion)
The version of the database engine.
- Parameters:
engineVersion- The version of the database engine.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
licenseModel
AwsRdsDbSnapshotDetails.Builder licenseModel(String 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
AwsRdsDbSnapshotDetails.Builder snapshotType(String snapshotType)
The type of the DB snapshot.
- Parameters:
snapshotType- The type of the DB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iops
AwsRdsDbSnapshotDetails.Builder iops(Integer iops)
The provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
- Parameters:
iops- 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
AwsRdsDbSnapshotDetails.Builder optionGroupName(String optionGroupName)
The option group name for the DB snapshot.
- Parameters:
optionGroupName- The option group name for the DB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
percentProgress
AwsRdsDbSnapshotDetails.Builder percentProgress(Integer 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
AwsRdsDbSnapshotDetails.Builder sourceRegion(String 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
AwsRdsDbSnapshotDetails.Builder sourceDbSnapshotIdentifier(String sourceDbSnapshotIdentifier)
The DB snapshot ARN that the DB snapshot was copied from.
- Parameters:
sourceDbSnapshotIdentifier- The DB snapshot ARN that the DB snapshot was copied from.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
storageType
AwsRdsDbSnapshotDetails.Builder storageType(String storageType)
The storage type associated with the DB snapshot. Valid values are as follows:
-
gp2 -
io1 -
standard
- Parameters:
storageType- The storage type associated with the DB snapshot. Valid values are as follows:-
gp2 -
io1 -
standard
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
tdeCredentialArn
AwsRdsDbSnapshotDetails.Builder tdeCredentialArn(String 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
AwsRdsDbSnapshotDetails.Builder encrypted(Boolean encrypted)
Whether the DB snapshot is encrypted.
- Parameters:
encrypted- Whether the DB snapshot is encrypted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyId
AwsRdsDbSnapshotDetails.Builder kmsKeyId(String kmsKeyId)
If
Encryptedistrue, the KMS key identifier for the encrypted DB snapshot.- Parameters:
kmsKeyId- IfEncryptedistrue, the KMS key identifier for the encrypted DB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timezone
AwsRdsDbSnapshotDetails.Builder timezone(String timezone)
The time zone of the DB snapshot.
- Parameters:
timezone- The time zone of the DB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iamDatabaseAuthenticationEnabled
AwsRdsDbSnapshotDetails.Builder iamDatabaseAuthenticationEnabled(Boolean iamDatabaseAuthenticationEnabled)
Whether mapping of IAM accounts to database accounts is enabled.
- Parameters:
iamDatabaseAuthenticationEnabled- Whether mapping of IAM accounts to database accounts is enabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
processorFeatures
AwsRdsDbSnapshotDetails.Builder processorFeatures(Collection<AwsRdsDbProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
- Parameters:
processorFeatures- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
processorFeatures
AwsRdsDbSnapshotDetails.Builder processorFeatures(AwsRdsDbProcessorFeature... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
- Parameters:
processorFeatures- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
processorFeatures
AwsRdsDbSnapshotDetails.Builder processorFeatures(Consumer<AwsRdsDbProcessorFeature.Builder>... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This is a convenience method that creates an instance of theAwsRdsDbProcessorFeature.Builderavoiding the need to create one manually viaAwsRdsDbProcessorFeature.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#processorFeatures(List.) - Parameters:
processorFeatures- a consumer that will call methods onAwsRdsDbProcessorFeature.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#processorFeatures(java.util.Collection)
-
dbiResourceId
AwsRdsDbSnapshotDetails.Builder dbiResourceId(String dbiResourceId)
The identifier for the source DB instance.
- Parameters:
dbiResourceId- The identifier for the source DB instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-