Class: Aws::Redshift::Types::DescribeClusterSecurityGroupsMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::Redshift::Types::DescribeClusterSecurityGroupsMessage
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-redshift/types.rb
Overview
When making an API call, you may pass DescribeClusterSecurityGroupsMessage data as a hash:
{
cluster_security_group_name: "String",
max_records: 1,
marker: "String",
tag_keys: ["String"],
tag_values: ["String"],
}
Instance Attribute Summary collapse
-
#cluster_security_group_name ⇒ String
The name of a cluster security group for which you are requesting details.
-
#marker ⇒ String
An optional parameter that specifies the starting point to return a set of response records.
-
#max_records ⇒ Integer
The maximum number of response records to return in each call.
-
#tag_keys ⇒ Array<String>
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.
-
#tag_values ⇒ Array<String>
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.
Instance Attribute Details
#cluster_security_group_name ⇒ String
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`
3088 3089 3090 3091 3092 3093 3094 3095 |
# File 'lib/aws-sdk-redshift/types.rb', line 3088 class DescribeClusterSecurityGroupsMessage < Struct.new( :cluster_security_group_name, :max_records, :marker, :tag_keys, :tag_values) include Aws::Structure end |
#marker ⇒ String
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.
3088 3089 3090 3091 3092 3093 3094 3095 |
# File 'lib/aws-sdk-redshift/types.rb', line 3088 class DescribeClusterSecurityGroupsMessage < Struct.new( :cluster_security_group_name, :max_records, :marker, :tag_keys, :tag_values) include Aws::Structure end |
#max_records ⇒ Integer
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.
3088 3089 3090 3091 3092 3093 3094 3095 |
# File 'lib/aws-sdk-redshift/types.rb', line 3088 class DescribeClusterSecurityGroupsMessage < Struct.new( :cluster_security_group_name, :max_records, :marker, :tag_keys, :tag_values) include Aws::Structure end |
#tag_keys ⇒ Array<String>
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.
3088 3089 3090 3091 3092 3093 3094 3095 |
# File 'lib/aws-sdk-redshift/types.rb', line 3088 class DescribeClusterSecurityGroupsMessage < Struct.new( :cluster_security_group_name, :max_records, :marker, :tag_keys, :tag_values) include Aws::Structure end |
#tag_values ⇒ Array<String>
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.
3088 3089 3090 3091 3092 3093 3094 3095 |
# File 'lib/aws-sdk-redshift/types.rb', line 3088 class DescribeClusterSecurityGroupsMessage < Struct.new( :cluster_security_group_name, :max_records, :marker, :tag_keys, :tag_values) include Aws::Structure end |