Package software.amazon.awssdk.services.rds.model

Interface DBInstance.Builder

    • Method Detail

      • dbInstanceIdentifier

        DBInstance.Builder dbInstanceIdentifier​(String dbInstanceIdentifier)

        The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        Parameters:
        dbInstanceIdentifier - The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbInstanceClass

        DBInstance.Builder dbInstanceClass​(String dbInstanceClass)

        The name of the compute and memory capacity class of the DB instance.

        Parameters:
        dbInstanceClass - The name of the compute and memory capacity class of the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engine

        DBInstance.Builder engine​(String engine)

        The database engine used for this DB instance.

        Parameters:
        engine - The database engine used for this DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbInstanceStatus

        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.

        Parameters:
        dbInstanceStatus - The current state of this database.

        For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.

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

      • automaticRestartTime

        DBInstance.Builder automaticRestartTime​(Instant automaticRestartTime)

        The time when a stopped DB instance is restarted automatically.

        Parameters:
        automaticRestartTime - The time when a stopped DB instance is restarted automatically.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • masterUsername

        DBInstance.Builder masterUsername​(String masterUsername)

        The master username for the DB instance.

        Parameters:
        masterUsername - The master username for the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbName

        DBInstance.Builder dbName​(String dbName)

        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.

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

      • endpoint

        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.

        Parameters:
        endpoint - The connection endpoint for the DB instance.

        The endpoint might not be shown for instances with the status of creating.

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

      • allocatedStorage

        DBInstance.Builder allocatedStorage​(Integer allocatedStorage)

        The amount of storage in gibibytes (GiB) allocated for the DB instance.

        Parameters:
        allocatedStorage - The amount of storage in gibibytes (GiB) allocated for the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceCreateTime

        DBInstance.Builder instanceCreateTime​(Instant instanceCreateTime)

        The date and time when the DB instance was created.

        Parameters:
        instanceCreateTime - The date and time when the DB instance was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • preferredBackupWindow

        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.

        Parameters:
        preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • backupRetentionPeriod

        DBInstance.Builder backupRetentionPeriod​(Integer backupRetentionPeriod)

        The number of days for which automatic DB snapshots are retained.

        Parameters:
        backupRetentionPeriod - The number of days for which automatic DB snapshots are retained.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbSecurityGroups

        DBInstance.Builder dbSecurityGroups​(Collection<DBSecurityGroupMembership> dbSecurityGroups)

        A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

        Parameters:
        dbSecurityGroups - A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbSecurityGroups

        DBInstance.Builder dbSecurityGroups​(DBSecurityGroupMembership... dbSecurityGroups)

        A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

        Parameters:
        dbSecurityGroups - A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroups

        DBInstance.Builder vpcSecurityGroups​(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)

        The list of Amazon EC2 VPC security groups that the DB instance belongs to.

        Parameters:
        vpcSecurityGroups - The list of Amazon EC2 VPC security groups that the DB instance belongs to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroups

        DBInstance.Builder vpcSecurityGroups​(VpcSecurityGroupMembership... vpcSecurityGroups)

        The list of Amazon EC2 VPC security groups that the DB instance belongs to.

        Parameters:
        vpcSecurityGroups - The list of Amazon EC2 VPC security groups that the DB instance belongs to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbParameterGroups

        DBInstance.Builder dbParameterGroups​(Collection<DBParameterGroupStatus> dbParameterGroups)

        The list of DB parameter groups applied to this DB instance.

        Parameters:
        dbParameterGroups - The list of DB parameter groups applied to this DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbParameterGroups

        DBInstance.Builder dbParameterGroups​(DBParameterGroupStatus... dbParameterGroups)

        The list of DB parameter groups applied to this DB instance.

        Parameters:
        dbParameterGroups - The list of DB parameter groups applied to this DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • availabilityZone

        DBInstance.Builder availabilityZone​(String availabilityZone)

        The name of the Availability Zone where the DB instance is located.

        Parameters:
        availabilityZone - The name of the Availability Zone where the DB instance is located.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbSubnetGroup

        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.

        Parameters:
        dbSubnetGroup - Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • preferredMaintenanceWindow

        DBInstance.Builder preferredMaintenanceWindow​(String preferredMaintenanceWindow)

        The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        Parameters:
        preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • pendingModifiedValues

        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.

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

      • latestRestorableTime

        DBInstance.Builder latestRestorableTime​(Instant latestRestorableTime)

        The latest time to which a database in this DB instance can be restored with point-in-time restore.

        Parameters:
        latestRestorableTime - The latest time to which a database in this DB instance can be restored with point-in-time restore.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • multiAZ

        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.

        Parameters:
        multiAZ - Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engineVersion

        DBInstance.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.

      • autoMinorVersionUpgrade

        DBInstance.Builder autoMinorVersionUpgrade​(Boolean autoMinorVersionUpgrade)

        Indicates whether minor version patches are applied automatically.

        Parameters:
        autoMinorVersionUpgrade - Indicates whether minor version patches are applied automatically.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • readReplicaSourceDBInstanceIdentifier

        DBInstance.Builder readReplicaSourceDBInstanceIdentifier​(String readReplicaSourceDBInstanceIdentifier)

        The identifier of the source DB instance if this DB instance is a read replica.

        Parameters:
        readReplicaSourceDBInstanceIdentifier - The identifier of the source DB instance if this DB instance is a read replica.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • readReplicaDBInstanceIdentifiers

        DBInstance.Builder readReplicaDBInstanceIdentifiers​(Collection<String> readReplicaDBInstanceIdentifiers)

        The identifiers of the read replicas associated with this DB instance.

        Parameters:
        readReplicaDBInstanceIdentifiers - The identifiers of the read replicas associated with this DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • readReplicaDBInstanceIdentifiers

        DBInstance.Builder readReplicaDBInstanceIdentifiers​(String... readReplicaDBInstanceIdentifiers)

        The identifiers of the read replicas associated with this DB instance.

        Parameters:
        readReplicaDBInstanceIdentifiers - The identifiers of the read replicas associated with this DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • readReplicaDBClusterIdentifiers

        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.

        Parameters:
        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.

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

      • readReplicaDBClusterIdentifiers

        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.

        Parameters:
        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.

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

      • licenseModel

        DBInstance.Builder licenseModel​(String licenseModel)

        The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

        Parameters:
        licenseModel - The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • iops

        DBInstance.Builder iops​(Integer iops)

        The Provisioned IOPS (I/O operations per second) value for the DB instance.

        Parameters:
        iops - The Provisioned IOPS (I/O operations per second) value for the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionGroupMemberships

        DBInstance.Builder optionGroupMemberships​(Collection<OptionGroupMembership> optionGroupMemberships)

        The list of option group memberships for this DB instance.

        Parameters:
        optionGroupMemberships - The list of option group memberships for this DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionGroupMemberships

        DBInstance.Builder optionGroupMemberships​(OptionGroupMembership... optionGroupMemberships)

        The list of option group memberships for this DB instance.

        Parameters:
        optionGroupMemberships - The list of option group memberships for this DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • characterSetName

        DBInstance.Builder characterSetName​(String characterSetName)

        If present, specifies the name of the character set that this instance is associated with.

        Parameters:
        characterSetName - If present, specifies the name of the character set that this instance is associated with.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ncharCharacterSetName

        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.

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

      • secondaryAvailabilityZone

        DBInstance.Builder secondaryAvailabilityZone​(String secondaryAvailabilityZone)

        If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

        Parameters:
        secondaryAvailabilityZone - If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • publiclyAccessible

        DBInstance.Builder publiclyAccessible​(Boolean publiclyAccessible)

        Indicates whether the DB instance is publicly accessible.

        When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. 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.

        Parameters:
        publiclyAccessible - Indicates whether the DB instance is publicly accessible.

        When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. 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.

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

      • statusInfos

        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.

        Parameters:
        statusInfos - The status of a read replica. If the DB instance isn't a read replica, the value is blank.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • statusInfos

        DBInstance.Builder statusInfos​(DBInstanceStatusInfo... statusInfos)

        The status of a read replica. If the DB instance isn't a read replica, the value is blank.

        Parameters:
        statusInfos - The status of a read replica. If the DB instance isn't a read replica, the value is blank.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • storageType

        DBInstance.Builder storageType​(String storageType)

        The storage type associated with the DB instance.

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

      • tdeCredentialArn

        DBInstance.Builder tdeCredentialArn​(String tdeCredentialArn)

        The ARN from the key store with which the instance is associated for TDE encryption.

        Parameters:
        tdeCredentialArn - The ARN from the key store with which the instance is associated for TDE encryption.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbInstancePort

        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.

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

      • dbClusterIdentifier

        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.

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

      • storageEncrypted

        DBInstance.Builder storageEncrypted​(Boolean storageEncrypted)

        Indicates whether the DB instance is encrypted.

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

      • kmsKeyId

        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.

        Parameters:
        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.

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

      • dbiResourceId

        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.

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

      • domainMemberships

        DBInstance.Builder domainMemberships​(Collection<DomainMembership> domainMemberships)

        The Active Directory Domain membership records associated with the DB instance.

        Parameters:
        domainMemberships - The Active Directory Domain membership records associated with the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domainMemberships

        DBInstance.Builder domainMemberships​(DomainMembership... domainMemberships)

        The Active Directory Domain membership records associated with the DB instance.

        Parameters:
        domainMemberships - The Active Directory Domain membership records associated with the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • copyTagsToSnapshot

        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.

        Parameters:
        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.

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

      • monitoringInterval

        DBInstance.Builder monitoringInterval​(Integer monitoringInterval)

        The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

        Parameters:
        monitoringInterval - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enhancedMonitoringResourceArn

        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.

        Parameters:
        enhancedMonitoringResourceArn - The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • monitoringRoleArn

        DBInstance.Builder monitoringRoleArn​(String monitoringRoleArn)

        The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

        Parameters:
        monitoringRoleArn - The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • promotionTier

        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.

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

      • dbInstanceArn

        DBInstance.Builder dbInstanceArn​(String dbInstanceArn)

        The Amazon Resource Name (ARN) for the DB instance.

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

      • timezone

        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 RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified.

        Parameters:
        timezone - The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • iamDatabaseAuthenticationEnabled

        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.

        Parameters:
        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.

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

      • databaseInsightsMode

        DBInstance.Builder databaseInsightsMode​(String databaseInsightsMode)

        The mode of Database Insights that is enabled for the instance.

        Parameters:
        databaseInsightsMode - The mode of Database Insights that is enabled for the instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DatabaseInsightsMode, DatabaseInsightsMode

      • databaseInsightsMode

        DBInstance.Builder databaseInsightsMode​(DatabaseInsightsMode databaseInsightsMode)

        The mode of Database Insights that is enabled for the instance.

        Parameters:
        databaseInsightsMode - The mode of Database Insights that is enabled for the instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DatabaseInsightsMode, DatabaseInsightsMode

      • performanceInsightsEnabled

        DBInstance.Builder performanceInsightsEnabled​(Boolean performanceInsightsEnabled)

        Indicates whether Performance Insights is enabled for the DB instance.

        Parameters:
        performanceInsightsEnabled - Indicates whether Performance Insights is enabled for the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • performanceInsightsKMSKeyId

        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.

        Parameters:
        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.

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

      • performanceInsightsRetentionPeriod

        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

        Parameters:
        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

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

      • enabledCloudwatchLogsExports

        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.

        Parameters:
        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.

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

      • enabledCloudwatchLogsExports

        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.

        Parameters:
        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.

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

      • processorFeatures

        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.

        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

        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.

        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.

      • deletionProtection

        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.

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

      • associatedRoles

        DBInstance.Builder associatedRoles​(Collection<DBInstanceRole> associatedRoles)

        The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

        Parameters:
        associatedRoles - The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • associatedRoles

        DBInstance.Builder associatedRoles​(DBInstanceRole... associatedRoles)

        The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

        Parameters:
        associatedRoles - The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • associatedRoles

        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 the DBInstanceRole.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).

        Parameters:
        associatedRoles - a consumer that will call methods on DBInstanceRole.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #associatedRoles(java.util.Collection)

      • listenerEndpoint

        DBInstance.Builder listenerEndpoint​(Endpoint listenerEndpoint)

        The listener connection endpoint for SQL Server Always On.

        Parameters:
        listenerEndpoint - The listener connection endpoint for SQL Server Always On.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxAllocatedStorage

        DBInstance.Builder maxAllocatedStorage​(Integer maxAllocatedStorage)

        The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

        Parameters:
        maxAllocatedStorage - The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tagList

        DBInstance.Builder tagList​(Collection<Tag> tagList)
        Sets the value of the TagList property for this object.
        Parameters:
        tagList - The new value for the TagList property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tagList

        DBInstance.Builder tagList​(Tag... tagList)
        Sets the value of the TagList property for this object.
        Parameters:
        tagList - The new value for the TagList property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tagList

        DBInstance.Builder tagList​(Consumer<Tag.Builder>... tagList)
        Sets the value of the TagList property for this object. This is a convenience method that creates an instance of the 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).

        Parameters:
        tagList - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tagList(java.util.Collection)

      • dbInstanceAutomatedBackupsReplications

        DBInstance.Builder dbInstanceAutomatedBackupsReplications​(Collection<DBInstanceAutomatedBackupsReplication> dbInstanceAutomatedBackupsReplications)

        The list of replicated automated backups associated with the DB instance.

        Parameters:
        dbInstanceAutomatedBackupsReplications - The list of replicated automated backups associated with the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbInstanceAutomatedBackupsReplications

        DBInstance.Builder dbInstanceAutomatedBackupsReplications​(DBInstanceAutomatedBackupsReplication... dbInstanceAutomatedBackupsReplications)

        The list of replicated automated backups associated with the DB instance.

        Parameters:
        dbInstanceAutomatedBackupsReplications - The list of replicated automated backups associated with the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • customerOwnedIpEnabled

        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.

        Parameters:
        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.

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

      • awsBackupRecoveryPointArn

        DBInstance.Builder awsBackupRecoveryPointArn​(String awsBackupRecoveryPointArn)

        The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

        Parameters:
        awsBackupRecoveryPointArn - The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • activityStreamStatus

        DBInstance.Builder activityStreamStatus​(String activityStreamStatus)

        The status of the database activity stream.

        Parameters:
        activityStreamStatus - The status of the database activity stream.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ActivityStreamStatus, ActivityStreamStatus

      • activityStreamKmsKeyId

        DBInstance.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.

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

      • activityStreamKinesisStreamName

        DBInstance.Builder activityStreamKinesisStreamName​(String activityStreamKinesisStreamName)

        The name of the Amazon Kinesis data stream used for the database activity stream.

        Parameters:
        activityStreamKinesisStreamName - The name of the Amazon Kinesis data stream used for the database activity stream.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • activityStreamMode

        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.

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

      • activityStreamMode

        DBInstance.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.

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

      • activityStreamEngineNativeAuditFieldsIncluded

        DBInstance.Builder activityStreamEngineNativeAuditFieldsIncluded​(Boolean activityStreamEngineNativeAuditFieldsIncluded)

        Indicates whether engine-native audit fields are included in the database activity stream.

        Parameters:
        activityStreamEngineNativeAuditFieldsIncluded - Indicates whether engine-native audit fields are included in the database activity stream.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • automationMode

        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.

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

      • automationMode

        DBInstance.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.

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

      • resumeFullAutomationModeTime

        DBInstance.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.

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

      • customIamInstanceProfile

        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.

        Parameters:
        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.

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

      • backupTarget

        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.

        Parameters:
        backupTarget - The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • networkType

        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

        Parameters:
        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

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

      • activityStreamPolicyStatus

        DBInstance.Builder activityStreamPolicyStatus​(String activityStreamPolicyStatus)

        The status of the policy state of the activity stream.

        Parameters:
        activityStreamPolicyStatus - The status of the policy state of the activity stream.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ActivityStreamPolicyStatus, ActivityStreamPolicyStatus

      • storageThroughput

        DBInstance.Builder storageThroughput​(Integer storageThroughput)

        The storage throughput for the DB instance.

        This setting applies only to the gp3 storage type.

        Parameters:
        storageThroughput - The storage throughput for the DB instance.

        This setting applies only to the gp3 storage type.

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

      • dbSystemId

        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.

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

      • certificateDetails

        DBInstance.Builder certificateDetails​(CertificateDetails certificateDetails)

        The details of the DB instance's server certificate.

        Parameters:
        certificateDetails - The details of the DB instance's server certificate.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • readReplicaSourceDBClusterIdentifier

        DBInstance.Builder readReplicaSourceDBClusterIdentifier​(String readReplicaSourceDBClusterIdentifier)

        The identifier of the source DB cluster if this DB instance is a read replica.

        Parameters:
        readReplicaSourceDBClusterIdentifier - The identifier of the source DB cluster if this DB instance is a read replica.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • percentProgress

        DBInstance.Builder percentProgress​(String percentProgress)

        The progress of the storage optimization operation as a percentage.

        Parameters:
        percentProgress - The progress of the storage optimization operation as a percentage.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dedicatedLogVolume

        DBInstance.Builder dedicatedLogVolume​(Boolean dedicatedLogVolume)

        Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

        Parameters:
        dedicatedLogVolume - Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • isStorageConfigUpgradeAvailable

        DBInstance.Builder isStorageConfigUpgradeAvailable​(Boolean isStorageConfigUpgradeAvailable)

        Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.

        Parameters:
        isStorageConfigUpgradeAvailable - Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • multiTenant

        DBInstance.Builder multiTenant​(Boolean multiTenant)

        Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

        Parameters:
        multiTenant - Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engineLifecycleSupport

        DBInstance.Builder engineLifecycleSupport​(String engineLifecycleSupport)

        The life cycle type for the DB instance.

        For more information, see CreateDBInstance.

        Parameters:
        engineLifecycleSupport - The life cycle type for the DB instance.

        For more information, see CreateDBInstance.

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