@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()
Indicates that the DB instance should be associated with the specified CharacterSet.
|
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()
The database name.
|
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.
|
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()
True to enable Performance Insights for the DB instance, and otherwise false.
|
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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
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()
Indicates that the DB instance should be associated with the specified option group.
|
String |
performanceInsightsKMSKeyId()
The AWS KMS key identifier for encryption of Performance Insights data.
|
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 parameter is not supported.
|
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()
Returns the value of the Tags property for this object.
|
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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
List<String> |
vpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB instance.
|
overrideConfiguration
copy
public String dbName()
The database name.
Type: String
Type: String
public 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 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 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 String engine()
The name of the database engine to be used for this instance.
Valid Values: neptune
Valid Values: neptune
public String masterUsername()
The name for the master user. Not used.
public String masterUserPassword()
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Not used.
Not used.
public 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.
Default: The default DB security group for the database engine.
public 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.
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 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 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 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 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 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 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 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 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 String engineVersion()
The version number of the database engine to use.
public Boolean autoMinorVersionUpgrade()
Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
Default: true
Default: true
public 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 Integer iops()
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
public String optionGroupName()
Indicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
public String characterSetName()
Indicates that the DB instance should be associated with the specified CharacterSet.
Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
public Boolean publiclyAccessible()
This parameter is not supported.
public List<Tag> tags()
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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 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 String tdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
public String tdeCredentialPassword()
The password for the given ARN from the key store in order to access the device.
public 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 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 String domain()
Specify the Active Directory Domain to create the instance in.
public 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 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 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 String domainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
public 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 String timezone()
The time zone of the DB instance.
public Boolean enableIAMDatabaseAuthentication()
True to enable AWS Identity and Access Management (IAM) authentication for Neptune.
Default: false
Default: false
public Boolean enablePerformanceInsights()
True to enable Performance Insights for the DB instance, and otherwise false.
public String performanceInsightsKMSKeyId()
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
public 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.
public CreateDbInstanceRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateDbInstanceRequest.Builder,CreateDbInstanceRequest>
toBuilder
in class NeptuneRequest
public static CreateDbInstanceRequest.Builder builder()
public static Class<? extends CreateDbInstanceRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.