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

Class: Aws::Lightsail::Types::DeleteRelationalDatabaseRequest

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

{
  relational_database_name: "ResourceName", # required
  skip_final_snapshot: false,
  final_relational_database_snapshot_name: "ResourceName",
}

Instance Attribute Summary collapse

Instance Attribute Details

#final_relational_database_snapshot_nameString

The name of the database snapshot created if skip final snapshot is false, which is the default value for that parameter.

Specifying this parameter and also specifying the skip final snapshot parameter to true results in an error.

Constraints:

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

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

Returns:

  • (String)


2131
2132
2133
2134
2135
2136
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2131

class DeleteRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :skip_final_snapshot,
  :final_relational_database_snapshot_name)
  include Aws::Structure
end

#relational_database_nameString

The name of the database that you are deleting.

Returns:

  • (String)


2131
2132
2133
2134
2135
2136
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2131

class DeleteRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :skip_final_snapshot,
  :final_relational_database_snapshot_name)
  include Aws::Structure
end

#skip_final_snapshotBoolean

Determines whether a final database snapshot is created before your database is deleted. If true is specified, no database snapshot is created. If false is specified, a database snapshot is created before your database is deleted.

You must specify the final relational database snapshot name parameter if the skip final snapshot parameter is false.

Default: false

Returns:

  • (Boolean)


2131
2132
2133
2134
2135
2136
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2131

class DeleteRelationalDatabaseRequest < Struct.new(
  :relational_database_name,
  :skip_final_snapshot,
  :final_relational_database_snapshot_name)
  include Aws::Structure
end