Class: Aws::EC2::Types::AuthorizeSecurityGroupIngressRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::AuthorizeSecurityGroupIngressRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cidr_ip ⇒ String

  The IPv4 address range, in CIDR format.

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #from_port ⇒ Integer

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

• #group_id ⇒ String

  The ID of the security group.

• #group_name ⇒ String

  [Default VPC] The name of the security group.

• #ip_permissions ⇒ Array<Types::IpPermission>

  The permissions for the security group rules.

• #ip_protocol ⇒ String

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

• #source_security_group_name ⇒ String

  [Default VPC] The name of the source security group.

• #source_security_group_owner_id ⇒ String

  The Amazon Web Services account ID for the source security group, if the source security group is in a different account.

• #tag_specifications ⇒ Array<Types::TagSpecification>

  The tags applied to the security group rule.

• #to_port ⇒ Integer

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

Instance Attribute Details

#cidr_ip ⇒ String

The IPv4 address range, in CIDR format.

<note markdown=“1”> Amazon Web Services [canonicalizes] IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error.

</note>

To specify an IPv6 address range, use IP permissions instead.

To specify multiple rules and descriptions for the rules, use IP permissions instead.

[1]: en.wikipedia.org/wiki/Canonicalization

Returns:

• (String)

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

class AuthorizeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :tag_specifications,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ‘DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.

Returns:

• (Boolean)

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

class AuthorizeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :tag_specifications,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#from_port ⇒ Integer

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

To specify multiple rules and descriptions for the rules, use IP permissions instead.

Returns:

• (Integer)

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

class AuthorizeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :tag_specifications,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#group_id ⇒ String

The ID of the security group.

Returns:

• (String)

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

class AuthorizeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :tag_specifications,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#group_name ⇒ String

[Default VPC] The name of the security group. For security groups for a default VPC you can specify either the ID or the name of the security group. For security groups for a nondefault VPC, you must specify the ID of the security group.

Returns:

• (String)

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

class AuthorizeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :tag_specifications,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#ip_permissions ⇒ Array<Types::IpPermission>

The permissions for the security group rules.

Returns:

• (Array<Types::IpPermission>)

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

class AuthorizeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :tag_specifications,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#ip_protocol ⇒ String

The IP protocol name (‘tcp`, `udp`, `icmp`) or number (see [Protocol Numbers]). To specify all protocols, use `-1`.

To specify ‘icmpv6`, use IP permissions instead.

If you specify a protocol other than one of the supported values, traffic is allowed on all ports, regardless of any ports that you specify.

To specify multiple rules and descriptions for the rules, use IP permissions instead.

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

Returns:

• (String)

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

class AuthorizeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :tag_specifications,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#source_security_group_name ⇒ String

[Default VPC] The name of the source security group.

The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, specify a set of IP permissions instead.

Returns:

• (String)

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

class AuthorizeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :tag_specifications,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#source_security_group_owner_id ⇒ String

The Amazon Web Services account ID for the source security group, if the source security group is in a different account.

The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, use IP permissions instead.

Returns:

• (String)

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

class AuthorizeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :tag_specifications,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags applied to the security group rule.

Returns:

• (Array<Types::TagSpecification>)

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

class AuthorizeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :tag_specifications,
  :dry_run)
  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, 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).

To specify multiple rules and descriptions for the rules, use IP permissions instead.

Returns:

• (Integer)

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

class AuthorizeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :tag_specifications,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end