vpc_peering_authorizations

Creates, updates, deletes, gets or lists a vpc_peering_authorizations resource.

Overview

Name	vpc_peering_authorizations
Type	Resource
Id	aws.gamelift.vpc_peering_authorizations

Fields

The following fields are returned by SELECT queries:

describe_vpc_peering_authorizations

Name	Datatype	Description
vpc_peering_authorizations	array	A collection of objects that describe all valid VPC peering operations for the current Amazon Web Services account.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_vpc_peering_authorizations	select	region		This API works with the following fleet types: EC2 Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account. Related actions All APIs by task
create_vpc_peering_authorization	insert	region, GameLiftAwsAccountId, PeerVpcId		This API works with the following fleet types: EC2 Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift Servers fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. After you've received authorization, use CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Servers Fleets. You can peer with VPCs that are owned by any Amazon Web Services account you have access to, including the account that you use to manage your Amazon GameLift Servers fleets. You cannot peer with VPCs that are in different Regions. To request authorization to create a connection, call this operation from the Amazon Web Services account with the VPC that you want to peer to your Amazon GameLift Servers fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon GameLift Servers. If successful, VPC peering is authorized for the specified VPC. To request authorization to delete a connection, call this operation from the Amazon Web Services account with the VPC that is peered with your Amazon GameLift Servers fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the Amazon Web Services account that you use to manage Amazon GameLift Servers. The authorization remains valid for 24 hours unless it is canceled. You must create or delete the peering connection while the authorization is valid. Amazon GameLift Servers uses the caller's credentials to update peer-VPC resources. The IAM user that calls this operation must have the following Amazon EC2 permissions enabled: ec2:AcceptVpcPeeringConnection ec2:AuthorizeSecurityGroupEgress ec2:AuthorizeSecurityGroupIngress ec2:CreateRoute ec2:DescribeRouteTables ec2:DescribeSecurityGroups Related actions All APIs by task
delete_vpc_peering_authorization	delete	region		This API works with the following fleet types: EC2 Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, use DeleteVpcPeeringConnection. Related actions All APIs by task

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_vpc_peering_authorizations

This API works with the following fleet types: EC2 Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account. Related actions All APIs by task

SELECT
vpc_peering_authorizations
FROM aws.gamelift.vpc_peering_authorizations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_vpc_peering_authorization

This API works with the following fleet types: EC2 Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift Servers fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. After you've received authorization, use CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Servers Fleets. You can peer with VPCs that are owned by any Amazon Web Services account you have access to, including the account that you use to manage your Amazon GameLift Servers fleets. You cannot peer with VPCs that are in different Regions. To request authorization to create a connection, call this operation from the Amazon Web Services account with the VPC that you want to peer to your Amazon GameLift Servers fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon GameLift Servers. If successful, VPC peering is authorized for the specified VPC. To request authorization to delete a connection, call this operation from the Amazon Web Services account with the VPC that is peered with your Amazon GameLift Servers fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the Amazon Web Services account that you use to manage Amazon GameLift Servers. The authorization remains valid for 24 hours unless it is canceled. You must create or delete the peering connection while the authorization is valid. Amazon GameLift Servers uses the caller's credentials to update peer-VPC resources. The IAM user that calls this operation must have the following Amazon EC2 permissions enabled: ec2:AcceptVpcPeeringConnection ec2:AuthorizeSecurityGroupEgress ec2:AuthorizeSecurityGroupIngress ec2:CreateRoute ec2:DescribeRouteTables ec2:DescribeSecurityGroups Related actions All APIs by task

INSERT INTO aws.gamelift.vpc_peering_authorizations (
GameLiftAwsAccountId,
PeerVpcId,
region
)
SELECT 
'{{ GameLiftAwsAccountId }}' /* required */,
'{{ PeerVpcId }}' /* required */,
'{{ region }}'
RETURNING
vpc_peering_authorization
;

Manifest

# Description fields are for documentation purposes
- name: vpc_peering_authorizations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vpc_peering_authorizations resource.
  - name: GameLiftAwsAccountId
    value: "{{ GameLiftAwsAccountId }}"
    description: |
      A unique identifier for the Amazon Web Services account that you use to manage your Amazon GameLift Servers fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.
  - name: PeerVpcId
    value: "{{ PeerVpcId }}"
    description: |
      A unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Servers Fleets.

DELETE examples

delete_vpc_peering_authorization

This API works with the following fleet types: EC2 Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, use DeleteVpcPeeringConnection. Related actions All APIs by task

DELETE FROM aws.gamelift.vpc_peering_authorizations
WHERE region = '{{ region }}' --required
;