AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Invokes the CreateDBInstance operation against Amazon Relational Database Service.

Syntax

New-RDSDBInstance
-DBName <String>
-DBInstanceIdentifier <String>
-AllocatedStorage <Int32>
-AutoMinorVersionUpgrade <Boolean>
-AvailabilityZone <String>
-BackupRetentionPeriod <Int32>
-CharacterSetName <String>
-CopyTagsToSnapshot <Boolean>
-DBClusterIdentifier <String>
-DBInstanceClass <String>
-DBParameterGroupName <String>
-DBSecurityGroup <String[]>
-DBSubnetGroupName <String>
-Domain <String>
-DomainIAMRoleName <String>
-EnableIAMDatabaseAuthentication <Boolean>
-EnablePerformanceInsight <Boolean>
-Engine <String>
-EngineVersion <String>
-Iops <Int32>
-KmsKeyId <String>
-LicenseModel <String>
-MasterUsername <String>
-MasterUserPassword <String>
-MonitoringInterval <Int32>
-MonitoringRoleArn <String>
-MultiAZ <Boolean>
-OptionGroupName <String>
-PerformanceInsightsKMSKeyId <String>
-Port <Int32>
-PreferredBackupWindow <String>
-PreferredMaintenanceWindow <String>
-PromotionTier <Int32>
-PubliclyAccessible <Boolean>
-StorageEncrypted <Boolean>
-StorageType <String>
-Tag <Tag[]>
-TdeCredentialArn <String>
-TdeCredentialPassword <String>
-Timezone <String>
-VpcSecurityGroupId <String[]>
-Force <SwitchParameter>

Description

Creates a new DB instance.

Parameters

-AllocatedStorage <Int32>
The amount of storage (in gigabytes) to be initially allocated for the database instance.Type: IntegerAmazon AuroraNot 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.MySQLConstraints to the amount of storage for each storage type are the following:
  • General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDBConstraints to the amount of storage for each storage type are the following:
  • General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQLConstraints to the amount of storage for each storage type are the following:
  • General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.
OracleConstraints to the amount of storage for each storage type are the following:
  • General Purpose (SSD) storage (gp2): Must be an integer from 10 to 6144.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
  • Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL ServerConstraints to the amount of storage for each storage type are the following:
  • General Purpose (SSD) storage (gp2):
    • Enterprise and Standard editions: Must be an integer from 200 to 16384.
    • Web and Express editions: Must be an integer from 20 to 16384.
  • Provisioned IOPS storage (io1):
    • Enterprise and Standard editions: Must be an integer from 200 to 16384.
    • Web and Express editions: Must be an integer from 100 to 16384.
  • Magnetic storage (standard):
    • Enterprise and Standard editions: Must be an integer from 200 to 1024.
    • Web and Express editions: Must be an integer from 20 to 1024.
Required?False
Position?Named
Accept pipeline input?False
-AutoMinorVersionUpgrade <Boolean>
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.Default: true
Required?False
Position?Named
Accept pipeline input?False
-AvailabilityZone <String>
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 AWS 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 AWS Region as the current endpoint.
Required?False
Position?Named
Accept pipeline input?False
-BackupRetentionPeriod <Int32>
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.Amazon AuroraNot applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster.Default: 1Constraints:
  • Must be a value from 0 to 35
  • Cannot be set to 0 if the DB instance is a source to Read Replicas
Required?False
Position?Named
Accept pipeline input?False
-CharacterSetName <String>
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.Amazon AuroraNot applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
Required?False
Position?Named
Accept pipeline input?False
-CopyTagsToSnapshot <Boolean>
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
Required?False
Position?Named
Accept pipeline input?False
-DBClusterIdentifier <String>
The identifier of the DB cluster that the instance will belong to.For information on creating a DB cluster, see CreateDBCluster.Type: String
Required?False
Position?Named
Accept pipeline input?False
-DBInstanceClass <String>
The compute and memory capacity of the DB instance. Note that not all instance classes are available in all regions for all DB engines. 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.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBInstanceIdentifier <String>
The DB instance 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: mydbinstance
Required?False
Position?2
Accept pipeline input?True (ByPropertyName)
-DBName <String>
The meaning of this parameter differs according to the database engine you use.Type: StringMySQLThe 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:
  • Must contain 1 to 64 letters or numbers.
  • Cannot be a word reserved by the specified database engine
MariaDBThe 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:
  • Must contain 1 to 64 letters or numbers.
  • Cannot be a word reserved by the specified database engine
PostgreSQLThe 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:
  • Must contain 1 to 63 letters, numbers, or underscores.
  • Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
  • Cannot be a word reserved by the specified database engine
OracleThe 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: ORCLConstraints:
  • Cannot be longer than 8 characters
SQL ServerNot applicable. Must be null.Amazon AuroraThe name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance.Constraints:
  • Must contain 1 to 64 letters or numbers.
  • Cannot be a word reserved by the specified database engine
Required?False
Position?1
Accept pipeline input?True (ByValue, )
-DBParameterGroupName <String>
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:
  • Must be 1 to 255 letters, numbers, or hyphens.
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBSecurityGroup <String[]>
A list of DB security groups to associate with this DB instance.Default: The default DB security group for the database engine.
Required?False
Position?Named
Accept pipeline input?False
-DBSubnetGroupName <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Domain <String>
Specify the Active Directory Domain to create the instance in.
Required?False
Position?Named
Accept pipeline input?False
-DomainIAMRoleName <String>
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Required?False
Position?Named
Accept pipeline input?False
-EnableIAMDatabaseAuthentication <Boolean>
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false. You can enable IAM database authentication for the following database engines:Amazon AuroraNot applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see CreateDBCluster.MySQL
  • For MySQL 5.6, minor version 5.6.34 or higher
  • For MySQL 5.7, minor version 5.7.16 or higher
Default: false
Required?False
Position?Named
Accept pipeline input?False
-EnablePerformanceInsight <Boolean>
Documentation for this parameter is not currently available; please refer to the service API documentation.
Required?False
Position?Named
Accept pipeline input?False
-Engine <String>
The name of the database engine to be used for this instance. Not every database engine is available for every AWS Region. Valid Values:
  • aurora
  • mariadb
  • mysql
  • oracle-ee
  • oracle-se2
  • oracle-se1
  • oracle-se
  • postgres
  • sqlserver-ee
  • sqlserver-se
  • sqlserver-ex
  • sqlserver-web
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineVersion <String>
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.Amazon AuroraNot applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. For more information, see CreateDBCluster.MariaDB
  • 10.1.23 (supported in all AWS regions)
  • 10.1.19 (supported in all AWS regions)
  • 10.1.14 (supported in all regions except us-east-2)
  • 10.0.31 (supported in all AWS regions)
  • 10.0.28 (supported in all AWS regions)
  • 10.0.24 (supported in all AWS regions)
  • 10.0.17 (supported in all regions except us-east-2, ca-central-1, eu-west-2)
Microsoft SQL Server 2016
  • 13.00.4422.0.v1 (supported for all editions, and all AWS regions)
  • 13.00.2164.0.v1 (supported for all editions, and all AWS regions)
Microsoft SQL Server 2014
  • 12.00.5546.0.v1 (supported for all editions, and all AWS regions)
  • 12.00.5000.0.v1 (supported for all editions, and all AWS regions)
  • 12.00.4422.0.v1 (supported for all editions except Enterprise Edition, and all AWS regions except ca-central-1 and eu-west-2)
Microsoft SQL Server 2012
  • 11.00.6594.0.v1 (supported for all editions, and all AWS regions)
  • 11.00.6020.0.v1 (supported for all editions, and all AWS regions)
  • 11.00.5058.0.v1 (supported for all editions, and all AWS regions except us-east-2, ca-central-1, and eu-west-2)
  • 11.00.2100.60.v1 (supported for all editions, and all AWS regions except us-east-2, ca-central-1, and eu-west-2)
Microsoft SQL Server 2008 R2
  • 10.50.6529.0.v1 (supported for all editions, and all AWS regions except us-east-2, ca-central-1, and eu-west-2)
  • 10.50.6000.34.v1 (supported for all editions, and all AWS regions except us-east-2, ca-central-1, and eu-west-2)
  • 10.50.2789.0.v1 (supported for all editions, and all AWS regions except us-east-2, ca-central-1, and eu-west-2)
MySQL
  • 5.7.17 (supported in all AWS regions)
  • 5.7.16 (supported in all AWS regions)
  • 5.7.11 (supported in all AWS regions)
  • 5.6.35 (supported in all AWS regions)
  • 5.6.34 (supported in all AWS regions)
  • 5.6.29 (supported in all AWS regions)
  • 5.6.27 (supported in all regions except us-east-2, ca-central-1, eu-west-2)
  • 5.5.54 (supported in all AWS regions)
  • 5.5.53 (supported in all AWS regions)
  • 5.5.46 (supported in all AWS regions)
Oracle 12c
  • 12.1.0.2.v8 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
  • 12.1.0.2.v7 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
  • 12.1.0.2.v6 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
  • 12.1.0.2.v5 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
  • 12.1.0.2.v4 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
  • 12.1.0.2.v3 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
  • 12.1.0.2.v2 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
  • 12.1.0.2.v1 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
Oracle 11g
  • 11.2.0.4.v12 (supported for EE, SE1, and SE, in all AWS regions)
  • 11.2.0.4.v11 (supported for EE, SE1, and SE, in all AWS regions)
  • 11.2.0.4.v10 (supported for EE, SE1, and SE, in all AWS regions)
  • 11.2.0.4.v9 (supported for EE, SE1, and SE, in all AWS regions)
  • 11.2.0.4.v8 (supported for EE, SE1, and SE, in all AWS regions)
  • 11.2.0.4.v7 (supported for EE, SE1, and SE, in all AWS regions)
  • 11.2.0.4.v6 (supported for EE, SE1, and SE, in all AWS regions)
  • 11.2.0.4.v5 (supported for EE, SE1, and SE, in all AWS regions)
  • 11.2.0.4.v4 (supported for EE, SE1, and SE, in all AWS regions)
  • 11.2.0.4.v3 (supported for EE, SE1, and SE, in all AWS regions)
  • 11.2.0.4.v1 (supported for EE, SE1, and SE, in all AWS regions)
PostgreSQL
  • Version 9.6.x: 9.6.1 | 9.6.2 | 9.6.3
  • Version 9.5.x:9.5.6 | 9.5.4 | 9.5.2
  • Version 9.4.x:9.4.11 | 9.4.9 | 9.4.7
  • Version 9.3.x:9.3.16 | 9.3.14 | 9.3.12
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-Iops <Int32>
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.Constraints: Must be a multiple between 3 and 10 of the storage amount for the DB instance. Must also be an integer multiple of 1000. For example, if the size of your DB instance is 500 GB, then your Iops value can be 2000, 3000, 4000, or 5000.
Required?False
Position?Named
Accept pipeline input?False
-KmsKeyId <String>
The KMS key identifier for an encrypted DB instance.The KMS key identifier is the Amazon Resource 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.Amazon AuroraNot applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.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.
Required?False
Position?Named
Accept pipeline input?False
-LicenseModel <String>
License model information for this DB instance. Valid values: license-included | bring-your-own-license | general-public-license
Required?False
Position?Named
Accept pipeline input?False
-MasterUsername <String>
The name for the master user.Amazon AuroraNot applicable. The name for the master user is managed by the DB cluster. For more information, see CreateDBCluster. MariaDBConstraints:
  • Required for MariaDB.
  • Must be 1 to 16 letters or numbers.
  • Cannot be a reserved word for the chosen database engine.
Microsoft SQL ServerConstraints:
  • Required for SQL Server.
  • Must be 1 to 128 letters or numbers.
  • The first character must be a letter.
  • Cannot be a reserved word for the chosen database engine.
MySQLConstraints:
  • Required for MySQL.
  • Must be 1 to 16 letters or numbers.
  • First character must be a letter.
  • Cannot be a reserved word for the chosen database engine.
OracleConstraints:
  • Required for Oracle.
  • Must be 1 to 30 letters or numbers.
  • First character must be a letter.
  • Cannot be a reserved word for the chosen database engine.
PostgreSQLConstraints:
  • Required for PostgreSQL.
  • Must be 1 to 63 letters or numbers.
  • First character must be a letter.
  • Cannot be a reserved word for the chosen database engine.
Required?False
Position?Named
Accept pipeline input?False
-MasterUserPassword <String>
The password for the master user. Can be any printable ASCII character except "/", """, or "@".Amazon AuroraNot applicable. The password for the master user is managed by the DB cluster. For more information, see CreateDBCluster.MariaDBConstraints: Must contain from 8 to 41 characters.Microsoft SQL ServerConstraints: Must contain from 8 to 128 characters.MySQLConstraints: Must contain from 8 to 41 characters.OracleConstraints: Must contain from 8 to 30 characters.PostgreSQLConstraints: Must contain from 8 to 128 characters.
Required?False
Position?Named
Accept pipeline input?False
-MonitoringInterval <Int32>
The 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
Required?False
Position?Named
Accept pipeline input?False
-MonitoringRoleArn <String>
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to 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.If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
Required?False
Position?Named
Accept pipeline input?False
-MultiAZ <Boolean>
Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Required?False
Position?Named
Accept pipeline input?False
-OptionGroupName <String>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PerformanceInsightsKMSKeyId <String>
Documentation for this parameter is not currently available; please refer to the service API documentation.
Required?False
Position?Named
Accept pipeline input?False
-Port <Int32>
The port number on which the database accepts connections.MySQL Default: 3306 Valid Values: 1150-65535Type: IntegerMariaDB Default: 3306 Valid Values: 1150-65535Type: IntegerPostgreSQL Default: 5432 Valid Values: 1150-65535Type: IntegerOracle Default: 1521 Valid Values: 1150-65535SQL Server Default: 1433 Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.Amazon Aurora Default: 3306 Valid Values: 1150-65535Type: Integer
Required?False
Position?Named
Accept pipeline input?False
-PreferredBackupWindow <String>
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. Amazon AuroraNot applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster. Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window. Constraints:
  • Must be in the format hh24:mi-hh24:mi.
  • Times should be in Universal Coordinated Time (UTC).
  • Must not conflict with the preferred maintenance window.
  • Must be at least 30 minutes.
Required?False
Position?Named
Accept pipeline input?False
-PreferredMaintenanceWindow <String>
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 AWS 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, SunConstraints: Minimum 30-minute window.
Required?False
Position?Named
Accept pipeline input?False
-PromotionTier <Int32>
A 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. Default: 1Valid Values: 0 - 15
Required?False
Position?Named
Accept pipeline input?False
-PubliclyAccessible <Boolean>
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.
  • Default VPC: true
  • VPC: 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.
Required?False
Position?Named
Accept pipeline input?False
-StorageEncrypted <Boolean>
Specifies whether the DB instance is encrypted.Amazon AuroraNot applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.Default: false
Required?False
Position?Named
Accept pipeline input?False
-StorageType <String>
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
Required?False
Position?Named
Accept pipeline input?False
-Tag <Tag[]>
Documentation for this parameter is not currently available; please refer to the service API documentation.
Required?False
Position?Named
Accept pipeline input?False
-TdeCredentialArn <String>
The ARN from the Key Store with which to associate the instance for TDE encryption.
Required?False
Position?Named
Accept pipeline input?False
-TdeCredentialPassword <String>
The password for the given ARN from the Key Store in order to access the device.
Required?False
Position?Named
Accept pipeline input?False
-Timezone <String>
The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
Required?False
Position?Named
Accept pipeline input?False
-VpcSecurityGroupId <String[]>
A list of EC2 VPC security groups to associate with this DB instance.Amazon AuroraNot applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster.Default: The default EC2 VPC security group for the DB subnet group's VPC.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

You can pipe a String object to this cmdlet for the DBName parameter.

Outputs

This cmdlet returns a DBInstance object. The service call response (type Amazon.RDS.Model.CreateDBInstanceResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z