Amazonka.Lightsail.DeleteRelationalDatabase

Deletes a database in Amazon Lightsail.

The delete relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

Creating a Request

data DeleteRelationalDatabase

See: newDeleteRelationalDatabase smart constructor.

Constructors

DeleteRelationalDatabase'

Fields

• finalRelationalDatabaseSnapshotName :: Maybe Text

  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.
• skipFinalSnapshot :: Maybe Bool

  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

• relationalDatabaseName :: Text

  The name of the database that you are deleting.

Instances

ToJSON DeleteRelationalDatabase

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

toJSON :: DeleteRelationalDatabase -> Value

toEncoding :: DeleteRelationalDatabase -> Encoding

toJSONList :: [DeleteRelationalDatabase] -> Value

toEncodingList :: [DeleteRelationalDatabase] -> Encoding

ToHeaders DeleteRelationalDatabase

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

toHeaders :: DeleteRelationalDatabase -> [Header]

ToPath DeleteRelationalDatabase

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

toPath :: DeleteRelationalDatabase -> ByteString

ToQuery DeleteRelationalDatabase

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

toQuery :: DeleteRelationalDatabase -> QueryString

AWSRequest DeleteRelationalDatabase

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Associated Types

type AWSResponse DeleteRelationalDatabase

Methods

request :: (Service -> Service) -> DeleteRelationalDatabase -> Request DeleteRelationalDatabase

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteRelationalDatabase -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteRelationalDatabase)))

Generic DeleteRelationalDatabase

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Associated Types

type Rep DeleteRelationalDatabase :: Type -> Type

Methods

from :: DeleteRelationalDatabase -> Rep DeleteRelationalDatabase x

to :: Rep DeleteRelationalDatabase x -> DeleteRelationalDatabase

Read DeleteRelationalDatabase

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

readsPrec :: Int -> ReadS DeleteRelationalDatabase

readList :: ReadS [DeleteRelationalDatabase]

readPrec :: ReadPrec DeleteRelationalDatabase

readListPrec :: ReadPrec [DeleteRelationalDatabase]

Show DeleteRelationalDatabase

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

showsPrec :: Int -> DeleteRelationalDatabase -> ShowS

show :: DeleteRelationalDatabase -> String

showList :: [DeleteRelationalDatabase] -> ShowS

NFData DeleteRelationalDatabase

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

rnf :: DeleteRelationalDatabase -> ()

Eq DeleteRelationalDatabase

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

(==) :: DeleteRelationalDatabase -> DeleteRelationalDatabase -> Bool

(/=) :: DeleteRelationalDatabase -> DeleteRelationalDatabase -> Bool

Hashable DeleteRelationalDatabase

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

hashWithSalt :: Int -> DeleteRelationalDatabase -> Int

hash :: DeleteRelationalDatabase -> Int

type AWSResponse DeleteRelationalDatabase

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

type AWSResponse DeleteRelationalDatabase = DeleteRelationalDatabaseResponse

type Rep DeleteRelationalDatabase

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

type Rep DeleteRelationalDatabase = D1 ('MetaData "DeleteRelationalDatabase" "Amazonka.Lightsail.DeleteRelationalDatabase" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "DeleteRelationalDatabase'" 'PrefixI 'True) (S1 ('MetaSel ('Just "finalRelationalDatabaseSnapshotName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "skipFinalSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "relationalDatabaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteRelationalDatabase

Arguments

:: Text

$sel:relationalDatabaseName:DeleteRelationalDatabase'

-> DeleteRelationalDatabase

Create a value of DeleteRelationalDatabase with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:finalRelationalDatabaseSnapshotName:DeleteRelationalDatabase', deleteRelationalDatabase_finalRelationalDatabaseSnapshotName - 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.

$sel:skipFinalSnapshot:DeleteRelationalDatabase', deleteRelationalDatabase_skipFinalSnapshot - 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

$sel:relationalDatabaseName:DeleteRelationalDatabase', deleteRelationalDatabase_relationalDatabaseName - The name of the database that you are deleting.

Request Lenses

deleteRelationalDatabase_finalRelationalDatabaseSnapshotName :: Lens' DeleteRelationalDatabase (Maybe Text)

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.

deleteRelationalDatabase_skipFinalSnapshot :: Lens' DeleteRelationalDatabase (Maybe Bool)

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

deleteRelationalDatabase_relationalDatabaseName :: Lens' DeleteRelationalDatabase Text

The name of the database that you are deleting.

Destructuring the Response

data DeleteRelationalDatabaseResponse

See: newDeleteRelationalDatabaseResponse smart constructor.

Constructors

DeleteRelationalDatabaseResponse'

Fields

• operations :: Maybe [Operation]

  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DeleteRelationalDatabaseResponse

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Associated Types

type Rep DeleteRelationalDatabaseResponse :: Type -> Type

Methods

from :: DeleteRelationalDatabaseResponse -> Rep DeleteRelationalDatabaseResponse x

to :: Rep DeleteRelationalDatabaseResponse x -> DeleteRelationalDatabaseResponse

Read DeleteRelationalDatabaseResponse

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

readsPrec :: Int -> ReadS DeleteRelationalDatabaseResponse

readList :: ReadS [DeleteRelationalDatabaseResponse]

readPrec :: ReadPrec DeleteRelationalDatabaseResponse

readListPrec :: ReadPrec [DeleteRelationalDatabaseResponse]

Show DeleteRelationalDatabaseResponse

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

showsPrec :: Int -> DeleteRelationalDatabaseResponse -> ShowS

show :: DeleteRelationalDatabaseResponse -> String

showList :: [DeleteRelationalDatabaseResponse] -> ShowS

NFData DeleteRelationalDatabaseResponse

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

rnf :: DeleteRelationalDatabaseResponse -> ()

Eq DeleteRelationalDatabaseResponse

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

(==) :: DeleteRelationalDatabaseResponse -> DeleteRelationalDatabaseResponse -> Bool

(/=) :: DeleteRelationalDatabaseResponse -> DeleteRelationalDatabaseResponse -> Bool

type Rep DeleteRelationalDatabaseResponse

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

type Rep DeleteRelationalDatabaseResponse = D1 ('MetaData "DeleteRelationalDatabaseResponse" "Amazonka.Lightsail.DeleteRelationalDatabase" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "DeleteRelationalDatabaseResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Operation])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteRelationalDatabaseResponse

Arguments

:: Int

$sel:httpStatus:DeleteRelationalDatabaseResponse'

-> DeleteRelationalDatabaseResponse

Create a value of DeleteRelationalDatabaseResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:operations:DeleteRelationalDatabaseResponse', deleteRelationalDatabaseResponse_operations - An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

$sel:httpStatus:DeleteRelationalDatabaseResponse', deleteRelationalDatabaseResponse_httpStatus - The response's http status code.

Response Lenses

deleteRelationalDatabaseResponse_operations :: Lens' DeleteRelationalDatabaseResponse (Maybe [Operation])

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

deleteRelationalDatabaseResponse_httpStatus :: Lens' DeleteRelationalDatabaseResponse Int

The response's http status code.