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

Calls the Amazon Lightsail CreateRelationalDatabase API operation.

Syntax

New-LSRelationalDatabase
-RelationalDatabaseName <String>
-AvailabilityZone <String>
-MasterDatabaseName <String>
-MasterUsername <String>
-MasterUserPassword <String>
-PreferredBackupWindow <String>
-PreferredMaintenanceWindow <String>
-PubliclyAccessible <Boolean>
-RelationalDatabaseBlueprintId <String>
-RelationalDatabaseBundleId <String>
-Tag <Tag[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Creates a new database in Amazon Lightsail. The create relational database operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.

Parameters

-AvailabilityZone <String>
The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.
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?True (ByPropertyName)
-MasterDatabaseName <String>
The meaning of this parameter differs according to the database engine you use.MySQLThe name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, no database is created in the database resource.Constraints:
  • Must contain 1 to 64 letters or numbers.
  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).
  • Can't be a word reserved by the specified database engine.For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, and MySQL 8.0.
PostgreSQLThe name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, a database named postgres is created in the database resource.Constraints:
  • Must contain 1 to 63 letters or numbers.
  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).
  • Can't be a word reserved by the specified database engine.For more information about reserved words in PostgreSQL, see the SQL Key Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-MasterUsername <String>
The name for the master user.MySQLConstraints:
  • Required for MySQL.
  • Must be 1 to 16 letters or numbers. Can contain underscores.
  • First character must be a letter.
  • Can't be a reserved word for the chosen database engine.For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, or MySQL 8.0.
PostgreSQLConstraints:
  • Required for PostgreSQL.
  • Must be 1 to 63 letters or numbers. Can contain underscores.
  • First character must be a letter.
  • Can't be a reserved word for the chosen database engine.For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-MasterUserPassword <String>
The password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces.MySQLConstraints: Must contain from 8 to 41 characters.PostgreSQLConstraints: Must contain from 8 to 128 characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the RelationalDatabaseName parameter. The -PassThru parameter is deprecated, use -Select '^RelationalDatabaseName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreferredBackupWindow <String>
The daily time range during which automated backups are created for your new database if automated backups are enabled.The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.Constraints:
  • Must be in the hh24:mi-hh24:mi format.Example: 16:00-16:30
  • Specified in Coordinated Universal Time (UTC).
  • Must not conflict with the preferred maintenance window.
  • Must be at least 30 minutes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreferredMaintenanceWindow <String>
The weekly time range during which system maintenance can occur on your new database.The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.Constraints:
  • Must be in the ddd:hh24:mi-ddd:hh24:mi format.
  • Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
  • Must be at least 30 minutes.
  • Specified in Coordinated Universal Time (UTC).
  • Example: Tue:17:00-Tue:17:30
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PubliclyAccessible <Boolean>
Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RelationalDatabaseBlueprintId <String>
The blueprint ID for your new database. A blueprint describes the major engine version of a database.You can get a list of database blueprints IDs by using the get relational database blueprints operation.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-RelationalDatabaseBundleId <String>
The bundle ID for your new database. A bundle describes the performance specifications for your database.You can get a list of database bundle IDs by using the get relational database bundles operation.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-RelationalDatabaseName <String>
The name to use for your new Lightsail database resource.Constraints:
  • Must contain from 2 to 255 alphanumeric characters, or hyphens.
  • The first and last character must be a letter or number.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Operations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Lightsail.Model.CreateRelationalDatabaseResponse). Specifying the name of a property of type Amazon.Lightsail.Model.CreateRelationalDatabaseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
The tag keys and optional values to add to the resource during create.Use the TagResource action to tag a resource after it's created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

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?True (ByPropertyName)
AliasesAK
-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?True (ByValue, ByPropertyName)
-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?True (ByPropertyName)
-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?True (ByValue, ByPropertyName)
-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.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?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-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?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-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?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Lightsail.Model.Operation or Amazon.Lightsail.Model.CreateRelationalDatabaseResponse
This cmdlet returns a collection of Amazon.Lightsail.Model.Operation objects. The service call response (type Amazon.Lightsail.Model.CreateRelationalDatabaseResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

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