com.amazonaws.services.docdb.model

Class CreateDBInstanceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.docdb.model.CreateDBInstanceRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDBInstanceRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input to CreateDBInstance.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDBInstanceRequest()

Method Summary

Modifier and Type	Method and Description
CreateDBInstanceRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getAutoMinorVersionUpgrade() Indicates that minor engine upgrades are applied automatically to the instance during the maintenance window.
String	getAvailabilityZone() The Amazon EC2 Availability Zone that the instance is created in.
String	getDBClusterIdentifier() The identifier of the cluster that the instance will belong to.
String	getDBInstanceClass() The compute and memory capacity of the instance; for example, db.r5.large.
String	getDBInstanceIdentifier() The instance identifier.
String	getEngine() The name of the database engine to be used for this instance.
String	getPreferredMaintenanceWindow() The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
Integer	getPromotionTier() 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<Tag>	getTags() The tags to be assigned to the instance.
int	hashCode()
Boolean	isAutoMinorVersionUpgrade() Indicates that minor engine upgrades are applied automatically to the instance during the maintenance window.
void	setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Indicates that minor engine upgrades are applied automatically to the instance during the maintenance window.
void	setAvailabilityZone(String availabilityZone) The Amazon EC2 Availability Zone that the instance is created in.
void	setDBClusterIdentifier(String dBClusterIdentifier) The identifier of the cluster that the instance will belong to.
void	setDBInstanceClass(String dBInstanceClass) The compute and memory capacity of the instance; for example, db.r5.large.
void	setDBInstanceIdentifier(String dBInstanceIdentifier) The instance identifier.
void	setEngine(String engine) The name of the database engine to be used for this instance.
void	setPreferredMaintenanceWindow(String preferredMaintenanceWindow) The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
void	setPromotionTier(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.
void	setTags(Collection<Tag> tags) The tags to be assigned to the instance.
String	toString() Returns a string representation of this object.
CreateDBInstanceRequest	withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Indicates that minor engine upgrades are applied automatically to the instance during the maintenance window.
CreateDBInstanceRequest	withAvailabilityZone(String availabilityZone) The Amazon EC2 Availability Zone that the instance is created in.
CreateDBInstanceRequest	withDBClusterIdentifier(String dBClusterIdentifier) The identifier of the cluster that the instance will belong to.
CreateDBInstanceRequest	withDBInstanceClass(String dBInstanceClass) The compute and memory capacity of the instance; for example, db.r5.large.
CreateDBInstanceRequest	withDBInstanceIdentifier(String dBInstanceIdentifier) The instance identifier.
CreateDBInstanceRequest	withEngine(String engine) The name of the database engine to be used for this instance.
CreateDBInstanceRequest	withPreferredMaintenanceWindow(String preferredMaintenanceWindow) The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
CreateDBInstanceRequest	withPromotionTier(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.
CreateDBInstanceRequest	withTags(Collection<Tag> tags) The tags to be assigned to the instance.
CreateDBInstanceRequest	withTags(Tag... tags) The tags to be assigned to the instance.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDBInstanceRequest

public CreateDBInstanceRequest()

Method Detail

setDBInstanceIdentifier

public void setDBInstanceIdentifier(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

Parameters:

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

getDBInstanceIdentifier

public String getDBInstanceIdentifier()

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

withDBInstanceIdentifier

public CreateDBInstanceRequest withDBInstanceIdentifier(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

Parameters:

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:

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

setDBInstanceClass

public void setDBInstanceClass(String dBInstanceClass)

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

Parameters:

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

getDBInstanceClass

public String getDBInstanceClass()

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.

withDBInstanceClass

public CreateDBInstanceRequest withDBInstanceClass(String dBInstanceClass)

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

Parameters:

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

Returns:

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

setEngine

public void setEngine(String engine)

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

Valid value: docdb

Parameters:

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

Valid value: docdb

getEngine

public String getEngine()

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

withEngine

public CreateDBInstanceRequest withEngine(String engine)

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

Valid value: docdb

Parameters:

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

Valid value: docdb

Returns:

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

setAvailabilityZone

public void setAvailabilityZone(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

Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

Parameters:

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

Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

getAvailabilityZone

public String getAvailabilityZone()

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

Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

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

Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

withAvailabilityZone

public CreateDBInstanceRequest withAvailabilityZone(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

Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

Parameters:

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

Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

Returns:

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

setPreferredMaintenanceWindow

public void setPreferredMaintenanceWindow(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.

Parameters:

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.

getPreferredMaintenanceWindow

public String getPreferredMaintenanceWindow()

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.

withPreferredMaintenanceWindow

public CreateDBInstanceRequest withPreferredMaintenanceWindow(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.

Parameters:

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:

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

setAutoMinorVersionUpgrade

public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

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

Default: true

Parameters:

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

Default: true

getAutoMinorVersionUpgrade

public Boolean getAutoMinorVersionUpgrade()

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

withAutoMinorVersionUpgrade

public CreateDBInstanceRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

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

Default: true

Parameters:

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

Default: true

Returns:

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

isAutoMinorVersionUpgrade

public Boolean isAutoMinorVersionUpgrade()

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

getTags

public List<Tag> getTags()

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

Returns:

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

setTags

public void setTags(Collection<Tag> tags)

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

Parameters:

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

withTags

public CreateDBInstanceRequest withTags(Tag... tags)

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

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

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

withTags

public CreateDBInstanceRequest withTags(Collection<Tag> tags)

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

Parameters:

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

Returns:

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

setDBClusterIdentifier

public void setDBClusterIdentifier(String dBClusterIdentifier)

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

Parameters:

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

getDBClusterIdentifier

public String getDBClusterIdentifier()

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

Returns:

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

withDBClusterIdentifier

public CreateDBInstanceRequest withDBClusterIdentifier(String dBClusterIdentifier)

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

Parameters:

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

Returns:

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

setPromotionTier

public void setPromotionTier(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

Parameters:

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

getPromotionTier

public Integer getPromotionTier()

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

withPromotionTier

public CreateDBInstanceRequest withPromotionTier(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

Parameters:

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:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateDBInstanceRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()