@Generated(value="software.amazon.awssdk:codegen") public final class CreateDbInstanceRequest extends NeptuneRequest implements ToCopyableBuilder<CreateDbInstanceRequest.Builder,CreateDbInstanceRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateDbInstanceRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
Integer |
allocatedStorage()
The amount of storage (in gibibytes) to allocate for the DB instance.
|
Boolean |
autoMinorVersionUpgrade()
Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
|
String |
availabilityZone()
The EC2 Availability Zone that the DB instance is created in
|
Integer |
backupRetentionPeriod()
The number of days for which automated backups are retained.
|
static CreateDbInstanceRequest.Builder |
builder() |
String |
characterSetName()
(Not supported by Neptune)
|
Boolean |
copyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.
|
String |
dbClusterIdentifier()
The identifier of the DB cluster that the instance will belong to.
|
String |
dbInstanceClass()
The compute and memory capacity of the DB instance, for example,
db.m4.large. |
String |
dbInstanceIdentifier()
The DB instance identifier.
|
String |
dbName()
Not supported.
|
String |
dbParameterGroupName()
The name of the DB parameter group to associate with this DB instance.
|
List<String> |
dbSecurityGroups()
A list of DB security groups to associate with this DB instance.
|
String |
dbSubnetGroupName()
A DB subnet group to associate with this DB instance.
|
Boolean |
deletionProtection()
A value that indicates whether the DB instance has deletion protection enabled.
|
String |
domain()
Specify the Active Directory Domain to create the instance in.
|
String |
domainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
List<String> |
enableCloudwatchLogsExports()
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
Boolean |
enableIAMDatabaseAuthentication()
True to enable AWS Identity and Access Management (IAM) authentication for Neptune.
|
Boolean |
enablePerformanceInsights()
(Not supported by Neptune)
|
String |
engine()
The name of the database engine to be used for this instance.
|
String |
engineVersion()
The version number of the database engine to use.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasDbSecurityGroups()
Returns true if the DBSecurityGroups property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasEnableCloudwatchLogsExports()
Returns true if the EnableCloudwatchLogsExports property was specified by the sender (it may be empty), or false
if the sender did not specify the value (it will be empty).
|
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).
|
boolean |
hasVpcSecurityGroupIds()
Returns true if the VpcSecurityGroupIds property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
Integer |
iops()
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance.
|
String |
kmsKeyId()
The AWS KMS key identifier for an encrypted DB instance.
|
String |
licenseModel()
License model information for this DB instance.
|
String |
masterUsername()
The name for the master user.
|
String |
masterUserPassword()
The password for the master user.
|
Integer |
monitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
String |
monitoringRoleArn()
The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs.
|
Boolean |
multiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
|
String |
optionGroupName()
(Not supported by Neptune)
|
String |
performanceInsightsKMSKeyId()
(Not supported by Neptune)
|
Integer |
port()
The port number on which the database accepts connections.
|
String |
preferredBackupWindow()
The daily time range during which automated backups are created.
|
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 Read Replica is promoted to the primary instance after a failure of
the existing primary instance.
|
Boolean |
publiclyAccessible()
This flag should no longer be used.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateDbInstanceRequest.Builder> |
serializableBuilderClass() |
Boolean |
storageEncrypted()
Specifies whether the DB instance is encrypted.
|
String |
storageType()
Specifies the storage type to be associated with the DB instance.
|
List<Tag> |
tags()
The tags to assign to the new instance.
|
String |
tdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
|
String |
tdeCredentialPassword()
The password for the given ARN from the key store in order to access the device.
|
String |
timezone()
The time zone of the DB instance.
|
CreateDbInstanceRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
List<String> |
vpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB instance.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String dbName()
Not supported.
public final String dbInstanceIdentifier()
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
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.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
public final Integer allocatedStorage()
The amount of storage (in gibibytes) to allocate for the DB instance.
Type: Integer
Not applicable. Neptune cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in a Neptune cluster volume.
Type: Integer
Not applicable. Neptune cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in a Neptune cluster volume.
public final String dbInstanceClass()
The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance
classes are available in all AWS Regions.
db.m4.large. Not all DB
instance classes are available in all AWS Regions.public final String engine()
The name of the database engine to be used for this instance.
Valid Values: neptune
Valid Values: neptune
public final String masterUsername()
The name for the master user. Not used.
public final String masterUserPassword()
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Not used.
Not used.
public final boolean hasDbSecurityGroups()
public final List<String> dbSecurityGroups()
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDbSecurityGroups() to see if a value was sent in this field.
Default: The default DB security group for the database engine.
public final boolean hasVpcSecurityGroupIds()
public final List<String> vpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB instance.
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasVpcSecurityGroupIds() to see if a value was sent in this field.
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
public final String availabilityZone()
The EC2 Availability Zone that the DB 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.
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.
public final String dbSubnetGroupName()
A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
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.
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.
public final String dbParameterGroupName()
The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
public final Integer backupRetentionPeriod()
The number of days for which automated backups are retained.
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: 1
Constraints:
Must be a value from 0 to 35
Cannot be set to 0 if the DB instance is a source to Read Replicas
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: 1
Constraints:
Must be a value from 0 to 35
Cannot be set to 0 if the DB instance is a source to Read Replicas
public final String preferredBackupWindow()
The daily time range during which automated backups are created.
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
public final Integer port()
The port number on which the database accepts connections.
Not applicable. The port is managed by the DB cluster. For more information, see CreateDBCluster.
Default: 8182
Type: Integer
Not applicable. The port is managed by the DB cluster. For more information, see CreateDBCluster.
Default: 8182
Type: Integer
public final Boolean multiAZ()
Specifies if the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
public final String engineVersion()
The version number of the database engine to use. Currently, setting this parameter has no effect.
public final Boolean autoMinorVersionUpgrade()
Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
Default: true
Default: true
public final String licenseModel()
License model information for this DB instance.
Valid values: license-included | bring-your-own-license |
general-public-license
Valid values: license-included | bring-your-own-license |
general-public-license
public final Integer iops()
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
public final String optionGroupName()
(Not supported by Neptune)
public final String characterSetName()
(Not supported by Neptune)
public final Boolean publiclyAccessible()
This flag should no longer be used.
public final boolean hasTags()
public final List<Tag> tags()
The tags to assign to the new 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.
public final String dbClusterIdentifier()
The identifier of the DB cluster that the instance will belong to.
For information on creating a DB cluster, see CreateDBCluster.
Type: String
For information on creating a DB cluster, see CreateDBCluster.
Type: String
public final String storageType()
Specifies the storage type to be associated with the DB instance.
Not applicable. Storage is managed by the DB Cluster.
Not applicable. Storage is managed by the DB Cluster.
public final String tdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
public final String tdeCredentialPassword()
The password for the given ARN from the key store in order to access the device.
public final Boolean storageEncrypted()
Specifies whether the DB instance is encrypted.
Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.
Default: false
Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.
Default: false
public final String kmsKeyId()
The AWS KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.
If the StorageEncrypted parameter is true, and you do not specify a value for the
KmsKeyId parameter, then Amazon Neptune will use your default encryption key. AWS KMS creates the
default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS
Region.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.
If the StorageEncrypted parameter is true, and you do not specify a value for the
KmsKeyId parameter, then Amazon Neptune will use your default encryption key. AWS KMS
creates the default encryption key for your AWS account. Your AWS account has a different default
encryption key for each AWS Region.
public final String domain()
Specify the Active Directory Domain to create the instance in.
public final Boolean copyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.
public final Integer monitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value
other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to
a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
public final String monitoringRoleArn()
The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess.
If MonitoringInterval is set to a value other than 0, then you must supply a
MonitoringRoleArn value.
arn:aws:iam:123456789012:role/emaccess.
If MonitoringInterval is set to a value other than 0, then you must supply a
MonitoringRoleArn value.
public final String domainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
public final Integer promotionTier()
A value that specifies the order in which an Read 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 final String timezone()
The time zone of the DB instance.
public final Boolean enableIAMDatabaseAuthentication()
True to enable AWS Identity and Access Management (IAM) authentication for Neptune.
Default: false
Default: false
public final Boolean enablePerformanceInsights()
(Not supported by Neptune)
public final String performanceInsightsKMSKeyId()
(Not supported by Neptune)
public final boolean hasEnableCloudwatchLogsExports()
public final List<String> enableCloudwatchLogsExports()
The list of log types that need to be enabled for exporting to CloudWatch Logs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasEnableCloudwatchLogsExports() to see if a value was sent in this field.
public final Boolean deletionProtection()
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. See Deleting a DB Instance.
DB instances in a DB cluster can be deleted even when deletion protection is enabled in their parent DB cluster.
DB instances in a DB cluster can be deleted even when deletion protection is enabled in their parent DB cluster.
public CreateDbInstanceRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateDbInstanceRequest.Builder,CreateDbInstanceRequest>toBuilder in class NeptuneRequestpublic static CreateDbInstanceRequest.Builder builder()
public static Class<? extends CreateDbInstanceRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2021. All rights reserved.