Package software.amazon.awssdk.services.securityhub.model

Interface AwsRdsDbInstanceDetails.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AwsRdsDbInstanceDetails.Builder,AwsRdsDbInstanceDetails>, SdkBuilder<AwsRdsDbInstanceDetails.Builder,AwsRdsDbInstanceDetails>, SdkPojo
Enclosing class:
AwsRdsDbInstanceDetails
public static interface AwsRdsDbInstanceDetails.Builder extends SdkPojo, CopyableBuilder<AwsRdsDbInstanceDetails.Builder,AwsRdsDbInstanceDetails>

  • Method Details

    • associatedRoles

      AwsRdsDbInstanceDetails.Builder associatedRoles(Collection<AwsRdsDbInstanceAssociatedRole> associatedRoles)

      The IAM roles associated with the DB instance.

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

    • associatedRoles

      AwsRdsDbInstanceDetails.Builder associatedRoles(AwsRdsDbInstanceAssociatedRole... associatedRoles)

      The IAM roles associated with the DB instance.

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

    • associatedRoles

      AwsRdsDbInstanceDetails.Builder associatedRoles(Consumer<AwsRdsDbInstanceAssociatedRole.Builder>... associatedRoles)

      The IAM roles associated with the DB instance.

      This is a convenience method that creates an instance of the AwsRdsDbInstanceAssociatedRole.Builder avoiding the need to create one manually via AwsRdsDbInstanceAssociatedRole.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to associatedRoles(List<AwsRdsDbInstanceAssociatedRole>).

      Parameters:
      associatedRoles - a consumer that will call methods on AwsRdsDbInstanceAssociatedRole.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • caCertificateIdentifier

      AwsRdsDbInstanceDetails.Builder caCertificateIdentifier(String caCertificateIdentifier)

      The identifier of the CA certificate for this DB instance.

      Parameters:
      caCertificateIdentifier - The identifier of the CA certificate for this DB instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbClusterIdentifier

      AwsRdsDbInstanceDetails.Builder dbClusterIdentifier(String dbClusterIdentifier)

      If the DB instance is a member of a DB cluster, contains 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, contains 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.

    • dbInstanceIdentifier

      AwsRdsDbInstanceDetails.Builder dbInstanceIdentifier(String dbInstanceIdentifier)

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

      Parameters:
      dbInstanceIdentifier - Contains a 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

      AwsRdsDbInstanceDetails.Builder dbInstanceClass(String dbInstanceClass)

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

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

    • dbInstancePort

      AwsRdsDbInstanceDetails.Builder dbInstancePort(Integer dbInstancePort)

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

    • dbiResourceId

      AwsRdsDbInstanceDetails.Builder dbiResourceId(String dbiResourceId)

      The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in CloudTrail log entries whenever the 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 CloudTrail log entries whenever the KMS key for the DB instance is accessed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbName

      AwsRdsDbInstanceDetails.Builder dbName(String dbName)

      The meaning of this parameter differs according to the database engine you use.

      MySQL, MariaDB, SQL Server, PostgreSQL

      Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

      Oracle

      Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

      Parameters:
      dbName - The meaning of this parameter differs according to the database engine you use.

      MySQL, MariaDB, SQL Server, PostgreSQL

      Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

      Oracle

      Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

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

    • deletionProtection

      AwsRdsDbInstanceDetails.Builder deletionProtection(Boolean deletionProtection)

      Indicates whether the DB instance has deletion protection enabled.

      When deletion protection is enabled, the database cannot be deleted.

      Parameters:
      deletionProtection - Indicates whether the DB instance has deletion protection enabled.

      When deletion protection is enabled, the database cannot be deleted.

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

    • endpoint

      AwsRdsDbInstanceDetails.Builder endpoint(AwsRdsDbInstanceEndpoint endpoint)

      Specifies the connection endpoint.

      Parameters:
      endpoint - Specifies the connection endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpoint

      default AwsRdsDbInstanceDetails.Builder endpoint(Consumer<AwsRdsDbInstanceEndpoint.Builder> endpoint)

      Specifies the connection endpoint.

      This is a convenience method that creates an instance of the AwsRdsDbInstanceEndpoint.Builder avoiding the need to create one manually via AwsRdsDbInstanceEndpoint.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to endpoint(AwsRdsDbInstanceEndpoint).

      Parameters:
      endpoint - a consumer that will call methods on AwsRdsDbInstanceEndpoint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • engine

      AwsRdsDbInstanceDetails.Builder engine(String engine)

      Provides the name of the database engine to use for this DB instance.

      Parameters:
      engine - Provides the name of the database engine to use for this DB instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineVersion

      AwsRdsDbInstanceDetails.Builder engineVersion(String engineVersion)

      Indicates the database engine version.

      Parameters:
      engineVersion - Indicates the database engine version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • iamDatabaseAuthenticationEnabled

      AwsRdsDbInstanceDetails.Builder iamDatabaseAuthenticationEnabled(Boolean iamDatabaseAuthenticationEnabled)

      True if mapping of IAM accounts to database accounts is enabled, and otherwise false.

      IAM database authentication can be enabled for the following database engines.

      • For MySQL 5.6, minor version 5.6.34 or higher

      • For MySQL 5.7, minor version 5.7.16 or higher

      • Aurora 5.6 or higher

      Parameters:
      iamDatabaseAuthenticationEnabled - True if mapping of IAM accounts to database accounts is enabled, and otherwise false.

      IAM database authentication can be enabled for the following database engines.

      • For MySQL 5.6, minor version 5.6.34 or higher

      • For MySQL 5.7, minor version 5.7.16 or higher

      • Aurora 5.6 or higher

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

    • instanceCreateTime

      AwsRdsDbInstanceDetails.Builder instanceCreateTime(String instanceCreateTime)

      Indicates when the DB instance was created.

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

      Parameters:
      instanceCreateTime - Indicates when the DB instance was created.

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

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

    • kmsKeyId

      AwsRdsDbInstanceDetails.Builder kmsKeyId(String kmsKeyId)

      If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.

      Parameters:
      kmsKeyId - If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • publiclyAccessible

      AwsRdsDbInstanceDetails.Builder publiclyAccessible(Boolean publiclyAccessible)

      Specifies the accessibility options for the DB instance.

      A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.

      A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

      Parameters:
      publiclyAccessible - Specifies the accessibility options for the DB instance.

      A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.

      A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

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

    • storageEncrypted

      AwsRdsDbInstanceDetails.Builder storageEncrypted(Boolean storageEncrypted)

      Specifies whether the DB instance is encrypted.

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

    • tdeCredentialArn

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

    • vpcSecurityGroups

      AwsRdsDbInstanceDetails.Builder vpcSecurityGroups(Collection<AwsRdsDbInstanceVpcSecurityGroup> vpcSecurityGroups)

      A list of VPC security groups that the DB instance belongs to.

      Parameters:
      vpcSecurityGroups - A list of 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

      AwsRdsDbInstanceDetails.Builder vpcSecurityGroups(AwsRdsDbInstanceVpcSecurityGroup... vpcSecurityGroups)

      A list of VPC security groups that the DB instance belongs to.

      Parameters:
      vpcSecurityGroups - A list of 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

      AwsRdsDbInstanceDetails.Builder vpcSecurityGroups(Consumer<AwsRdsDbInstanceVpcSecurityGroup.Builder>... vpcSecurityGroups)

      A list of VPC security groups that the DB instance belongs to.

      This is a convenience method that creates an instance of the AwsRdsDbInstanceVpcSecurityGroup.Builder avoiding the need to create one manually via AwsRdsDbInstanceVpcSecurityGroup.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcSecurityGroups(List<AwsRdsDbInstanceVpcSecurityGroup>).

      Parameters:
      vpcSecurityGroups - a consumer that will call methods on AwsRdsDbInstanceVpcSecurityGroup.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • multiAz

      AwsRdsDbInstanceDetails.Builder multiAz(Boolean multiAz)

      Whether the DB instance is a multiple Availability Zone deployment.

      Parameters:
      multiAz - Whether the DB instance is a multiple Availability Zone deployment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enhancedMonitoringResourceArn

      AwsRdsDbInstanceDetails.Builder enhancedMonitoringResourceArn(String enhancedMonitoringResourceArn)

      The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.

      Parameters:
      enhancedMonitoringResourceArn - The ARN of the 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.

    • dbInstanceStatus

      AwsRdsDbInstanceDetails.Builder dbInstanceStatus(String dbInstanceStatus)

      The current status of the DB instance.

      Parameters:
      dbInstanceStatus - The current status of the DB instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • masterUsername

      AwsRdsDbInstanceDetails.Builder masterUsername(String masterUsername)

      The master user name of the DB instance.

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

    • allocatedStorage

      AwsRdsDbInstanceDetails.Builder allocatedStorage(Integer allocatedStorage)

      The amount of storage (in gigabytes) to initially allocate for the DB instance.

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

    • preferredBackupWindow

      AwsRdsDbInstanceDetails.Builder preferredBackupWindow(String preferredBackupWindow)

      The range of time each day when automated backups are created, if automated backups are enabled.

      Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

      Parameters:
      preferredBackupWindow - The range of time each day when automated backups are created, if automated backups are enabled.

      Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

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

    • backupRetentionPeriod

      AwsRdsDbInstanceDetails.Builder backupRetentionPeriod(Integer backupRetentionPeriod)

      The number of days for which to retain automated backups.

      Parameters:
      backupRetentionPeriod - The number of days for which to retain automated backups.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbSecurityGroups

      AwsRdsDbInstanceDetails.Builder dbSecurityGroups(Collection<String> dbSecurityGroups)

      A list of the DB security groups to assign to the DB instance.

      Parameters:
      dbSecurityGroups - A list of the DB security groups to assign to the DB instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbSecurityGroups

      AwsRdsDbInstanceDetails.Builder dbSecurityGroups(String... dbSecurityGroups)

      A list of the DB security groups to assign to the DB instance.

      Parameters:
      dbSecurityGroups - A list of the DB security groups to assign to the DB instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbParameterGroups

      AwsRdsDbInstanceDetails.Builder dbParameterGroups(Collection<AwsRdsDbParameterGroup> dbParameterGroups)

      A list of the DB parameter groups to assign to the DB instance.

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

    • dbParameterGroups

      AwsRdsDbInstanceDetails.Builder dbParameterGroups(AwsRdsDbParameterGroup... dbParameterGroups)

      A list of the DB parameter groups to assign to the DB instance.

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

    • dbParameterGroups

      AwsRdsDbInstanceDetails.Builder dbParameterGroups(Consumer<AwsRdsDbParameterGroup.Builder>... dbParameterGroups)

      A list of the DB parameter groups to assign to the DB instance.

      This is a convenience method that creates an instance of the AwsRdsDbParameterGroup.Builder avoiding the need to create one manually via AwsRdsDbParameterGroup.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dbParameterGroups(List<AwsRdsDbParameterGroup>).

      Parameters:
      dbParameterGroups - a consumer that will call methods on AwsRdsDbParameterGroup.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • availabilityZone

      AwsRdsDbInstanceDetails.Builder availabilityZone(String availabilityZone)

      The Availability Zone where the DB instance will be created.

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

    • dbSubnetGroup

      AwsRdsDbInstanceDetails.Builder dbSubnetGroup(AwsRdsDbSubnetGroup dbSubnetGroup)

      Information about the subnet group that is associated with the DB instance.

      Parameters:
      dbSubnetGroup - Information about the subnet group that is associated with the DB instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbSubnetGroup

      default AwsRdsDbInstanceDetails.Builder dbSubnetGroup(Consumer<AwsRdsDbSubnetGroup.Builder> dbSubnetGroup)

      Information about the subnet group that is associated with the DB instance.

      This is a convenience method that creates an instance of the AwsRdsDbSubnetGroup.Builder avoiding the need to create one manually via AwsRdsDbSubnetGroup.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dbSubnetGroup(AwsRdsDbSubnetGroup).

      Parameters:
      dbSubnetGroup - a consumer that will call methods on AwsRdsDbSubnetGroup.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • preferredMaintenanceWindow

      AwsRdsDbInstanceDetails.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

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

      Uses the format <day>:HH:MM-<day>:HH:MM.

      For the day values, use mon|tue|wed|thu|fri| sat|sun.

      For example, sun:09:32-sun:10:02.

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

      Uses the format <day>:HH:MM-<day>:HH:MM.

      For the day values, use mon|tue|wed|thu| fri|sat|sun.

      For example, sun:09:32-sun:10:02.

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

    • pendingModifiedValues

      AwsRdsDbInstanceDetails.Builder pendingModifiedValues(AwsRdsDbPendingModifiedValues pendingModifiedValues)

      Changes to the DB instance that are currently pending.

      Parameters:
      pendingModifiedValues - Changes to the DB instance that are currently pending.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pendingModifiedValues

      default AwsRdsDbInstanceDetails.Builder pendingModifiedValues(Consumer<AwsRdsDbPendingModifiedValues.Builder> pendingModifiedValues)

      Changes to the DB instance that are currently pending.

      This is a convenience method that creates an instance of the AwsRdsDbPendingModifiedValues.Builder avoiding the need to create one manually via AwsRdsDbPendingModifiedValues.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to pendingModifiedValues(AwsRdsDbPendingModifiedValues).

      Parameters:
      pendingModifiedValues - a consumer that will call methods on AwsRdsDbPendingModifiedValues.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • latestRestorableTime

      AwsRdsDbInstanceDetails.Builder latestRestorableTime(String latestRestorableTime)

      Specifies the latest time to which a database can be restored with point-in-time restore.

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

      Parameters:
      latestRestorableTime - Specifies the latest time to which a database can be restored with point-in-time restore.

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

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

    • autoMinorVersionUpgrade

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

      AwsRdsDbInstanceDetails.Builder readReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)

      If this DB instance is a read replica, contains the identifier of the source DB instance.

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

    • readReplicaDBInstanceIdentifiers

      AwsRdsDbInstanceDetails.Builder readReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)

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

      Parameters:
      readReplicaDBInstanceIdentifiers - List of 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

      AwsRdsDbInstanceDetails.Builder readReplicaDBInstanceIdentifiers(String... readReplicaDBInstanceIdentifiers)

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

      Parameters:
      readReplicaDBInstanceIdentifiers - List of 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

      AwsRdsDbInstanceDetails.Builder readReplicaDBClusterIdentifiers(Collection<String> readReplicaDBClusterIdentifiers)

      List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.

      Parameters:
      readReplicaDBClusterIdentifiers - List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • readReplicaDBClusterIdentifiers

      AwsRdsDbInstanceDetails.Builder readReplicaDBClusterIdentifiers(String... readReplicaDBClusterIdentifiers)

      List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.

      Parameters:
      readReplicaDBClusterIdentifiers - List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • licenseModel

      AwsRdsDbInstanceDetails.Builder licenseModel(String licenseModel)

      License model information for this DB instance.

      Parameters:
      licenseModel - License model information for this DB instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • iops

      AwsRdsDbInstanceDetails.Builder iops(Integer iops)

      Specifies the provisioned IOPS (I/O operations per second) for this DB instance.

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

    • optionGroupMemberships

      AwsRdsDbInstanceDetails.Builder optionGroupMemberships(Collection<AwsRdsDbOptionGroupMembership> 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

      AwsRdsDbInstanceDetails.Builder optionGroupMemberships(AwsRdsDbOptionGroupMembership... 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

      AwsRdsDbInstanceDetails.Builder optionGroupMemberships(Consumer<AwsRdsDbOptionGroupMembership.Builder>... optionGroupMemberships)

      The list of option group memberships for this DB instance.

      This is a convenience method that creates an instance of the AwsRdsDbOptionGroupMembership.Builder avoiding the need to create one manually via AwsRdsDbOptionGroupMembership.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to optionGroupMemberships(List<AwsRdsDbOptionGroupMembership>).

      Parameters:
      optionGroupMemberships - a consumer that will call methods on AwsRdsDbOptionGroupMembership.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • characterSetName

      AwsRdsDbInstanceDetails.Builder characterSetName(String characterSetName)

      The name of the character set that this DB instance is associated with.

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

    • secondaryAvailabilityZone

      AwsRdsDbInstanceDetails.Builder secondaryAvailabilityZone(String secondaryAvailabilityZone)

      For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.

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

    • statusInfos

      AwsRdsDbInstanceDetails.Builder statusInfos(Collection<AwsRdsDbStatusInfo> statusInfos)

      The status of a read replica. If the instance isn't a read replica, this is empty.

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

    • statusInfos

      AwsRdsDbInstanceDetails.Builder statusInfos(AwsRdsDbStatusInfo... statusInfos)

      The status of a read replica. If the instance isn't a read replica, this is empty.

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

    • statusInfos

      AwsRdsDbInstanceDetails.Builder statusInfos(Consumer<AwsRdsDbStatusInfo.Builder>... statusInfos)

      The status of a read replica. If the instance isn't a read replica, this is empty.

      This is a convenience method that creates an instance of the AwsRdsDbStatusInfo.Builder avoiding the need to create one manually via AwsRdsDbStatusInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to statusInfos(List<AwsRdsDbStatusInfo>).

      Parameters:
      statusInfos - a consumer that will call methods on AwsRdsDbStatusInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageType

      AwsRdsDbInstanceDetails.Builder storageType(String storageType)

      The storage type for the DB instance.

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

    • domainMemberships

      AwsRdsDbInstanceDetails.Builder domainMemberships(Collection<AwsRdsDbDomainMembership> 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

      AwsRdsDbInstanceDetails.Builder domainMemberships(AwsRdsDbDomainMembership... 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

      AwsRdsDbInstanceDetails.Builder domainMemberships(Consumer<AwsRdsDbDomainMembership.Builder>... domainMemberships)

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

      This is a convenience method that creates an instance of the AwsRdsDbDomainMembership.Builder avoiding the need to create one manually via AwsRdsDbDomainMembership.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to domainMemberships(List<AwsRdsDbDomainMembership>).

      Parameters:
      domainMemberships - a consumer that will call methods on AwsRdsDbDomainMembership.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • copyTagsToSnapshot

      AwsRdsDbInstanceDetails.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)

      Whether to copy resource tags to snapshots of the DB instance.

      Parameters:
      copyTagsToSnapshot - Whether to copy resource tags to snapshots of the DB instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • monitoringInterval

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

    • monitoringRoleArn

      AwsRdsDbInstanceDetails.Builder monitoringRoleArn(String monitoringRoleArn)

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

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

    • promotionTier

      AwsRdsDbInstanceDetails.Builder promotionTier(Integer promotionTier)

      The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.

      Parameters:
      promotionTier - The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timezone

      AwsRdsDbInstanceDetails.Builder timezone(String timezone)

      The time zone of the DB instance.

      Parameters:
      timezone - The time zone of the DB instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • performanceInsightsEnabled

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

      AwsRdsDbInstanceDetails.Builder performanceInsightsKmsKeyId(String performanceInsightsKmsKeyId)

      The identifier of the KMS key used to encrypt the Performance Insights data.

      Parameters:
      performanceInsightsKmsKeyId - The identifier of the KMS key used to encrypt the Performance Insights data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • performanceInsightsRetentionPeriod

      AwsRdsDbInstanceDetails.Builder performanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)

      The number of days to retain Performance Insights data.

      Parameters:
      performanceInsightsRetentionPeriod - The number of days to retain Performance Insights data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enabledCloudWatchLogsExports

      AwsRdsDbInstanceDetails.Builder enabledCloudWatchLogsExports(Collection<String> enabledCloudWatchLogsExports)

      A list of log types that this DB instance is configured to export to CloudWatch Logs.

      Parameters:
      enabledCloudWatchLogsExports - A list of log types that this DB instance is configured to export to CloudWatch Logs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enabledCloudWatchLogsExports

      AwsRdsDbInstanceDetails.Builder enabledCloudWatchLogsExports(String... enabledCloudWatchLogsExports)

      A list of log types that this DB instance is configured to export to CloudWatch Logs.

      Parameters:
      enabledCloudWatchLogsExports - A list of log types that this DB instance is configured to export to CloudWatch Logs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • processorFeatures

      AwsRdsDbInstanceDetails.Builder processorFeatures(Collection<AwsRdsDbProcessorFeature> processorFeatures)

      The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

      Parameters:
      processorFeatures - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • processorFeatures

      AwsRdsDbInstanceDetails.Builder processorFeatures(AwsRdsDbProcessorFeature... processorFeatures)

      The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

      Parameters:
      processorFeatures - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • processorFeatures

      AwsRdsDbInstanceDetails.Builder processorFeatures(Consumer<AwsRdsDbProcessorFeature.Builder>... processorFeatures)

      The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

      This is a convenience method that creates an instance of the AwsRdsDbProcessorFeature.Builder avoiding the need to create one manually via AwsRdsDbProcessorFeature.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to processorFeatures(List<AwsRdsDbProcessorFeature>).

      Parameters:
      processorFeatures - a consumer that will call methods on AwsRdsDbProcessorFeature.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • listenerEndpoint

      AwsRdsDbInstanceDetails.Builder listenerEndpoint(AwsRdsDbInstanceEndpoint listenerEndpoint)
      Sets the value of the ListenerEndpoint property for this object.
      Parameters:
      listenerEndpoint - The new value for the ListenerEndpoint property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • listenerEndpoint

      default AwsRdsDbInstanceDetails.Builder listenerEndpoint(Consumer<AwsRdsDbInstanceEndpoint.Builder> listenerEndpoint)
      Sets the value of the ListenerEndpoint property for this object. This is a convenience method that creates an instance of the AwsRdsDbInstanceEndpoint.Builder avoiding the need to create one manually via AwsRdsDbInstanceEndpoint.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to listenerEndpoint(AwsRdsDbInstanceEndpoint).

      Parameters:
      listenerEndpoint - a consumer that will call methods on AwsRdsDbInstanceEndpoint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxAllocatedStorage

      AwsRdsDbInstanceDetails.Builder maxAllocatedStorage(Integer maxAllocatedStorage)

      The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

      Parameters:
      maxAllocatedStorage - The upper limit 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.