Package software.amazon.awssdk.services.docdb.model

Class CreateDbClusterRequest

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.CreateDbClusterRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDbClusterRequest extends DocDbRequest implements ToCopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>

Represents the input to CreateDBCluster.

  • Method Details

    • hasAvailabilityZones

      public final boolean hasAvailabilityZones()
      For responses, this returns true if the service returned a value for the AvailabilityZones 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.

    • availabilityZones

      public final List<String> availabilityZones()

      A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

      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 hasAvailabilityZones() method.

      Returns:
      A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

    • backupRetentionPeriod

      public final Integer backupRetentionPeriod()

      The number of days for which automated backups are retained. You must specify a minimum value of 1.

      Default: 1

      Constraints:

      • Must be a value from 1 to 35.

      Returns:
      The number of days for which automated backups are retained. You must specify a minimum value of 1.

      Default: 1

      Constraints:

      • Must be a value from 1 to 35.

    • dbClusterIdentifier

      public final String dbClusterIdentifier()

      The cluster 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: my-cluster

      Returns:
      The cluster 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: my-cluster

    • dbClusterParameterGroupName

      public final String dbClusterParameterGroupName()

      The name of the cluster parameter group to associate with this cluster.

      Returns:
      The name of the cluster parameter group to associate with this cluster.

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

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

    • dbSubnetGroupName

      public final String dbSubnetGroupName()

      A subnet group to associate with this cluster.

      Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

      Example: mySubnetgroup

      Returns:
      A subnet group to associate with this cluster.

      Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

      Example: mySubnetgroup

    • engine

      public final String engine()

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

      Valid values: docdb

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

      Valid values: docdb

    • engineVersion

      public final String engineVersion()

      The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

      Returns:
      The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

    • port

      public final Integer port()

      The port number on which the instances in the cluster accept connections.

      Returns:
      The port number on which the instances in the cluster accept connections.

    • masterUsername

      public final String masterUsername()

      The name of the master user for the cluster.

      Constraints:

      • Must be from 1 to 63 letters or numbers.

      • The first character must be a letter.

      • Cannot be a reserved word for the chosen database engine.

      Returns:
      The name of the master user for the cluster.

      Constraints:

      • Must be from 1 to 63 letters or numbers.

      • The first character must be a letter.

      • Cannot be a reserved word for the chosen database engine.

    • masterUserPassword

      public final String masterUserPassword()

      The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

      Constraints: Must contain from 8 to 100 characters.

      Returns:
      The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

      Constraints: Must contain from 8 to 100 characters.

    • preferredBackupWindow

      public final String preferredBackupWindow()

      The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

      The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi.

      • Must be in Universal Coordinated Time (UTC).

      • Must not conflict with the preferred maintenance window.

      • Must be at least 30 minutes.

      Returns:
      The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

      The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi.

      • Must be in Universal Coordinated Time (UTC).

      • Must not conflict with the preferred maintenance window.

      • Must be at least 30 minutes.

    • preferredMaintenanceWindow

      public final String preferredMaintenanceWindow()

      The weekly time range 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 weekly time range 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.

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

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

    • storageEncrypted

      public final Boolean storageEncrypted()

      Specifies whether the cluster is encrypted.

      Returns:
      Specifies whether the cluster is encrypted.

    • kmsKeyId

      public final String kmsKeyId()

      The KMS key identifier for an encrypted cluster.

      The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.

      If an encryption key is not specified in KmsKeyId:

      • If the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.

      KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.

      Returns:
      The KMS key identifier for an encrypted cluster.

      The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.

      If an encryption key is not specified in KmsKeyId:

      • If the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.

      KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.

    • preSignedUrl

      public final String preSignedUrl()

      Not currently supported.

      Returns:
      Not currently supported.

    • 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()

      A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.

      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:
      A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.

    • deletionProtection

      public final Boolean deletionProtection()

      Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

      Returns:
      Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

    • globalClusterIdentifier

      public final String globalClusterIdentifier()

      The cluster identifier of the new global cluster.

      Returns:
      The cluster identifier of the new global cluster.

    • sourceRegion

      public final String sourceRegion()
      If PreSignedUrl is not specified, this is the region where the source snapshot is located. A PreSignedUrl will be generated automatically by the SDK.
      Returns:
      If PreSignedUrl is not specified, this is the region where the source snapshot is located. A PreSignedUrl will be generated automatically by the SDK.

    • toBuilder

      public CreateDbClusterRequest.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<CreateDbClusterRequest.Builder,CreateDbClusterRequest>
      Specified by:
      toBuilder in class DocDbRequest
      Returns:
      a builder for type T

    • builder

      public static CreateDbClusterRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateDbClusterRequest.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.