Package software.amazon.awssdk.services.neptune.model

Class CreateDbClusterRequest

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

  • 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 EC2 Availability Zones that instances in the DB 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 EC2 Availability Zones that instances in the DB 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

    • characterSetName

      public final String characterSetName()

      (Not supported by Neptune)

      Returns:
      (Not supported by Neptune)

    • copyTagsToSnapshot

      public final Boolean copyTagsToSnapshot()

      If set to true, tags are copied to any snapshot of the DB cluster that is created.

      Returns:
      If set to true, tags are copied to any snapshot of the DB cluster that is created.

    • databaseName

      public final String databaseName()

      The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating.

      Returns:
      The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating.

    • dbClusterIdentifier

      public final String dbClusterIdentifier()

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

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

    • dbClusterParameterGroupName

      public final String dbClusterParameterGroupName()

      The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used.

      Constraints:

      • If supplied, must match the name of an existing DBClusterParameterGroup.

      Returns:
      The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used.

      Constraints:

      • If supplied, must match the name of an existing DBClusterParameterGroup.

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

    • dbSubnetGroupName

      public final String dbSubnetGroupName()

      A DB subnet group to associate with this DB cluster.

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

      Example: mySubnetgroup

      Returns:
      A DB subnet group to associate with this DB 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 DB cluster.

      Valid Values: neptune

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

      Valid Values: neptune

    • engineVersion

      public final String engineVersion()

      The version number of the database engine to use for the new DB cluster.

      Example: 1.0.2.1

      Returns:
      The version number of the database engine to use for the new DB cluster.

      Example: 1.0.2.1

    • port

      public final Integer port()

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

      Default: 8182

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

      Default: 8182

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

    • optionGroupName

      public final String optionGroupName()

      (Not supported by Neptune)

      Returns:
      (Not supported by Neptune)

    • 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 Region. To see the time blocks available, see Neptune Maintenance Window in the Amazon Neptune User Guide.

      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 Region. To see the time blocks available, see Neptune Maintenance Window in the Amazon Neptune User Guide.

      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 Region, occurring on a random day of the week. To see the time blocks available, see Neptune Maintenance Window in the Amazon Neptune User Guide.

      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 Region, occurring on a random day of the week. To see the time blocks available, see Neptune Maintenance Window in the Amazon Neptune User Guide.

      Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

      Constraints: Minimum 30-minute window.

    • replicationSourceIdentifier

      public final String replicationSourceIdentifier()

      The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

      Returns:
      The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

    • 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 DB 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 assign to the new DB cluster.

    • storageEncrypted

      public final Boolean storageEncrypted()

      Specifies whether the DB cluster is encrypted.

      Returns:
      Specifies whether the DB cluster is encrypted.

    • kmsKeyId

      public final String kmsKeyId()

      The Amazon KMS key identifier for an encrypted DB cluster.

      The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then 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 ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key.

      • If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, 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.

      If you create a Read Replica of an encrypted DB cluster in another Amazon Region, you must set KmsKeyId to a KMS key ID that is valid in the destination Amazon Region. This key is used to encrypt the Read Replica in that Amazon Region.

      Returns:
      The Amazon KMS key identifier for an encrypted DB cluster.

      The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then 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 ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key.

      • If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, 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.

      If you create a Read Replica of an encrypted DB cluster in another Amazon Region, you must set KmsKeyId to a KMS key ID that is valid in the destination Amazon Region. This key is used to encrypt the Read Replica in that Amazon Region.

    • preSignedUrl

      public final String preSignedUrl()

      This parameter is not currently supported.

      Returns:
      This parameter is not currently supported.

    • enableIAMDatabaseAuthentication

      public final Boolean enableIAMDatabaseAuthentication()

      If set to true, enables Amazon Identity and Access Management (IAM) authentication for the entire DB cluster (this cannot be set at an instance level).

      Default: false.

      Returns:
      If set to true, enables Amazon Identity and Access Management (IAM) authentication for the entire DB cluster (this cannot be set at an instance level).

      Default: false.

    • 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 the log types that this DB cluster should export to CloudWatch Logs. Valid log types are: audit (to publish audit logs) and slowquery (to publish slow-query logs). See Publishing Neptune logs to Amazon 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:
      A list of the log types that this DB cluster should export to CloudWatch Logs. Valid log types are: audit (to publish audit logs) and slowquery (to publish slow-query logs). See Publishing Neptune logs to Amazon CloudWatch logs.

    • deletionProtection

      public final Boolean deletionProtection()

      A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is enabled.

      Returns:
      A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is enabled.

    • serverlessV2ScalingConfiguration

      public final ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration()

      Contains the scaling configuration of a Neptune Serverless DB cluster.

      For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

      Returns:
      Contains the scaling configuration of a Neptune Serverless DB cluster.

      For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

    • globalClusterIdentifier

      public final String globalClusterIdentifier()

      The ID of the Neptune global database to which this new DB cluster should be added.

      Returns:
      The ID of the Neptune global database to which this new DB cluster should be added.

    • storageType

      public final String storageType()

      The storage type to associate with the DB cluster.

      Valid Values:

      • standard | iopt1

      Default:

      • standard

      When you create a Neptune cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to standard.

      Returns:
      The storage type to associate with the DB cluster.

      Valid Values:

      • standard | iopt1

      Default:

      • standard

      When you create a Neptune cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to standard.

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