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

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

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

{
  cidr_ip: "String",
  from_port: 1,
  group_id: "String",
  group_name: "String",
  ip_permissions: [
    {
      from_port: 1,
      ip_protocol: "String",
      ip_ranges: [
        {
          cidr_ip: "String",
        },
      ],
      ipv_6_ranges: [
        {
          cidr_ipv_6: "String",
        },
      ],
      prefix_list_ids: [
        {
          prefix_list_id: "String",
        },
      ],
      to_port: 1,
      user_id_group_pairs: [
        {
          group_id: "String",
          group_name: "String",
          peering_status: "String",
          user_id: "String",
          vpc_id: "String",
          vpc_peering_connection_id: "String",
        },
      ],
    },
  ],
  ip_protocol: "String",
  source_security_group_name: "String",
  source_security_group_owner_id: "String",
  to_port: 1,
  dry_run: false,
}

Contains the parameters for AuthorizeSecurityGroupIngress.

Instance Attribute Summary collapse

Instance Attribute Details

#cidr_ipString

The CIDR IPv4 address range. You can't specify this parameter when specifying a source security group.

Returns:

  • (String)


1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1261

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)
  include Aws::Structure
end

#dry_runBoolean

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)


1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1261

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)
  include Aws::Structure
end

#from_portInteger

The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. For the ICMP/ICMPv6 type number, use -1 to specify all types.

Returns:

  • (Integer)


1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1261

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)
  include Aws::Structure
end

#group_idString

The ID of the security group. Required for a nondefault VPC.

Returns:

  • (String)


1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1261

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)
  include Aws::Structure
end

#group_nameString

[EC2-Classic, default VPC] The name of the security group.

Returns:

  • (String)


1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1261

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)
  include Aws::Structure
end

#ip_permissionsArray<Types::IpPermission>

A set of IP permissions. Can be used to specify multiple rules in a single command.

Returns:



1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1261

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)
  include Aws::Structure
end

#ip_protocolString

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all protocols. If you specify -1, or a protocol number other than tcp, udp, icmp, or 58 (ICMPv6), traffic on all ports is allowed, regardless of any ports you specify. For tcp, udp, and icmp, you must specify a port range. For protocol 58 (ICMPv6), you can optionally specify a port range; if you don't, traffic for all types and codes is allowed.

Returns:

  • (String)


1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1261

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)
  include Aws::Structure
end

#source_security_group_nameString

[EC2-Classic, 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. For EC2-VPC, the source security group must be in the same VPC.

Returns:

  • (String)


1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1261

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)
  include Aws::Structure
end

#source_security_group_owner_idString

[EC2-Classic] The AWS account number 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)


1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1261

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)
  include Aws::Structure
end

#to_portInteger

The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code number. For the ICMP/ICMPv6 code number, use -1 to specify all codes.

Returns:

  • (Integer)


1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1261

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)
  include Aws::Structure
end