@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateDBInstanceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input to CreateDBInstance.
NOOP
Constructor and Description |
---|
CreateDBInstanceRequest() |
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()
This parameter does not apply to Amazon DocumentDB.
|
String |
getAvailabilityZone()
The Amazon EC2 Availability Zone that the instance is created in.
|
String |
getCACertificateIdentifier()
The CA certificate identifier to use for the DB instance's server certificate.
|
Boolean |
getCopyTagsToSnapshot()
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
|
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.
|
Boolean |
getEnablePerformanceInsights()
A value that indicates whether to enable Performance Insights for the DB Instance.
|
String |
getEngine()
The name of the database engine to be used for this instance.
|
String |
getPerformanceInsightsKMSKeyId()
The KMS key identifier for encryption of Performance Insights data.
|
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()
This parameter does not apply to Amazon DocumentDB.
|
Boolean |
isCopyTagsToSnapshot()
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
|
Boolean |
isEnablePerformanceInsights()
A value that indicates whether to enable Performance Insights for the DB Instance.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter does not apply to Amazon DocumentDB.
|
void |
setAvailabilityZone(String availabilityZone)
The Amazon EC2 Availability Zone that the instance is created in.
|
void |
setCACertificateIdentifier(String cACertificateIdentifier)
The CA certificate identifier to use for the DB instance's server certificate.
|
void |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
|
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 |
setEnablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to enable Performance Insights for the DB Instance.
|
void |
setEngine(String engine)
The name of the database engine to be used for this instance.
|
void |
setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The KMS key identifier for encryption of Performance Insights data.
|
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)
This parameter does not apply to Amazon DocumentDB.
|
CreateDBInstanceRequest |
withAvailabilityZone(String availabilityZone)
The Amazon EC2 Availability Zone that the instance is created in.
|
CreateDBInstanceRequest |
withCACertificateIdentifier(String cACertificateIdentifier)
The CA certificate identifier to use for the DB instance's server certificate.
|
CreateDBInstanceRequest |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
|
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 |
withEnablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to enable Performance Insights for the DB Instance.
|
CreateDBInstanceRequest |
withEngine(String engine)
The name of the database engine to be used for this instance.
|
CreateDBInstanceRequest |
withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The KMS key identifier for encryption of Performance Insights data.
|
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.
|
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
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
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
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
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
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
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
public void setDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the instance; for example, db.r5.large
.
dBInstanceClass
- The compute and memory capacity of the instance; for example, db.r5.large
.public String getDBInstanceClass()
The compute and memory capacity of the instance; for example, db.r5.large
.
db.r5.large
.public CreateDBInstanceRequest withDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the instance; for example, db.r5.large
.
dBInstanceClass
- The compute and memory capacity of the instance; for example, db.r5.large
.public void setEngine(String engine)
The name of the database engine to be used for this instance.
Valid value: docdb
engine
- The name of the database engine to be used for this instance.
Valid value: docdb
public String getEngine()
The name of the database engine to be used for this instance.
Valid value: docdb
Valid value: docdb
public CreateDBInstanceRequest withEngine(String engine)
The name of the database engine to be used for this instance.
Valid value: docdb
engine
- The name of the database engine to be used for this instance.
Valid value: docdb
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 Amazon Web Services Region.
Example: us-east-1d
availabilityZone
- The Amazon EC2 Availability Zone that the instance is created in.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
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 Amazon Web Services Region.
Example: us-east-1d
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
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 Amazon Web Services Region.
Example: us-east-1d
availabilityZone
- The Amazon EC2 Availability Zone that the instance is created in.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
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 Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
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 Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
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 Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
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 Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
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 Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
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 Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
Default: false
autoMinorVersionUpgrade
- This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version
upgrades regardless of the value set.
Default: false
public Boolean getAutoMinorVersionUpgrade()
This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
Default: false
Default: false
public CreateDBInstanceRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
Default: false
autoMinorVersionUpgrade
- This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version
upgrades regardless of the value set.
Default: false
public Boolean isAutoMinorVersionUpgrade()
This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
Default: false
Default: false
public List<Tag> getTags()
The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
public void setTags(Collection<Tag> tags)
The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
tags
- The tags to be assigned to the instance. You can assign up to 10 tags to an instance.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.
tags
- The tags to be assigned to the instance. You can assign up to 10 tags to an instance.public CreateDBInstanceRequest withTags(Collection<Tag> tags)
The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
tags
- The tags to be assigned to the instance. You can assign up to 10 tags to an instance.public void setDBClusterIdentifier(String dBClusterIdentifier)
The identifier of the cluster that the instance will belong to.
dBClusterIdentifier
- The identifier of the cluster that the instance will belong to.public String getDBClusterIdentifier()
The identifier of the cluster that the instance will belong to.
public CreateDBInstanceRequest withDBClusterIdentifier(String dBClusterIdentifier)
The identifier of the cluster that the instance will belong to.
dBClusterIdentifier
- The identifier of the cluster that the instance will belong to.public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
copyTagsToSnapshot
- A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By
default, tags are not copied.public Boolean getCopyTagsToSnapshot()
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
public CreateDBInstanceRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
copyTagsToSnapshot
- A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By
default, tags are not copied.public Boolean isCopyTagsToSnapshot()
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
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
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
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
Default: 1
Valid values: 0-15
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
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
public void setEnablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.
enablePerformanceInsights
- A value that indicates whether to enable Performance Insights for the DB Instance. For more information,
see Using
Amazon Performance Insights.public Boolean getEnablePerformanceInsights()
A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.
public CreateDBInstanceRequest withEnablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.
enablePerformanceInsights
- A value that indicates whether to enable Performance Insights for the DB Instance. For more information,
see Using
Amazon Performance Insights.public Boolean isEnablePerformanceInsights()
A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.
public void setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
performanceInsightsKMSKeyId
- The KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
public String getPerformanceInsightsKMSKeyId()
The KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
public CreateDBInstanceRequest withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
performanceInsightsKMSKeyId
- The KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
public void setCACertificateIdentifier(String cACertificateIdentifier)
The CA certificate identifier to use for the DB instance's server certificate.
For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.
cACertificateIdentifier
- The CA certificate identifier to use for the DB instance's server certificate.
For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.
public String getCACertificateIdentifier()
The CA certificate identifier to use for the DB instance's server certificate.
For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.
For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.
public CreateDBInstanceRequest withCACertificateIdentifier(String cACertificateIdentifier)
The CA certificate identifier to use for the DB instance's server certificate.
For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.
cACertificateIdentifier
- The CA certificate identifier to use for the DB instance's server certificate.
For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.
public String toString()
toString
in class Object
Object.toString()
public CreateDBInstanceRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Privacy | Site terms | Cookie preferences | © 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.