GSP
Quick Navigator
Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::DocDB::CreateDBCluster(3) User Contributed Perl Documentation Paws::DocDB::CreateDBCluster(3)

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

This class represents the parameters used for calling the method CreateDBCluster on the Amazon DocumentDB with MongoDB compatibility 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('DocDB');
    my $CreateDBClusterResult = $rds->CreateDBCluster(
      DBClusterIdentifier         => 'MyString',
      Engine                      => 'MyString',
      AvailabilityZones           => [ 'MyString', ... ],            # OPTIONAL
      BackupRetentionPeriod       => 1,                              # OPTIONAL
      DBClusterParameterGroupName => 'MyString',                     # OPTIONAL
      DBSubnetGroupName           => 'MyString',                     # OPTIONAL
      DeletionProtection          => 1,                              # OPTIONAL
      EnableCloudwatchLogsExports => [ 'MyString', ... ],            # OPTIONAL
      EngineVersion               => 'MyString',                     # OPTIONAL
      GlobalClusterIdentifier     => 'MyGlobalClusterIdentifier',    # OPTIONAL
      KmsKeyId                    => 'MyString',                     # OPTIONAL
      MasterUserPassword          => 'MyString',                     # OPTIONAL
      MasterUsername              => 'MyString',                     # OPTIONAL
      Port                        => 1,                              # OPTIONAL
      PreSignedUrl                => 'MyString',                     # OPTIONAL
      PreferredBackupWindow       => 'MyString',                     # OPTIONAL
      PreferredMaintenanceWindow  => 'MyString',                     # OPTIONAL
      StorageEncrypted            => 1,                              # OPTIONAL
      Tags                        => [
        {
          Key   => 'MyString',
          Value => 'MyString',
        },
        ...
      ],                                                             # OPTIONAL
      VpcSecurityGroupIds => [ 'MyString', ... ],                    # OPTIONAL
    );
    # Results:
    my $DBCluster = $CreateDBClusterResult->DBCluster;
    # Returns a L<Paws::DocDB::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 Amazon EC2 Availability Zones that instances in the 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.

REQUIRED DBClusterIdentifier => Str

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.
  • The first character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: "my-cluster"

The name of the cluster parameter group to associate with this cluster.

A subnet group to associate with this cluster.

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

Example: "mySubnetgroup"

Specifies whether this cluster can be deleted. If "DeletionProtection" is enabled, the cluster cannot be deleted unless it is modified and "DeletionProtection" is disabled. "DeletionProtection" protects clusters from being accidentally deleted.

A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events (https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html) and Profiling Amazon DocumentDB Operations (https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html).

REQUIRED Engine => Str

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

Valid values: "docdb"

The version number of the database engine to use. The "--engine-version" will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

The cluster identifier of the new global cluster.

The KMS key identifier for an encrypted cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same account that owns the KMS encryption key that is used to encrypt the new cluster, 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 the "StorageEncrypted" parameter is "true", Amazon DocumentDB uses your default encryption key.

KMS creates the default encryption key for your account. Your account has a different default encryption key for each Regions.

The name of the master user for the cluster.

Constraints:

  • Must be from 1 to 63 letters or numbers.
  • The first character must be a letter.
  • 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 forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

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

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

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.

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 Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Not currently supported.

Specifies whether the cluster is encrypted.

The tags to be assigned to the cluster.

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

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

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>

2022-06-01 perl v5.40.2
Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.