CreateDbClusterRequest (AWS Java SDK :: Services

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(value="software.amazon.awssdk:codegen")
public final class CreateDbClusterRequest
extends NeptuneRequest
implements ToCopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateDbClusterRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateDbClusterRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`availabilityZones()` A list of EC2 Availability Zones that instances in the DB cluster can be created in.
`Integer`	`backupRetentionPeriod()` The number of days for which automated backups are retained.
`static CreateDbClusterRequest.Builder`	`builder()`
`String`	`characterSetName()` (Not supported by Neptune)
`Boolean`	`copyTagsToSnapshot()` If set to `true`, tags are copied to any snapshot of the DB cluster that is created.
`String`	`databaseName()` The name for your database of up to 64 alpha-numeric characters.
`String`	`dbClusterIdentifier()` The DB cluster identifier.
`String`	`dbClusterParameterGroupName()` The name of the DB cluster parameter group to associate with this DB cluster.
`String`	`dbSubnetGroupName()` A DB subnet group to associate with this DB cluster.
`Boolean`	`deletionProtection()` A value that indicates whether the DB cluster has deletion protection enabled.
`List<String>`	`enableCloudwatchLogsExports()` The list of log types that need to be enabled for exporting to CloudWatch Logs.
`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).
`String`	`engine()` The name of the database engine to be used for this DB cluster.
`String`	`engineVersion()` The version number of the database engine to use for the new DB cluster.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAvailabilityZones()` Returns true if the AvailabilityZones property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasEnableCloudwatchLogsExports()` Returns true if the EnableCloudwatchLogsExports property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasVpcSecurityGroupIds()` Returns true if the VpcSecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`kmsKeyId()` The Amazon KMS key identifier for an encrypted DB cluster.
`String`	`masterUsername()` Not supported by Neptune.
`String`	`masterUserPassword()` Not supported by Neptune.
`String`	`optionGroupName()` (Not supported by Neptune)
`Integer`	`port()` The port number on which the instances in the DB cluster accept connections.
`String`	`preferredBackupWindow()` The daily time range during which automated backups are created if automated backups are enabled using the `BackupRetentionPeriod` parameter.
`String`	`preferredMaintenanceWindow()` The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`String`	`preSignedUrl()` This parameter is not currently supported.
`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.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateDbClusterRequest.Builder>`	`serializableBuilderClass()`
`String`	`sourceRegion()` If PreSignedUrl is not specified, this is the region where the source snapshot is located.
`Boolean`	`storageEncrypted()` Specifies whether the DB cluster is encrypted.
`List<Tag>`	`tags()` The tags to assign to the new DB cluster.
`CreateDbClusterRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<String>`	`vpcSecurityGroupIds()` A list of EC2 VPC security groups to associate with this DB cluster.

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
  - hasAvailabilityZones
```
public final boolean hasAvailabilityZones()
```
    Returns true if the AvailabilityZones property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasAvailabilityZones() to see if a value was sent in this field.
    
    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()
```
    Returns true if the VpcSecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasVpcSecurityGroupIds() to see if a value was sent in this field.
    
    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 Adjusting the Preferred 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 Adjusting the Preferred 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 Adjusting the Preferred 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 Adjusting the Preferred 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()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    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()
```
    Returns true if the EnableCloudwatchLogsExports property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasEnableCloudwatchLogsExports() to see if a value was sent in this field.
    
    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 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.
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>
    
    Specified by:
    
    toBuilder in class NeptuneRequest
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateDbClusterRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasAvailabilityZones

availabilityZones

backupRetentionPeriod

characterSetName

copyTagsToSnapshot

databaseName

dbClusterIdentifier

dbClusterParameterGroupName

hasVpcSecurityGroupIds

vpcSecurityGroupIds

dbSubnetGroupName

engine

engineVersion

port

masterUsername

masterUserPassword

optionGroupName

preferredBackupWindow

preferredMaintenanceWindow

replicationSourceIdentifier

hasTags

tags

storageEncrypted

kmsKeyId

preSignedUrl

enableIAMDatabaseAuthentication

hasEnableCloudwatchLogsExports

enableCloudwatchLogsExports

deletionProtection

sourceRegion

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields