UpdateFleetPortSettings
Updates permissions that allow inbound traffic to connect to game sessions in the fleet.
To update settings, specify the fleet ID to be updated and specify the changes to be
made. List the permissions you want to add in
InboundPermissionAuthorizations
, and permissions you want to remove in
InboundPermissionRevocations
. Permissions to be removed must match
existing fleet permissions.
If successful, the fleet ID for the updated fleet is returned. For fleets with remote
locations, port setting updates can take time to propagate across all locations. You can
check the status of updates in each location by calling
DescribeFleetPortSettings
with a location name.
Learn more
Setting up Amazon GameLift fleets
Request Syntax
{
"FleetId": "string
",
"InboundPermissionAuthorizations": [
{
"FromPort": number
,
"IpRange": "string
",
"Protocol": "string
",
"ToPort": number
}
],
"InboundPermissionRevocations": [
{
"FromPort": number
,
"IpRange": "string
",
"Protocol": "string
",
"ToPort": number
}
]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
- FleetId
-
A unique identifier for the fleet to update port settings for. You can use either the fleet ID or ARN value.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
^[a-z]*fleet-[a-zA-Z0-9\-]+$|^arn:.*:[a-z]*fleet\/[a-z]*fleet-[a-zA-Z0-9\-]+$
Required: Yes
- InboundPermissionAuthorizations
-
A collection of port settings to be added to the fleet resource.
Type: Array of IpPermission objects
Array Members: Maximum number of 50 items.
Required: No
- InboundPermissionRevocations
-
A collection of port settings to be removed from the fleet resource.
Type: Array of IpPermission objects
Array Members: Maximum number of 50 items.
Required: No
Response Syntax
{
"FleetArn": "string",
"FleetId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- FleetArn
-
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift 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
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
^arn:.*:[a-z]*fleet\/[a-z]*fleet-[a-zA-Z0-9\-]+$
- FleetId
-
A unique identifier for the fleet that was updated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[a-z]*fleet-[a-zA-Z0-9\-]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
HTTP Status Code: 400
- InternalServiceException
-
The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
HTTP Status Code: 500
- InvalidFleetStatusException
-
The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.
HTTP Status Code: 400
- InvalidRequestException
-
One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
HTTP Status Code: 400
- LimitExceededException
-
The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
HTTP Status Code: 400
- NotFoundException
-
The requested resources was not found. The resource was either not created yet or deleted.
HTTP Status Code: 400
- UnauthorizedException
-
The client failed authentication. Clients should not retry such requests.
HTTP Status Code: 400
Examples
Update fleet to open to enable SSH access
The following example opens port 22 for SSH access:
HTTP requests are authenticated using an Amazon Signature Version 4 signature in the Authorization
header field.
Sample Request
{
"FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
"InboundPermissionAuthorizations": [
{
"FromPort": 22,
"IpRange": "54.186.139.221/32",
"Protocol": "TCP",
"ToPort": 22
}
]
}
Sample Response
{
"FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa"
}
Update fleet to enable Windows Remote Desktop access
The following example opens port 3389 for Windows Remote Desktop access:
HTTP requests are authenticated using an Amazon Signature Version 4 signature in the Authorization
header field.
Sample Request
{
"FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
"InboundPermissionAuthorizations": [
{
"FromPort": 3389,
"IpRange": "54.186.139.221/32",
"Protocol": "TCP",
"ToPort": 3389
}
]
}
Sample Response
{
"FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa"
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: