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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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",
    },
  ],
}

See Also:

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) 


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1484

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_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) 


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1484

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

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) 


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1484

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_name ⇒ String

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) 


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1484

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_name ⇒ String

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

Returns:

  • (String) 


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1484

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_time ⇒ Time

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) 


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1484

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_name ⇒ String

The name of the source database.

Returns:

  • (String) 


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1484

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

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



1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1484

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_time ⇒ Boolean

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) 


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1484

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