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 sets of IP permissions.

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

  [Nondefault VPC] 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>

  [VPC Only] 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. You can’t specify this parameter when specifying a source security group. To specify an IPv6 address range, use a set of IP permissions.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

Returns:

• (String)

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

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,
  :dry_run,
  :tag_specifications)
  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 3378

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

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

Returns:

• (Integer)

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

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,
  :dry_run,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#group_id ⇒ String

The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

Returns:

• (String)

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

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,
  :dry_run,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#group_name ⇒ String

[Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

Returns:

• (String)

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

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,
  :dry_run,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#ip_permissions ⇒ Array<Types::IpPermission>

The sets of IP permissions.

Returns:

• (Array<Types::IpPermission>)

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

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,
  :dry_run,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#ip_protocol ⇒ String

The IP protocol name (‘tcp`, `udp`, `icmp`) or number (see [Protocol Numbers]). To specify `icmpv6`, use a set of IP permissions.

Use ‘-1` to specify all protocols. If you specify `-1` or a protocol other than `tcp`, `udp`, or `icmp`, traffic on all ports is allowed, regardless of any ports you specify.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

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

Returns:

• (String)

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

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,
  :dry_run,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#source_security_group_name ⇒ String

[Default VPC] The name of the source security group. You can’t specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. The source security group must be in the same VPC.

Returns:

• (String)

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

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,
  :dry_run,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#source_security_group_owner_id ⇒ String

[Nondefault VPC] The Amazon Web Services account ID for the source security group, if the source security group is in a different account. You can’t specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.

Returns:

• (String)

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

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,
  :dry_run,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

[VPC Only] The tags applied to the security group rule.

Returns:

• (Array<Types::TagSpecification>)

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

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,
  :dry_run,
  :tag_specifications)
  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 code. A value of -1 indicates all ICMP codes. If you specify all ICMP types, you must specify all ICMP codes.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

Returns:

• (Integer)

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

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,
  :dry_run,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end