Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- describeClusterSecurityGroups :: DescribeClusterSecurityGroups
- data DescribeClusterSecurityGroups
- dcsgTagValues :: Lens' DescribeClusterSecurityGroups [Text]
- dcsgTagKeys :: Lens' DescribeClusterSecurityGroups [Text]
- dcsgClusterSecurityGroupName :: Lens' DescribeClusterSecurityGroups (Maybe Text)
- dcsgMarker :: Lens' DescribeClusterSecurityGroups (Maybe Text)
- dcsgMaxRecords :: Lens' DescribeClusterSecurityGroups (Maybe Int)
- describeClusterSecurityGroupsResponse :: Int -> DescribeClusterSecurityGroupsResponse
- data DescribeClusterSecurityGroupsResponse
- dcsgsrsClusterSecurityGroups :: Lens' DescribeClusterSecurityGroupsResponse [ClusterSecurityGroup]
- dcsgsrsMarker :: Lens' DescribeClusterSecurityGroupsResponse (Maybe Text)
- dcsgsrsResponseStatus :: Lens' DescribeClusterSecurityGroupsResponse Int
Creating a Request
describeClusterSecurityGroups :: DescribeClusterSecurityGroups Source #
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 calledadmin
andtest
. 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 calledowner
andenvironment
. 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 aDescribeClusterSecurityGroups
request exceed the value specified inMaxRecords
, AWS returns a value in theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
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 specifiedMaxRecords
value, a value is returned in amarker
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 Source #
See: describeClusterSecurityGroups
smart constructor.
Request Lenses
dcsgTagValues :: Lens' DescribeClusterSecurityGroups [Text] Source #
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] Source #
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) Source #
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) Source #
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) Source #
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 Source #
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 ofClusterSecurityGroup
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 theMarker
parameter and retrying the command. If theMarker
field is empty, all response records have been retrieved for the request.dcsgsrsResponseStatus
- -- | The response status code.
data DescribeClusterSecurityGroupsResponse Source #
See: describeClusterSecurityGroupsResponse
smart constructor.
Response Lenses
dcsgsrsClusterSecurityGroups :: Lens' DescribeClusterSecurityGroupsResponse [ClusterSecurityGroup] Source #
A list of ClusterSecurityGroup
instances.
dcsgsrsMarker :: Lens' DescribeClusterSecurityGroupsResponse (Maybe Text) Source #
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 Source #
- - | The response status code.