[ aws . gamelift ]

describe-container-group-port-mappings

Description

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, 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

See also: AWS API Documentation

Synopsis

  describe-container-group-port-mappings
--fleet-id <value>
--container-group-type <value>
[--compute-name <value>]
[--instance-id <value>]
[--container-name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--fleet-id (string) [required]

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

Constraints:

• min: 1
• max: 512
• pattern: ^[a-z]*fleet-[a-zA-Z0-9\-]+$|^arn:.*:[a-z]*fleet\/[a-z]*fleet-[a-zA-Z0-9\-]+$

--container-group-type (string) [required]

The type of container group to retrieve port mappings for.

• GAME_SERVER – Get port mappings for a game server container group.
• PER_INSTANCE – Get port mappings for a per-instance container group.

Possible values:

• GAME_SERVER
• PER_INSTANCE

--compute-name (string)

A unique identifier for the compute resource for which to retrieve port mappings. For a container fleet, a compute represents a game server container group running on a fleet instance. You can use either the compute name or ARN value.

When ContainerGroupType is GAME_SERVER , this parameter is required.

When ContainerGroupType is PER_INSTANCE , do not provide this parameter. If you provide a compute name with PER_INSTANCE , the request fails with an InvalidRequestException .

Constraints:

• max: 1024
• pattern: ^[a-zA-Z0-9\-]+(\/[a-zA-Z0-9\-]+)?$|^arn:.*:compute\/[a-zA-Z0-9\-]+(\/[a-zA-Z0-9\-]+)?

--instance-id (string)

A unique identifier for the fleet instance to retrieve port mappings for.

When ContainerGroupType is PER_INSTANCE , this parameter is required.

When ContainerGroupType is GAME_SERVER , this parameter is optional. If you provide an instance ID, it must match the instance that’s running the specified compute. If the instance ID doesn’t match, the request fails with an InvalidRequestException .

Constraints:

• pattern: [a-zA-Z0-9\.-]+

--container-name (string)

A container name to filter the results. When provided, the operation returns port mappings for the specified container only. If no container with the specified name exists in the container group, the request fails with a NotFoundException .

If not provided, the operation returns port mappings for all containers in the container group.

Constraints:

• min: 1
• max: 128
• pattern: ^[a-zA-Z0-9\-]+$

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream
• off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

FleetId -> (string)

A unique identifier for the container fleet.

Constraints:

• min: 1
• max: 128
• pattern: ^[a-z]*fleet-[a-zA-Z0-9\-]+

Location -> (string)

The location of the fleet instance, expressed as an Amazon Web Services Region code, such as us-west-2 .

Constraints:

• min: 1
• max: 64
• pattern: ^[A-Za-z0-9\-]+

ContainerGroupDefinitionArn -> (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.

Constraints:

• min: 1
• max: 512
• pattern: ^arn:.*:containergroupdefinition\/[a-zA-Z0-9\-]+(:[0-9]+)?$

ContainerGroupType -> (string)

The type of container group that was specified in the request. Valid values are GAME_SERVER or PER_INSTANCE .

Possible values:

• GAME_SERVER
• PER_INSTANCE

ComputeName -> (string)

A unique identifier for the compute resource running the game server container group. Returned when ContainerGroupType is GAME_SERVER .

Constraints:

• min: 1
• max: 128
• pattern: ^[a-zA-Z0-9\-]+(\/[a-zA-Z0-9\-]+)?

InstanceId -> (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.

Constraints:

• pattern: [a-zA-Z0-9\.-]+

ContainerGroupPortMappings -> (list)

A list of ContainerGroupPortMapping objects that describe the port mappings for each container in the container group.

(structure)

Describes the port mappings for a single container in a container group. Each mapping shows how a container port maps to a connection port on the fleet instance.

Returned by: DescribeContainerGroupPortMappings

ContainerName -> (string)

The name of the container, as defined in the container group definition.

Constraints:

• min: 1
• max: 128
• pattern: ^[a-zA-Z0-9\-]+$

ContainerRuntimeId -> (string)

The runtime ID for the container that’s running in a compute. This value is unique within the compute.

Constraints:

• min: 1

ContainerPortMappings -> (list)

A list of ContainerPortMapping objects that describe the port mappings for this container.

(structure)

Describes a mapping between a container port and a connection port on a fleet instance. You define container ports in a container group definition. Amazon GameLift Servers assigns connection ports when it deploys the container group to an instance.

Part of: ContainerGroupPortMapping

ContainerPort -> (integer)

The port number on the container. This port is defined in the container group definition. Container port numbers must be unique within a container group definition.

Constraints:

• min: 1
• max: 60000

ConnectionPort -> (integer)

The port number on the fleet instance that maps to the container port. Connection ports are assigned by Amazon GameLift Servers when the container group is deployed to an instance.

Constraints:

• min: 1
• max: 60000

Protocol -> (string)

The network protocol for the port mapping. Valid values are TCP or UDP .

Possible values:

• TCP
• UDP