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


Manual Reference Pages  -  PAWS::RDS::CREATEDBINSTANCE (3)

.ds Aq ’

NAME

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

CONTENTS

DESCRIPTION

This class represents the parameters used for calling the method CreateDBInstance on the Amazon Relational Database Service service. Use the attributes of this class as arguments to method CreateDBInstance.

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

As an example:



  $service_obj->CreateDBInstance(Att1 => $value1, Att2 => $value2, ...);



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.

ATTRIBUTES

    AllocatedStorage => Int

The amount of storage (in gigabytes) to be initially allocated for the database instance.

Type: Integer

<B>MySQLB>

Constraints: Must be an integer from 5 to 6144.

<B>PostgreSQLB>

Constraints: Must be an integer from 5 to 6144.

<B>OracleB>

Constraints: Must be an integer from 10 to 6144.

<B>SQL ServerB>

Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition)

    AutoMinorVersionUpgrade => Bool

Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.

Default: true

    AvailabilityZone => Str

The EC2 Availability Zone that the database instance will be created in. For information on regions and Availability Zones, see Regions and Availability Zones.

Default: A random, system-chosen Availability Zone in the endpoint’s region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.

    BackupRetentionPeriod => Int

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:
o Must be a value from 0 to 35
o Cannot be set to 0 if the DB instance is a source to Read Replicas

    CharacterSetName => Str

For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

    CopyTagsToSnapshot => Bool

This property is not currently implemented.

    DBClusterIdentifier => Str

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

For information on creating a DB cluster, see CreateDBCluster.

Type: String

REQUIRED DBInstanceClass => Str

The compute and memory capacity of the DB instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

REQUIRED DBInstanceIdentifier => Str

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:
o Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).
o First character must be a letter.
o Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance

    DBName => Str

The meaning of this parameter differs according to the database engine you use.

Type: String

<B>MySQLB>

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:
o Must contain 1 to 64 alphanumeric characters
o Cannot be a word reserved by the specified database engine
<B>PostgreSQLB>

The name of the database to create when the DB instance is created. If this parameter is not specified, the default postgres database is created in the DB instance.

Constraints:
o Must contain 1 to 63 alphanumeric characters
o Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
o Cannot be a word reserved by the specified database engine
<B>OracleB>

The Oracle System ID (SID) of the created DB instance.

Default: ORCL

Constraints:
o Cannot be longer than 8 characters
<B>SQL ServerB>

Not applicable. Must be null.

    DBParameterGroupName => Str

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.

Constraints:
o Must be 1 to 255 alphanumeric characters
o First character must be a letter
o Cannot end with a hyphen or contain two consecutive hyphens

    DBSecurityGroups => ArrayRef[Str]

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

    DBSubnetGroupName => Str

A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.

    Domain => Str

Specify the Active Directory Domain to create the instance in.

REQUIRED Engine => Str

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

Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres

Not every database engine is available for every AWS region.

    EngineVersion => Str

The version number of the database engine to use.

The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region.

<B>MySQLB>
o <B>Version 5.1 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):B> 5.1.73a | 5.1.73b
o <B>Version 5.5 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):B> 5.5.40 | 5.5.40a
o <B>Version 5.5 (Available in all regions):B> 5.5.40b | 5.5.41 | 5.5.42
o <B>Version 5.6 (Available in all regions):B> 5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23
<B>MySQLB>
o <B>Version 5.1 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):B> 5.1.73a | 5.1.73b
o <B>Version 5.5 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):B> 5.5.40 | 5.5.40a
o <B>Version 5.5 (Available in all regions):B> 5.5.40b | 5.5.41 | 5.5.42
o <B>Version 5.6 (Available in all regions):B> 5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23
<B>MySQLB>
o <B>Version 5.1 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):B> 5.1.73a | 5.1.73b
o <B>Version 5.5 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):B> 5.5.40 | 5.5.40a
o <B>Version 5.5 (Available in all regions):B> 5.5.40b | 5.5.41 | 5.5.42
o <B>Version 5.6 (Available in all regions):B> 5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23
<B>MySQLB>
o <B>Version 5.1 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):B> 5.1.73a | 5.1.73b
o <B>Version 5.5 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):B> 5.5.40 | 5.5.40a
o <B>Version 5.5 (Available in all regions):B> 5.5.40b | 5.5.41 | 5.5.42
o <B>Version 5.6 (Available in all regions):B> 5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23
<B>Oracle Database Enterprise Edition (oracle-ee)B>
o <B>Version 11.2 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):B> 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
o <B>Version 11.2 (Available in all regions):B> 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3
o <B>Version 12.1 (Available in all regions):B> 12.1.0.1.v1
<B>Oracle Database Enterprise Edition (oracle-ee)B>
o <B>Version 11.2 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):B> 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
o <B>Version 11.2 (Available in all regions):B> 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3
o <B>Version 12.1 (Available in all regions):B> 12.1.0.1.v1
<B>Oracle Database Enterprise Edition (oracle-ee)B>
o <B>Version 11.2 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):B> 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
o <B>Version 11.2 (Available in all regions):B> 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3
o <B>Version 12.1 (Available in all regions):B> 12.1.0.1.v1
<B>Oracle Database Standard Edition (oracle-se)B>
o <B>Version 11.2 (Only available in the following regions: us-west-1):B> 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
o <B>Version 11.2 (Only available in the following regions: eu-central-1, us-west-1):B> 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3
o <B>Version 12.1 (Only available in the following regions: eu-central-1, us-west-1):B> 12.1.0.1.v1
<B>Oracle Database Standard Edition (oracle-se)B>
o <B>Version 11.2 (Only available in the following regions: us-west-1):B> 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
o <B>Version 11.2 (Only available in the following regions: eu-central-1, us-west-1):B> 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3
o <B>Version 12.1 (Only available in the following regions: eu-central-1, us-west-1):B> 12.1.0.1.v1
<B>Oracle Database Standard Edition (oracle-se)B>
o <B>Version 11.2 (Only available in the following regions: us-west-1):B> 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
o <B>Version 11.2 (Only available in the following regions: eu-central-1, us-west-1):B> 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3
o <B>Version 12.1 (Only available in the following regions: eu-central-1, us-west-1):B> 12.1.0.1.v1
<B>Oracle Database Standard Edition One (oracle-se1)B>
o <B>Version 11.2 (Only available in the following regions: us-west-1):B> 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
o <B>Version 11.2 (Only available in the following regions: eu-central-1, us-west-1):B> 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3
o <B>Version 12.1 (Only available in the following regions: eu-central-1, us-west-1):B> 12.1.0.1.v1
<B>Oracle Database Standard Edition One (oracle-se1)B>
o <B>Version 11.2 (Only available in the following regions: us-west-1):B> 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
o <B>Version 11.2 (Only available in the following regions: eu-central-1, us-west-1):B> 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3
o <B>Version 12.1 (Only available in the following regions: eu-central-1, us-west-1):B> 12.1.0.1.v1
<B>Oracle Database Standard Edition One (oracle-se1)B>
o <B>Version 11.2 (Only available in the following regions: us-west-1):B> 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
o <B>Version 11.2 (Only available in the following regions: eu-central-1, us-west-1):B> 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3
o <B>Version 12.1 (Only available in the following regions: eu-central-1, us-west-1):B> 12.1.0.1.v1
<B>PostgreSQLB>
o <B>Version 9.3 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):B> 9.3.1 | 9.3.2
o <B>Version 9.3 (Available in all regions):B> 9.3.3 | 9.3.5 | 9.3.6
o <B>Version 9.4 (Available in all regions):B> 9.4.1
<B>PostgreSQLB>
o <B>Version 9.3 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):B> 9.3.1 | 9.3.2
o <B>Version 9.3 (Available in all regions):B> 9.3.3 | 9.3.5 | 9.3.6
o <B>Version 9.4 (Available in all regions):B> 9.4.1
<B>PostgreSQLB>
o <B>Version 9.3 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):B> 9.3.1 | 9.3.2
o <B>Version 9.3 (Available in all regions):B> 9.3.3 | 9.3.5 | 9.3.6
o <B>Version 9.4 (Available in all regions):B> 9.4.1
<B>Microsoft SQL Server Enterprise Edition (sqlserver-ee)B>
o <B>Version 10.50 (Only available in the following regions: eu-central-1, us-west-1):B> 10.50.2789.0.v1
o <B>Version 11.00 (Only available in the following regions: eu-central-1, us-west-1):B> 11.00.2100.60.v1
<B>Microsoft SQL Server Enterprise Edition (sqlserver-ee)B>
o <B>Version 10.50 (Only available in the following regions: eu-central-1, us-west-1):B> 10.50.2789.0.v1
o <B>Version 11.00 (Only available in the following regions: eu-central-1, us-west-1):B> 11.00.2100.60.v1
<B>Microsoft SQL Server Express Edition (sqlserver-ex)B>
o <B>Version 10.50 (Available in all regions):B> 10.50.2789.0.v1
o <B>Version 11.00 (Available in all regions):B> 11.00.2100.60.v1
<B>Microsoft SQL Server Express Edition (sqlserver-ex)B>
o <B>Version 10.50 (Available in all regions):B> 10.50.2789.0.v1
o <B>Version 11.00 (Available in all regions):B> 11.00.2100.60.v1
<B>Microsoft SQL Server Standard Edition (sqlserver-se)B>
o <B>Version 10.50 (Available in all regions):B> 10.50.2789.0.v1
o <B>Version 11.00 (Available in all regions):B> 11.00.2100.60.v1
<B>Microsoft SQL Server Standard Edition (sqlserver-se)B>
o <B>Version 10.50 (Available in all regions):B> 10.50.2789.0.v1
o <B>Version 11.00 (Available in all regions):B> 11.00.2100.60.v1
<B>Microsoft SQL Server Web Edition (sqlserver-web)B>
o <B>Version 10.50 (Available in all regions):B> 10.50.2789.0.v1
o <B>Version 11.00 (Available in all regions):B> 11.00.2100.60.v1
<B>Microsoft SQL Server Web Edition (sqlserver-web)B>
o <B>Version 10.50 (Available in all regions):B> 10.50.2789.0.v1
o <B>Version 11.00 (Available in all regions):B> 11.00.2100.60.v1

    Iops => Int

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Constraints: To use PIOPS, this value must be an integer greater than 1000.

    KmsKeyId => Str

The KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resoure Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS 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.

    LicenseModel => Str

License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

    MasterUsername => Str

The name of master user for the client DB instance.

<B>MySQLB>

Constraints:
o Must be 1 to 16 alphanumeric characters.
o First character must be a letter.
o Cannot be a reserved word for the chosen database engine.
Type: String

<B>OracleB>

Constraints:
o Must be 1 to 30 alphanumeric characters.
o First character must be a letter.
o Cannot be a reserved word for the chosen database engine.
<B>SQL ServerB>

Constraints:
o Must be 1 to 128 alphanumeric characters.
o First character must be a letter.
o Cannot be a reserved word for the chosen database engine.
<B>PostgreSQLB>

Constraints:
o Must be 1 to 63 alphanumeric characters.
o First character must be a letter.
o Cannot be a reserved word for the chosen database engine.

    MasterUserPassword => Str

The password for the master database user. Can be any printable ASCII character except /, "", or @".

Type: String

<B>MySQLB>

Constraints: Must contain from 8 to 41 characters.

<B>OracleB>

Constraints: Must contain from 8 to 30 characters.

<B>SQL ServerB>

Constraints: Must contain from 8 to 128 characters.

<B>PostgreSQLB>

Constraints: Must contain from 8 to 128 characters.

    MultiAZ => Bool

Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true. Do not set this value if you want a Multi-AZ deployment for a SQL Server DB instance. Multi-AZ for SQL Server is set using the Mirroring option in an option group.

    OptionGroupName => Str

Indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

    Port => Int

The port number on which the database accepts connections.

<B>MySQLB>

Default: 3306

Valid Values: 1150-65535

Type: Integer

<B>PostgreSQLB>

Default: 5432

Valid Values: 1150-65535

Type: Integer

<B>OracleB>

Default: 1521

Valid Values: 1150-65535

<B>SQL ServerB>

Default: 1433

Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

    PreferredBackupWindow => Str

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see DB Instance Backups.

Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:
o Must be in the format hh24:mi-hh24:mi.
o Times should be in Universal Coordinated Time (UTC).
o Must not conflict with the preferred maintenance window.
o Must be at least 30 minutes.

    PreferredMaintenanceWindow => Str

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see DB Instance Maintenance.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

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

Constraints: Minimum 30-minute window.

    PubliclyAccessible => Bool

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
o <B>Default VPC:B> true
o <B>VPC:B> false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

    StorageEncrypted => Bool

Specifies whether the DB instance is encrypted.

Default: false

    StorageType => Str

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

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

    TdeCredentialArn => Str

The ARN from the Key Store with which to associate the instance for TDE encryption.

    TdeCredentialPassword => Str

The password for the given ARN from the Key Store in order to access the device.

    VpcSecurityGroupIds => ArrayRef[Str]

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

Default: The default EC2 VPC security group for the DB subnet group’s VPC.

SEE ALSO

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

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PAWS::RDS::CREATEDBINSTANCE (3) 2015-08-06

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