update-security-group-rule-descriptions-ingress¶
Description¶
Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
update-security-group-rule-descriptions-ingress
[--dry-run | --no-dry-run]
[--group-id <value>]
[--group-name <value>]
[--ip-permissions <value>]
[--security-group-rule-descriptions <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--dry-run | --no-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 isUnauthorizedOperation.
--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 (list)
The IP permissions for the security group rule. You must specify either IP permissions or a description.
(structure)
Describes a set of permissions for a security group rule.
FromPort -> (integer)
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of
-1indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.IpProtocol -> (string)
The IP protocol name (
tcp,udp,icmp,icmpv6) or number (see Protocol Numbers ).[VPC only] Use
-1to specify all protocols. When authorizing security group rules, specifying-1or a protocol number other thantcp,udp,icmp, oricmpv6allows traffic on all ports, regardless of any port range you specify. Fortcp,udp, andicmp, you must specify a port range. Foricmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.IpRanges -> (list)
The IPv4 ranges.
(structure)
Describes an IPv4 range.
CidrIp -> (string)
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
Description -> (string)
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
Ipv6Ranges -> (list)
[VPC only] The IPv6 ranges.
(structure)
[EC2-VPC only] Describes an IPv6 range.
CidrIpv6 -> (string)
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
Description -> (string)
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
PrefixListIds -> (list)
[VPC only] The prefix list IDs.
(structure)
Describes a prefix list ID.
Description -> (string)
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
PrefixListId -> (string)
The ID of the prefix.
ToPort -> (integer)
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of
-1indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.UserIdGroupPairs -> (list)
The security group and Amazon Web Services account ID pairs.
(structure)
Describes a security group and Amazon Web Services account ID pair.
Note
We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide .
Description -> (string)
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
GroupId -> (string)
The ID of the security group.
GroupName -> (string)
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
PeeringStatus -> (string)
The status of a VPC peering connection, if applicable.
UserId -> (string)
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
VpcId -> (string)
The ID of the VPC for the referenced security group, if applicable.
VpcPeeringConnectionId -> (string)
The ID of the VPC peering connection, if applicable.
Shorthand Syntax:
FromPort=integer,IpProtocol=string,IpRanges=[{CidrIp=string,Description=string},{CidrIp=string,Description=string}],Ipv6Ranges=[{CidrIpv6=string,Description=string},{CidrIpv6=string,Description=string}],PrefixListIds=[{Description=string,PrefixListId=string},{Description=string,PrefixListId=string}],ToPort=integer,UserIdGroupPairs=[{Description=string,GroupId=string,GroupName=string,PeeringStatus=string,UserId=string,VpcId=string,VpcPeeringConnectionId=string},{Description=string,GroupId=string,GroupName=string,PeeringStatus=string,UserId=string,VpcId=string,VpcPeeringConnectionId=string}] ...
JSON Syntax:
[
{
"FromPort": integer,
"IpProtocol": "string",
"IpRanges": [
{
"CidrIp": "string",
"Description": "string"
}
...
],
"Ipv6Ranges": [
{
"CidrIpv6": "string",
"Description": "string"
}
...
],
"PrefixListIds": [
{
"Description": "string",
"PrefixListId": "string"
}
...
],
"ToPort": integer,
"UserIdGroupPairs": [
{
"Description": "string",
"GroupId": "string",
"GroupName": "string",
"PeeringStatus": "string",
"UserId": "string",
"VpcId": "string",
"VpcPeeringConnectionId": "string"
}
...
]
}
...
]
--security-group-rule-descriptions (list)
[VPC only] The description for the ingress security group rules. You must specify either a description or IP permissions.
(structure)
Describes the description of a security group rule.
You can use this when you want to update the security group rule description for either an inbound or outbound rule.
SecurityGroupRuleId -> (string)
The ID of the security group rule.
Description -> (string)
The description of the security group rule.
Shorthand Syntax:
SecurityGroupRuleId=string,Description=string ...
JSON Syntax:
[
{
"SecurityGroupRuleId": "string",
"Description": "string"
}
...
]
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
Example 1: To update the description of an inbound security group rule with a CIDR source
The following update-security-group-rule-descriptions-ingress example updates the description for the security group rule for the specified port and IPv4 address range. The description ‘SSH access from ABC office’ replaces any existing description for the rule.
aws ec2 update-security-group-rule-descriptions-ingress \
--group-id sg-02f0d35a850ba727f \
--ip-permissions IpProtocol=tcp,FromPort=22,ToPort=22,IpRanges='[{CidrIp=203.0.113.0/16,Description="SSH access from corpnet"}]'
Output:
{
"Return": true
}
For more information, see Security group rules in the Amazon EC2 User Guide.
Example 2: To update the description of an inbound security group rule with a prefix list source
The following update-security-group-rule-descriptions-ingress example updates the description for the security group rule for the specified port and prefix list. The description ‘SSH access from ABC office’ replaces any existing description for the rule.
aws ec2 update-security-group-rule-descriptions-ingress \
--group-id sg-02f0d35a850ba727f \
--ip-permissions IpProtocol=tcp,FromPort=22,ToPort=22,PrefixListIds='[{PrefixListId=pl-12345678,Description="SSH access from corpnet"}]'
Output:
{
"Return": true
}
For more information, see Security group rules in the Amazon EC2 User Guide.