Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.GameLift.RegisterCompute

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Registers your compute resources in a fleet you previously created. After you register a compute to your fleet, you can monitor and manage your compute using GameLift. The operation returns the compute resource containing SDK endpoint you can use to connect your game server to GameLift.

Learn more

Synopsis

data RegisterCompute = RegisterCompute' {
- certificatePath :: Maybe Text
- dnsName :: Maybe Text
- ipAddress :: Maybe Text
- location :: Maybe Text
- fleetId :: Text
- computeName :: Text
}
newRegisterCompute :: Text -> Text -> RegisterCompute
registerCompute_certificatePath :: Lens' RegisterCompute (Maybe Text)
registerCompute_dnsName :: Lens' RegisterCompute (Maybe Text)
registerCompute_ipAddress :: Lens' RegisterCompute (Maybe Text)
registerCompute_location :: Lens' RegisterCompute (Maybe Text)
registerCompute_fleetId :: Lens' RegisterCompute Text
registerCompute_computeName :: Lens' RegisterCompute Text
data RegisterComputeResponse = RegisterComputeResponse' {
- compute :: Maybe Compute
- httpStatus :: Int
}
newRegisterComputeResponse :: Int -> RegisterComputeResponse
registerComputeResponse_compute :: Lens' RegisterComputeResponse (Maybe Compute)
registerComputeResponse_httpStatus :: Lens' RegisterComputeResponse Int

Creating a Request

data RegisterCompute Source #

See: newRegisterCompute smart constructor.

Constructors

RegisterCompute'

Fields

certificatePath :: Maybe Text
The path to the TLS certificate on your compute resource. The path and certificate are not validated by GameLift.
dnsName :: Maybe Text
The DNS name of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.
ipAddress :: Maybe Text
The IP address of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.
location :: Maybe Text
The name of the custom location you added to the fleet you are registering this compute resource to.
fleetId :: Text
A unique identifier for the fleet to register the compute to. You can use either the fleet ID or ARN value.
computeName :: Text
A descriptive label that is associated with the compute resource registered to your fleet.

Instances

Instances details

ToJSON RegisterCompute Source #
Instance details Defined in Amazonka.GameLift.RegisterCompute Methods toJSON :: RegisterCompute -> Value # toEncoding :: RegisterCompute -> Encoding # toJSONList :: [RegisterCompute] -> Value # toEncodingList :: [RegisterCompute] -> Encoding #
ToHeaders RegisterCompute Source #
Instance details Defined in Amazonka.GameLift.RegisterCompute Methods toHeaders :: RegisterCompute -> [Header] #
ToPath RegisterCompute Source #
Instance details Defined in Amazonka.GameLift.RegisterCompute Methods toPath :: RegisterCompute -> ByteString #
ToQuery RegisterCompute Source #
Instance details Defined in Amazonka.GameLift.RegisterCompute Methods toQuery :: RegisterCompute -> QueryString #
AWSRequest RegisterCompute Source #
Instance details Defined in Amazonka.GameLift.RegisterCompute Associated Types type AWSResponse RegisterCompute # Methods request :: (Service -> Service) -> RegisterCompute -> Request RegisterCompute # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RegisterCompute -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterCompute))) #
Generic RegisterCompute Source #
Instance details Defined in Amazonka.GameLift.RegisterCompute Associated Types type Rep RegisterCompute :: Type -> Type # Methods from :: RegisterCompute -> Rep RegisterCompute x # to :: Rep RegisterCompute x -> RegisterCompute #
Read RegisterCompute Source #
Instance details Defined in Amazonka.GameLift.RegisterCompute Methods readsPrec :: Int -> ReadS RegisterCompute # readList :: ReadS [RegisterCompute] # readPrec :: ReadPrec RegisterCompute # readListPrec :: ReadPrec [RegisterCompute] #
Show RegisterCompute Source #
Instance details Defined in Amazonka.GameLift.RegisterCompute Methods showsPrec :: Int -> RegisterCompute -> ShowS # show :: RegisterCompute -> String # showList :: [RegisterCompute] -> ShowS #
NFData RegisterCompute Source #
Instance details Defined in Amazonka.GameLift.RegisterCompute Methods rnf :: RegisterCompute -> () #
Eq RegisterCompute Source #
Instance details Defined in Amazonka.GameLift.RegisterCompute Methods (==) :: RegisterCompute -> RegisterCompute -> Bool # (/=) :: RegisterCompute -> RegisterCompute -> Bool #
Hashable RegisterCompute Source #
Instance details Defined in Amazonka.GameLift.RegisterCompute Methods hashWithSalt :: Int -> RegisterCompute -> Int # hash :: RegisterCompute -> Int #
type AWSResponse RegisterCompute Source #
Instance details Defined in Amazonka.GameLift.RegisterCompute type AWSResponse RegisterCompute = RegisterComputeResponse
type Rep RegisterCompute Source #
Instance details Defined in Amazonka.GameLift.RegisterCompute type Rep RegisterCompute = D1 ('MetaData "RegisterCompute" "Amazonka.GameLift.RegisterCompute" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "RegisterCompute'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "certificatePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "dnsName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ipAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "computeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newRegisterCompute Source #

Arguments

:: Text	`RegisterCompute`
-> Text	`RegisterCompute`
-> RegisterCompute

Create a value of RegisterCompute 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:certificatePath:RegisterCompute', registerCompute_certificatePath - The path to the TLS certificate on your compute resource. The path and certificate are not validated by GameLift.

RegisterCompute, registerCompute_dnsName - The DNS name of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.

RegisterCompute, registerCompute_ipAddress - The IP address of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.

RegisterCompute, registerCompute_location - The name of the custom location you added to the fleet you are registering this compute resource to.

RegisterCompute, registerCompute_fleetId - A unique identifier for the fleet to register the compute to. You can use either the fleet ID or ARN value.

RegisterCompute, registerCompute_computeName - A descriptive label that is associated with the compute resource registered to your fleet.

Request Lenses

registerCompute_certificatePath :: Lens' RegisterCompute (Maybe Text) Source #

The path to the TLS certificate on your compute resource. The path and certificate are not validated by GameLift.

registerCompute_dnsName :: Lens' RegisterCompute (Maybe Text) Source #

The DNS name of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.

registerCompute_ipAddress :: Lens' RegisterCompute (Maybe Text) Source #

The IP address of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.

registerCompute_location :: Lens' RegisterCompute (Maybe Text) Source #

The name of the custom location you added to the fleet you are registering this compute resource to.

registerCompute_fleetId :: Lens' RegisterCompute Text Source #

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

registerCompute_computeName :: Lens' RegisterCompute Text Source #

A descriptive label that is associated with the compute resource registered to your fleet.

Destructuring the Response

data RegisterComputeResponse Source #

See: newRegisterComputeResponse smart constructor.

Constructors

RegisterComputeResponse'
Fields compute :: Maybe Compute The details of the compute resource you registered to the specified fleet. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic RegisterComputeResponse Source #
Instance details Defined in Amazonka.GameLift.RegisterCompute Associated Types type Rep RegisterComputeResponse :: Type -> Type # Methods from :: RegisterComputeResponse -> Rep RegisterComputeResponse x # to :: Rep RegisterComputeResponse x -> RegisterComputeResponse #
Read RegisterComputeResponse Source #
Instance details Defined in Amazonka.GameLift.RegisterCompute Methods readsPrec :: Int -> ReadS RegisterComputeResponse # readList :: ReadS [RegisterComputeResponse] # readPrec :: ReadPrec RegisterComputeResponse # readListPrec :: ReadPrec [RegisterComputeResponse] #
Show RegisterComputeResponse Source #
Instance details Defined in Amazonka.GameLift.RegisterCompute Methods showsPrec :: Int -> RegisterComputeResponse -> ShowS # show :: RegisterComputeResponse -> String # showList :: [RegisterComputeResponse] -> ShowS #
NFData RegisterComputeResponse Source #
Instance details Defined in Amazonka.GameLift.RegisterCompute Methods rnf :: RegisterComputeResponse -> () #
Eq RegisterComputeResponse Source #
Instance details Defined in Amazonka.GameLift.RegisterCompute Methods (==) :: RegisterComputeResponse -> RegisterComputeResponse -> Bool # (/=) :: RegisterComputeResponse -> RegisterComputeResponse -> Bool #
type Rep RegisterComputeResponse Source #
Instance details Defined in Amazonka.GameLift.RegisterCompute type Rep RegisterComputeResponse = D1 ('MetaData "RegisterComputeResponse" "Amazonka.GameLift.RegisterCompute" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "RegisterComputeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "compute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Compute)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRegisterComputeResponse Source #

Arguments

:: Int	`$sel:httpStatus:RegisterComputeResponse'`
-> RegisterComputeResponse

Create a value of RegisterComputeResponse 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:compute:RegisterComputeResponse', registerComputeResponse_compute - The details of the compute resource you registered to the specified fleet.

$sel:httpStatus:RegisterComputeResponse', registerComputeResponse_httpStatus - The response's http status code.

Response Lenses

registerComputeResponse_compute :: Lens' RegisterComputeResponse (Maybe Compute) Source #

The details of the compute resource you registered to the specified fleet.

registerComputeResponse_httpStatus :: Lens' RegisterComputeResponse Int Source #

The response's http status code.