[ aws . ec2 ]

modify-security-group-rules

Description

Modifies the rules of a security group.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  modify-security-group-rules
--group-id <value>
--security-group-rules <value>
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--group-id (string)

The ID of the security group.

--security-group-rules (list)

Information about the security group properties to update.

(structure)

Describes an update to a security group rule.

SecurityGroupRuleId -> (string)

The ID of the security group rule.

SecurityGroupRule -> (structure)

Information about the security group rule.

IpProtocol -> (string)

The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).

Use -1 to specify all protocols.

FromPort -> (integer)

The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

ToPort -> (integer)

The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.

CidrIpv4 -> (string)

The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.

CidrIpv6 -> (string)

The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.

PrefixListId -> (string)

The ID of the prefix list.

ReferencedGroupId -> (string)

The ID of the security group that is referenced in the security group rule.

Description -> (string)

The description of the security group rule.

Shorthand Syntax:

SecurityGroupRuleId=string,SecurityGroupRule={IpProtocol=string,FromPort=integer,ToPort=integer,CidrIpv4=string,CidrIpv6=string,PrefixListId=string,ReferencedGroupId=string,Description=string} ...

JSON Syntax:

[
  {
    "SecurityGroupRuleId": "string",
    "SecurityGroupRule": {
      "IpProtocol": "string",
      "FromPort": integer,
      "ToPort": integer,
      "CidrIpv4": "string",
      "CidrIpv6": "string",
      "PrefixListId": "string",
      "ReferencedGroupId": "string",
      "Description": "string"
    }
  }
  ...
]

--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 is UnauthorizedOperation .

--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.

See ‘aws help’ for descriptions of global parameters.

Examples

To modify a security group rules to update the rule description, the IP protocol, and the CidrIpv4 address range

The following modify-security-group-rules example updates the description, the IP protocol, and the IPV4 CIDR range of a specified security group rule. Use the security-group-rules parameter to enter the updates for the specified security group rules. -1 specifies all protocols.

aws ec2 modify-security-group-rules \
    --group-id sg-1234567890abcdef0 \
    --security-group-rules SecurityGroupRuleId=sgr-abcdef01234567890,SecurityGroupRule={Description=test,IpProtocol=-1,CidrIpv4=0.0.0.0/0}

Output:

{
    "Return": true
}

For more information about security group rules, see Security group rules <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules.html> in the Amazon EC2 User Guide.

Output

Return -> (boolean)

Returns true if the request succeeds; otherwise, returns an error.