Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.

When you share snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.

Synopsis

data DescribeDBClusterSnapshotAttributes = DescribeDBClusterSnapshotAttributes' {
- dbClusterSnapshotIdentifier :: Text
}
newDescribeDBClusterSnapshotAttributes :: Text -> DescribeDBClusterSnapshotAttributes
describeDBClusterSnapshotAttributes_dbClusterSnapshotIdentifier :: Lens' DescribeDBClusterSnapshotAttributes Text
data DescribeDBClusterSnapshotAttributesResponse = DescribeDBClusterSnapshotAttributesResponse' {
- dbClusterSnapshotAttributesResult :: Maybe DBClusterSnapshotAttributesResult
- httpStatus :: Int
}
newDescribeDBClusterSnapshotAttributesResponse :: Int -> DescribeDBClusterSnapshotAttributesResponse
describeDBClusterSnapshotAttributesResponse_dbClusterSnapshotAttributesResult :: Lens' DescribeDBClusterSnapshotAttributesResponse (Maybe DBClusterSnapshotAttributesResult)
describeDBClusterSnapshotAttributesResponse_httpStatus :: Lens' DescribeDBClusterSnapshotAttributesResponse Int

Creating a Request

data DescribeDBClusterSnapshotAttributes Source #

Represents the input to DescribeDBClusterSnapshotAttributes.

See: newDescribeDBClusterSnapshotAttributes smart constructor.

Constructors

DescribeDBClusterSnapshotAttributes'
Fields dbClusterSnapshotIdentifier :: Text The identifier for the cluster snapshot to describe the attributes for.

Instances

Instances details

ToHeaders DescribeDBClusterSnapshotAttributes Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes Methods toHeaders :: DescribeDBClusterSnapshotAttributes -> [Header] #
ToPath DescribeDBClusterSnapshotAttributes Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes Methods toPath :: DescribeDBClusterSnapshotAttributes -> ByteString #
ToQuery DescribeDBClusterSnapshotAttributes Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes Methods toQuery :: DescribeDBClusterSnapshotAttributes -> QueryString #
AWSRequest DescribeDBClusterSnapshotAttributes Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes Associated Types type AWSResponse DescribeDBClusterSnapshotAttributes # Methods request :: (Service -> Service) -> DescribeDBClusterSnapshotAttributes -> Request DescribeDBClusterSnapshotAttributes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDBClusterSnapshotAttributes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDBClusterSnapshotAttributes))) #
Generic DescribeDBClusterSnapshotAttributes Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes Associated Types type Rep DescribeDBClusterSnapshotAttributes :: Type -> Type # Methods from :: DescribeDBClusterSnapshotAttributes -> Rep DescribeDBClusterSnapshotAttributes x # to :: Rep DescribeDBClusterSnapshotAttributes x -> DescribeDBClusterSnapshotAttributes #
Read DescribeDBClusterSnapshotAttributes Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes Methods readsPrec :: Int -> ReadS DescribeDBClusterSnapshotAttributes # readList :: ReadS [DescribeDBClusterSnapshotAttributes] # readPrec :: ReadPrec DescribeDBClusterSnapshotAttributes # readListPrec :: ReadPrec [DescribeDBClusterSnapshotAttributes] #
Show DescribeDBClusterSnapshotAttributes Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes Methods showsPrec :: Int -> DescribeDBClusterSnapshotAttributes -> ShowS # show :: DescribeDBClusterSnapshotAttributes -> String # showList :: [DescribeDBClusterSnapshotAttributes] -> ShowS #
NFData DescribeDBClusterSnapshotAttributes Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes Methods rnf :: DescribeDBClusterSnapshotAttributes -> () #
Eq DescribeDBClusterSnapshotAttributes Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes Methods (==) :: DescribeDBClusterSnapshotAttributes -> DescribeDBClusterSnapshotAttributes -> Bool # (/=) :: DescribeDBClusterSnapshotAttributes -> DescribeDBClusterSnapshotAttributes -> Bool #
Hashable DescribeDBClusterSnapshotAttributes Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes Methods hashWithSalt :: Int -> DescribeDBClusterSnapshotAttributes -> Int # hash :: DescribeDBClusterSnapshotAttributes -> Int #
type AWSResponse DescribeDBClusterSnapshotAttributes Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes type AWSResponse DescribeDBClusterSnapshotAttributes = DescribeDBClusterSnapshotAttributesResponse
type Rep DescribeDBClusterSnapshotAttributes Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes type Rep DescribeDBClusterSnapshotAttributes = D1 ('MetaData "DescribeDBClusterSnapshotAttributes" "Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBClusterSnapshotAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeDBClusterSnapshotAttributes Source #

Arguments

:: Text	`DescribeDBClusterSnapshotAttributes`
-> DescribeDBClusterSnapshotAttributes

Create a value of DescribeDBClusterSnapshotAttributes 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:

DescribeDBClusterSnapshotAttributes, describeDBClusterSnapshotAttributes_dbClusterSnapshotIdentifier - The identifier for the cluster snapshot to describe the attributes for.

Request Lenses

describeDBClusterSnapshotAttributes_dbClusterSnapshotIdentifier :: Lens' DescribeDBClusterSnapshotAttributes Text Source #

The identifier for the cluster snapshot to describe the attributes for.

Destructuring the Response

data DescribeDBClusterSnapshotAttributesResponse Source #

See: newDescribeDBClusterSnapshotAttributesResponse smart constructor.

Constructors

DescribeDBClusterSnapshotAttributesResponse'
Fields dbClusterSnapshotAttributesResult :: Maybe DBClusterSnapshotAttributesResult httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeDBClusterSnapshotAttributesResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes Associated Types type Rep DescribeDBClusterSnapshotAttributesResponse :: Type -> Type # Methods from :: DescribeDBClusterSnapshotAttributesResponse -> Rep DescribeDBClusterSnapshotAttributesResponse x # to :: Rep DescribeDBClusterSnapshotAttributesResponse x -> DescribeDBClusterSnapshotAttributesResponse #
Read DescribeDBClusterSnapshotAttributesResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes Methods readsPrec :: Int -> ReadS DescribeDBClusterSnapshotAttributesResponse # readList :: ReadS [DescribeDBClusterSnapshotAttributesResponse] # readPrec :: ReadPrec DescribeDBClusterSnapshotAttributesResponse # readListPrec :: ReadPrec [DescribeDBClusterSnapshotAttributesResponse] #
Show DescribeDBClusterSnapshotAttributesResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes Methods showsPrec :: Int -> DescribeDBClusterSnapshotAttributesResponse -> ShowS # show :: DescribeDBClusterSnapshotAttributesResponse -> String # showList :: [DescribeDBClusterSnapshotAttributesResponse] -> ShowS #
NFData DescribeDBClusterSnapshotAttributesResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes Methods rnf :: DescribeDBClusterSnapshotAttributesResponse -> () #
Eq DescribeDBClusterSnapshotAttributesResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes Methods (==) :: DescribeDBClusterSnapshotAttributesResponse -> DescribeDBClusterSnapshotAttributesResponse -> Bool # (/=) :: DescribeDBClusterSnapshotAttributesResponse -> DescribeDBClusterSnapshotAttributesResponse -> Bool #
type Rep DescribeDBClusterSnapshotAttributesResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes type Rep DescribeDBClusterSnapshotAttributesResponse = D1 ('MetaData "DescribeDBClusterSnapshotAttributesResponse" "Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBClusterSnapshotAttributesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshotAttributesResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBClusterSnapshotAttributesResult)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeDBClusterSnapshotAttributesResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeDBClusterSnapshotAttributesResponse'`
-> DescribeDBClusterSnapshotAttributesResponse

Create a value of DescribeDBClusterSnapshotAttributesResponse 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:dbClusterSnapshotAttributesResult:DescribeDBClusterSnapshotAttributesResponse', describeDBClusterSnapshotAttributesResponse_dbClusterSnapshotAttributesResult - Undocumented member.

$sel:httpStatus:DescribeDBClusterSnapshotAttributesResponse', describeDBClusterSnapshotAttributesResponse_httpStatus - The response's http status code.

Response Lenses

describeDBClusterSnapshotAttributesResponse_dbClusterSnapshotAttributesResult :: Lens' DescribeDBClusterSnapshotAttributesResponse (Maybe DBClusterSnapshotAttributesResult) Source #

Undocumented member.

describeDBClusterSnapshotAttributesResponse_httpStatus :: Lens' DescribeDBClusterSnapshotAttributesResponse Int Source #

The response's http status code.