amazonka-gamelift-2.0: Amazon GameLift SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GameLift.DescribeVpcPeeringConnections

Description

Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID.

To retrieve connection information, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect.

Related actions

All APIs by task

Synopsis

Creating a Request

data DescribeVpcPeeringConnections Source #

See: newDescribeVpcPeeringConnections smart constructor.

Constructors

DescribeVpcPeeringConnections' 

Fields

  • fleetId :: Maybe Text

    A unique identifier for the fleet. You can use either the fleet ID or ARN value.

Instances

Instances details
ToJSON DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.GameLift.DescribeVpcPeeringConnections

ToHeaders DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.GameLift.DescribeVpcPeeringConnections

ToPath DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.GameLift.DescribeVpcPeeringConnections

ToQuery DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.GameLift.DescribeVpcPeeringConnections

AWSRequest DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.GameLift.DescribeVpcPeeringConnections

Generic DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.GameLift.DescribeVpcPeeringConnections

Associated Types

type Rep DescribeVpcPeeringConnections :: Type -> Type #

Read DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.GameLift.DescribeVpcPeeringConnections

Show DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.GameLift.DescribeVpcPeeringConnections

NFData DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.GameLift.DescribeVpcPeeringConnections

Eq DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.GameLift.DescribeVpcPeeringConnections

Hashable DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.GameLift.DescribeVpcPeeringConnections

type AWSResponse DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.GameLift.DescribeVpcPeeringConnections

type Rep DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.GameLift.DescribeVpcPeeringConnections

type Rep DescribeVpcPeeringConnections = D1 ('MetaData "DescribeVpcPeeringConnections" "Amazonka.GameLift.DescribeVpcPeeringConnections" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DescribeVpcPeeringConnections'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDescribeVpcPeeringConnections :: DescribeVpcPeeringConnections Source #

Create a value of DescribeVpcPeeringConnections with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeVpcPeeringConnections, describeVpcPeeringConnections_fleetId - A unique identifier for the fleet. You can use either the fleet ID or ARN value.

Request Lenses

describeVpcPeeringConnections_fleetId :: Lens' DescribeVpcPeeringConnections (Maybe Text) Source #

A unique identifier for the fleet. You can use either the fleet ID or ARN value.

Destructuring the Response

data DescribeVpcPeeringConnectionsResponse Source #

Constructors

DescribeVpcPeeringConnectionsResponse' 

Fields

Instances

Instances details
Generic DescribeVpcPeeringConnectionsResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeVpcPeeringConnections

Read DescribeVpcPeeringConnectionsResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeVpcPeeringConnections

Show DescribeVpcPeeringConnectionsResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeVpcPeeringConnections

NFData DescribeVpcPeeringConnectionsResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeVpcPeeringConnections

Eq DescribeVpcPeeringConnectionsResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeVpcPeeringConnections

type Rep DescribeVpcPeeringConnectionsResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeVpcPeeringConnections

type Rep DescribeVpcPeeringConnectionsResponse = D1 ('MetaData "DescribeVpcPeeringConnectionsResponse" "Amazonka.GameLift.DescribeVpcPeeringConnections" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DescribeVpcPeeringConnectionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "vpcPeeringConnections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VpcPeeringConnection])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeVpcPeeringConnectionsResponse Source #

Create a value of DescribeVpcPeeringConnectionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:vpcPeeringConnections:DescribeVpcPeeringConnectionsResponse', describeVpcPeeringConnectionsResponse_vpcPeeringConnections - A collection of VPC peering connection records that match the request.

$sel:httpStatus:DescribeVpcPeeringConnectionsResponse', describeVpcPeeringConnectionsResponse_httpStatus - The response's http status code.

Response Lenses