Update Security Group Rule Descriptions Ingress

ec2_update_security_group_rule_descriptions_ingress

R Documentation

Updates the description of an ingress (inbound) security group rule¶

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.

Usage¶

ec2_update_security_group_rule_descriptions_ingress(DryRun, GroupId,
  GroupName, IpPermissions, SecurityGroupRuleDescriptions)

Arguments¶

DryRun

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.

GroupId

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.

GroupName

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

IpPermissions

The IP permissions for the security group rule. You must specify either IP permissions or a description.

SecurityGroupRuleDescriptions

The description for the ingress security group rules. You must specify either a description or IP permissions.

Value¶

A list with the following syntax:

list(
  Return = TRUE|FALSE
)

Request syntax¶

svc$update_security_group_rule_descriptions_ingress(
  DryRun = TRUE|FALSE,
  GroupId = "string",
  GroupName = "string",
  IpPermissions = list(
    list(
      IpProtocol = "string",
      FromPort = 123,
      ToPort = 123,
      UserIdGroupPairs = list(
        list(
          Description = "string",
          UserId = "string",
          GroupName = "string",
          GroupId = "string",
          VpcId = "string",
          VpcPeeringConnectionId = "string",
          PeeringStatus = "string"
        )
      ),
      IpRanges = list(
        list(
          Description = "string",
          CidrIp = "string"
        )
      ),
      Ipv6Ranges = list(
        list(
          Description = "string",
          CidrIpv6 = "string"
        )
      ),
      PrefixListIds = list(
        list(
          Description = "string",
          PrefixListId = "string"
        )
      )
    )
  ),
  SecurityGroupRuleDescriptions = list(
    list(
      SecurityGroupRuleId = "string",
      Description = "string"
    )
  )
)

Examples¶

## Not run: 
# This example updates the description for the specified security group
# rule.
svc$update_security_group_rule_descriptions_ingress(
  GroupId = "sg-123abc12",
  IpPermissions = list(
    list(
      FromPort = 22L,
      IpProtocol = "tcp",
      IpRanges = list(
        list(
          CidrIp = "203.0.113.0/16",
          Description = "SSH access from the LA office"
        )
      ),
      ToPort = 22L
    )
  )
)

## End(Not run)