Class: Aws::EC2::Types::IpPermission

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::IpPermission

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

Describes the permissions for a security group rule.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #from_port ⇒ Integer

  If the protocol is TCP or UDP, this is the start of the port range.

• #ip_protocol ⇒ String

  The IP protocol name (‘tcp`, `udp`, `icmp`, `icmpv6`) or number (see [Protocol Numbers]).

• #ip_ranges ⇒ Array<Types::IpRange>

  The IPv4 address ranges.

• #ipv_6_ranges ⇒ Array<Types::Ipv6Range>

  The IPv6 address ranges.

• #prefix_list_ids ⇒ Array<Types::PrefixListId>

  The prefix list IDs.

• #to_port ⇒ Integer

  If the protocol is TCP or UDP, this is the end of the port range.

• #user_id_group_pairs ⇒ Array<Types::UserIdGroupPair>

  The security group and Amazon Web Services account ID pairs.

Instance Attribute Details

#from_port ⇒ Integer

If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 45226

class IpPermission < Struct.new(
  :ip_protocol,
  :from_port,
  :to_port,
  :user_id_group_pairs,
  :ip_ranges,
  :ipv_6_ranges,
  :prefix_list_ids)
  SENSITIVE = []
  include Aws::Structure
end

#ip_protocol ⇒ String

The IP protocol name (‘tcp`, `udp`, `icmp`, `icmpv6`) or number (see [Protocol Numbers]).

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.

[1]: www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 45226

class IpPermission < Struct.new(
  :ip_protocol,
  :from_port,
  :to_port,
  :user_id_group_pairs,
  :ip_ranges,
  :ipv_6_ranges,
  :prefix_list_ids)
  SENSITIVE = []
  include Aws::Structure
end

#ip_ranges ⇒ Array<Types::IpRange>

The IPv4 address ranges.

Returns:

• (Array<Types::IpRange>)

# File 'lib/aws-sdk-ec2/types.rb', line 45226

class IpPermission < Struct.new(
  :ip_protocol,
  :from_port,
  :to_port,
  :user_id_group_pairs,
  :ip_ranges,
  :ipv_6_ranges,
  :prefix_list_ids)
  SENSITIVE = []
  include Aws::Structure
end

#ipv_6_ranges ⇒ Array<Types::Ipv6Range>

The IPv6 address ranges.

Returns:

• (Array<Types::Ipv6Range>)

# File 'lib/aws-sdk-ec2/types.rb', line 45226

class IpPermission < Struct.new(
  :ip_protocol,
  :from_port,
  :to_port,
  :user_id_group_pairs,
  :ip_ranges,
  :ipv_6_ranges,
  :prefix_list_ids)
  SENSITIVE = []
  include Aws::Structure
end

#prefix_list_ids ⇒ Array<Types::PrefixListId>

The prefix list IDs.

Returns:

• (Array<Types::PrefixListId>)

# File 'lib/aws-sdk-ec2/types.rb', line 45226

class IpPermission < Struct.new(
  :ip_protocol,
  :from_port,
  :to_port,
  :user_id_group_pairs,
  :ip_ranges,
  :ipv_6_ranges,
  :prefix_list_ids)
  SENSITIVE = []
  include Aws::Structure
end

#to_port ⇒ Integer

If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 45226

class IpPermission < Struct.new(
  :ip_protocol,
  :from_port,
  :to_port,
  :user_id_group_pairs,
  :ip_ranges,
  :ipv_6_ranges,
  :prefix_list_ids)
  SENSITIVE = []
  include Aws::Structure
end

#user_id_group_pairs ⇒ Array<Types::UserIdGroupPair>

The security group and Amazon Web Services account ID pairs.

Returns:

• (Array<Types::UserIdGroupPair>)

# File 'lib/aws-sdk-ec2/types.rb', line 45226

class IpPermission < Struct.new(
  :ip_protocol,
  :from_port,
  :to_port,
  :user_id_group_pairs,
  :ip_ranges,
  :ipv_6_ranges,
  :prefix_list_ids)
  SENSITIVE = []
  include Aws::Structure
end