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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

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)


60481
60482
60483
60484
60485
60486
60487
60488
60489
60490
60491
60492
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 60481

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)


60481
60482
60483
60484
60485
60486
60487
60488
60489
60490
60491
60492
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 60481

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)


60481
60482
60483
60484
60485
60486
60487
60488
60489
60490
60491
60492
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 60481

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

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)


60481
60482
60483
60484
60485
60486
60487
60488
60489
60490
60491
60492
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 60481

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)


60481
60482
60483
60484
60485
60486
60487
60488
60489
60490
60491
60492
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 60481

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)


60481
60482
60483
60484
60485
60486
60487
60488
60489
60490
60491
60492
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 60481

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)


60481
60482
60483
60484
60485
60486
60487
60488
60489
60490
60491
60492
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 60481

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

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)


60481
60482
60483
60484
60485
60486
60487
60488
60489
60490
60491
60492
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 60481

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