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

Interface DBInstanceAutomatedBackup.Builder

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

  • Method Details

    • dbInstanceArn

      DBInstanceAutomatedBackup.Builder dbInstanceArn(String dbInstanceArn)

      The Amazon Resource Name (ARN) for the automated backups.

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

    • dbiResourceId

      DBInstanceAutomatedBackup.Builder dbiResourceId(String dbiResourceId)

      The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

      Parameters:
      dbiResourceId - The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • region

      DBInstanceAutomatedBackup.Builder region(String region)

      The Amazon Web Services Region associated with the automated backup.

      Parameters:
      region - The Amazon Web Services Region associated with the automated backup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbInstanceIdentifier

      DBInstanceAutomatedBackup.Builder dbInstanceIdentifier(String dbInstanceIdentifier)

      The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

      Parameters:
      dbInstanceIdentifier - The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • restoreWindow

      DBInstanceAutomatedBackup.Builder restoreWindow(RestoreWindow restoreWindow)

      The earliest and latest time a DB instance can be restored to.

      Parameters:
      restoreWindow - The earliest and latest time a DB instance can be restored to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • restoreWindow

      default DBInstanceAutomatedBackup.Builder restoreWindow(Consumer<RestoreWindow.Builder> restoreWindow)

      The earliest and latest time a DB instance can be restored to.

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

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

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

    • allocatedStorage

      DBInstanceAutomatedBackup.Builder allocatedStorage(Integer allocatedStorage)

      The allocated storage size for the the automated backup in gibibytes (GiB).

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

    • status

      DBInstanceAutomatedBackup.Builder status(String status)

      A list of status information for an automated backup:

      • active - Automated backups for current instances.

      • retained - Automated backups for deleted instances.

      • creating - Automated backups that are waiting for the first automated snapshot to be available.

      Parameters:
      status - A list of status information for an automated backup:

      • active - Automated backups for current instances.

      • retained - Automated backups for deleted instances.

      • creating - Automated backups that are waiting for the first automated snapshot to be available.

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

    • port

      DBInstanceAutomatedBackup.Builder port(Integer port)

      The port number that the automated backup used for connections.

      Default: Inherits from the source DB instance

      Valid Values: 1150-65535

      Parameters:
      port - The port number that the automated backup used for connections.

      Default: Inherits from the source DB instance

      Valid Values: 1150-65535

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

    • availabilityZone

      DBInstanceAutomatedBackup.Builder availabilityZone(String availabilityZone)

      The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

      Parameters:
      availabilityZone - The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcId

      DBInstanceAutomatedBackup.Builder vpcId(String vpcId)

      The VPC ID associated with the DB instance.

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

    • instanceCreateTime

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

    • masterUsername

      DBInstanceAutomatedBackup.Builder masterUsername(String masterUsername)

      The master user name of an automated backup.

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

    • engine

      DBInstanceAutomatedBackup.Builder engine(String engine)

      The name of the database engine for this automated backup.

      Parameters:
      engine - The name of the database engine for this automated backup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineVersion

      DBInstanceAutomatedBackup.Builder engineVersion(String engineVersion)

      The version of the database engine for the automated backup.

      Parameters:
      engineVersion - The version of the database engine for the automated backup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • licenseModel

      DBInstanceAutomatedBackup.Builder licenseModel(String licenseModel)

      The license model information for the automated backup.

      Parameters:
      licenseModel - The license model information for the automated backup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • iops

      DBInstanceAutomatedBackup.Builder iops(Integer iops)

      The IOPS (I/O operations per second) value for the automated backup.

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

    • optionGroupName

      DBInstanceAutomatedBackup.Builder optionGroupName(String optionGroupName)

      The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

      Parameters:
      optionGroupName - The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tdeCredentialArn

      DBInstanceAutomatedBackup.Builder tdeCredentialArn(String tdeCredentialArn)

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

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

    • encrypted

      DBInstanceAutomatedBackup.Builder encrypted(Boolean encrypted)

      Indicates whether the automated backup is encrypted.

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

    • storageType

      DBInstanceAutomatedBackup.Builder storageType(String storageType)

      The storage type associated with the automated backup.

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

    • kmsKeyId

      DBInstanceAutomatedBackup.Builder kmsKeyId(String kmsKeyId)

      The Amazon Web Services KMS key ID for an automated backup.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

      Parameters:
      kmsKeyId - The Amazon Web Services KMS key ID for an automated backup.

      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.

    • timezone

      DBInstanceAutomatedBackup.Builder timezone(String timezone)

      The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

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

    • iamDatabaseAuthenticationEnabled

      DBInstanceAutomatedBackup.Builder iamDatabaseAuthenticationEnabled(Boolean iamDatabaseAuthenticationEnabled)

      True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

      Parameters:
      iamDatabaseAuthenticationEnabled - True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • backupRetentionPeriod

      DBInstanceAutomatedBackup.Builder backupRetentionPeriod(Integer backupRetentionPeriod)

      The retention period for the automated backups.

      Parameters:
      backupRetentionPeriod - The retention period for the automated backups.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbInstanceAutomatedBackupsArn

      DBInstanceAutomatedBackup.Builder dbInstanceAutomatedBackupsArn(String dbInstanceAutomatedBackupsArn)

      The Amazon Resource Name (ARN) for the replicated automated backups.

      Parameters:
      dbInstanceAutomatedBackupsArn - The Amazon Resource Name (ARN) for the replicated automated backups.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbInstanceAutomatedBackupsReplications

      DBInstanceAutomatedBackup.Builder dbInstanceAutomatedBackupsReplications(Collection<DBInstanceAutomatedBackupsReplication> dbInstanceAutomatedBackupsReplications)

      The list of replications to different Amazon Web Services Regions associated with the automated backup.

      Parameters:
      dbInstanceAutomatedBackupsReplications - The list of replications to different Amazon Web Services Regions associated with the automated backup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbInstanceAutomatedBackupsReplications

      DBInstanceAutomatedBackup.Builder dbInstanceAutomatedBackupsReplications(DBInstanceAutomatedBackupsReplication... dbInstanceAutomatedBackupsReplications)

      The list of replications to different Amazon Web Services Regions associated with the automated backup.

      Parameters:
      dbInstanceAutomatedBackupsReplications - The list of replications to different Amazon Web Services Regions associated with the automated backup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbInstanceAutomatedBackupsReplications

      DBInstanceAutomatedBackup.Builder dbInstanceAutomatedBackupsReplications(Consumer<DBInstanceAutomatedBackupsReplication.Builder>... dbInstanceAutomatedBackupsReplications)

      The list of replications to different Amazon Web Services Regions associated with the automated backup.

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

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

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

    • backupTarget

      DBInstanceAutomatedBackup.Builder backupTarget(String backupTarget)

      The location where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

      Parameters:
      backupTarget - The location where automated backups 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.

    • storageThroughput

      DBInstanceAutomatedBackup.Builder storageThroughput(Integer storageThroughput)

      The storage throughput for the automated backup.

      Parameters:
      storageThroughput - The storage throughput for the automated backup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • awsBackupRecoveryPointArn

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

    • dedicatedLogVolume

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

    • multiTenant

      DBInstanceAutomatedBackup.Builder multiTenant(Boolean multiTenant)

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

      Parameters:
      multiTenant - Specifies whether the automatic backup is for a DB instance 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.