Class: Aws::EC2::Types::SecurityGroupRuleRequest

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 SecurityGroupRuleRequest data as a hash:

{
  ip_protocol: "String",
  from_port: 1,
  to_port: 1,
  cidr_ipv_4: "String",
  cidr_ipv_6: "String",
  prefix_list_id: "PrefixListResourceId",
  referenced_group_id: "SecurityGroupId",
  description: "String",
}

Describes a security group rule.

You must specify exactly one of the following parameters, based on the rule type:

  • CidrIpv4

  • CidrIpv6

  • PrefixListId

  • ReferencedGroupId

When you modify a rule, you cannot change the rule type. For example, if the rule uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4 address range.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cidr_ipv_4String

The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.

Returns:

  • (String)


55874
55875
55876
55877
55878
55879
55880
55881
55882
55883
55884
55885
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 55874

class SecurityGroupRuleRequest < Struct.new(
  :ip_protocol,
  :from_port,
  :to_port,
  :cidr_ipv_4,
  :cidr_ipv_6,
  :prefix_list_id,
  :referenced_group_id,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#cidr_ipv_6String

The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.

Returns:

  • (String)


55874
55875
55876
55877
55878
55879
55880
55881
55882
55883
55884
55885
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 55874

class SecurityGroupRuleRequest < Struct.new(
  :ip_protocol,
  :from_port,
  :to_port,
  :cidr_ipv_4,
  :cidr_ipv_6,
  :prefix_list_id,
  :referenced_group_id,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the security group rule.

Returns:

  • (String)


55874
55875
55876
55877
55878
55879
55880
55881
55882
55883
55884
55885
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 55874

class SecurityGroupRuleRequest < Struct.new(
  :ip_protocol,
  :from_port,
  :to_port,
  :cidr_ipv_4,
  :cidr_ipv_6,
  :prefix_list_id,
  :referenced_group_id,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#from_portInteger

The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

Returns:

  • (Integer)


55874
55875
55876
55877
55878
55879
55880
55881
55882
55883
55884
55885
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 55874

class SecurityGroupRuleRequest < Struct.new(
  :ip_protocol,
  :from_port,
  :to_port,
  :cidr_ipv_4,
  :cidr_ipv_6,
  :prefix_list_id,
  :referenced_group_id,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#ip_protocolString

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

Use -1 to specify all protocols.

Returns:

  • (String)


55874
55875
55876
55877
55878
55879
55880
55881
55882
55883
55884
55885
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 55874

class SecurityGroupRuleRequest < Struct.new(
  :ip_protocol,
  :from_port,
  :to_port,
  :cidr_ipv_4,
  :cidr_ipv_6,
  :prefix_list_id,
  :referenced_group_id,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#prefix_list_idString

The ID of the prefix list.

Returns:

  • (String)


55874
55875
55876
55877
55878
55879
55880
55881
55882
55883
55884
55885
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 55874

class SecurityGroupRuleRequest < Struct.new(
  :ip_protocol,
  :from_port,
  :to_port,
  :cidr_ipv_4,
  :cidr_ipv_6,
  :prefix_list_id,
  :referenced_group_id,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#referenced_group_idString

The ID of the security group that is referenced in the security group rule.

Returns:

  • (String)


55874
55875
55876
55877
55878
55879
55880
55881
55882
55883
55884
55885
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 55874

class SecurityGroupRuleRequest < Struct.new(
  :ip_protocol,
  :from_port,
  :to_port,
  :cidr_ipv_4,
  :cidr_ipv_6,
  :prefix_list_id,
  :referenced_group_id,
  :description)
  SENSITIVE = []
  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. If you specify all ICMP/ICMPv6 types, you must specify all codes.

Returns:

  • (Integer)


55874
55875
55876
55877
55878
55879
55880
55881
55882
55883
55884
55885
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 55874

class SecurityGroupRuleRequest < Struct.new(
  :ip_protocol,
  :from_port,
  :to_port,
  :cidr_ipv_4,
  :cidr_ipv_6,
  :prefix_list_id,
  :referenced_group_id,
  :description)
  SENSITIVE = []
  include Aws::Structure
end