/ 
Paws-0.41
River stage two • 11 direct dependents • 13 total dependents
⭐ Starred 171 GitHub stars
/ Paws::Neptune::CreateDBCluster

NAME

Paws::Neptune::CreateDBCluster - Arguments for method CreateDBCluster on Paws::Neptune

DESCRIPTION

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.

SYNOPSIS

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
  EnableCloudwatchLogsExports     => [ '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

ATTRIBUTES

AvailabilityZones => ArrayRef[Str|Undef]

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

BackupRetentionPeriod => Int

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 => Str

A value that indicates that the DB cluster should be associated with the specified CharacterSet.

DatabaseName => Str

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.

REQUIRED DBClusterIdentifier => Str

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 => Str

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.

DBSubnetGroupName => Str

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

EnableCloudwatchLogsExports => ArrayRef[Str|Undef]

The list of log types that need to be enabled for exporting to CloudWatch Logs.

EnableIAMDatabaseAuthentication => Bool

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

REQUIRED Engine => Str

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

Valid Values: neptune

EngineVersion => Str

The version number of the database engine to use.

Example: 1.0.1

KmsKeyId => Str

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.

MasterUsername => Str

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.

MasterUserPassword => Str

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.

OptionGroupName => Str

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.

Port => Int

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

Default: 8182

PreferredBackupWindow => Str

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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html) 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 => Str

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 (https://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.

PreSignedUrl => Str

This parameter is not currently supported.

ReplicationSourceIdentifier => Str

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

StorageEncrypted => Bool

Specifies whether the DB cluster is encrypted.

Tags => ArrayRef[Paws::Neptune::Tag]

The tags to assign to the new DB cluster.

VpcSecurityGroupIds => ArrayRef[Str|Undef]

A list of EC2 VPC security groups to associate with this DB cluster.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateDBCluster in Paws::Neptune

BUGS and CONTRIBUTIONS

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