@Generated(value="software.amazon.awssdk:codegen") public final class CreateDbClusterRequest extends NeptuneRequest implements ToCopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateDbClusterRequest.Builder |
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()
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
|
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 |
enableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
false.
|
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.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
kmsKeyId()
The AWS KMS key identifier for an encrypted DB cluster.
|
String |
masterUsername()
The name of the master user for the DB cluster.
|
String |
masterUserPassword()
The password for the master database user.
|
String |
optionGroupName()
A value that indicates that the DB cluster should be associated with the specified option group.
|
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()
A URL that contains a Signature Version 4 signed request for the
CreateDBCluster action to be called
in the source AWS Region where the DB cluster is replicated from. |
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() |
Boolean |
storageEncrypted()
Specifies whether the DB cluster is encrypted.
|
List<Tag> |
tags()
Returns the value of the Tags property for this object.
|
CreateDbClusterRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
List<String> |
vpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB cluster.
|
overrideConfiguration
copy
public 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.
public 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
Default: 1
Constraints:
Must be a value from 1 to 35
public String characterSetName()
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
public 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.
public 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
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
public 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.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
public 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.
public 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
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
public String engine()
The name of the database engine to be used for this DB cluster.
Valid Values: neptune
Valid Values: neptune
public String engineVersion()
The version number of the database engine to use.
Example: 1.0.1
Example: 1.0.1
public Integer port()
The port number on which the instances in the DB cluster accept connections.
Default: 8182
Default: 8182
public String masterUsername()
The name of the master user for the DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
public String masterUserPassword()
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
Constraints: Must contain from 8 to 41 characters.
public String optionGroupName()
A value that indicates that the DB cluster should be associated with the specified option group.
Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
public 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 AWS 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.
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS 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.
public 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 AWS 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.
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 AWS 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.
public 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.
public List<Tag> tags()
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Boolean storageEncrypted()
Specifies whether the DB cluster is encrypted.
public String kmsKeyId()
The AWS 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 AWS 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.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId
to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that
AWS Region.
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 AWS 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.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set
KmsKeyId
to a KMS key ID that is valid in the destination AWS Region. This key is used to
encrypt the Read Replica in that AWS Region.
public String preSignedUrl()
A URL that contains a Signature Version 4 signed request for the CreateDBCluster
action to be called
in the source AWS Region where the DB cluster is replicated from. You only need to specify
PreSignedUrl
when you are performing cross-region replication from an encrypted DB cluster.
The pre-signed URL must be a valid request for the CreateDBCluster
API action that can be executed
in the source AWS Region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId
- The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in
the destination AWS Region. This should refer to the same KMS key for both the CreateDBCluster
action that is called in the destination AWS Region, and the action contained in the pre-signed URL.
DestinationRegion
- The name of the AWS Region that Read Replica will be created in.
ReplicationSourceIdentifier
- The DB cluster identifier for the encrypted DB cluster to be copied.
This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you
are copying an encrypted DB cluster from the us-west-2 AWS Region, then your
ReplicationSourceIdentifier
would look like Example:
arn:aws:rds:us-west-2:123456789012:cluster:neptune-cluster1
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
CreateDBCluster
action to
be called in the source AWS Region where the DB cluster is replicated from. You only need to specify
PreSignedUrl
when you are performing cross-region replication from an encrypted DB
cluster.
The pre-signed URL must be a valid request for the CreateDBCluster
API action that can be
executed in the source AWS Region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId
- The AWS KMS key identifier for the key to use to encrypt the copy of the DB
cluster in the destination AWS Region. This should refer to the same KMS key for both the
CreateDBCluster
action that is called in the destination AWS Region, and the action
contained in the pre-signed URL.
DestinationRegion
- The name of the AWS Region that Read Replica will be created in.
ReplicationSourceIdentifier
- The DB cluster identifier for the encrypted DB cluster to be
copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For
example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your
ReplicationSourceIdentifier
would look like Example:
arn:aws:rds:us-west-2:123456789012:cluster:neptune-cluster1
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
public Boolean enableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
Default: false
public CreateDbClusterRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>
toBuilder
in class NeptuneRequest
public static CreateDbClusterRequest.Builder builder()
public static Class<? extends CreateDbClusterRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.