| 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.Redshift.DescribeClusterSecurityGroups
Description
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.
Synopsis
- data DescribeClusterSecurityGroups = DescribeClusterSecurityGroups' {}
- newDescribeClusterSecurityGroups :: DescribeClusterSecurityGroups
- describeClusterSecurityGroups_tagValues :: Lens' DescribeClusterSecurityGroups (Maybe [Text])
- describeClusterSecurityGroups_tagKeys :: Lens' DescribeClusterSecurityGroups (Maybe [Text])
- describeClusterSecurityGroups_clusterSecurityGroupName :: Lens' DescribeClusterSecurityGroups (Maybe Text)
- describeClusterSecurityGroups_marker :: Lens' DescribeClusterSecurityGroups (Maybe Text)
- describeClusterSecurityGroups_maxRecords :: Lens' DescribeClusterSecurityGroups (Maybe Int)
- data DescribeClusterSecurityGroupsResponse = DescribeClusterSecurityGroupsResponse' {}
- newDescribeClusterSecurityGroupsResponse :: Int -> DescribeClusterSecurityGroupsResponse
- describeClusterSecurityGroupsResponse_clusterSecurityGroups :: Lens' DescribeClusterSecurityGroupsResponse (Maybe [ClusterSecurityGroup])
- describeClusterSecurityGroupsResponse_marker :: Lens' DescribeClusterSecurityGroupsResponse (Maybe Text)
- describeClusterSecurityGroupsResponse_httpStatus :: Lens' DescribeClusterSecurityGroupsResponse Int
Creating a Request
data DescribeClusterSecurityGroups Source #
See: newDescribeClusterSecurityGroups smart constructor.
Constructors
| DescribeClusterSecurityGroups' | |
Fields
| |
Instances
newDescribeClusterSecurityGroups :: DescribeClusterSecurityGroups Source #
Create a value of DescribeClusterSecurityGroups 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:tagValues:DescribeClusterSecurityGroups', describeClusterSecurityGroups_tagValues - 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.
$sel:tagKeys:DescribeClusterSecurityGroups', describeClusterSecurityGroups_tagKeys - 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.
$sel:clusterSecurityGroupName:DescribeClusterSecurityGroups', describeClusterSecurityGroups_clusterSecurityGroupName - 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
$sel:marker:DescribeClusterSecurityGroups', describeClusterSecurityGroups_marker - 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, Amazon Web Services
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.
$sel:maxRecords:DescribeClusterSecurityGroups', describeClusterSecurityGroups_maxRecords - 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.
Request Lenses
describeClusterSecurityGroups_tagValues :: Lens' DescribeClusterSecurityGroups (Maybe [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.
describeClusterSecurityGroups_tagKeys :: Lens' DescribeClusterSecurityGroups (Maybe [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.
describeClusterSecurityGroups_clusterSecurityGroupName :: 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
describeClusterSecurityGroups_marker :: 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, Amazon Web Services
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.
describeClusterSecurityGroups_maxRecords :: 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
data DescribeClusterSecurityGroupsResponse Source #
See: newDescribeClusterSecurityGroupsResponse smart constructor.
Constructors
| DescribeClusterSecurityGroupsResponse' | |
Fields
| |
Instances
newDescribeClusterSecurityGroupsResponse Source #
Arguments
| :: Int | |
| -> DescribeClusterSecurityGroupsResponse |
Create a value of DescribeClusterSecurityGroupsResponse 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:clusterSecurityGroups:DescribeClusterSecurityGroupsResponse', describeClusterSecurityGroupsResponse_clusterSecurityGroups - A list of ClusterSecurityGroup instances.
$sel:marker:DescribeClusterSecurityGroups', describeClusterSecurityGroupsResponse_marker - 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.
$sel:httpStatus:DescribeClusterSecurityGroupsResponse', describeClusterSecurityGroupsResponse_httpStatus - The response's http status code.
Response Lenses
describeClusterSecurityGroupsResponse_clusterSecurityGroups :: Lens' DescribeClusterSecurityGroupsResponse (Maybe [ClusterSecurityGroup]) Source #
A list of ClusterSecurityGroup instances.
describeClusterSecurityGroupsResponse_marker :: 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.
describeClusterSecurityGroupsResponse_httpStatus :: Lens' DescribeClusterSecurityGroupsResponse Int Source #
The response's http status code.