Class CreateDbInstanceRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.neptune.model.NeptuneRequest
-
- software.amazon.awssdk.services.neptune.model.CreateDbInstanceRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateDbInstanceRequest.Builder,CreateDbInstanceRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDbInstanceRequest extends NeptuneRequest implements ToCopyableBuilder<CreateDbInstanceRequest.Builder,CreateDbInstanceRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateDbInstanceRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IntegerallocatedStorage()Not supported by Neptune.BooleanautoMinorVersionUpgrade()Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.StringavailabilityZone()The EC2 Availability Zone that the DB instance is created inIntegerbackupRetentionPeriod()The number of days for which automated backups are retained.static CreateDbInstanceRequest.Builderbuilder()StringcharacterSetName()(Not supported by Neptune)BooleancopyTagsToSnapshot()True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.StringdbClusterIdentifier()The identifier of the DB cluster that the instance will belong to.StringdbInstanceClass()The compute and memory capacity of the DB instance, for example,db.m4.large.StringdbInstanceIdentifier()The DB instance identifier.StringdbName()Not supported.StringdbParameterGroupName()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.StringdbSubnetGroupName()A DB subnet group to associate with this DB instance.BooleandeletionProtection()A value that indicates whether the DB instance has deletion protection enabled.Stringdomain()Specify the Active Directory Domain to create the instance in.StringdomainIAMRoleName()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.BooleanenableIAMDatabaseAuthentication()Not supported by Neptune (ignored).BooleanenablePerformanceInsights()(Not supported by Neptune)Stringengine()The name of the database engine to be used for this instance.StringengineVersion()The version number of the database engine to use.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasDbSecurityGroups()For responses, this returns true if the service returned a value for the DBSecurityGroups property.booleanhasEnableCloudwatchLogsExports()For responses, this returns true if the service returned a value for the EnableCloudwatchLogsExports property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.booleanhasVpcSecurityGroupIds()For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.Integeriops()The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.StringkmsKeyId()The Amazon KMS key identifier for an encrypted DB instance.StringlicenseModel()License model information for this DB instance.StringmasterUsername()Not supported by Neptune.StringmasterUserPassword()Not supported by Neptune.IntegermonitoringInterval()The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.StringmonitoringRoleArn()The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs.BooleanmultiAZ()Specifies if the DB instance is a Multi-AZ deployment.StringoptionGroupName()(Not supported by Neptune)StringperformanceInsightsKMSKeyId()(Not supported by Neptune)Integerport()The port number on which the database accepts connections.StringpreferredBackupWindow()The daily time range during which automated backups are created.StringpreferredMaintenanceWindow()The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).IntegerpromotionTier()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.BooleanpubliclyAccessible()Deprecated.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateDbInstanceRequest.Builder>serializableBuilderClass()BooleanstorageEncrypted()Specifies whether the DB instance is encrypted.StringstorageType()Specifies the storage type to be associated with the DB instance.List<Tag>tags()The tags to assign to the new instance.StringtdeCredentialArn()The ARN from the key store with which to associate the instance for TDE encryption.StringtdeCredentialPassword()The password for the given ARN from the key store in order to access the device.Stringtimezone()The time zone of the DB instance.CreateDbInstanceRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<String>vpcSecurityGroupIds()A list of EC2 VPC security groups to associate with this DB instance.-
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
-
dbName
public final String dbName()
Not supported.
- Returns:
- Not supported.
-
dbInstanceIdentifier
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- Returns:
- 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 -
-
-
allocatedStorage
public final Integer allocatedStorage()
Not supported by Neptune.
- Returns:
- Not supported by Neptune.
-
dbInstanceClass
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 Amazon Regions.- Returns:
- The compute and memory capacity of the DB instance, for example,
db.m4.large. Not all DB instance classes are available in all Amazon Regions.
-
engine
public final String engine()
The name of the database engine to be used for this instance.
Valid Values:
neptune- Returns:
- The name of the database engine to be used for this instance.
Valid Values:
neptune
-
masterUsername
public final String masterUsername()
Not supported by Neptune.
- Returns:
- Not supported by Neptune.
-
masterUserPassword
public final String masterUserPassword()
Not supported by Neptune.
- Returns:
- Not supported by Neptune.
-
hasDbSecurityGroups
public final boolean hasDbSecurityGroups()
For responses, this returns true if the service returned a value for the DBSecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
dbSecurityGroups
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDbSecurityGroups()method.- Returns:
- A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
-
hasVpcSecurityGroupIds
public final boolean hasVpcSecurityGroupIds()
For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
vpcSecurityGroupIds
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasVpcSecurityGroupIds()method.- Returns:
- 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.
-
availabilityZone
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 Amazon Region.
Example:
us-east-1dConstraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to
true. The specified Availability Zone must be in the same Amazon Region as the current endpoint.- Returns:
- The EC2 Availability Zone that the DB instance is created in
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Region.
Example:
us-east-1dConstraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to
true. The specified Availability Zone must be in the same Amazon Region as the current endpoint.
-
dbSubnetGroupName
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.
- Returns:
- 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.
-
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:miThe default is a 30-minute window selected at random from an 8-hour block of time for each Amazon 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:miThe default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
-
dbParameterGroupName
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
- Returns:
- 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
-
-
-
backupRetentionPeriod
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
- Returns:
- 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
-
-
-
preferredBackupWindow
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.
- Returns:
- 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.
-
port
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:
8182Type: Integer
- Returns:
- 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:
8182Type: Integer
-
multiAZ
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.
- Returns:
- 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.
-
engineVersion
public final String engineVersion()
The version number of the database engine to use. Currently, setting this parameter has no effect.
- Returns:
- The version number of the database engine to use. Currently, setting this parameter has no effect.
-
autoMinorVersionUpgrade
public final Boolean autoMinorVersionUpgrade()
Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
Default:
true- Returns:
- Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance
window.
Default:
true
-
licenseModel
public final String licenseModel()
License model information for this DB instance.
Valid values:
license-included|bring-your-own-license|general-public-license- Returns:
- License model information for this DB instance.
Valid values:
license-included|bring-your-own-license|general-public-license
-
iops
public final Integer iops()
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
- Returns:
- The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
-
optionGroupName
public final String optionGroupName()
(Not supported by Neptune)
- Returns:
- (Not supported by Neptune)
-
characterSetName
public final String characterSetName()
(Not supported by Neptune)
- Returns:
- (Not supported by Neptune)
-
publiclyAccessible
@Deprecated public final Boolean publiclyAccessible()
Deprecated.This flag should no longer be used.
- Returns:
- This flag should no longer be used.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- The tags to assign to the new instance.
-
dbClusterIdentifier
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
- Returns:
- The identifier of the DB cluster that the instance will belong to.
For information on creating a DB cluster, see CreateDBCluster.
Type: String
-
storageType
public final String storageType()
Specifies the storage type to be associated with the DB instance.
Not applicable. Storage is managed by the DB Cluster.
- Returns:
- Specifies the storage type to be associated with the DB instance.
Not applicable. Storage is managed by the DB Cluster.
-
tdeCredentialArn
public final String tdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
- Returns:
- The ARN from the key store with which to associate the instance for TDE encryption.
-
tdeCredentialPassword
public final String tdeCredentialPassword()
The password for the given ARN from the key store in order to access the device.
- Returns:
- The password for the given ARN from the key store in order to access the device.
-
storageEncrypted
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
- Returns:
- 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
-
kmsKeyId
public final String kmsKeyId()
The Amazon 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 Amazon 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
StorageEncryptedparameter is true, and you do not specify a value for theKmsKeyIdparameter, then Amazon Neptune will use your default encryption key. Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region.- Returns:
- The Amazon 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 Amazon 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
StorageEncryptedparameter is true, and you do not specify a value for theKmsKeyIdparameter, then Amazon Neptune will use your default encryption key. Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region.
-
domain
public final String domain()
Specify the Active Directory Domain to create the instance in.
- Returns:
- Specify the Active Directory Domain to create the instance in.
-
copyTagsToSnapshot
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.
- Returns:
- True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.
-
monitoringInterval
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
MonitoringRoleArnis specified, then you must also setMonitoringIntervalto a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60- Returns:
- 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
MonitoringRoleArnis specified, then you must also setMonitoringIntervalto a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60
-
monitoringRoleArn
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
MonitoringIntervalis set to a value other than 0, then you must supply aMonitoringRoleArnvalue.- Returns:
- 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
MonitoringIntervalis set to a value other than 0, then you must supply aMonitoringRoleArnvalue.
-
domainIAMRoleName
public final String domainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
- Returns:
- Specify the name of the IAM role to be used when making API calls to the Directory Service.
-
promotionTier
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
- Returns:
- 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
-
timezone
public final String timezone()
The time zone of the DB instance.
- Returns:
- The time zone of the DB instance.
-
enableIAMDatabaseAuthentication
public final Boolean enableIAMDatabaseAuthentication()
Not supported by Neptune (ignored).
- Returns:
- Not supported by Neptune (ignored).
-
enablePerformanceInsights
public final Boolean enablePerformanceInsights()
(Not supported by Neptune)
- Returns:
- (Not supported by Neptune)
-
performanceInsightsKMSKeyId
public final String performanceInsightsKMSKeyId()
(Not supported by Neptune)
- Returns:
- (Not supported by Neptune)
-
hasEnableCloudwatchLogsExports
public final boolean hasEnableCloudwatchLogsExports()
For responses, this returns true if the service returned a value for the EnableCloudwatchLogsExports property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
enableCloudwatchLogsExports
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasEnableCloudwatchLogsExports()method.- Returns:
- The list of log types that need to be enabled for exporting to CloudWatch Logs.
-
deletionProtection
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.
- Returns:
- 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.
-
toBuilder
public CreateDbInstanceRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateDbInstanceRequest.Builder,CreateDbInstanceRequest>- Specified by:
toBuilderin classNeptuneRequest
-
builder
public static CreateDbInstanceRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateDbInstanceRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-