libZSservicesZSamazonka-lightsailZSamazonka-lightsail
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Lightsail.DeleteRelationalDatabase

Description

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.

Synopsis

Creating a Request

data DeleteRelationalDatabase Source #

See: newDeleteRelationalDatabase smart constructor.

Constructors

DeleteRelationalDatabase' 

Fields

  • 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

  • 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.
  • relationalDatabaseName :: Text

    The name of the database that you are deleting.

Instances

Instances details
Eq DeleteRelationalDatabase Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

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

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

Read DeleteRelationalDatabase Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

readsPrec :: Int -> ReadS DeleteRelationalDatabase #

readList :: ReadS [DeleteRelationalDatabase] #

readPrec :: ReadPrec DeleteRelationalDatabase #

readListPrec :: ReadPrec [DeleteRelationalDatabase] #

Show DeleteRelationalDatabase Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

showsPrec :: Int -> DeleteRelationalDatabase -> ShowS #

show :: DeleteRelationalDatabase -> String #

showList :: [DeleteRelationalDatabase] -> ShowS #

Generic DeleteRelationalDatabase Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Associated Types

type Rep DeleteRelationalDatabase :: Type -> Type #

Methods

from :: DeleteRelationalDatabase -> Rep DeleteRelationalDatabase x #

to :: Rep DeleteRelationalDatabase x -> DeleteRelationalDatabase #

NFData DeleteRelationalDatabase Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

rnf :: DeleteRelationalDatabase -> () #

Hashable DeleteRelationalDatabase Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

hashWithSalt :: Int -> DeleteRelationalDatabase -> Int #

hash :: DeleteRelationalDatabase -> Int #

ToJSON DeleteRelationalDatabase Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

toJSON :: DeleteRelationalDatabase -> Value #

toEncoding :: DeleteRelationalDatabase -> Encoding #

toJSONList :: [DeleteRelationalDatabase] -> Value #

toEncodingList :: [DeleteRelationalDatabase] -> Encoding #

AWSRequest DeleteRelationalDatabase Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Associated Types

type AWSResponse DeleteRelationalDatabase #

Methods

request :: DeleteRelationalDatabase -> Request DeleteRelationalDatabase #

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

ToHeaders DeleteRelationalDatabase Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

toHeaders :: DeleteRelationalDatabase -> [Header] #

ToPath DeleteRelationalDatabase Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

toPath :: DeleteRelationalDatabase -> ByteString #

ToQuery DeleteRelationalDatabase Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

toQuery :: DeleteRelationalDatabase -> QueryString #

type Rep DeleteRelationalDatabase Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

type Rep DeleteRelationalDatabase = D1 ('MetaData "DeleteRelationalDatabase" "Amazonka.Lightsail.DeleteRelationalDatabase" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "DeleteRelationalDatabase'" 'PrefixI 'True) (S1 ('MetaSel ('Just "skipFinalSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "finalRelationalDatabaseSnapshotName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "relationalDatabaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DeleteRelationalDatabase Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

type AWSResponse DeleteRelationalDatabase = DeleteRelationalDatabaseResponse

newDeleteRelationalDatabase Source #

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: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: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:relationalDatabaseName:DeleteRelationalDatabase', deleteRelationalDatabase_relationalDatabaseName - The name of the database that you are deleting.

Request Lenses

deleteRelationalDatabase_skipFinalSnapshot :: Lens' DeleteRelationalDatabase (Maybe Bool) Source #

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_finalRelationalDatabaseSnapshotName :: Lens' DeleteRelationalDatabase (Maybe Text) Source #

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_relationalDatabaseName :: Lens' DeleteRelationalDatabase Text Source #

The name of the database that you are deleting.

Destructuring the Response

data DeleteRelationalDatabaseResponse Source #

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

Instances details
Eq DeleteRelationalDatabaseResponse Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

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

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

Read DeleteRelationalDatabaseResponse Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

readsPrec :: Int -> ReadS DeleteRelationalDatabaseResponse #

readList :: ReadS [DeleteRelationalDatabaseResponse] #

readPrec :: ReadPrec DeleteRelationalDatabaseResponse #

readListPrec :: ReadPrec [DeleteRelationalDatabaseResponse] #

Show DeleteRelationalDatabaseResponse Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

showsPrec :: Int -> DeleteRelationalDatabaseResponse -> ShowS #

show :: DeleteRelationalDatabaseResponse -> String #

showList :: [DeleteRelationalDatabaseResponse] -> ShowS #

Generic DeleteRelationalDatabaseResponse Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Associated Types

type Rep DeleteRelationalDatabaseResponse :: Type -> Type #

Methods

from :: DeleteRelationalDatabaseResponse -> Rep DeleteRelationalDatabaseResponse x #

to :: Rep DeleteRelationalDatabaseResponse x -> DeleteRelationalDatabaseResponse #

NFData DeleteRelationalDatabaseResponse Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

Methods

rnf :: DeleteRelationalDatabaseResponse -> () #

type Rep DeleteRelationalDatabaseResponse Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteRelationalDatabase

type Rep DeleteRelationalDatabaseResponse = D1 ('MetaData "DeleteRelationalDatabaseResponse" "Amazonka.Lightsail.DeleteRelationalDatabase" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" '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 Source #

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]) Source #

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 Source #

The response's http status code.