Network.AWS.Redshift.DescribeClusterSecurityGroups

Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide .

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all security groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.

This operation returns paginated results.

Creating a Request

describeClusterSecurityGroups :: DescribeClusterSecurityGroups

Creates a value of DescribeClusterSecurityGroups with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcsgTagValues - A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called admin and test . If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.
• dcsgTagKeys - A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called owner and environment . If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them.
• dcsgClusterSecurityGroupName - The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both. Example: securitygroup1
• dcsgMarker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.
• dcsgMaxRecords - The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.

data DescribeClusterSecurityGroups

See: describeClusterSecurityGroups smart constructor.

Instances

Eq DescribeClusterSecurityGroups

Methods

(==) :: DescribeClusterSecurityGroups -> DescribeClusterSecurityGroups -> Bool

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

Data DescribeClusterSecurityGroups

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeClusterSecurityGroups -> c DescribeClusterSecurityGroups

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeClusterSecurityGroups

toConstr :: DescribeClusterSecurityGroups -> Constr

dataTypeOf :: DescribeClusterSecurityGroups -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeClusterSecurityGroups)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeClusterSecurityGroups)

gmapT :: (forall b. Data b => b -> b) -> DescribeClusterSecurityGroups -> DescribeClusterSecurityGroups

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClusterSecurityGroups -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClusterSecurityGroups -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeClusterSecurityGroups -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeClusterSecurityGroups -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeClusterSecurityGroups -> m DescribeClusterSecurityGroups

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClusterSecurityGroups -> m DescribeClusterSecurityGroups

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClusterSecurityGroups -> m DescribeClusterSecurityGroups

Read DescribeClusterSecurityGroups

Methods

readsPrec :: Int -> ReadS DescribeClusterSecurityGroups

readList :: ReadS [DescribeClusterSecurityGroups]

readPrec :: ReadPrec DescribeClusterSecurityGroups

readListPrec :: ReadPrec [DescribeClusterSecurityGroups]

Show DescribeClusterSecurityGroups

Methods

showsPrec :: Int -> DescribeClusterSecurityGroups -> ShowS

show :: DescribeClusterSecurityGroups -> String

showList :: [DescribeClusterSecurityGroups] -> ShowS

Generic DescribeClusterSecurityGroups

Associated Types

type Rep DescribeClusterSecurityGroups :: * -> *

Methods

from :: DescribeClusterSecurityGroups -> Rep DescribeClusterSecurityGroups x

to :: Rep DescribeClusterSecurityGroups x -> DescribeClusterSecurityGroups

Hashable DescribeClusterSecurityGroups

Methods

hashWithSalt :: Int -> DescribeClusterSecurityGroups -> Int

hash :: DescribeClusterSecurityGroups -> Int

NFData DescribeClusterSecurityGroups

Methods

rnf :: DescribeClusterSecurityGroups -> ()

AWSPager DescribeClusterSecurityGroups

Methods

page :: DescribeClusterSecurityGroups -> Rs DescribeClusterSecurityGroups -> Maybe DescribeClusterSecurityGroups

AWSRequest DescribeClusterSecurityGroups

Associated Types

type Rs DescribeClusterSecurityGroups :: *

Methods

request :: DescribeClusterSecurityGroups -> Request DescribeClusterSecurityGroups

response :: MonadResource m => Logger -> Service -> Proxy * DescribeClusterSecurityGroups -> ClientResponse -> m (Response DescribeClusterSecurityGroups)

ToPath DescribeClusterSecurityGroups

Methods

toPath :: DescribeClusterSecurityGroups -> ByteString

ToHeaders DescribeClusterSecurityGroups

Methods

toHeaders :: DescribeClusterSecurityGroups -> [Header]

ToQuery DescribeClusterSecurityGroups

Methods

toQuery :: DescribeClusterSecurityGroups -> QueryString

type Rep DescribeClusterSecurityGroups

type Rep DescribeClusterSecurityGroups = D1 (MetaData "DescribeClusterSecurityGroups" "Network.AWS.Redshift.DescribeClusterSecurityGroups" "amazonka-redshift-1.4.5-2iQeXmFrftS29tYZtVOT2g" False) (C1 (MetaCons "DescribeClusterSecurityGroups'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dcsgTagValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_dcsgTagKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_dcsgClusterSecurityGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dcsgMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dcsgMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))))))

type Rs DescribeClusterSecurityGroups

type Rs DescribeClusterSecurityGroups = DescribeClusterSecurityGroupsResponse

Request Lenses

dcsgTagValues :: Lens' DescribeClusterSecurityGroups [Text]

A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called admin and test . If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.

dcsgTagKeys :: Lens' DescribeClusterSecurityGroups [Text]

A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called owner and environment . If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them.

dcsgClusterSecurityGroupName :: Lens' DescribeClusterSecurityGroups (Maybe Text)

The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both. Example: securitygroup1

dcsgMarker :: Lens' DescribeClusterSecurityGroups (Maybe Text)

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.

dcsgMaxRecords :: Lens' DescribeClusterSecurityGroups (Maybe Int)

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.

Destructuring the Response

describeClusterSecurityGroupsResponse

Arguments

:: Int

dcsgsrsResponseStatus

-> DescribeClusterSecurityGroupsResponse

Creates a value of DescribeClusterSecurityGroupsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcsgsrsClusterSecurityGroups - A list of ClusterSecurityGroup instances.
• dcsgsrsMarker - A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
• dcsgsrsResponseStatus - -- | The response status code.

data DescribeClusterSecurityGroupsResponse

See: describeClusterSecurityGroupsResponse smart constructor.

Instances

Eq DescribeClusterSecurityGroupsResponse

Methods

(==) :: DescribeClusterSecurityGroupsResponse -> DescribeClusterSecurityGroupsResponse -> Bool

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

Data DescribeClusterSecurityGroupsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeClusterSecurityGroupsResponse -> c DescribeClusterSecurityGroupsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeClusterSecurityGroupsResponse

toConstr :: DescribeClusterSecurityGroupsResponse -> Constr

dataTypeOf :: DescribeClusterSecurityGroupsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeClusterSecurityGroupsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeClusterSecurityGroupsResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeClusterSecurityGroupsResponse -> DescribeClusterSecurityGroupsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClusterSecurityGroupsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClusterSecurityGroupsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeClusterSecurityGroupsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeClusterSecurityGroupsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeClusterSecurityGroupsResponse -> m DescribeClusterSecurityGroupsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClusterSecurityGroupsResponse -> m DescribeClusterSecurityGroupsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClusterSecurityGroupsResponse -> m DescribeClusterSecurityGroupsResponse

Read DescribeClusterSecurityGroupsResponse

Methods

readsPrec :: Int -> ReadS DescribeClusterSecurityGroupsResponse

readList :: ReadS [DescribeClusterSecurityGroupsResponse]

readPrec :: ReadPrec DescribeClusterSecurityGroupsResponse

readListPrec :: ReadPrec [DescribeClusterSecurityGroupsResponse]

Show DescribeClusterSecurityGroupsResponse

Methods

showsPrec :: Int -> DescribeClusterSecurityGroupsResponse -> ShowS

show :: DescribeClusterSecurityGroupsResponse -> String

showList :: [DescribeClusterSecurityGroupsResponse] -> ShowS

Generic DescribeClusterSecurityGroupsResponse

Associated Types

type Rep DescribeClusterSecurityGroupsResponse :: * -> *

Methods

from :: DescribeClusterSecurityGroupsResponse -> Rep DescribeClusterSecurityGroupsResponse x

to :: Rep DescribeClusterSecurityGroupsResponse x -> DescribeClusterSecurityGroupsResponse

NFData DescribeClusterSecurityGroupsResponse

Methods

rnf :: DescribeClusterSecurityGroupsResponse -> ()

type Rep DescribeClusterSecurityGroupsResponse

type Rep DescribeClusterSecurityGroupsResponse = D1 (MetaData "DescribeClusterSecurityGroupsResponse" "Network.AWS.Redshift.DescribeClusterSecurityGroups" "amazonka-redshift-1.4.5-2iQeXmFrftS29tYZtVOT2g" False) (C1 (MetaCons "DescribeClusterSecurityGroupsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dcsgsrsClusterSecurityGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ClusterSecurityGroup]))) ((:*:) (S1 (MetaSel (Just Symbol "_dcsgsrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dcsgsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

dcsgsrsClusterSecurityGroups :: Lens' DescribeClusterSecurityGroupsResponse [ClusterSecurityGroup]

A list of ClusterSecurityGroup instances.

dcsgsrsMarker :: Lens' DescribeClusterSecurityGroupsResponse (Maybe Text)

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

dcsgsrsResponseStatus :: Lens' DescribeClusterSecurityGroupsResponse Int

• - | The response status code.