You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::DescribeSecurityGroupsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribeSecurityGroupsRequest data as a hash:

{
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  group_ids: ["String"],
  group_names: ["String"],
  dry_run: false,
  next_token: "String",
  max_results: 1,
}

Contains the parameters for DescribeSecurityGroups.

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (Boolean)


9552
9553
9554
9555
9556
9557
9558
9559
9560
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9552

class DescribeSecurityGroupsRequest < Struct.new(
  :filters,
  :group_ids,
  :group_names,
  :dry_run,
  :next_token,
  :max_results)
  include Aws::Structure
end

#filtersArray<Types::Filter>

One or more filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.prefix-list-id - The ID (prefix) of the AWS service to which the security group allows access.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - An IPv4 CIDR range that has been granted permission in a security group rule.

  • ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been granted permission.

  • ip-permission.group-name - The name of a security group that has been granted permission.

  • ip-permission.ipv6-cidr - An IPv6 CIDR range that has been granted permission in a security group rule.

  • ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been granted permission.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag-key - The key of a tag assigned to the security group.

  • tag-value - The value of a tag assigned to the security group.

  • vpc-id - The ID of the VPC specified when the security group was created.

Returns:



9552
9553
9554
9555
9556
9557
9558
9559
9560
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9552

class DescribeSecurityGroupsRequest < Struct.new(
  :filters,
  :group_ids,
  :group_names,
  :dry_run,
  :next_token,
  :max_results)
  include Aws::Structure
end

#group_idsArray<String>

One or more security group IDs. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

Returns:

  • (Array<String>)


9552
9553
9554
9555
9556
9557
9558
9559
9560
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9552

class DescribeSecurityGroupsRequest < Struct.new(
  :filters,
  :group_ids,
  :group_names,
  :dry_run,
  :next_token,
  :max_results)
  include Aws::Structure
end

#group_namesArray<String>

[EC2-Classic and default VPC only] One or more security group names. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

Returns:

  • (Array<String>)


9552
9553
9554
9555
9556
9557
9558
9559
9560
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9552

class DescribeSecurityGroupsRequest < Struct.new(
  :filters,
  :group_ids,
  :group_names,
  :dry_run,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000.

Returns:

  • (Integer)


9552
9553
9554
9555
9556
9557
9558
9559
9560
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9552

class DescribeSecurityGroupsRequest < Struct.new(
  :filters,
  :group_ids,
  :group_names,
  :dry_run,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

The token to request the next page of results.

Returns:

  • (String)


9552
9553
9554
9555
9556
9557
9558
9559
9560
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9552

class DescribeSecurityGroupsRequest < Struct.new(
  :filters,
  :group_ids,
  :group_names,
  :dry_run,
  :next_token,
  :max_results)
  include Aws::Structure
end