software.amazon.awssdk.services.rds.model

Class PromoteReadReplicaRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rds.model.RdsRequest

software.amazon.awssdk.services.rds.model.PromoteReadReplicaRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PromoteReadReplicaRequest.Builder,PromoteReadReplicaRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class PromoteReadReplicaRequest
extends RdsRequest
implements ToCopyableBuilder<PromoteReadReplicaRequest.Builder,PromoteReadReplicaRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PromoteReadReplicaRequest.Builder

Method Summary

Modifier and Type	Method and Description
Integer	backupRetentionPeriod() The number of days to retain automated backups.
static PromoteReadReplicaRequest.Builder	builder()
String	dbInstanceIdentifier() The DB instance identifier.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	preferredBackupWindow() The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
List<SdkField<?>>	sdkFields()
static Class<? extends PromoteReadReplicaRequest.Builder>	serializableBuilderClass()
PromoteReadReplicaRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

dbInstanceIdentifier

public String dbInstanceIdentifier()

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

• Must match the identifier of an existing Read Replica DB instance.

Example: mydbinstance

Returns:

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

• Must match the identifier of an existing Read Replica DB instance.

Example: mydbinstance

backupRetentionPeriod

public Integer backupRetentionPeriod()

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

• Must be a value from 0 to 8

Returns:

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

• Must be a value from 0 to 8

preferredBackupWindow

public String preferredBackupWindow()

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

• Must be in the format hh24:mi-hh24:mi.

• Must be in Universal Coordinated Time (UTC).

• Must not conflict with the preferred maintenance window.

• Must be at least 30 minutes.

Returns:

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

• Must be in the format hh24:mi-hh24:mi.

• Must be in Universal Coordinated Time (UTC).

• Must not conflict with the preferred maintenance window.

• Must be at least 30 minutes.

toBuilder

public PromoteReadReplicaRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PromoteReadReplicaRequest.Builder,PromoteReadReplicaRequest>

Specified by:

toBuilder in class RdsRequest

Returns:

a builder for type T

builder

public static PromoteReadReplicaRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PromoteReadReplicaRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.