Menu
Amazon GameLift Service
API Reference (API Version 2015-10-01)

VpcPeeringConnection

Represents a peering connection between a VPC on one of your AWS accounts and the VPC for your Amazon GameLift fleets. This record may be for an active peering connection or a pending connection that has not yet been established.

VPC peering connection operations include:

Contents

Note

In the following list, the required parameters are described first.

FleetId

Unique identifier for a fleet. This ID determines the ID of the Amazon GameLift VPC for your fleet.

Type: String

Pattern: ^fleet-\S+

Required: No

GameLiftVpcId

Unique identifier for the VPC that contains the Amazon GameLift fleet for this connection. This VPC is managed by Amazon GameLift and does not appear in your AWS account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

IpV4CidrBlock

CIDR block of IPv4 addresses assigned to the VPC peering connection for the GameLift VPC. The peered VPC also has an IPv4 CIDR block associated with it; these blocks cannot overlap or the peering connection cannot be created.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

PeerVpcId

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. To get VPC information, including IDs, use the Virtual Private Cloud service tools, including the VPC Dashboard in the AWS Management Console.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Status

Object that contains status information about the connection. Status indicates if a connection is pending, successful, or failed.

Type: VpcPeeringConnectionStatus object

Required: No

VpcPeeringConnectionId

Unique identifier that is automatically assigned to the connection record. This ID is referenced in VPC peering connection events, and is used when deleting a connection with DeleteVpcPeeringConnection.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: