amazonka-gamelift-2.0: Amazon GameLift SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GameLift.UpdateFleetPortSettings

Description

Updates permissions that allow inbound traffic to connect to game sessions that are being hosted on instances 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 GameLift fleets

Synopsis

Creating a Request

data UpdateFleetPortSettings Source #

See: newUpdateFleetPortSettings smart constructor.

Constructors

UpdateFleetPortSettings' 

Fields

Instances

Instances details
ToJSON UpdateFleetPortSettings Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetPortSettings

ToHeaders UpdateFleetPortSettings Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetPortSettings

ToPath UpdateFleetPortSettings Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetPortSettings

ToQuery UpdateFleetPortSettings Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetPortSettings

AWSRequest UpdateFleetPortSettings Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetPortSettings

Generic UpdateFleetPortSettings Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetPortSettings

Associated Types

type Rep UpdateFleetPortSettings :: Type -> Type #

Read UpdateFleetPortSettings Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetPortSettings

Show UpdateFleetPortSettings Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetPortSettings

NFData UpdateFleetPortSettings Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetPortSettings

Methods

rnf :: UpdateFleetPortSettings -> () #

Eq UpdateFleetPortSettings Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetPortSettings

Hashable UpdateFleetPortSettings Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetPortSettings

type AWSResponse UpdateFleetPortSettings Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetPortSettings

type Rep UpdateFleetPortSettings Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetPortSettings

type Rep UpdateFleetPortSettings = D1 ('MetaData "UpdateFleetPortSettings" "Amazonka.GameLift.UpdateFleetPortSettings" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "UpdateFleetPortSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "inboundPermissionAuthorizations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IpPermission])) :*: (S1 ('MetaSel ('Just "inboundPermissionRevocations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IpPermission])) :*: S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateFleetPortSettings Source #

Create a value of UpdateFleetPortSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:inboundPermissionAuthorizations:UpdateFleetPortSettings', updateFleetPortSettings_inboundPermissionAuthorizations - A collection of port settings to be added to the fleet resource.

$sel:inboundPermissionRevocations:UpdateFleetPortSettings', updateFleetPortSettings_inboundPermissionRevocations - A collection of port settings to be removed from the fleet resource.

UpdateFleetPortSettings, updateFleetPortSettings_fleetId - A unique identifier for the fleet to update port settings for. You can use either the fleet ID or ARN value.

Request Lenses

updateFleetPortSettings_inboundPermissionAuthorizations :: Lens' UpdateFleetPortSettings (Maybe [IpPermission]) Source #

A collection of port settings to be added to the fleet resource.

updateFleetPortSettings_inboundPermissionRevocations :: Lens' UpdateFleetPortSettings (Maybe [IpPermission]) Source #

A collection of port settings to be removed from the fleet resource.

updateFleetPortSettings_fleetId :: Lens' UpdateFleetPortSettings Text Source #

A unique identifier for the fleet to update port settings for. You can use either the fleet ID or ARN value.

Destructuring the Response

data UpdateFleetPortSettingsResponse Source #

See: newUpdateFleetPortSettingsResponse smart constructor.

Constructors

UpdateFleetPortSettingsResponse' 

Fields

  • fleetArn :: Maybe Text

    The Amazon Resource Name (ARN) that is assigned to a 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.

  • fleetId :: Maybe Text

    A unique identifier for the fleet that was updated.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic UpdateFleetPortSettingsResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetPortSettings

Associated Types

type Rep UpdateFleetPortSettingsResponse :: Type -> Type #

Read UpdateFleetPortSettingsResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetPortSettings

Show UpdateFleetPortSettingsResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetPortSettings

NFData UpdateFleetPortSettingsResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetPortSettings

Eq UpdateFleetPortSettingsResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetPortSettings

type Rep UpdateFleetPortSettingsResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetPortSettings

type Rep UpdateFleetPortSettingsResponse = D1 ('MetaData "UpdateFleetPortSettingsResponse" "Amazonka.GameLift.UpdateFleetPortSettings" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "UpdateFleetPortSettingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fleetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateFleetPortSettingsResponse Source #

Create a value of UpdateFleetPortSettingsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateFleetPortSettingsResponse, updateFleetPortSettingsResponse_fleetArn - The Amazon Resource Name (ARN) that is assigned to a 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.

UpdateFleetPortSettings, updateFleetPortSettingsResponse_fleetId - A unique identifier for the fleet that was updated.

$sel:httpStatus:UpdateFleetPortSettingsResponse', updateFleetPortSettingsResponse_httpStatus - The response's http status code.

Response Lenses

updateFleetPortSettingsResponse_fleetArn :: Lens' UpdateFleetPortSettingsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) that is assigned to a 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.

updateFleetPortSettingsResponse_fleetId :: Lens' UpdateFleetPortSettingsResponse (Maybe Text) Source #

A unique identifier for the fleet that was updated.