Package 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("software.amazon.awssdk:codegen")
public final class PromoteReadReplicaRequest
extends RdsRequest
implements ToCopyableBuilder<PromoteReadReplicaRequest.Builder,PromoteReadReplicaRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PromoteReadReplicaRequest.Builder

Method Summary

Modifier and Type	Method	Description
Integer	backupRetentionPeriod()	The number of days for which automated backups are retained.
static PromoteReadReplicaRequest.Builder	builder()
String	dbInstanceIdentifier()	The DB instance identifier.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTagSpecifications()	For responses, this returns true if the service returned a value for the TagSpecifications property.
String	preferredBackupWindow()	The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PromoteReadReplicaRequest.Builder>	serializableBuilderClass()
List<TagSpecification>	tagSpecifications()	Tags to assign to resources associated with the DB instance.
PromoteReadReplicaRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

dbInstanceIdentifier

public final 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 final Integer backupRetentionPeriod()

The number of days for which automated backups are retained. 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 35.

• Can't be set to 0 if the DB instance is a source to read replicas.

Returns:

The number of days for which automated backups are retained. 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 35.

• Can't be set to 0 if the DB instance is a source to read replicas.

preferredBackupWindow

public final 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 Amazon Web Services 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 Amazon Web Services 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.

hasTagSpecifications

public final boolean hasTagSpecifications()

For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tagSpecifications

public final List<TagSpecification> tagSpecifications()

Tags to assign to resources associated with the DB instance.

Valid Values:

• auto-backup - The DB instance's automated backup.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagSpecifications() method.

Returns:

Tags to assign to resources associated with the DB instance.

Valid Values:

• auto-backup - The DB instance's automated backup.

toBuilder

public PromoteReadReplicaRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PromoteReadReplicaRequest.Builder,PromoteReadReplicaRequest>

Specified by:

toBuilder in class RdsRequest

builder

public static PromoteReadReplicaRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo