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>

  • Method Details

    • 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 the isEmpty() 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 the isEmpty() 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-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 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-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 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:mi

      The 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:mi

      The 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: 8182

      Type: 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: 8182

      Type: 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 the isEmpty() 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()

      Not applicable. In Neptune the storage type is managed at the DB Cluster level.

      Returns:
      Not applicable. In Neptune the storage type is managed at the DB Cluster level.

    • 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 StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, 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 StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, 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 MonitoringRoleArn is specified, then you must also set MonitoringInterval to 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 MonitoringRoleArn is specified, then you must also set MonitoringInterval to 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 MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

      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 MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

    • 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 the isEmpty() 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateDbInstanceRequest.Builder,CreateDbInstanceRequest>
      Specified by:
      toBuilder in class NeptuneRequest
      Returns:
      a builder for type T

    • builder

      public static CreateDbInstanceRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateDbInstanceRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends 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.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.