Class CreateDbInstanceRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.docdb.model.DocDbRequest
software.amazon.awssdk.services.docdb.model.CreateDbInstanceRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateDbInstanceRequest.Builder,CreateDbInstanceRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDbInstanceRequest extends DocDbRequest implements ToCopyableBuilder<CreateDbInstanceRequest.Builder,CreateDbInstanceRequest>

Represents the input to CreateDBInstance.

  • Method Details

    • dbInstanceIdentifier

      public final 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

      Returns:
      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

    • dbInstanceClass

      public final String dbInstanceClass()

      The compute and memory capacity of the instance; for example, db.r5.large.

      Returns:
      The compute and memory capacity of the instance; for example, db.r5.large.

    • engine

      public final String engine()

      The name of the database engine to be used for this instance.

      Valid value: docdb

      Returns:
      The name of the database engine to be used for this instance.

      Valid value: docdb

    • availabilityZone

      public final 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

      Returns:
      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

    • 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 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.

      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 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.

    • autoMinorVersionUpgrade

      public final 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

      Returns:
      This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

      Default: false

    • 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 be assigned to the instance. You can assign up to 10 tags to an 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 be assigned to the instance. You can assign up to 10 tags to an instance.

    • dbClusterIdentifier

      public final String dbClusterIdentifier()

      The identifier of the cluster that the instance will belong to.

      Returns:
      The identifier of the cluster that the instance will belong to.

    • copyTagsToSnapshot

      public final 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.

      Returns:
      A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

    • promotionTier

      public final 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

      Returns:
      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

    • enablePerformanceInsights

      public final Boolean enablePerformanceInsights()

      A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

      Returns:
      A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

    • performanceInsightsKMSKeyId

      public final 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.

      Returns:
      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.

    • caCertificateIdentifier

      public final 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.

      Returns:
      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.

    • 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 DocDbRequest
      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.