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

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

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 IpPermission data as a 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

Instance Attribute Details

#from_portInteger

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.

Returns:

  • (Integer)


23394
23395
23396
23397
23398
23399
23400
23401
23402
23403
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23394

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

#ip_protocolString

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers).

[EC2-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 58 (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 58 (ICMPv6), you can optionally specify a port range; if you don't, traffic for all types and codes is allowed when authorizing rules.

Returns:

  • (String)


23394
23395
23396
23397
23398
23399
23400
23401
23402
23403
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23394

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

#ip_rangesArray<Types::IpRange>

The IPv4 ranges.

Returns:



23394
23395
23396
23397
23398
23399
23400
23401
23402
23403
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23394

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

#ipv_6_rangesArray<Types::Ipv6Range>

[EC2-VPC only] The IPv6 ranges.

Returns:



23394
23395
23396
23397
23398
23399
23400
23401
23402
23403
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23394

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

#prefix_list_idsArray<Types::PrefixListId>

[EC2-VPC only] The prefix list IDs for an AWS service. With AuthorizeSecurityGroupEgress, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.

Returns:



23394
23395
23396
23397
23398
23399
23400
23401
23402
23403
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23394

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

#to_portInteger

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 for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.

Returns:

  • (Integer)


23394
23395
23396
23397
23398
23399
23400
23401
23402
23403
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23394

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

#user_id_group_pairsArray<Types::UserIdGroupPair>

The security group and AWS account ID pairs.

Returns:



23394
23395
23396
23397
23398
23399
23400
23401
23402
23403
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23394

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