software.amazon.awssdk.services.docdb.model

Class CreateDbInstanceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.docdb.model.DocDbRequest

software.amazon.awssdk.services.docdb.model.CreateDbInstanceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDbInstanceRequest.Builder,CreateDbInstanceRequest>

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

Represents the input to CreateDBInstance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDbInstanceRequest.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	autoMinorVersionUpgrade() Indicates that minor engine upgrades are applied automatically to the instance during the maintenance window.
String	availabilityZone() The Amazon EC2 Availability Zone that the instance is created in.
static CreateDbInstanceRequest.Builder	builder()
String	dbClusterIdentifier() The identifier of the cluster that the instance will belong to.
String	dbInstanceClass() The compute and memory capacity of the instance; for example, db.r5.large.
String	dbInstanceIdentifier() The instance identifier.
String	engine() The name of the database engine to be used for this instance.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	preferredMaintenanceWindow() The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
Integer	promotionTier() A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDbInstanceRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() The tags to be assigned to the instance.
CreateDbInstanceRequest.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 instance identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• The first character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Returns:

The instance identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• The first character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

dbInstanceClass

public final String dbInstanceClass()

The compute and memory capacity of the instance; for example, db.r5.large.

Returns:

The compute and memory capacity of the instance; for example, db.r5.large.

engine

public final String engine()

The name of the database engine to be used for this instance.

Valid value: docdb

Returns:

The name of the database engine to be used for this instance.

Valid value: docdb

availabilityZone

public final String availabilityZone()

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

Returns:

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

preferredMaintenanceWindow

public final String preferredMaintenanceWindow()

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

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Returns:

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

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

autoMinorVersionUpgrade

public final Boolean autoMinorVersionUpgrade()

Indicates that minor engine upgrades are applied automatically to the instance during the maintenance window.

Default: true

Returns:

Indicates that minor engine upgrades are applied automatically to the instance during the maintenance window.

Default: true

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<Tag> tags()

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

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

You can use hasTags() to see if a value was sent in this field.

Returns:

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

dbClusterIdentifier

public final String dbClusterIdentifier()

The identifier of the cluster that the instance will belong to.

Returns:

The identifier of the cluster that the instance will belong to.

promotionTier

public final Integer promotionTier()

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

Returns:

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

toBuilder

public CreateDbInstanceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDbInstanceRequest.Builder,CreateDbInstanceRequest>

Specified by:

toBuilder in class DocDbRequest

builder

public static CreateDbInstanceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateDbInstanceRequest.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