You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::EC2::Types::AuthorizeSecurityGroupIngressRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::AuthorizeSecurityGroupIngressRequest
- Defined in:
- (unknown)
Overview
When passing AuthorizeSecurityGroupIngressRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
cidr_ip: "String",
from_port: 1,
group_id: "SecurityGroupId",
group_name: "SecurityGroupName",
ip_permissions: [
{
from_port: 1,
ip_protocol: "String",
ip_ranges: [
{
cidr_ip: "String",
description: "String",
},
],
ipv_6_ranges: [
{
cidr_ipv_6: "String",
description: "String",
},
],
prefix_list_ids: [
{
description: "String",
prefix_list_id: "String",
},
],
to_port: 1,
user_id_group_pairs: [
{
description: "String",
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,
}
Instance Attribute Summary collapse
-
#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
The start of port range for the TCP and UDP protocols, or an ICMP type number.
-
#group_id ⇒ String
The ID of the security group.
-
#group_name ⇒ String
[EC2-Classic, 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][1]). -
#source_security_group_name ⇒ String
[EC2-Classic, default VPC] The name of the source security group.
-
#source_security_group_owner_id ⇒ String
[nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account.
-
#to_port ⇒ Integer
The end of port range for the TCP and UDP protocols, or an ICMP code number.
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.
#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
.
#from_port ⇒ Integer
The start of port range for the TCP and UDP protocols, or an ICMP type
number. For the ICMP type number, use -1
to specify all types. If you
specify all ICMP types, you must specify all codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
#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.
#group_name ⇒ String
[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.
#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). To specify icmpv6
, use a set of IP permissions.
[VPC only] 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.
#source_security_group_name ⇒ String
[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.
#source_security_group_owner_id ⇒ String
[nondefault VPC] The AWS 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.
#to_port ⇒ Integer
The end of port range for the TCP and UDP protocols, or an ICMP code
number. For the ICMP code number, use -1
to specify all codes. If you
specify all ICMP types, you must specify all codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.