| Package | Description |
|---|---|
| software.amazon.awssdk.services.rds.model |
| Modifier and Type | Method and Description |
|---|---|
DBInstance.Builder |
DBInstance.Builder.activityStreamEngineNativeAuditFieldsIncluded(Boolean activityStreamEngineNativeAuditFieldsIncluded)
Indicates whether engine-native audit fields are included in the database activity stream.
|
DBInstance.Builder |
DBInstance.Builder.activityStreamKinesisStreamName(String activityStreamKinesisStreamName)
The name of the Amazon Kinesis data stream used for the database activity stream.
|
DBInstance.Builder |
DBInstance.Builder.activityStreamKmsKeyId(String activityStreamKmsKeyId)
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
|
DBInstance.Builder |
DBInstance.Builder.activityStreamMode(ActivityStreamMode activityStreamMode)
The mode of the database activity stream.
|
DBInstance.Builder |
DBInstance.Builder.activityStreamMode(String activityStreamMode)
The mode of the database activity stream.
|
DBInstance.Builder |
DBInstance.Builder.activityStreamPolicyStatus(ActivityStreamPolicyStatus activityStreamPolicyStatus)
The status of the policy state of the activity stream.
|
DBInstance.Builder |
DBInstance.Builder.activityStreamPolicyStatus(String activityStreamPolicyStatus)
The status of the policy state of the activity stream.
|
DBInstance.Builder |
DBInstance.Builder.activityStreamStatus(ActivityStreamStatus activityStreamStatus)
The status of the database activity stream.
|
DBInstance.Builder |
DBInstance.Builder.activityStreamStatus(String activityStreamStatus)
The status of the database activity stream.
|
DBInstance.Builder |
DBInstance.Builder.allocatedStorage(Integer allocatedStorage)
The amount of storage in gibibytes (GiB) allocated for the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.associatedRoles(Collection<DBInstanceRole> associatedRoles)
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.associatedRoles(Consumer<DBInstanceRole.Builder>... associatedRoles)
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.associatedRoles(DBInstanceRole... associatedRoles)
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.automaticRestartTime(Instant automaticRestartTime)
The time when a stopped DB instance is restarted automatically.
|
DBInstance.Builder |
DBInstance.Builder.automationMode(AutomationMode automationMode)
The automation mode of the RDS Custom DB instance:
full or all paused. |
DBInstance.Builder |
DBInstance.Builder.automationMode(String automationMode)
The automation mode of the RDS Custom DB instance:
full or all paused. |
DBInstance.Builder |
DBInstance.Builder.autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates whether minor version patches are applied automatically.
|
DBInstance.Builder |
DBInstance.Builder.availabilityZone(String availabilityZone)
The name of the Availability Zone where the DB instance is located.
|
DBInstance.Builder |
DBInstance.Builder.awsBackupRecoveryPointArn(String awsBackupRecoveryPointArn)
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
|
DBInstance.Builder |
DBInstance.Builder.backupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automatic DB snapshots are retained.
|
DBInstance.Builder |
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.
|
static DBInstance.Builder |
DBInstance.builder() |
DBInstance.Builder |
DBInstance.Builder.caCertificateIdentifier(String caCertificateIdentifier)
The identifier of the CA certificate for this DB instance.
|
DBInstance.Builder |
DBInstance.Builder.certificateDetails(CertificateDetails certificateDetails)
The details of the DB instance's server certificate.
|
default DBInstance.Builder |
DBInstance.Builder.certificateDetails(Consumer<CertificateDetails.Builder> certificateDetails)
The details of the DB instance's server certificate.
|
DBInstance.Builder |
DBInstance.Builder.characterSetName(String characterSetName)
If present, specifies the name of the character set that this instance is associated with.
|
DBInstance.Builder |
DBInstance.Builder.copyTagsToSnapshot(Boolean copyTagsToSnapshot)
Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.customerOwnedIpEnabled(Boolean customerOwnedIpEnabled)
Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
|
DBInstance.Builder |
DBInstance.Builder.customIamInstanceProfile(String customIamInstanceProfile)
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
|
DBInstance.Builder |
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 |
DBInstance.Builder.dbInstanceArn(String dbInstanceArn)
The Amazon Resource Name (ARN) for the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.dbInstanceAutomatedBackupsReplications(Collection<DBInstanceAutomatedBackupsReplication> dbInstanceAutomatedBackupsReplications)
The list of replicated automated backups associated with the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.dbInstanceAutomatedBackupsReplications(Consumer<DBInstanceAutomatedBackupsReplication.Builder>... dbInstanceAutomatedBackupsReplications)
The list of replicated automated backups associated with the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.dbInstanceAutomatedBackupsReplications(DBInstanceAutomatedBackupsReplication... dbInstanceAutomatedBackupsReplications)
The list of replicated automated backups associated with the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.dbInstanceClass(String dbInstanceClass)
The name of the compute and memory capacity class of the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.dbInstanceIdentifier(String dbInstanceIdentifier)
The user-supplied database identifier.
|
DBInstance.Builder |
DBInstance.Builder.dbInstancePort(Integer dbInstancePort)
The port that the DB instance listens on.
|
DBInstance.Builder |
DBInstance.Builder.dbInstanceStatus(String dbInstanceStatus)
The current state of this database.
|
DBInstance.Builder |
DBInstance.Builder.dbiResourceId(String dbiResourceId)
The Amazon Web Services Region-unique, immutable identifier for the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.dbName(String dbName)
Contains the initial database name that you provided (if required) when you created the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.dbParameterGroups(Collection<DBParameterGroupStatus> dbParameterGroups)
The list of DB parameter groups applied to this DB instance.
|
DBInstance.Builder |
DBInstance.Builder.dbParameterGroups(Consumer<DBParameterGroupStatus.Builder>... dbParameterGroups)
The list of DB parameter groups applied to this DB instance.
|
DBInstance.Builder |
DBInstance.Builder.dbParameterGroups(DBParameterGroupStatus... dbParameterGroups)
The list of DB parameter groups applied to this DB instance.
|
DBInstance.Builder |
DBInstance.Builder.dbSecurityGroups(Collection<DBSecurityGroupMembership> dbSecurityGroups)
A list of DB security group elements containing
DBSecurityGroup.Name and
DBSecurityGroup.Status subelements. |
DBInstance.Builder |
DBInstance.Builder.dbSecurityGroups(Consumer<DBSecurityGroupMembership.Builder>... dbSecurityGroups)
A list of DB security group elements containing
DBSecurityGroup.Name and
DBSecurityGroup.Status subelements. |
DBInstance.Builder |
DBInstance.Builder.dbSecurityGroups(DBSecurityGroupMembership... dbSecurityGroups)
A list of DB security group elements containing
DBSecurityGroup.Name and
DBSecurityGroup.Status subelements. |
default DBInstance.Builder |
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 |
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 |
DBInstance.Builder.dbSystemId(String dbSystemId)
The Oracle system ID (Oracle SID) for a container database (CDB).
|
DBInstance.Builder |
DBInstance.Builder.deletionProtection(Boolean deletionProtection)
Indicates whether the DB instance has deletion protection enabled.
|
DBInstance.Builder |
DBInstance.Builder.domainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.domainMemberships(Consumer<DomainMembership.Builder>... domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.domainMemberships(DomainMembership... domainMemberships)
The Active Directory Domain membership records associated with the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.enabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)
A list of log types that this DB instance is configured to export to CloudWatch Logs.
|
DBInstance.Builder |
DBInstance.Builder.enabledCloudwatchLogsExports(String... enabledCloudwatchLogsExports)
A list of log types that this DB instance is configured to export to CloudWatch Logs.
|
default DBInstance.Builder |
DBInstance.Builder.endpoint(Consumer<Endpoint.Builder> endpoint)
The connection endpoint for the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.endpoint(Endpoint endpoint)
The connection endpoint for the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.engine(String engine)
The database engine used for this DB instance.
|
DBInstance.Builder |
DBInstance.Builder.engineVersion(String engineVersion)
The version of the database engine.
|
DBInstance.Builder |
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 |
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 |
DBInstance.Builder.instanceCreateTime(Instant instanceCreateTime)
The date and time when the DB instance was created.
|
DBInstance.Builder |
DBInstance.Builder.iops(Integer iops)
The Provisioned IOPS (I/O operations per second) value for the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.kmsKeyId(String kmsKeyId)
If
StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB
instance. |
DBInstance.Builder |
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 |
DBInstance.Builder.licenseModel(String licenseModel)
The license model information for this DB instance.
|
default DBInstance.Builder |
DBInstance.Builder.listenerEndpoint(Consumer<Endpoint.Builder> listenerEndpoint)
The listener connection endpoint for SQL Server Always On.
|
DBInstance.Builder |
DBInstance.Builder.listenerEndpoint(Endpoint listenerEndpoint)
The listener connection endpoint for SQL Server Always On.
|
DBInstance.Builder |
DBInstance.Builder.masterUsername(String masterUsername)
The master username for the DB instance.
|
default DBInstance.Builder |
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 |
DBInstance.Builder.masterUserSecret(MasterUserSecret masterUserSecret)
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
|
DBInstance.Builder |
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 |
DBInstance.Builder.monitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
DBInstance.Builder |
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 |
DBInstance.Builder.multiAZ(Boolean multiAZ)
Indicates whether the DB instance is a Multi-AZ deployment.
|
DBInstance.Builder |
DBInstance.Builder.ncharCharacterSetName(String ncharCharacterSetName)
The name of the NCHAR character set for the Oracle DB instance.
|
DBInstance.Builder |
DBInstance.Builder.networkType(String networkType)
The network type of the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.optionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships)
The list of option group memberships for this DB instance.
|
DBInstance.Builder |
DBInstance.Builder.optionGroupMemberships(Consumer<OptionGroupMembership.Builder>... optionGroupMemberships)
The list of option group memberships for this DB instance.
|
DBInstance.Builder |
DBInstance.Builder.optionGroupMemberships(OptionGroupMembership... optionGroupMemberships)
The list of option group memberships for this DB instance.
|
default DBInstance.Builder |
DBInstance.Builder.pendingModifiedValues(Consumer<PendingModifiedValues.Builder> pendingModifiedValues)
Information about pending changes to the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.pendingModifiedValues(PendingModifiedValues pendingModifiedValues)
Information about pending changes to the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.percentProgress(String percentProgress)
The progress of the storage optimization operation as a percentage.
|
DBInstance.Builder |
DBInstance.Builder.performanceInsightsEnabled(Boolean performanceInsightsEnabled)
Indicates whether Performance Insights is enabled for the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
DBInstance.Builder |
DBInstance.Builder.performanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data.
|
DBInstance.Builder |
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 |
DBInstance.Builder.preferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
DBInstance.Builder |
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 |
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 |
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 |
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 |
DBInstance.Builder.publiclyAccessible(Boolean publiclyAccessible)
Indicates whether the DB instance is publicly accessible.
|
DBInstance.Builder |
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 |
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 |
DBInstance.Builder.readReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)
The identifiers of the read replicas associated with this DB instance.
|
DBInstance.Builder |
DBInstance.Builder.readReplicaDBInstanceIdentifiers(String... readReplicaDBInstanceIdentifiers)
The identifiers of the read replicas associated with this DB instance.
|
DBInstance.Builder |
DBInstance.Builder.readReplicaSourceDBClusterIdentifier(String readReplicaSourceDBClusterIdentifier)
The identifier of the source DB cluster if this DB instance is a read replica.
|
DBInstance.Builder |
DBInstance.Builder.readReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)
The identifier of the source DB instance if this DB instance is a read replica.
|
DBInstance.Builder |
DBInstance.Builder.replicaMode(ReplicaMode replicaMode)
The open mode of an Oracle read replica.
|
DBInstance.Builder |
DBInstance.Builder.replicaMode(String replicaMode)
The open mode of an Oracle read replica.
|
DBInstance.Builder |
DBInstance.Builder.resumeFullAutomationModeTime(Instant resumeFullAutomationModeTime)
The number of minutes to pause the automation.
|
DBInstance.Builder |
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 |
DBInstance.Builder.statusInfos(Collection<DBInstanceStatusInfo> statusInfos)
The status of a read replica.
|
DBInstance.Builder |
DBInstance.Builder.statusInfos(Consumer<DBInstanceStatusInfo.Builder>... statusInfos)
The status of a read replica.
|
DBInstance.Builder |
DBInstance.Builder.statusInfos(DBInstanceStatusInfo... statusInfos)
The status of a read replica.
|
DBInstance.Builder |
DBInstance.Builder.storageEncrypted(Boolean storageEncrypted)
Indicates whether the DB instance is encrypted.
|
DBInstance.Builder |
DBInstance.Builder.storageThroughput(Integer storageThroughput)
The storage throughput for the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.storageType(String storageType)
The storage type associated with the DB instance.
|
DBInstance.Builder |
DBInstance.Builder.tagList(Collection<Tag> tagList)
Sets the value of the TagList property for this object.
|
DBInstance.Builder |
DBInstance.Builder.tagList(Consumer<Tag.Builder>... tagList)
Sets the value of the TagList property for this object.
|
DBInstance.Builder |
DBInstance.Builder.tagList(Tag... tagList)
Sets the value of the TagList property for this object.
|
DBInstance.Builder |
DBInstance.Builder.tdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which the instance is associated for TDE encryption.
|
DBInstance.Builder |
DBInstance.Builder.timezone(String timezone)
The time zone of the DB instance.
|
DBInstance.Builder |
DBInstance.toBuilder() |
DBInstance.Builder |
DBInstance.Builder.vpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
The list of Amazon EC2 VPC security groups that the DB instance belongs to.
|
DBInstance.Builder |
DBInstance.Builder.vpcSecurityGroups(Consumer<VpcSecurityGroupMembership.Builder>... vpcSecurityGroups)
The list of Amazon EC2 VPC security groups that the DB instance belongs to.
|
DBInstance.Builder |
DBInstance.Builder.vpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
The list of Amazon EC2 VPC security groups that the DB instance belongs to.
|
| Modifier and Type | Method and Description |
|---|---|
static Class<? extends DBInstance.Builder> |
DBInstance.serializableBuilderClass() |
| Modifier and Type | Method and Description |
|---|---|
default RebootDbInstanceResponse.Builder |
RebootDbInstanceResponse.Builder.dbInstance(Consumer<DBInstance.Builder> dbInstance)
Sets the value of the DBInstance property for this object.
|
default StopDbInstanceResponse.Builder |
StopDbInstanceResponse.Builder.dbInstance(Consumer<DBInstance.Builder> dbInstance)
Sets the value of the DBInstance property for this object.
|
default SwitchoverReadReplicaResponse.Builder |
SwitchoverReadReplicaResponse.Builder.dbInstance(Consumer<DBInstance.Builder> dbInstance)
Sets the value of the DBInstance property for this object.
|
default DeleteDbInstanceResponse.Builder |
DeleteDbInstanceResponse.Builder.dbInstance(Consumer<DBInstance.Builder> dbInstance)
Sets the value of the DBInstance property for this object.
|
default PromoteReadReplicaResponse.Builder |
PromoteReadReplicaResponse.Builder.dbInstance(Consumer<DBInstance.Builder> dbInstance)
Sets the value of the DBInstance property for this object.
|
default RestoreDbInstanceFromS3Response.Builder |
RestoreDbInstanceFromS3Response.Builder.dbInstance(Consumer<DBInstance.Builder> dbInstance)
Sets the value of the DBInstance property for this object.
|
default RestoreDbInstanceFromDbSnapshotResponse.Builder |
RestoreDbInstanceFromDbSnapshotResponse.Builder.dbInstance(Consumer<DBInstance.Builder> dbInstance)
Sets the value of the DBInstance property for this object.
|
default CreateDbInstanceResponse.Builder |
CreateDbInstanceResponse.Builder.dbInstance(Consumer<DBInstance.Builder> dbInstance)
Sets the value of the DBInstance property for this object.
|
default StartDbInstanceResponse.Builder |
StartDbInstanceResponse.Builder.dbInstance(Consumer<DBInstance.Builder> dbInstance)
Sets the value of the DBInstance property for this object.
|
default CreateDbInstanceReadReplicaResponse.Builder |
CreateDbInstanceReadReplicaResponse.Builder.dbInstance(Consumer<DBInstance.Builder> dbInstance)
Sets the value of the DBInstance property for this object.
|
default ModifyDbInstanceResponse.Builder |
ModifyDbInstanceResponse.Builder.dbInstance(Consumer<DBInstance.Builder> dbInstance)
Sets the value of the DBInstance property for this object.
|
default RestoreDbInstanceToPointInTimeResponse.Builder |
RestoreDbInstanceToPointInTimeResponse.Builder.dbInstance(Consumer<DBInstance.Builder> dbInstance)
Sets the value of the DBInstance property for this object.
|
Copyright © 2023. All rights reserved.