Paws::Neptune::CreateDBCluster - Arguments for method CreateDBCluster on Paws::Neptune
This class represents the parameters used for calling the method CreateDBCluster on the Amazon Neptune service. Use the attributes of this class as arguments to method CreateDBCluster.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDBCluster.
my $rds = Paws->service('Neptune'); my $CreateDBClusterResult = $rds->CreateDBCluster( DBClusterIdentifier => 'MyString', Engine => 'MyString', AvailabilityZones => [ 'MyString', ... ], # OPTIONAL BackupRetentionPeriod => 1, # OPTIONAL CharacterSetName => 'MyString', # OPTIONAL DBClusterParameterGroupName => 'MyString', # OPTIONAL DBSubnetGroupName => 'MyString', # OPTIONAL DatabaseName => 'MyString', # OPTIONAL EnableIAMDatabaseAuthentication => 1, # OPTIONAL EngineVersion => 'MyString', # OPTIONAL KmsKeyId => 'MyString', # OPTIONAL MasterUserPassword => 'MyString', # OPTIONAL MasterUsername => 'MyString', # OPTIONAL OptionGroupName => 'MyString', # OPTIONAL Port => 1, # OPTIONAL PreSignedUrl => 'MyString', # OPTIONAL PreferredBackupWindow => 'MyString', # OPTIONAL PreferredMaintenanceWindow => 'MyString', # OPTIONAL ReplicationSourceIdentifier => 'MyString', # OPTIONAL StorageEncrypted => 1, # OPTIONAL Tags => [ { Key => 'MyString', Value => 'MyString', }, ... ], # OPTIONAL VpcSecurityGroupIds => [ 'MyString', ... ], # OPTIONAL ); # Results: my $DBCluster = $CreateDBClusterResult->DBCluster; # Returns a L<Paws::Neptune::CreateDBClusterResult> object.
Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/rds/CreateDBCluster
A list of EC2 Availability Zones that instances in the DB cluster can be created in.
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
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
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.
The DB cluster identifier. This parameter is stored as a lowercase string.
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
my-cluster1
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used.
If supplied, must match the name of an existing DBClusterParameterGroup.
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
mySubnetgroup
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
false
The name of the database engine to be used for this DB cluster.
Valid Values: neptune
neptune
The version number of the database engine to use.
Example: 1.0.1
1.0.1
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:
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.
ReplicationSourceIdentifier
If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon Neptune will use your default encryption key.
StorageEncrypted
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 name of the master user for the DB cluster.
Must be 1 to 16 letters or numbers.
Cannot be a reserved word for the chosen database engine.
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.
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.
The port number on which the instances in the DB cluster accept connections.
Default: 8182
8182
The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
BackupRetentionPeriod
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 (http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html) in the Amazon Neptune User Guide.
Must be in the format hh24:mi-hh24:mi.
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.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
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 (http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html) in the Amazon Neptune User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
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.
CreateDBCluster
PreSignedUrl
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.
DestinationRegion
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.
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) (http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) and Signature Version 4 Signing Process (http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
Specifies whether the DB cluster is encrypted.
A list of EC2 VPC security groups to associate with this DB cluster.
This class forms part of Paws, documenting arguments for method CreateDBCluster in Paws::Neptune
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.