Class: Aws::Lightsail::Types::CreateRelationalDatabaseRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-lightsail/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:master_user_password]

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zone ⇒ 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.

Returns:

  • (String) 


4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
 
# File 'lib/aws-sdk-lightsail/types.rb', line 4625

class CreateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :relational_database_blueprint_id,
  :relational_database_bundle_id,
  :master_database_name,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :publicly_accessible,
  :tags)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#master_database_name ⇒ String

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

MySQL

The 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].

PostgreSQL

The 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].

[1]: dev.mysql.com/doc/refman/5.6/en/keywords.html [2]: dev.mysql.com/doc/refman/5.7/en/keywords.html [3]: dev.mysql.com/doc/refman/8.0/en/keywords.html [4]: www.postgresql.org/docs/9.6/sql-keywords-appendix.html [5]: www.postgresql.org/docs/10/sql-keywords-appendix.html [6]: www.postgresql.org/docs/11/sql-keywords-appendix.html [7]: www.postgresql.org/docs/12/sql-keywords-appendix.html

Returns:

  • (String) 


4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
 
# File 'lib/aws-sdk-lightsail/types.rb', line 4625

class CreateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :relational_database_blueprint_id,
  :relational_database_bundle_id,
  :master_database_name,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :publicly_accessible,
  :tags)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#master_user_password ⇒ String

The password for the master user. The password can include any printable ASCII character except “/”, “”“, or ”@“. It cannot contain spaces.

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Returns:

  • (String) 


4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
 
# File 'lib/aws-sdk-lightsail/types.rb', line 4625

class CreateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :relational_database_blueprint_id,
  :relational_database_bundle_id,
  :master_database_name,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :publicly_accessible,
  :tags)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#master_username ⇒ String

The name for the master user.

MySQL

Constraints:

  • 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].

PostgreSQL

Constraints:

  • 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].

[1]: dev.mysql.com/doc/refman/5.6/en/keywords.html [2]: dev.mysql.com/doc/refman/5.7/en/keywords.html [3]: dev.mysql.com/doc/refman/8.0/en/keywords.html [4]: www.postgresql.org/docs/9.6/sql-keywords-appendix.html [5]: www.postgresql.org/docs/10/sql-keywords-appendix.html [6]: www.postgresql.org/docs/11/sql-keywords-appendix.html [7]: www.postgresql.org/docs/12/sql-keywords-appendix.html

Returns:

  • (String) 


4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
 
# File 'lib/aws-sdk-lightsail/types.rb', line 4625

class CreateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :relational_database_blueprint_id,
  :relational_database_bundle_id,
  :master_database_name,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :publicly_accessible,
  :tags)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#preferred_backup_window ⇒ 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][1

guide in the Amazon Relational Database

Service 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.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow

Returns:

  • (String) 


4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
 
# File 'lib/aws-sdk-lightsail/types.rb', line 4625

class CreateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :relational_database_blueprint_id,
  :relational_database_bundle_id,
  :master_database_name,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :publicly_accessible,
  :tags)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#preferred_maintenance_window ⇒ 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`

Returns:

  • (String) 


4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
 
# File 'lib/aws-sdk-lightsail/types.rb', line 4625

class CreateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :relational_database_blueprint_id,
  :relational_database_bundle_id,
  :master_database_name,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :publicly_accessible,
  :tags)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#publicly_accessible ⇒ 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.

Returns:

  • (Boolean) 


4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
 
# File 'lib/aws-sdk-lightsail/types.rb', line 4625

class CreateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :relational_database_blueprint_id,
  :relational_database_bundle_id,
  :master_database_name,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :publicly_accessible,
  :tags)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#relational_database_blueprint_id ⇒ 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.

Returns:

  • (String) 


4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
 
# File 'lib/aws-sdk-lightsail/types.rb', line 4625

class CreateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :relational_database_blueprint_id,
  :relational_database_bundle_id,
  :master_database_name,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :publicly_accessible,
  :tags)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#relational_database_bundle_id ⇒ 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.

Returns:

  • (String) 


4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
 
# File 'lib/aws-sdk-lightsail/types.rb', line 4625

class CreateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :relational_database_blueprint_id,
  :relational_database_bundle_id,
  :master_database_name,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :publicly_accessible,
  :tags)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#relational_database_name ⇒ 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.

Returns:

  • (String) 


4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
 
# File 'lib/aws-sdk-lightsail/types.rb', line 4625

class CreateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :relational_database_blueprint_id,
  :relational_database_bundle_id,
  :master_database_name,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :publicly_accessible,
  :tags)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end

#tags ⇒ Array<Types::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.

Returns:



4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
 
# File 'lib/aws-sdk-lightsail/types.rb', line 4625

class CreateRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :relational_database_blueprint_id,
  :relational_database_bundle_id,
  :master_database_name,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :publicly_accessible,
  :tags)
  SENSITIVE = [:master_user_password]
  include Aws::Structure
end