You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass CreateRelationalDatabaseRequest data as a hash:

{
  relational_database_name: "ResourceName", # required
  availability_zone: "string",
  relational_database_blueprint_id: "string", # required
  relational_database_bundle_id: "string", # required
  master_database_name: "string", # required
  master_username: "string", # required
  master_user_password: "SensitiveString",
  preferred_backup_window: "string",
  preferred_maintenance_window: "string",
  publicly_accessible: false,
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zoneString

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)


1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1724

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)
  include Aws::Structure
end

#master_database_nameString

The name of the master database created when the Lightsail database resource is created.

Constraints:

  • Must contain from 1 to 64 alphanumeric characters.

  • Cannot be a word reserved by the specified database engine

Returns:

  • (String)


1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1724

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)
  include Aws::Structure
end

#master_user_passwordString

The password for the master user of your new database. The password can include any printable ASCII character except "/", """, or "@".

Constraints: Must contain 8 to 41 characters.

Returns:

  • (String)


1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1724

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)
  include Aws::Structure
end

#master_usernameString

The master user name for your new database.

Constraints:

  • Master user name is required.

  • Must contain from 1 to 16 alphanumeric characters.

  • The first character must be a letter.

  • Cannot be a reserved word for the database engine you choose.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6 or MySQL 5.7 respectively.

Returns:

  • (String)


1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1724

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)
  include Aws::Structure
end

#preferred_backup_windowString

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 Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Returns:

  • (String)


1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1724

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)
  include Aws::Structure
end

#preferred_maintenance_windowString

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 Universal Coordinated Time (UTC).

  • Example: Tue:17:00-Tue:17:30

Returns:

  • (String)


1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1724

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)
  include Aws::Structure
end

#publicly_accessibleBoolean

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)


1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1724

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)
  include Aws::Structure
end

#relational_database_blueprint_idString

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)


1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1724

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)
  include Aws::Structure
end

#relational_database_bundle_idString

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)


1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1724

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)
  include Aws::Structure
end

#relational_database_nameString

The name to use for your new database.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

Returns:

  • (String)


1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1724

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)
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tag keys and optional values to add to the resource during create.

To tag a resource after it has been created, see the tag resource operation.

Returns:



1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1724

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)
  include Aws::Structure
end