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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Describes a set of 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][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

  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 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

Returns:

• (Integer)

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

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

#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.

Returns:

• (String)

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

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

#ip_ranges ⇒ Array<Types::IpRange>

The IPv4 ranges.

Returns:

• (Array<Types::IpRange>)

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

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

#ipv_6_ranges ⇒ Array<Types::Ipv6Range>

[VPC only] The IPv6 ranges.

Returns:

• (Array<Types::Ipv6Range>)

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

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

#prefix_list_ids ⇒ Array<Types::PrefixListId>

[VPC only] The prefix list IDs.

Returns:

• (Array<Types::PrefixListId>)

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

class IpPermission < Struct.new(
  :from_port,
  :ip_protocol,
  :ip_ranges,
  :ipv_6_ranges,
  :prefix_list_ids,
  :to_port,
  :user_id_group_pairs)
  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 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

Returns:

• (Integer)

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

class IpPermission < Struct.new(
  :from_port,
  :ip_protocol,
  :ip_ranges,
  :ipv_6_ranges,
  :prefix_list_ids,
  :to_port,
  :user_id_group_pairs)
  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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39342

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