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

Class: Aws::Lightsail::Types::CreateRelationalDatabaseFromSnapshotRequest

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 CreateRelationalDatabaseFromSnapshotRequest data as a hash:

{
  relational_database_name: "ResourceName", # required
  availability_zone: "string",
  publicly_accessible: false,
  relational_database_snapshot_name: "ResourceName",
  relational_database_bundle_id: "string",
  source_relational_database_name: "ResourceName",
  restore_time: Time.now,
  use_latest_restorable_time: 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)


1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1534

class CreateRelationalDatabaseFromSnapshotRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :publicly_accessible,
  :relational_database_snapshot_name,
  :relational_database_bundle_id,
  :source_relational_database_name,
  :restore_time,
  :use_latest_restorable_time,
  :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)


1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1534

class CreateRelationalDatabaseFromSnapshotRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :publicly_accessible,
  :relational_database_snapshot_name,
  :relational_database_bundle_id,
  :source_relational_database_name,
  :restore_time,
  :use_latest_restorable_time,
  :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.

When creating a new database from a snapshot, you cannot choose a bundle that is smaller than the bundle of the source database.

Returns:

  • (String)


1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1534

class CreateRelationalDatabaseFromSnapshotRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :publicly_accessible,
  :relational_database_snapshot_name,
  :relational_database_bundle_id,
  :source_relational_database_name,
  :restore_time,
  :use_latest_restorable_time,
  :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)


1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1534

class CreateRelationalDatabaseFromSnapshotRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :publicly_accessible,
  :relational_database_snapshot_name,
  :relational_database_bundle_id,
  :source_relational_database_name,
  :restore_time,
  :use_latest_restorable_time,
  :tags)
  include Aws::Structure
end

#relational_database_snapshot_nameString

The name of the database snapshot from which to create your new database.

Returns:

  • (String)


1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1534

class CreateRelationalDatabaseFromSnapshotRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :publicly_accessible,
  :relational_database_snapshot_name,
  :relational_database_bundle_id,
  :source_relational_database_name,
  :restore_time,
  :use_latest_restorable_time,
  :tags)
  include Aws::Structure
end

#restore_timeTime

The date and time to restore your database from.

Constraints:

  • Must be before the latest restorable time for the database.

  • Cannot be specified if the use latest restorable time parameter is true.

  • Specified in Universal Coordinated Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a restore time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the restore time.

Returns:

  • (Time)


1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1534

class CreateRelationalDatabaseFromSnapshotRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :publicly_accessible,
  :relational_database_snapshot_name,
  :relational_database_bundle_id,
  :source_relational_database_name,
  :restore_time,
  :use_latest_restorable_time,
  :tags)
  include Aws::Structure
end

#source_relational_database_nameString

The name of the source database.

Returns:

  • (String)


1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1534

class CreateRelationalDatabaseFromSnapshotRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :publicly_accessible,
  :relational_database_snapshot_name,
  :relational_database_bundle_id,
  :source_relational_database_name,
  :restore_time,
  :use_latest_restorable_time,
  :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:



1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1534

class CreateRelationalDatabaseFromSnapshotRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :publicly_accessible,
  :relational_database_snapshot_name,
  :relational_database_bundle_id,
  :source_relational_database_name,
  :restore_time,
  :use_latest_restorable_time,
  :tags)
  include Aws::Structure
end

#use_latest_restorable_timeBoolean

Specifies whether your database is restored from the latest backup time. A value of true restores from the latest backup time.

Default: false

Constraints: Cannot be specified if the restore time parameter is provided.

Returns:

  • (Boolean)


1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1534

class CreateRelationalDatabaseFromSnapshotRequest < Struct.new(
  :relational_database_name,
  :availability_zone,
  :publicly_accessible,
  :relational_database_snapshot_name,
  :relational_database_bundle_id,
  :source_relational_database_name,
  :restore_time,
  :use_latest_restorable_time,
  :tags)
  include Aws::Structure
end