container_group_port_mappings
Creates, updates, deletes, gets or lists a container_group_port_mappings resource.
Overview
| Name | container_group_port_mappings |
| Type | Resource |
| Id | aws.gamelift.container_group_port_mappings |
Fields
The following fields are returned by SELECT queries:
- describe_container_group_port_mappings
| Name | Datatype | Description |
|---|---|---|
compute_name | string | A unique identifier for the compute resource running the game server container group. Returned when ContainerGroupType is GAME_SERVER. (pattern: <code>^[a-zA-Z0-9-]+(/[a-zA-Z0-9-]+)?$</code>) |
container_group_definition_arn | string | The Amazon Resource Name (ARN) that is assigned to the container group definition. The ARN value also identifies the specific container group definition version in use. (pattern: <code>^arn:.*:containergroupdefinition/[a-zA-Z0-9-]+(:[0-9]+)?$</code>) |
container_group_port_mappings | array | A list of ContainerGroupPortMapping objects that describe the port mappings for each container in the container group. |
container_group_type | string | The type of container group that was specified in the request. Valid values are GAME_SERVER or PER_INSTANCE. (GAME_SERVER, PER_INSTANCE) |
fleet_arn | string | The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift fleet ARN, the resource ID matches the FleetId value. (pattern: <code>^arn:.*:[a-z]*fleet/[a-z]*fleet-[a-zA-Z0-9-]+$</code>) |
fleet_id | string | A unique identifier for the container fleet. (pattern: <code>^[a-z]*fleet-[a-zA-Z0-9-]+$</code>) |
instance_id | string | A unique identifier for the fleet instance. For GAME_SERVER requests, this is the instance running the specified compute. For PER_INSTANCE requests, this is the instance specified in the request. (pattern: <code>^[a-zA-Z0-9.-]+$</code>) |
location | string | The location of the fleet instance, expressed as an Amazon Web Services Region code, such as us-west-2. (pattern: <code>^[A-Za-z0-9-]+$</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_container_group_port_mappings | select | region | This API works with the following fleet types: Container Retrieves the port mappings for a container group running on a container fleet. Port mappings show how container ports are mapped to connection ports on the fleet instance. Use this operation to find the connection port for a specific container on a fleet instance. Request options Get port mappings for a game server container group. Provide the fleet ID, set ContainerGroupType to GAME_SERVER, and specify the ComputeName for the game server container group. Get port mappings for a per-instance container group. Provide the fleet ID, set ContainerGroupType to PER_INSTANCE, and specify the InstanceId for the instance. Optionally filter results to a single container by providing a ContainerName. Results This operation returns the fleet ID, fleet ARN, location, container group definition ARN, container group type, compute name (for game server container groups), instance ID, and a list of ContainerGroupPortMapping objects. Each object contains the container name, runtime ID, and a list of port mappings that show how container ports map to connection ports on the instance. Learn more Connect to containers Create a container group definition |
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_container_group_port_mappings
This API works with the following fleet types: Container Retrieves the port mappings for a container group running on a container fleet. Port mappings show how container ports are mapped to connection ports on the fleet instance. Use this operation to find the connection port for a specific container on a fleet instance. Request options Get port mappings for a game server container group. Provide the fleet ID, set ContainerGroupType to GAME_SERVER, and specify the ComputeName for the game server container group. Get port mappings for a per-instance container group. Provide the fleet ID, set ContainerGroupType to PER_INSTANCE, and specify the InstanceId for the instance. Optionally filter results to a single container by providing a ContainerName. Results This operation returns the fleet ID, fleet ARN, location, container group definition ARN, container group type, compute name (for game server container groups), instance ID, and a list of ContainerGroupPortMapping objects. Each object contains the container name, runtime ID, and a list of port mappings that show how container ports map to connection ports on the instance. Learn more Connect to containers Create a container group definition
SELECT
compute_name,
container_group_definition_arn,
container_group_port_mappings,
container_group_type,
fleet_arn,
fleet_id,
instance_id,
location
FROM aws.gamelift.container_group_port_mappings
WHERE region = '{{ region }}' -- required
;