libZSservicesZSamazonka-elasticacheZSamazonka-elasticache
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.ElastiCache.DescribeCacheSecurityGroups

Description

Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeCacheSecurityGroups Source #

Represents the input of a DescribeCacheSecurityGroups operation.

See: newDescribeCacheSecurityGroups smart constructor.

Constructors

DescribeCacheSecurityGroups' 

Fields

  • cacheSecurityGroupName :: Maybe Text

    The name of the cache security 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 DescribeCacheSecurityGroups Source # 
Instance details

Defined in Amazonka.ElastiCache.DescribeCacheSecurityGroups

Read DescribeCacheSecurityGroups Source # 
Instance details

Defined in Amazonka.ElastiCache.DescribeCacheSecurityGroups

Show DescribeCacheSecurityGroups Source # 
Instance details

Defined in Amazonka.ElastiCache.DescribeCacheSecurityGroups

Generic DescribeCacheSecurityGroups Source # 
Instance details

Defined in Amazonka.ElastiCache.DescribeCacheSecurityGroups

Associated Types

type Rep DescribeCacheSecurityGroups :: Type -> Type #

NFData DescribeCacheSecurityGroups Source # 
Instance details

Defined in Amazonka.ElastiCache.DescribeCacheSecurityGroups

Hashable DescribeCacheSecurityGroups Source # 
Instance details

Defined in Amazonka.ElastiCache.DescribeCacheSecurityGroups

AWSPager DescribeCacheSecurityGroups Source # 
Instance details

Defined in Amazonka.ElastiCache.DescribeCacheSecurityGroups

AWSRequest DescribeCacheSecurityGroups Source # 
Instance details

Defined in Amazonka.ElastiCache.DescribeCacheSecurityGroups

ToHeaders DescribeCacheSecurityGroups Source # 
Instance details

Defined in Amazonka.ElastiCache.DescribeCacheSecurityGroups

ToPath DescribeCacheSecurityGroups Source # 
Instance details

Defined in Amazonka.ElastiCache.DescribeCacheSecurityGroups

ToQuery DescribeCacheSecurityGroups Source # 
Instance details

Defined in Amazonka.ElastiCache.DescribeCacheSecurityGroups

type Rep DescribeCacheSecurityGroups Source # 
Instance details

Defined in Amazonka.ElastiCache.DescribeCacheSecurityGroups

type Rep DescribeCacheSecurityGroups = D1 ('MetaData "DescribeCacheSecurityGroups" "Amazonka.ElastiCache.DescribeCacheSecurityGroups" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "DescribeCacheSecurityGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cacheSecurityGroupName") '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 DescribeCacheSecurityGroups Source # 
Instance details

Defined in Amazonka.ElastiCache.DescribeCacheSecurityGroups

newDescribeCacheSecurityGroups :: DescribeCacheSecurityGroups Source #

Create a value of DescribeCacheSecurityGroups 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:cacheSecurityGroupName:DescribeCacheSecurityGroups', describeCacheSecurityGroups_cacheSecurityGroupName - The name of the cache security group to return details for.

$sel:marker:DescribeCacheSecurityGroups', describeCacheSecurityGroups_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:DescribeCacheSecurityGroups', describeCacheSecurityGroups_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

describeCacheSecurityGroups_cacheSecurityGroupName :: Lens' DescribeCacheSecurityGroups (Maybe Text) Source #

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

describeCacheSecurityGroups_marker :: Lens' DescribeCacheSecurityGroups (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.

describeCacheSecurityGroups_maxRecords :: Lens' DescribeCacheSecurityGroups (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 DescribeCacheSecurityGroupsResponse Source #

Represents the output of a DescribeCacheSecurityGroups operation.

See: newDescribeCacheSecurityGroupsResponse smart constructor.

Constructors

DescribeCacheSecurityGroupsResponse' 

Fields

Instances

Instances details
Eq DescribeCacheSecurityGroupsResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.DescribeCacheSecurityGroups

Read DescribeCacheSecurityGroupsResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.DescribeCacheSecurityGroups

Show DescribeCacheSecurityGroupsResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.DescribeCacheSecurityGroups

Generic DescribeCacheSecurityGroupsResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.DescribeCacheSecurityGroups

NFData DescribeCacheSecurityGroupsResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.DescribeCacheSecurityGroups

type Rep DescribeCacheSecurityGroupsResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.DescribeCacheSecurityGroups

type Rep DescribeCacheSecurityGroupsResponse = D1 ('MetaData "DescribeCacheSecurityGroupsResponse" "Amazonka.ElastiCache.DescribeCacheSecurityGroups" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "DescribeCacheSecurityGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cacheSecurityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CacheSecurityGroup])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeCacheSecurityGroupsResponse Source #

Create a value of DescribeCacheSecurityGroupsResponse 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:cacheSecurityGroups:DescribeCacheSecurityGroupsResponse', describeCacheSecurityGroupsResponse_cacheSecurityGroups - A list of cache security groups. Each element in the list contains detailed information about one group.

$sel:marker:DescribeCacheSecurityGroups', describeCacheSecurityGroupsResponse_marker - Provides an identifier to allow retrieval of paginated results.

$sel:httpStatus:DescribeCacheSecurityGroupsResponse', describeCacheSecurityGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describeCacheSecurityGroupsResponse_cacheSecurityGroups :: Lens' DescribeCacheSecurityGroupsResponse (Maybe [CacheSecurityGroup]) Source #

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

describeCacheSecurityGroupsResponse_marker :: Lens' DescribeCacheSecurityGroupsResponse (Maybe Text) Source #

Provides an identifier to allow retrieval of paginated results.