You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::EC2::Types::IpPermission
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::IpPermission
- Defined in:
- (unknown)
Overview
When passing IpPermission as input to an Aws::Client method, you can use a vanilla Hash:
{
from_port: 1,
ip_protocol: "String",
ip_ranges: [
{
cidr_ip: "String",
description: "String",
},
],
ipv_6_ranges: [
{
cidr_ipv_6: "String",
description: "String",
},
],
prefix_list_ids: [
{
description: "String",
prefix_list_id: "String",
},
],
to_port: 1,
user_id_group_pairs: [
{
description: "String",
group_id: "String",
group_name: "String",
peering_status: "String",
user_id: "String",
vpc_id: "String",
vpc_peering_connection_id: "String",
},
],
}
Describes a set of permissions for a security group rule.
Instance Attribute Summary collapse
-
#from_port ⇒ Integer
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
-
#ip_protocol ⇒ String
The IP protocol name (
tcp
,udp
,icmp
,icmpv6
) or number (see [Protocol Numbers][1]). -
#ip_ranges ⇒ Array<Types::IpRange>
The IPv4 ranges.
-
#ipv_6_ranges ⇒ Array<Types::Ipv6Range>
[VPC only] The IPv6 ranges.
-
#prefix_list_ids ⇒ Array<Types::PrefixListId>
[VPC only] The prefix list IDs.
-
#to_port ⇒ Integer
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
-
#user_id_group_pairs ⇒ Array<Types::UserIdGroupPair>
The security group and AWS account ID pairs.
Instance Attribute Details
#from_port ⇒ Integer
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6
type number. A value of -1
indicates all ICMP/ICMPv6 types. If you
specify all ICMP/ICMPv6 types, you must specify all codes.
#ip_protocol ⇒ String
The IP protocol name (tcp
, udp
, icmp
, icmpv6
) or number (see
Protocol Numbers).
[VPC only] Use -1
to specify all protocols. When authorizing
security group rules, specifying -1
or a protocol number other than
tcp
, udp
, icmp
, or icmpv6
allows traffic on all ports,
regardless of any port range you specify. For tcp
, udp
, and icmp
,
you must specify a port range. For icmpv6
, the port range is optional;
if you omit the port range, traffic for all types and codes is allowed.
#ip_ranges ⇒ Array<Types::IpRange>
The IPv4 ranges.
#ipv_6_ranges ⇒ Array<Types::Ipv6Range>
[VPC only] The IPv6 ranges.
#prefix_list_ids ⇒ Array<Types::PrefixListId>
[VPC only] The prefix list IDs.
#to_port ⇒ Integer
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6
code. A value of -1
indicates all ICMP/ICMPv6 codes. If you specify
all ICMP/ICMPv6 types, you must specify all codes.
#user_id_group_pairs ⇒ Array<Types::UserIdGroupPair>
The security group and AWS account ID pairs.