Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ElastiCache.DescribeCacheSubnetGroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeCacheSubnetGroups Source #

Represents the input of a DescribeCacheSubnetGroups operation.

See: newDescribeCacheSubnetGroups smart constructor.

Constructors

DescribeCacheSubnetGroups'

Fields

cacheSubnetGroupName :: Maybe Text
The name of the cache subnet group to return details for.
marker :: Maybe Text
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
maxRecords :: Maybe Int
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.

Instances

Instances details

Eq DescribeCacheSubnetGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheSubnetGroups Methods (==) :: DescribeCacheSubnetGroups -> DescribeCacheSubnetGroups -> Bool # (/=) :: DescribeCacheSubnetGroups -> DescribeCacheSubnetGroups -> Bool #
Read DescribeCacheSubnetGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheSubnetGroups Methods readsPrec :: Int -> ReadS DescribeCacheSubnetGroups # readList :: ReadS [DescribeCacheSubnetGroups] # readPrec :: ReadPrec DescribeCacheSubnetGroups # readListPrec :: ReadPrec [DescribeCacheSubnetGroups] #
Show DescribeCacheSubnetGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheSubnetGroups Methods showsPrec :: Int -> DescribeCacheSubnetGroups -> ShowS # show :: DescribeCacheSubnetGroups -> String # showList :: [DescribeCacheSubnetGroups] -> ShowS #
Generic DescribeCacheSubnetGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheSubnetGroups Associated Types type Rep DescribeCacheSubnetGroups :: Type -> Type # Methods from :: DescribeCacheSubnetGroups -> Rep DescribeCacheSubnetGroups x # to :: Rep DescribeCacheSubnetGroups x -> DescribeCacheSubnetGroups #
NFData DescribeCacheSubnetGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheSubnetGroups Methods rnf :: DescribeCacheSubnetGroups -> () #
Hashable DescribeCacheSubnetGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheSubnetGroups Methods hashWithSalt :: Int -> DescribeCacheSubnetGroups -> Int # hash :: DescribeCacheSubnetGroups -> Int #
AWSPager DescribeCacheSubnetGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheSubnetGroups Methods page :: DescribeCacheSubnetGroups -> AWSResponse DescribeCacheSubnetGroups -> Maybe DescribeCacheSubnetGroups #
AWSRequest DescribeCacheSubnetGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheSubnetGroups Associated Types type AWSResponse DescribeCacheSubnetGroups # Methods request :: DescribeCacheSubnetGroups -> Request DescribeCacheSubnetGroups # response :: MonadResource m => Logger -> Service -> Proxy DescribeCacheSubnetGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeCacheSubnetGroups))) #
ToHeaders DescribeCacheSubnetGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheSubnetGroups Methods toHeaders :: DescribeCacheSubnetGroups -> [Header] #
ToPath DescribeCacheSubnetGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheSubnetGroups Methods toPath :: DescribeCacheSubnetGroups -> ByteString #
ToQuery DescribeCacheSubnetGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheSubnetGroups Methods toQuery :: DescribeCacheSubnetGroups -> QueryString #
type Rep DescribeCacheSubnetGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheSubnetGroups type Rep DescribeCacheSubnetGroups = D1 ('MetaData "DescribeCacheSubnetGroups" "Amazonka.ElastiCache.DescribeCacheSubnetGroups" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "DescribeCacheSubnetGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cacheSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))
type AWSResponse DescribeCacheSubnetGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheSubnetGroups type AWSResponse DescribeCacheSubnetGroups = DescribeCacheSubnetGroupsResponse

newDescribeCacheSubnetGroups :: DescribeCacheSubnetGroups Source #

Create a value of DescribeCacheSubnetGroups 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:cacheSubnetGroupName:DescribeCacheSubnetGroups', describeCacheSubnetGroups_cacheSubnetGroupName - The name of the cache subnet group to return details for.

$sel:marker:DescribeCacheSubnetGroups', describeCacheSubnetGroups_marker - An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:maxRecords:DescribeCacheSubnetGroups', describeCacheSubnetGroups_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

Request Lenses

describeCacheSubnetGroups_cacheSubnetGroupName :: Lens' DescribeCacheSubnetGroups (Maybe Text) Source #

The name of the cache subnet group to return details for.

describeCacheSubnetGroups_marker :: Lens' DescribeCacheSubnetGroups (Maybe Text) Source #

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeCacheSubnetGroups_maxRecords :: Lens' DescribeCacheSubnetGroups (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

Destructuring the Response

data DescribeCacheSubnetGroupsResponse Source #

Represents the output of a DescribeCacheSubnetGroups operation.

See: newDescribeCacheSubnetGroupsResponse smart constructor.

Constructors

DescribeCacheSubnetGroupsResponse'
Fields marker :: Maybe Text Provides an identifier to allow retrieval of paginated results. cacheSubnetGroups :: Maybe [CacheSubnetGroup] A list of cache subnet groups. Each element in the list contains detailed information about one group. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeCacheSubnetGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheSubnetGroups Methods (==) :: DescribeCacheSubnetGroupsResponse -> DescribeCacheSubnetGroupsResponse -> Bool # (/=) :: DescribeCacheSubnetGroupsResponse -> DescribeCacheSubnetGroupsResponse -> Bool #
Read DescribeCacheSubnetGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheSubnetGroups Methods readsPrec :: Int -> ReadS DescribeCacheSubnetGroupsResponse # readList :: ReadS [DescribeCacheSubnetGroupsResponse] # readPrec :: ReadPrec DescribeCacheSubnetGroupsResponse # readListPrec :: ReadPrec [DescribeCacheSubnetGroupsResponse] #
Show DescribeCacheSubnetGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheSubnetGroups Methods showsPrec :: Int -> DescribeCacheSubnetGroupsResponse -> ShowS # show :: DescribeCacheSubnetGroupsResponse -> String # showList :: [DescribeCacheSubnetGroupsResponse] -> ShowS #
Generic DescribeCacheSubnetGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheSubnetGroups Associated Types type Rep DescribeCacheSubnetGroupsResponse :: Type -> Type # Methods from :: DescribeCacheSubnetGroupsResponse -> Rep DescribeCacheSubnetGroupsResponse x # to :: Rep DescribeCacheSubnetGroupsResponse x -> DescribeCacheSubnetGroupsResponse #
NFData DescribeCacheSubnetGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheSubnetGroups Methods rnf :: DescribeCacheSubnetGroupsResponse -> () #
type Rep DescribeCacheSubnetGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheSubnetGroups type Rep DescribeCacheSubnetGroupsResponse = D1 ('MetaData "DescribeCacheSubnetGroupsResponse" "Amazonka.ElastiCache.DescribeCacheSubnetGroups" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "DescribeCacheSubnetGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "cacheSubnetGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CacheSubnetGroup])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeCacheSubnetGroupsResponse Source #

Arguments

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

Create a value of DescribeCacheSubnetGroupsResponse 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:marker:DescribeCacheSubnetGroups', describeCacheSubnetGroupsResponse_marker - Provides an identifier to allow retrieval of paginated results.

$sel:cacheSubnetGroups:DescribeCacheSubnetGroupsResponse', describeCacheSubnetGroupsResponse_cacheSubnetGroups - A list of cache subnet groups. Each element in the list contains detailed information about one group.

$sel:httpStatus:DescribeCacheSubnetGroupsResponse', describeCacheSubnetGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describeCacheSubnetGroupsResponse_marker :: Lens' DescribeCacheSubnetGroupsResponse (Maybe Text) Source #

Provides an identifier to allow retrieval of paginated results.

describeCacheSubnetGroupsResponse_cacheSubnetGroups :: Lens' DescribeCacheSubnetGroupsResponse (Maybe [CacheSubnetGroup]) Source #

A list of cache subnet groups. Each element in the list contains detailed information about one group.

describeCacheSubnetGroupsResponse_httpStatus :: Lens' DescribeCacheSubnetGroupsResponse Int Source #

The response's http status code.