Skip to content

aws.gamelift.describe_vpc_peering_connections

Example SQL Queries

SELECT * FROM
aws.gamelift.describe_vpc_peering_connections;

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

Table Definition

Column NameColumn Data Type
fleet_id Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
vpc_peering_connections

A collection of VPC peering connection records that match the request.

STRUCT(
"fleet_id" VARCHAR,
"fleet_arn" VARCHAR,
"ip_v4_cidr_block" VARCHAR,
"vpc_peering_connection_id" VARCHAR,
"status" STRUCT(
"code" VARCHAR,
"message" VARCHAR
),
"peer_vpc_id" VARCHAR,
"game_lift_vpc_id" VARCHAR
)[]
Show child fields
vpc_peering_connections[]
Show child fields
vpc_peering_connections[].fleet_arn

The Amazon Resource Name (ARN) associated with the GameLift fleet resource for this connection.

vpc_peering_connections[].fleet_id

A unique identifier for the fleet. This ID determines the ID of the Amazon GameLift VPC for your fleet.

vpc_peering_connections[].game_lift_vpc_id

A 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 Amazon Web Services account.

vpc_peering_connections[].ip_v4_cidr_block

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.

vpc_peering_connections[].peer_vpc_id

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift 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 Fleets.

vpc_peering_connections[].status

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

Show child fields
vpc_peering_connections[].status.code

Code indicating the status of a VPC peering connection.

vpc_peering_connections[].status.message

Additional messaging associated with the connection status.

vpc_peering_connections[].vpc_peering_connection_id

A 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.