[ aws . ec2 ]

describe-security-group-references

Description

[VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you’ve specified in this request.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-security-group-references
[--dry-run | --no-dry-run]
--group-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <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 is UnauthorizedOperation .

--group-id (list)

The IDs of the security groups in your account.

(string)

Syntax:

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe security group references

This example describes the security group references for sg-bbbb2222. The response indicates that security group sg-bbbb2222 is being referenced by a security group in VPC vpc-aaaaaaaa.

Command:

aws ec2 describe-security-group-references --group-id sg-bbbbb22222

Output:

{
  "SecurityGroupsReferenceSet": [
    {
      "ReferencingVpcId": "vpc-aaaaaaaa ",
      "GroupId": "sg-bbbbb22222",
      "VpcPeeringConnectionId": "pcx-b04deed9"
    }
  ]
}

Output

SecurityGroupReferenceSet -> (list)

Information about the VPCs with the referencing security groups.

(structure)

Describes a VPC with a security group that references your security group.

GroupId -> (string)

The ID of your security group.

ReferencingVpcId -> (string)

The ID of the VPC with the referencing security group.

VpcPeeringConnectionId -> (string)

The ID of the VPC peering connection.