![]() |
![]()
| ![]() |
![]()
NAMEPaws::RDS::CreateDBInstance - Arguments for method CreateDBInstance on Paws::RDS DESCRIPTIONThis 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 shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDBInstance. SYNOPSISmy $rds = Paws->service('RDS'); # To create a DB instance. # This example creates a DB instance. my $CreateDBInstanceResult = $rds->CreateDBInstance( 'AllocatedStorage' => 5, 'DBInstanceClass' => 'db.t2.micro', 'DBInstanceIdentifier' => 'mymysqlinstance', 'Engine' => 'MySQL', 'MasterUserPassword' => 'MyPassword', 'MasterUsername' => 'MyUser' ); # Results: my $DBInstance = $CreateDBInstanceResult->DBInstance; # Returns a L<Paws::RDS::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> ATTRIBUTESAllocatedStorage => IntThe amount of storage (in gibibytes) to allocate for the DB instance. Type: Integer Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. MySQL Constraints to the amount of storage for each storage type are the following:
MariaDB Constraints to the amount of storage for each storage type are the following:
PostgreSQL Constraints to the amount of storage for each storage type are the following:
Oracle Constraints to the amount of storage for each storage type are the following:
SQL Server Constraints to the amount of storage for each storage type are the following:
AutoMinorVersionUpgrade => BoolA value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically. AvailabilityZone => StrThe Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region. Example: "us-east-1d" Constraint: The "AvailabilityZone" parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint. If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in. For more information about RDS on VMware, see the RDS on VMware User Guide. (https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html) BackupRetentionPeriod => IntThe 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. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints:
CharacterSetName => StrFor supported engines, indicates that the DB instance should be associated with the specified CharacterSet. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see "CreateDBCluster". CopyTagsToSnapshot => BoolA value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. Amazon Aurora Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. DBClusterIdentifier => StrThe identifier of the DB cluster that the instance will belong to. REQUIRED DBInstanceClass => StrThe compute and memory capacity of the DB instance, for example, "db.m4.large". Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the Amazon RDS User Guide. REQUIRED DBInstanceIdentifier => StrThe DB instance identifier. This parameter is stored as a lowercase string. Constraints:
Example: "mydbinstance" DBName => StrThe meaning of this parameter differs according to the database engine you use. MySQL The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints:
MariaDB The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints:
PostgreSQL The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named "postgres" is created in the DB instance. Constraints:
Oracle The Oracle System ID (SID) of the created DB instance. If you specify "null", the default value "ORCL" is used. You can't specify the string NULL, or any other reserved word, for "DBName". Default: "ORCL" Constraints:
SQL Server Not applicable. Must be null. Amazon Aurora MySQL The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster. Constraints:
Amazon Aurora PostgreSQL The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named "postgres" is created in the DB cluster. Constraints:
DBParameterGroupName => StrThe name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used. Constraints:
DBSecurityGroups => ArrayRef[Str|Undef]A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine. DBSubnetGroupName => StrA DB subnet group to associate with this DB instance. If there is no DB subnet group, then it is a non-VPC DB instance. DeletionProtection => BoolA value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). Amazon Aurora Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see "CreateDBCluster". DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. Domain => StrThe Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the Amazon RDS User Guide. DomainIAMRoleName => StrSpecify the name of the IAM role to be used when making API calls to the Directory Service. EnableCloudwatchLogsExports => ArrayRef[Str|Undef]The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. MariaDB Possible values are "audit", "error", "general", and "slowquery". Microsoft SQL Server Possible values are "agent" and "error". MySQL Possible values are "audit", "error", "general", and "slowquery". Oracle Possible values are "alert", "audit", "listener", "trace", and "oemagent". PostgreSQL Possible values are "postgresql" and "upgrade". EnableCustomerOwnedIp => BoolA value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing) in the Amazon Web Services Outposts User Guide. EnableIAMDatabaseAuthentication => BoolA value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster. For more information, see IAM Database Authentication for MySQL and PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the Amazon RDS User Guide. EnablePerformanceInsights => BoolA value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the Amazon Relational Database Service User Guide. REQUIRED Engine => StrThe name of the database engine to be used for this instance. Not every database engine is available for every Amazon Web Services Region. Valid Values:
EngineVersion => StrThe version number of the database engine to use. For a list of valid engine versions, use the "DescribeDBEngineVersions" action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. MariaDB See MariaDB on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the Amazon RDS User Guide. PostgreSQL See Amazon RDS for PostgreSQL versions and extensions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) in the Amazon RDS User Guide. Iops => IntThe amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the Amazon RDS User Guide. Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance. KmsKeyId => StrThe Amazon Web Services KMS key identifier for an encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN. Amazon Aurora Not applicable. The Amazon Web Services KMS key identifier is managed by the DB cluster. For more information, see "CreateDBCluster". If "StorageEncrypted" is enabled, and you do not specify a value for the "KmsKeyId" parameter, then Amazon RDS uses your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region. LicenseModel => StrLicense model information for this DB instance. Valid values: "license-included" | "bring-your-own-license" | "general-public-license" MasterUsername => StrThe name for the master user. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. MariaDB Constraints:
Microsoft SQL Server Constraints:
MySQL Constraints:
Oracle Constraints:
PostgreSQL Constraints:
MasterUserPassword => StrThe password for the master user. The password can include any printable ASCII character except "/", """, or "@". Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. MariaDB Constraints: Must contain from 8 to 41 characters. Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. MySQL Constraints: Must contain from 8 to 41 characters. Oracle Constraints: Must contain from 8 to 30 characters. PostgreSQL Constraints: Must contain from 8 to 128 characters. MaxAllocatedStorage => IntThe upper limit to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the Amazon RDS User Guide. MonitoringInterval => IntThe interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If "MonitoringRoleArn" is specified, then you must also set "MonitoringInterval" to a value other than 0. Valid Values: "0, 1, 5, 10, 15, 30, 60" MonitoringRoleArn => StrThe ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, "arn:aws:iam:123456789012:role/emaccess". For information on creating a monitoring role, go to Setting Up and Enabling Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the Amazon RDS User Guide. If "MonitoringInterval" is set to a value other than 0, then you must supply a "MonitoringRoleArn" value. MultiAZ => BoolA value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the "AvailabilityZone" parameter if the DB instance is a Multi-AZ deployment. NcharCharacterSetName => StrThe name of the NCHAR character set for the Oracle DB instance. OptionGroupName => StrA value that 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, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance PerformanceInsightsKMSKeyId => StrThe Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). If you do not specify a value for "PerformanceInsightsKMSKeyId", then Amazon RDS uses your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region. PerformanceInsightsRetentionPeriod => IntThe amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). Port => IntThe port number on which the database accepts connections. MySQL Default: 3306 Valid values: "1150-65535" Type: Integer MariaDB Default: 3306 Valid values: "1150-65535" Type: Integer PostgreSQL Default: 5432 Valid values: "1150-65535" Type: Integer Oracle Default: 1521 Valid values: "1150-65535" SQL Server Default: 1433 Valid values: "1150-65535" except 1234, 1434, 3260, 3343, 3389, 47001, and "49152-49156". Amazon Aurora Default: 3306 Valid values: "1150-65535" Type: Integer PreferredBackupWindow => StrThe 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 Amazon Web Services Region. For more information, see Backup window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the Amazon RDS User Guide. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. Constraints:
PreferredMaintenanceWindow => StrThe time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance). 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 Amazon Web Services Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. ProcessorFeatures => ArrayRef[Paws::RDS::ProcessorFeature]The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. PromotionTier => IntA value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) in the Amazon Aurora User Guide. Default: 1 Valid Values: 0 - 15 PubliclyAccessible => BoolA value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether "DBSubnetGroupName" is specified. If "DBSubnetGroupName" isn't specified, and "PubliclyAccessible" isn't specified, the following applies:
If "DBSubnetGroupName" is specified, and "PubliclyAccessible" isn't specified, the following applies:
StorageEncrypted => BoolA value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster. StorageType => StrSpecifies 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 "gp2" Tags => ArrayRef[Paws::RDS::Tag]Tags to assign to the DB instance. TdeCredentialArn => StrThe ARN from the key store with which to associate the instance for TDE encryption. TdeCredentialPassword => StrThe password for the given ARN from the key store in order to access the device. Timezone => StrThe time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone). VpcSecurityGroupIds => ArrayRef[Str|Undef]A list of Amazon EC2 VPC security groups to associate with this DB instance. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. Default: The default EC2 VPC security group for the DB subnet group's VPC. SEE ALSOThis class forms part of Paws, documenting arguments for method CreateDBInstance in Paws::RDS BUGS and CONTRIBUTIONSThe source code is located here: <https://github.com/pplu/aws-sdk-perl> Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>
|