/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::DocDB::CreateDBInstance

NAME

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

DESCRIPTION

This class represents the parameters used for calling the method CreateDBInstance on the Amazon DocumentDB with MongoDB compatibility service. Use the attributes of this class as arguments to method CreateDBInstance.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDBInstance.

SYNOPSIS

my $rds = Paws->service('DocDB');
my $CreateDBInstanceResult = $rds->CreateDBInstance(
  DBClusterIdentifier        => 'MyString',
  DBInstanceClass            => 'MyString',
  DBInstanceIdentifier       => 'MyString',
  Engine                     => 'MyString',
  AutoMinorVersionUpgrade    => 1,             # OPTIONAL
  AvailabilityZone           => 'MyString',    # OPTIONAL
  PreferredMaintenanceWindow => 'MyString',    # OPTIONAL
  PromotionTier              => 1,             # OPTIONAL
  Tags                       => [
    {
      Key   => 'MyString',
      Value => 'MyString',
    },
    ...
  ],                                           # OPTIONAL
);

# Results:
my $DBInstance = $CreateDBInstanceResult->DBInstance;

# Returns a L<Paws::DocDB::CreateDBInstanceResult> 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/CreateDBInstance

ATTRIBUTES

AutoMinorVersionUpgrade => Bool

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

AvailabilityZone => Str

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's Region.

Example: us-east-1d

REQUIRED DBClusterIdentifier => Str

The identifier of the cluster that the instance will belong to.

REQUIRED DBInstanceClass => Str

The compute and memory capacity of the instance; for example, db.r5.large.

REQUIRED DBInstanceIdentifier => Str

The instance 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: mydbinstance

REQUIRED Engine => Str

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

Valid value: docdb

PreferredMaintenanceWindow => Str

The time range each week 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.

PromotionTier => Int

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

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

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

SEE ALSO

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

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