createVpcPeeringConnection method

Future<void> createVpcPeeringConnection({
  1. required String fleetId,
  2. required String peerVpcAwsAccountId,
  3. required String peerVpcId,
})

Establishes a VPC peering connection between a virtual private cloud (VPC) in an AWS account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. You can peer with VPCs in any AWS account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions. For more information, see VPC Peering with Amazon GameLift Fleets.

Before calling this operation to establish the peering connection, you first need to call CreateVpcPeeringAuthorization and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc.

To establish the connection, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The AWS account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a VpcPeeringConnection request is created. You can use continuous polling to track the request's status using DescribeVpcPeeringConnections, or by monitoring fleet events for success or failure using DescribeFleetEvents.

May throw UnauthorizedException. May throw InvalidRequestException. May throw NotFoundException. May throw InternalServiceException.

Parameter fleetId : A unique identifier for a fleet. You can use either the fleet ID or ARN value. This tells Amazon GameLift which GameLift VPC to peer with.

Parameter peerVpcAwsAccountId : A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.

Parameter peerVpcId : A 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. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

Implementation

Future<void> createVpcPeeringConnection({
  required String fleetId,
  required String peerVpcAwsAccountId,
  required String peerVpcId,
}) async {
  ArgumentError.checkNotNull(fleetId, 'fleetId');
  ArgumentError.checkNotNull(peerVpcAwsAccountId, 'peerVpcAwsAccountId');
  _s.validateStringLength(
    'peerVpcAwsAccountId',
    peerVpcAwsAccountId,
    1,
    1024,
    isRequired: true,
  );
  ArgumentError.checkNotNull(peerVpcId, 'peerVpcId');
  _s.validateStringLength(
    'peerVpcId',
    peerVpcId,
    1,
    1024,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'GameLift.CreateVpcPeeringConnection'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'FleetId': fleetId,
      'PeerVpcAwsAccountId': peerVpcAwsAccountId,
      'PeerVpcId': peerVpcId,
    },
  );
}