public static interface DBInstance.Builder extends SdkPojo, CopyableBuilder<DBInstance.Builder,DBInstance>
| Modifier and Type | Method and Description |
|---|---|
DBInstance.Builder |
activityStreamEngineNativeAuditFieldsIncluded(Boolean activityStreamEngineNativeAuditFieldsIncluded)
Indicates whether engine-native audit fields are included in the database activity stream.
|
DBInstance.Builder |
activityStreamKinesisStreamName(String activityStreamKinesisStreamName)
The name of the Amazon Kinesis data stream used for the database activity stream.
|
DBInstance.Builder |
activityStreamKmsKeyId(String activityStreamKmsKeyId)
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
|
DBInstance.Builder |
activityStreamMode(ActivityStreamMode activityStreamMode)
The mode of the database activity stream.
|
DBInstance.Builder |
activityStreamMode(String activityStreamMode)
The mode of the database activity stream.
|
DBInstance.Builder |
activityStreamPolicyStatus(ActivityStreamPolicyStatus activityStreamPolicyStatus)
The status of the policy state of the activity stream.
|
DBInstance.Builder |
activityStreamPolicyStatus(String activityStreamPolicyStatus)
The status of the policy state of the activity stream.
|
DBInstance.Builder |
activityStreamStatus(ActivityStreamStatus activityStreamStatus)
The status of the database activity stream.
|
DBInstance.Builder |
activityStreamStatus(String activityStreamStatus)
The status of the database activity stream.
|
DBInstance.Builder |
allocatedStorage(Integer allocatedStorage)
The amount of storage in gibibytes (GiB) allocated for the DB instance.
|
DBInstance.Builder |
associatedRoles(Collection<DBInstanceRole> associatedRoles)
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
|
DBInstance.Builder |
associatedRoles(Consumer<DBInstanceRole.Builder>... associatedRoles)
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
|
DBInstance.Builder |
associatedRoles(DBInstanceRole... associatedRoles)
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
|
DBInstance.Builder |
automaticRestartTime(Instant automaticRestartTime)
The time when a stopped DB instance is restarted automatically.
|
DBInstance.Builder |
automationMode(AutomationMode automationMode)
The automation mode of the RDS Custom DB instance:
full or all paused. |
DBInstance.Builder |
automationMode(String automationMode)
The automation mode of the RDS Custom DB instance:
full or all paused. |
DBInstance.Builder |
autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates whether minor version patches are applied automatically.
|
DBInstance.Builder |
availabilityZone(String availabilityZone)
The name of the Availability Zone where the DB instance is located.
|
DBInstance.Builder |
awsBackupRecoveryPointArn(String awsBackupRecoveryPointArn)
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
|
DBInstance.Builder |
backupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automatic DB snapshots are retained.
|
DBInstance.Builder |
backupTarget(String backupTarget)
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the
Amazon Web Services Region.
|
DBInstance.Builder |
caCertificateIdentifier(String caCertificateIdentifier)
The identifier of the CA certificate for this DB instance.
|
DBInstance.Builder |
certificateDetails(CertificateDetails certificateDetails)
The details of the DB instance's server certificate.
|
default DBInstance.Builder |
certificateDetails(Consumer<CertificateDetails.Builder> certificateDetails)
The details of the DB instance's server certificate.
|
DBInstance.Builder |
characterSetName(String characterSetName)
If present, specifies the name of the character set that this instance is associated with.
|
DBInstance.Builder |
copyTagsToSnapshot(Boolean copyTagsToSnapshot)
Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
|
DBInstance.Builder |
customerOwnedIpEnabled(Boolean customerOwnedIpEnabled)
Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
|
DBInstance.Builder |
customIamInstanceProfile(String customIamInstanceProfile)
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
|
DBInstance.Builder |
dbClusterIdentifier(String dbClusterIdentifier)
If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is
a member of.
|
DBInstance.Builder |
dbInstanceArn(String dbInstanceArn)
The Amazon Resource Name (ARN) for the DB instance.
|
DBInstance.Builder |
dbInstanceAutomatedBackupsReplications(Collection<DBInstanceAutomatedBackupsReplication> dbInstanceAutomatedBackupsReplications)
The list of replicated automated backups associated with the DB instance.
|
DBInstance.Builder |
dbInstanceAutomatedBackupsReplications(Consumer<DBInstanceAutomatedBackupsReplication.Builder>... dbInstanceAutomatedBackupsReplications)
The list of replicated automated backups associated with the DB instance.
|
DBInstance.Builder |
dbInstanceAutomatedBackupsReplications(DBInstanceAutomatedBackupsReplication... dbInstanceAutomatedBackupsReplications)
The list of replicated automated backups associated with the DB instance.
|
DBInstance.Builder |
dbInstanceClass(String dbInstanceClass)
The name of the compute and memory capacity class of the DB instance.
|
DBInstance.Builder |
dbInstanceIdentifier(String dbInstanceIdentifier)
The user-supplied database identifier.
|
DBInstance.Builder |
dbInstancePort(Integer dbInstancePort)
The port that the DB instance listens on.
|
DBInstance.Builder |
dbInstanceStatus(String dbInstanceStatus)
The current state of this database.
|
DBInstance.Builder |
dbiResourceId(String dbiResourceId)
The Amazon Web Services Region-unique, immutable identifier for the DB instance.
|
DBInstance.Builder |
dbName(String dbName)
Contains the initial database name that you provided (if required) when you created the DB instance.
|
DBInstance.Builder |
dbParameterGroups(Collection<DBParameterGroupStatus> dbParameterGroups)
The list of DB parameter groups applied to this DB instance.
|
DBInstance.Builder |
dbParameterGroups(Consumer<DBParameterGroupStatus.Builder>... dbParameterGroups)
The list of DB parameter groups applied to this DB instance.
|
DBInstance.Builder |
dbParameterGroups(DBParameterGroupStatus... dbParameterGroups)
The list of DB parameter groups applied to this DB instance.
|
DBInstance.Builder |
dbSecurityGroups(Collection<DBSecurityGroupMembership> dbSecurityGroups)
A list of DB security group elements containing
DBSecurityGroup.Name and
DBSecurityGroup.Status subelements. |
DBInstance.Builder |
dbSecurityGroups(Consumer<DBSecurityGroupMembership.Builder>... dbSecurityGroups)
A list of DB security group elements containing
DBSecurityGroup.Name and
DBSecurityGroup.Status subelements. |
DBInstance.Builder |
dbSecurityGroups(DBSecurityGroupMembership... dbSecurityGroups)
A list of DB security group elements containing
DBSecurityGroup.Name and
DBSecurityGroup.Status subelements. |
default DBInstance.Builder |
dbSubnetGroup(Consumer<DBSubnetGroup.Builder> dbSubnetGroup)
Information about the subnet group associated with the DB instance, including the name, description, and
subnets in the subnet group.
|
DBInstance.Builder |
dbSubnetGroup(DBSubnetGroup dbSubnetGroup)
Information about the subnet group associated with the DB instance, including the name, description, and
subnets in the subnet group.
|
DBInstance.Builder |
dbSystemId(String dbSystemId)
The Oracle system ID (Oracle SID) for a container database (CDB).
|
DBInstance.Builder |
deletionProtection(Boolean deletionProtection)
Indicates whether the DB instance has deletion protection enabled.
|
DBInstance.Builder |
domainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
|
DBInstance.Builder |
domainMemberships(Consumer<DomainMembership.Builder>... domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
|
DBInstance.Builder |
domainMemberships(DomainMembership... domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
|
DBInstance.Builder |
enabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)
A list of log types that this DB instance is configured to export to CloudWatch Logs.
|
DBInstance.Builder |
enabledCloudwatchLogsExports(String... enabledCloudwatchLogsExports)
A list of log types that this DB instance is configured to export to CloudWatch Logs.
|
default DBInstance.Builder |
endpoint(Consumer<Endpoint.Builder> endpoint)
The connection endpoint for the DB instance.
|
DBInstance.Builder |
endpoint(Endpoint endpoint)
The connection endpoint for the DB instance.
|
DBInstance.Builder |
engine(String engine)
The database engine used for this DB instance.
|
DBInstance.Builder |
engineVersion(String engineVersion)
The version of the database engine.
|
DBInstance.Builder |
enhancedMonitoringResourceArn(String enhancedMonitoringResourceArn)
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring
metrics data for the DB instance.
|
DBInstance.Builder |
iamDatabaseAuthenticationEnabled(Boolean iamDatabaseAuthenticationEnabled)
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database
accounts is enabled for the DB instance.
|
DBInstance.Builder |
instanceCreateTime(Instant instanceCreateTime)
The date and time when the DB instance was created.
|
DBInstance.Builder |
iops(Integer iops)
The Provisioned IOPS (I/O operations per second) value for the DB instance.
|
DBInstance.Builder |
kmsKeyId(String kmsKeyId)
If
StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB
instance. |
DBInstance.Builder |
latestRestorableTime(Instant latestRestorableTime)
The latest time to which a database in this DB instance can be restored with point-in-time restore.
|
DBInstance.Builder |
licenseModel(String licenseModel)
The license model information for this DB instance.
|
default DBInstance.Builder |
listenerEndpoint(Consumer<Endpoint.Builder> listenerEndpoint)
The listener connection endpoint for SQL Server Always On.
|
DBInstance.Builder |
listenerEndpoint(Endpoint listenerEndpoint)
The listener connection endpoint for SQL Server Always On.
|
DBInstance.Builder |
masterUsername(String masterUsername)
The master username for the DB instance.
|
default DBInstance.Builder |
masterUserSecret(Consumer<MasterUserSecret.Builder> masterUserSecret)
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
|
DBInstance.Builder |
masterUserSecret(MasterUserSecret masterUserSecret)
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
|
DBInstance.Builder |
maxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB
instance.
|
DBInstance.Builder |
monitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
DBInstance.Builder |
monitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
|
DBInstance.Builder |
multiAZ(Boolean multiAZ)
Indicates whether the DB instance is a Multi-AZ deployment.
|
DBInstance.Builder |
ncharCharacterSetName(String ncharCharacterSetName)
The name of the NCHAR character set for the Oracle DB instance.
|
DBInstance.Builder |
networkType(String networkType)
The network type of the DB instance.
|
DBInstance.Builder |
optionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships)
The list of option group memberships for this DB instance.
|
DBInstance.Builder |
optionGroupMemberships(Consumer<OptionGroupMembership.Builder>... optionGroupMemberships)
The list of option group memberships for this DB instance.
|
DBInstance.Builder |
optionGroupMemberships(OptionGroupMembership... optionGroupMemberships)
The list of option group memberships for this DB instance.
|
default DBInstance.Builder |
pendingModifiedValues(Consumer<PendingModifiedValues.Builder> pendingModifiedValues)
Information about pending changes to the DB instance.
|
DBInstance.Builder |
pendingModifiedValues(PendingModifiedValues pendingModifiedValues)
Information about pending changes to the DB instance.
|
DBInstance.Builder |
performanceInsightsEnabled(Boolean performanceInsightsEnabled)
Indicates whether Performance Insights is enabled for the DB instance.
|
DBInstance.Builder |
performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
DBInstance.Builder |
performanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data.
|
DBInstance.Builder |
preferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, as
determined by the
BackupRetentionPeriod. |
DBInstance.Builder |
preferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
DBInstance.Builder |
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.
|
DBInstance.Builder |
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.
|
DBInstance.Builder |
processorFeatures(ProcessorFeature... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
DBInstance.Builder |
promotionTier(Integer promotionTier)
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the
existing primary instance.
|
DBInstance.Builder |
publiclyAccessible(Boolean publiclyAccessible)
Indicates whether the DB instance is publicly accessible.
|
DBInstance.Builder |
readReplicaDBClusterIdentifiers(Collection<String> readReplicaDBClusterIdentifiers)
The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.
|
DBInstance.Builder |
readReplicaDBClusterIdentifiers(String... readReplicaDBClusterIdentifiers)
The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.
|
DBInstance.Builder |
readReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)
The identifiers of the read replicas associated with this DB instance.
|
DBInstance.Builder |
readReplicaDBInstanceIdentifiers(String... readReplicaDBInstanceIdentifiers)
The identifiers of the read replicas associated with this DB instance.
|
DBInstance.Builder |
readReplicaSourceDBClusterIdentifier(String readReplicaSourceDBClusterIdentifier)
The identifier of the source DB cluster if this DB instance is a read replica.
|
DBInstance.Builder |
readReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)
The identifier of the source DB instance if this DB instance is a read replica.
|
DBInstance.Builder |
replicaMode(ReplicaMode replicaMode)
The open mode of an Oracle read replica.
|
DBInstance.Builder |
replicaMode(String replicaMode)
The open mode of an Oracle read replica.
|
DBInstance.Builder |
resumeFullAutomationModeTime(Instant resumeFullAutomationModeTime)
The number of minutes to pause the automation.
|
DBInstance.Builder |
secondaryAvailabilityZone(String secondaryAvailabilityZone)
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
|
DBInstance.Builder |
statusInfos(Collection<DBInstanceStatusInfo> statusInfos)
The status of a read replica.
|
DBInstance.Builder |
statusInfos(Consumer<DBInstanceStatusInfo.Builder>... statusInfos)
The status of a read replica.
|
DBInstance.Builder |
statusInfos(DBInstanceStatusInfo... statusInfos)
The status of a read replica.
|
DBInstance.Builder |
storageEncrypted(Boolean storageEncrypted)
Indicates whether the DB instance is encrypted.
|
DBInstance.Builder |
storageThroughput(Integer storageThroughput)
The storage throughput for the DB instance.
|
DBInstance.Builder |
storageType(String storageType)
The storage type associated with the DB instance.
|
DBInstance.Builder |
tagList(Collection<Tag> tagList)
Sets the value of the TagList property for this object.
|
DBInstance.Builder |
tagList(Consumer<Tag.Builder>... tagList)
Sets the value of the TagList property for this object.
|
DBInstance.Builder |
tagList(Tag... tagList)
Sets the value of the TagList property for this object.
|
DBInstance.Builder |
tdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which the instance is associated for TDE encryption.
|
DBInstance.Builder |
timezone(String timezone)
The time zone of the DB instance.
|
DBInstance.Builder |
vpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
The list of Amazon EC2 VPC security groups that the DB instance belongs to.
|
DBInstance.Builder |
vpcSecurityGroups(Consumer<VpcSecurityGroupMembership.Builder>... vpcSecurityGroups)
The list of Amazon EC2 VPC security groups that the DB instance belongs to.
|
DBInstance.Builder |
vpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
The list of Amazon EC2 VPC security groups that the DB instance belongs to.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildDBInstance.Builder dbInstanceIdentifier(String dbInstanceIdentifier)
The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
dbInstanceIdentifier - The user-supplied database identifier. This identifier is the unique key that identifies a DB
instance.DBInstance.Builder dbInstanceClass(String dbInstanceClass)
The name of the compute and memory capacity class of the DB instance.
dbInstanceClass - The name of the compute and memory capacity class of the DB instance.DBInstance.Builder engine(String engine)
The database engine used for this DB instance.
engine - The database engine used for this DB instance.DBInstance.Builder dbInstanceStatus(String dbInstanceStatus)
The current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
dbInstanceStatus - The current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
DBInstance.Builder automaticRestartTime(Instant automaticRestartTime)
The time when a stopped DB instance is restarted automatically.
automaticRestartTime - The time when a stopped DB instance is restarted automatically.DBInstance.Builder masterUsername(String masterUsername)
The master username for the DB instance.
masterUsername - The master username for the DB instance.DBInstance.Builder dbName(String dbName)
Contains the initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.
dbName - Contains the initial database name that you provided (if required) when you created the DB instance.
This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name
identifies the PDB rather than the CDB.DBInstance.Builder endpoint(Endpoint endpoint)
The connection endpoint for the DB instance.
The endpoint might not be shown for instances with the status of creating.
endpoint - The connection endpoint for the DB instance.
The endpoint might not be shown for instances with the status of creating.
default DBInstance.Builder endpoint(Consumer<Endpoint.Builder> endpoint)
The connection endpoint for the DB instance.
The endpoint might not be shown for instances with the status of creating.
Endpoint.Builder avoiding the
need to create one manually via Endpoint.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to endpoint(Endpoint).
endpoint - a consumer that will call methods on Endpoint.Builderendpoint(Endpoint)DBInstance.Builder allocatedStorage(Integer allocatedStorage)
The amount of storage in gibibytes (GiB) allocated for the DB instance.
allocatedStorage - The amount of storage in gibibytes (GiB) allocated for the DB instance.DBInstance.Builder instanceCreateTime(Instant instanceCreateTime)
The date and time when the DB instance was created.
instanceCreateTime - The date and time when the DB instance was created.DBInstance.Builder preferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod.
preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod.DBInstance.Builder backupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automatic DB snapshots are retained.
backupRetentionPeriod - The number of days for which automatic DB snapshots are retained.DBInstance.Builder dbSecurityGroups(Collection<DBSecurityGroupMembership> dbSecurityGroups)
A list of DB security group elements containing DBSecurityGroup.Name and
DBSecurityGroup.Status subelements.
dbSecurityGroups - A list of DB security group elements containing DBSecurityGroup.Name and
DBSecurityGroup.Status subelements.DBInstance.Builder dbSecurityGroups(DBSecurityGroupMembership... dbSecurityGroups)
A list of DB security group elements containing DBSecurityGroup.Name and
DBSecurityGroup.Status subelements.
dbSecurityGroups - A list of DB security group elements containing DBSecurityGroup.Name and
DBSecurityGroup.Status subelements.DBInstance.Builder dbSecurityGroups(Consumer<DBSecurityGroupMembership.Builder>... dbSecurityGroups)
A list of DB security group elements containing DBSecurityGroup.Name and
DBSecurityGroup.Status subelements.
DBSecurityGroupMembership.Builder avoiding the need to
create one manually via DBSecurityGroupMembership.builder()
.
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #dbSecurityGroups(List.
dbSecurityGroups - a consumer that will call methods on
DBSecurityGroupMembership.Builder#dbSecurityGroups(java.util.Collection) DBInstance.Builder vpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
The list of Amazon EC2 VPC security groups that the DB instance belongs to.
vpcSecurityGroups - The list of Amazon EC2 VPC security groups that the DB instance belongs to.DBInstance.Builder vpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
The list of Amazon EC2 VPC security groups that the DB instance belongs to.
vpcSecurityGroups - The list of Amazon EC2 VPC security groups that the DB instance belongs to.DBInstance.Builder vpcSecurityGroups(Consumer<VpcSecurityGroupMembership.Builder>... vpcSecurityGroups)
The list of Amazon EC2 VPC security groups that the DB instance belongs to.
This is a convenience method that creates an instance of theVpcSecurityGroupMembership.Builder avoiding the need to
create one manually via
VpcSecurityGroupMembership.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #vpcSecurityGroups(List.
vpcSecurityGroups - a consumer that will call methods on
VpcSecurityGroupMembership.Builder#vpcSecurityGroups(java.util.Collection) DBInstance.Builder dbParameterGroups(Collection<DBParameterGroupStatus> dbParameterGroups)
The list of DB parameter groups applied to this DB instance.
dbParameterGroups - The list of DB parameter groups applied to this DB instance.DBInstance.Builder dbParameterGroups(DBParameterGroupStatus... dbParameterGroups)
The list of DB parameter groups applied to this DB instance.
dbParameterGroups - The list of DB parameter groups applied to this DB instance.DBInstance.Builder dbParameterGroups(Consumer<DBParameterGroupStatus.Builder>... dbParameterGroups)
The list of DB parameter groups applied to this DB instance.
This is a convenience method that creates an instance of theDBParameterGroupStatus.Builder avoiding the need to create
one manually via DBParameterGroupStatus.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #dbParameterGroups(List.
dbParameterGroups - a consumer that will call methods on
DBParameterGroupStatus.Builder#dbParameterGroups(java.util.Collection) DBInstance.Builder availabilityZone(String availabilityZone)
The name of the Availability Zone where the DB instance is located.
availabilityZone - The name of the Availability Zone where the DB instance is located.DBInstance.Builder dbSubnetGroup(DBSubnetGroup dbSubnetGroup)
Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
dbSubnetGroup - Information about the subnet group associated with the DB instance, including the name, description,
and subnets in the subnet group.default DBInstance.Builder dbSubnetGroup(Consumer<DBSubnetGroup.Builder> dbSubnetGroup)
Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
This is a convenience method that creates an instance of theDBSubnetGroup.Builder avoiding the need
to create one manually via DBSubnetGroup.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to dbSubnetGroup(DBSubnetGroup).
dbSubnetGroup - a consumer that will call methods on DBSubnetGroup.BuilderdbSubnetGroup(DBSubnetGroup)DBInstance.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).DBInstance.Builder pendingModifiedValues(PendingModifiedValues pendingModifiedValues)
Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.
pendingModifiedValues - Information about pending changes to the DB instance. This information is returned only when there are
pending changes. Specific changes are identified by subelements.default DBInstance.Builder pendingModifiedValues(Consumer<PendingModifiedValues.Builder> pendingModifiedValues)
Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.
This is a convenience method that creates an instance of thePendingModifiedValues.Builder avoiding
the need to create one manually via PendingModifiedValues.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to pendingModifiedValues(PendingModifiedValues).
pendingModifiedValues - a consumer that will call methods on PendingModifiedValues.BuilderpendingModifiedValues(PendingModifiedValues)DBInstance.Builder latestRestorableTime(Instant latestRestorableTime)
The latest time to which a database in this DB instance can be restored with point-in-time restore.
latestRestorableTime - The latest time to which a database in this DB instance can be restored with point-in-time restore.DBInstance.Builder multiAZ(Boolean multiAZ)
Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.
multiAZ - Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom
DB instances.DBInstance.Builder engineVersion(String engineVersion)
The version of the database engine.
engineVersion - The version of the database engine.DBInstance.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates whether minor version patches are applied automatically.
autoMinorVersionUpgrade - Indicates whether minor version patches are applied automatically.DBInstance.Builder readReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)
The identifier of the source DB instance if this DB instance is a read replica.
readReplicaSourceDBInstanceIdentifier - The identifier of the source DB instance if this DB instance is a read replica.DBInstance.Builder readReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)
The identifiers of the read replicas associated with this DB instance.
readReplicaDBInstanceIdentifiers - The identifiers of the read replicas associated with this DB instance.DBInstance.Builder readReplicaDBInstanceIdentifiers(String... readReplicaDBInstanceIdentifiers)
The identifiers of the read replicas associated with this DB instance.
readReplicaDBInstanceIdentifiers - The identifiers of the read replicas associated with this DB instance.DBInstance.Builder readReplicaDBClusterIdentifiers(Collection<String> readReplicaDBClusterIdentifiers)
The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Currently, each RDS DB instance can have only one Aurora read replica.
readReplicaDBClusterIdentifiers - The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.
For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL
DB cluster for the Aurora read replica is shown. This output doesn't contain information about
cross-Region Aurora read replicas. Currently, each RDS DB instance can have only one Aurora read replica.
DBInstance.Builder readReplicaDBClusterIdentifiers(String... readReplicaDBClusterIdentifiers)
The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Currently, each RDS DB instance can have only one Aurora read replica.
readReplicaDBClusterIdentifiers - The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.
For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL
DB cluster for the Aurora read replica is shown. This output doesn't contain information about
cross-Region Aurora read replicas. Currently, each RDS DB instance can have only one Aurora read replica.
DBInstance.Builder replicaMode(String replicaMode)
The open mode of an Oracle read replica. The default is open-read-only. For more information,
see Working with
Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This attribute is only supported in RDS for Oracle.
replicaMode - The open mode of an Oracle read replica. The default is open-read-only. For more
information, see Working with
Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This attribute is only supported in RDS for Oracle.
ReplicaMode,
ReplicaModeDBInstance.Builder replicaMode(ReplicaMode replicaMode)
The open mode of an Oracle read replica. The default is open-read-only. For more information,
see Working with
Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This attribute is only supported in RDS for Oracle.
replicaMode - The open mode of an Oracle read replica. The default is open-read-only. For more
information, see Working with
Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This attribute is only supported in RDS for Oracle.
ReplicaMode,
ReplicaModeDBInstance.Builder licenseModel(String licenseModel)
The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
licenseModel - The license model information for this DB instance. This setting doesn't apply to RDS Custom DB
instances.DBInstance.Builder iops(Integer iops)
The Provisioned IOPS (I/O operations per second) value for the DB instance.
iops - The Provisioned IOPS (I/O operations per second) value for the DB instance.DBInstance.Builder optionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships)
The list of option group memberships for this DB instance.
optionGroupMemberships - The list of option group memberships for this DB instance.DBInstance.Builder optionGroupMemberships(OptionGroupMembership... optionGroupMemberships)
The list of option group memberships for this DB instance.
optionGroupMemberships - The list of option group memberships for this DB instance.DBInstance.Builder optionGroupMemberships(Consumer<OptionGroupMembership.Builder>... optionGroupMemberships)
The list of option group memberships for this DB instance.
This is a convenience method that creates an instance of theOptionGroupMembership.Builder avoiding the need to create
one manually via OptionGroupMembership.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately
and its result is passed to #optionGroupMemberships(List.
optionGroupMemberships - a consumer that will call methods on
OptionGroupMembership.Builder#optionGroupMemberships(java.util.Collection) DBInstance.Builder characterSetName(String characterSetName)
If present, specifies the name of the character set that this instance is associated with.
characterSetName - If present, specifies the name of the character set that this instance is associated with.DBInstance.Builder ncharCharacterSetName(String ncharCharacterSetName)
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
ncharCharacterSetName - The name of the NCHAR character set for the Oracle DB instance. This character set specifies the
Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.DBInstance.Builder secondaryAvailabilityZone(String secondaryAvailabilityZone)
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
secondaryAvailabilityZone - If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ
support.DBInstance.Builder publiclyAccessible(Boolean publiclyAccessible)
Indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
publiclyAccessible - Indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
DBInstance.Builder statusInfos(Collection<DBInstanceStatusInfo> statusInfos)
The status of a read replica. If the DB instance isn't a read replica, the value is blank.
statusInfos - The status of a read replica. If the DB instance isn't a read replica, the value is blank.DBInstance.Builder statusInfos(DBInstanceStatusInfo... statusInfos)
The status of a read replica. If the DB instance isn't a read replica, the value is blank.
statusInfos - The status of a read replica. If the DB instance isn't a read replica, the value is blank.DBInstance.Builder statusInfos(Consumer<DBInstanceStatusInfo.Builder>... statusInfos)
The status of a read replica. If the DB instance isn't a read replica, the value is blank.
This is a convenience method that creates an instance of theDBInstanceStatusInfo.Builder avoiding the need to create
one manually via DBInstanceStatusInfo.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately
and its result is passed to #statusInfos(List.
statusInfos - a consumer that will call methods on
DBInstanceStatusInfo.Builder#statusInfos(java.util.Collection) DBInstance.Builder storageType(String storageType)
The storage type associated with the DB instance.
storageType - The storage type associated with the DB instance.DBInstance.Builder tdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which the instance is associated for TDE encryption.
tdeCredentialArn - The ARN from the key store with which the instance is associated for TDE encryption.DBInstance.Builder dbInstancePort(Integer dbInstancePort)
The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
dbInstancePort - The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a
different port than the DB cluster port.DBInstance.Builder dbClusterIdentifier(String dbClusterIdentifier)
If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.
dbClusterIdentifier - If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB
instance is a member of.DBInstance.Builder storageEncrypted(Boolean storageEncrypted)
Indicates whether the DB instance is encrypted.
storageEncrypted - Indicates whether the DB instance is encrypted.DBInstance.Builder kmsKeyId(String kmsKeyId)
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB
instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
kmsKeyId - If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the
encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBInstance.Builder dbiResourceId(String dbiResourceId)
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
dbiResourceId - The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is
found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the
DB instance is accessed.DBInstance.Builder caCertificateIdentifier(String caCertificateIdentifier)
The identifier of the CA certificate for this DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
caCertificateIdentifier - The identifier of the CA certificate for this DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
DBInstance.Builder domainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
domainMemberships - The Active Directory Domain membership records associated with the DB instance.DBInstance.Builder domainMemberships(DomainMembership... domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
domainMemberships - The Active Directory Domain membership records associated with the DB instance.DBInstance.Builder domainMemberships(Consumer<DomainMembership.Builder>... domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
This is a convenience method that creates an instance of theDomainMembership.Builder avoiding the need to create one
manually via DomainMembership.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and
its result is passed to #domainMemberships(List.
domainMemberships - a consumer that will call methods on
DomainMembership.Builder#domainMemberships(java.util.Collection) DBInstance.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)
Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB
cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more
information, see DBCluster.
copyTagsToSnapshot - Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the
DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For
more information, see DBCluster.
DBInstance.Builder monitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
monitoringInterval - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
instance.DBInstance.Builder enhancedMonitoringResourceArn(String enhancedMonitoringResourceArn)
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
enhancedMonitoringResourceArn - The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced
Monitoring metrics data for the DB instance.DBInstance.Builder monitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
monitoringRoleArn - The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch
Logs.DBInstance.Builder promotionTier(Integer promotionTier)
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
promotionTier - The order of priority in which an Aurora Replica is promoted to the primary instance after a failure
of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.DBInstance.Builder dbInstanceArn(String dbInstanceArn)
The Amazon Resource Name (ARN) for the DB instance.
dbInstanceArn - The Amazon Resource Name (ARN) for the DB instance.DBInstance.Builder timezone(String timezone)
The time zone of the DB instance. In most cases, the Timezone element is empty.
Timezone content appears only for Microsoft SQL Server DB instances that were created with a
time zone specified.
timezone - The time zone of the DB instance. In most cases, the Timezone element is empty.
Timezone content appears only for Microsoft SQL Server DB instances that were created
with a time zone specified.DBInstance.Builder iamDatabaseAuthenticationEnabled(Boolean iamDatabaseAuthenticationEnabled)
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.
For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.
iamDatabaseAuthenticationEnabled - Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts is enabled for the DB instance.
For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.
DBInstance.Builder performanceInsightsEnabled(Boolean performanceInsightsEnabled)
Indicates whether Performance Insights is enabled for the DB instance.
performanceInsightsEnabled - Indicates whether Performance Insights is enabled for the DB instance.DBInstance.Builder performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
performanceInsightsKMSKeyId - The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBInstance.Builder performanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months *
31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
performanceInsightsRetentionPeriod - The number of days to retain Performance Insights data.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3
months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
DBInstance.Builder enabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Monitoring Amazon RDS log files in the Amazon RDS User Guide.
enabledCloudwatchLogsExports - A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Monitoring Amazon RDS log files in the Amazon RDS User Guide.
DBInstance.Builder enabledCloudwatchLogsExports(String... enabledCloudwatchLogsExports)
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Monitoring Amazon RDS log files in the Amazon RDS User Guide.
enabledCloudwatchLogsExports - A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Monitoring Amazon RDS log files in the Amazon RDS User Guide.
DBInstance.Builder 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.
processorFeatures - The number of CPU cores and the number of threads per core for the DB instance class of the DB
instance.DBInstance.Builder processorFeatures(ProcessorFeature... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
processorFeatures - The number of CPU cores and the number of threads per core for the DB instance class of the DB
instance.DBInstance.Builder 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.
This is a convenience method that creates an instance of theProcessorFeature.Builder avoiding the need to create one
manually via ProcessorFeature.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and
its result is passed to #processorFeatures(List.
processorFeatures - a consumer that will call methods on
ProcessorFeature.Builder#processorFeatures(java.util.Collection) DBInstance.Builder deletionProtection(Boolean deletionProtection)
Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
deletionProtection - Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when
deletion protection is enabled. For more information, see Deleting a DB
Instance.DBInstance.Builder associatedRoles(Collection<DBInstanceRole> associatedRoles)
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
associatedRoles - The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.DBInstance.Builder associatedRoles(DBInstanceRole... associatedRoles)
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
associatedRoles - The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.DBInstance.Builder associatedRoles(Consumer<DBInstanceRole.Builder>... associatedRoles)
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
This is a convenience method that creates an instance of theDBInstanceRole.Builder avoiding the need to create one
manually via DBInstanceRole.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and
its result is passed to #associatedRoles(List.
associatedRoles - a consumer that will call methods on
DBInstanceRole.Builder#associatedRoles(java.util.Collection) DBInstance.Builder listenerEndpoint(Endpoint listenerEndpoint)
The listener connection endpoint for SQL Server Always On.
listenerEndpoint - The listener connection endpoint for SQL Server Always On.default DBInstance.Builder listenerEndpoint(Consumer<Endpoint.Builder> listenerEndpoint)
The listener connection endpoint for SQL Server Always On.
This is a convenience method that creates an instance of theEndpoint.Builder avoiding the need to
create one manually via Endpoint.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to listenerEndpoint(Endpoint).
listenerEndpoint - a consumer that will call methods on Endpoint.BuilderlistenerEndpoint(Endpoint)DBInstance.Builder maxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
maxAllocatedStorage - The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB
instance.DBInstance.Builder tagList(Collection<Tag> tagList)
tagList - The new value for the TagList property for this object.DBInstance.Builder tagList(Tag... tagList)
tagList - The new value for the TagList property for this object.DBInstance.Builder tagList(Consumer<Tag.Builder>... tagList)
Tag.Builder avoiding the need to create one manually via
Tag.builder().
When the Consumer completes, SdkBuilder.build() is
called immediately and its result is passed to #tagList(List.
tagList - a consumer that will call methods on Tag.Builder#tagList(java.util.Collection) DBInstance.Builder dbInstanceAutomatedBackupsReplications(Collection<DBInstanceAutomatedBackupsReplication> dbInstanceAutomatedBackupsReplications)
The list of replicated automated backups associated with the DB instance.
dbInstanceAutomatedBackupsReplications - The list of replicated automated backups associated with the DB instance.DBInstance.Builder dbInstanceAutomatedBackupsReplications(DBInstanceAutomatedBackupsReplication... dbInstanceAutomatedBackupsReplications)
The list of replicated automated backups associated with the DB instance.
dbInstanceAutomatedBackupsReplications - The list of replicated automated backups associated with the DB instance.DBInstance.Builder dbInstanceAutomatedBackupsReplications(Consumer<DBInstanceAutomatedBackupsReplication.Builder>... dbInstanceAutomatedBackupsReplications)
The list of replicated automated backups associated with the DB instance.
This is a convenience method that creates an instance of theDBInstanceAutomatedBackupsReplication.Builder avoiding the
need to create one manually via
DBInstanceAutomatedBackupsReplication.builder().
When the Consumer completes,
SdkBuilder.build() is
called immediately and its result is passed to #dbInstanceAutomatedBackupsReplications(List.
dbInstanceAutomatedBackupsReplications - a consumer that will call methods on
DBInstanceAutomatedBackupsReplication.Builder#dbInstanceAutomatedBackupsReplications(java.util.Collection) DBInstance.Builder customerOwnedIpEnabled(Boolean customerOwnedIpEnabled)
Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
customerOwnedIpEnabled - Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB
instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
DBInstance.Builder awsBackupRecoveryPointArn(String awsBackupRecoveryPointArn)
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
awsBackupRecoveryPointArn - The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.DBInstance.Builder activityStreamStatus(String activityStreamStatus)
The status of the database activity stream.
activityStreamStatus - The status of the database activity stream.ActivityStreamStatus,
ActivityStreamStatusDBInstance.Builder activityStreamStatus(ActivityStreamStatus activityStreamStatus)
The status of the database activity stream.
activityStreamStatus - The status of the database activity stream.ActivityStreamStatus,
ActivityStreamStatusDBInstance.Builder activityStreamKmsKeyId(String activityStreamKmsKeyId)
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
activityStreamKmsKeyId - The Amazon Web Services KMS key identifier used for encrypting messages in the database activity
stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name
for the KMS key.DBInstance.Builder activityStreamKinesisStreamName(String activityStreamKinesisStreamName)
The name of the Amazon Kinesis data stream used for the database activity stream.
activityStreamKinesisStreamName - The name of the Amazon Kinesis data stream used for the database activity stream.DBInstance.Builder activityStreamMode(String activityStreamMode)
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
activityStreamMode - The mode of the database activity stream. Database events such as a change or access generate an
activity stream event. RDS for Oracle always handles these events asynchronously.ActivityStreamMode,
ActivityStreamModeDBInstance.Builder activityStreamMode(ActivityStreamMode activityStreamMode)
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
activityStreamMode - The mode of the database activity stream. Database events such as a change or access generate an
activity stream event. RDS for Oracle always handles these events asynchronously.ActivityStreamMode,
ActivityStreamModeDBInstance.Builder activityStreamEngineNativeAuditFieldsIncluded(Boolean activityStreamEngineNativeAuditFieldsIncluded)
Indicates whether engine-native audit fields are included in the database activity stream.
activityStreamEngineNativeAuditFieldsIncluded - Indicates whether engine-native audit fields are included in the database activity stream.DBInstance.Builder automationMode(String automationMode)
The automation mode of the RDS Custom DB instance: full or all paused. If
full, the DB instance automates monitoring and instance recovery. If all paused,
the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
automationMode - The automation mode of the RDS Custom DB instance: full or all paused. If
full, the DB instance automates monitoring and instance recovery. If
all paused, the instance pauses automation for the duration set by
--resume-full-automation-mode-minutes.AutomationMode,
AutomationModeDBInstance.Builder automationMode(AutomationMode automationMode)
The automation mode of the RDS Custom DB instance: full or all paused. If
full, the DB instance automates monitoring and instance recovery. If all paused,
the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
automationMode - The automation mode of the RDS Custom DB instance: full or all paused. If
full, the DB instance automates monitoring and instance recovery. If
all paused, the instance pauses automation for the duration set by
--resume-full-automation-mode-minutes.AutomationMode,
AutomationModeDBInstance.Builder resumeFullAutomationModeTime(Instant resumeFullAutomationModeTime)
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
resumeFullAutomationModeTime - The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full
automation. The minimum value is 60 (default). The maximum value is 1,440.DBInstance.Builder customIamInstanceProfile(String customIamInstanceProfile)
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
customIamInstanceProfile - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
DBInstance.Builder backupTarget(String backupTarget)
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
backupTarget - The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or
the Amazon Web Services Region.DBInstance.Builder networkType(String networkType)
The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB instance. A
DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid Values: IPV4 | DUAL
networkType - The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB instance. A
DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid Values: IPV4 | DUAL
DBInstance.Builder activityStreamPolicyStatus(String activityStreamPolicyStatus)
The status of the policy state of the activity stream.
activityStreamPolicyStatus - The status of the policy state of the activity stream.ActivityStreamPolicyStatus,
ActivityStreamPolicyStatusDBInstance.Builder activityStreamPolicyStatus(ActivityStreamPolicyStatus activityStreamPolicyStatus)
The status of the policy state of the activity stream.
activityStreamPolicyStatus - The status of the policy state of the activity stream.ActivityStreamPolicyStatus,
ActivityStreamPolicyStatusDBInstance.Builder storageThroughput(Integer storageThroughput)
The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
storageThroughput - The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
DBInstance.Builder dbSystemId(String dbSystemId)
The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.
dbSystemId - The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of
the CDB. This setting is only valid for RDS Custom DB instances.DBInstance.Builder masterUserSecret(MasterUserSecret masterUserSecret)
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
masterUserSecret - The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
default DBInstance.Builder masterUserSecret(Consumer<MasterUserSecret.Builder> masterUserSecret)
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
This is a convenience method that creates an instance of theMasterUserSecret.Builder avoiding the
need to create one manually via MasterUserSecret.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to masterUserSecret(MasterUserSecret).
masterUserSecret - a consumer that will call methods on MasterUserSecret.BuildermasterUserSecret(MasterUserSecret)DBInstance.Builder certificateDetails(CertificateDetails certificateDetails)
The details of the DB instance's server certificate.
certificateDetails - The details of the DB instance's server certificate.default DBInstance.Builder certificateDetails(Consumer<CertificateDetails.Builder> certificateDetails)
The details of the DB instance's server certificate.
This is a convenience method that creates an instance of theCertificateDetails.Builder avoiding the
need to create one manually via CertificateDetails.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to certificateDetails(CertificateDetails).
certificateDetails - a consumer that will call methods on CertificateDetails.BuildercertificateDetails(CertificateDetails)DBInstance.Builder readReplicaSourceDBClusterIdentifier(String readReplicaSourceDBClusterIdentifier)
The identifier of the source DB cluster if this DB instance is a read replica.
readReplicaSourceDBClusterIdentifier - The identifier of the source DB cluster if this DB instance is a read replica.Copyright © 2023. All rights reserved.