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.CreateVpcPeeringAuthorization

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. After you've received authorization, use CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Fleets.

You can peer with VPCs that are owned by any Amazon Web Services account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions.

To request authorization to create a connection, call this operation from the Amazon Web Services account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC.

To request authorization to delete a connection, call this operation from the Amazon Web Services account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the Amazon Web Services account that you use to manage Amazon GameLift.

The authorization remains valid for 24 hours unless it is canceled. You must create or delete the peering connection while the authorization is valid.

Related actions

All APIs by task

Synopsis

data CreateVpcPeeringAuthorization = CreateVpcPeeringAuthorization' {
- gameLiftAwsAccountId :: Text
- peerVpcId :: Text
}
newCreateVpcPeeringAuthorization :: Text -> Text -> CreateVpcPeeringAuthorization
createVpcPeeringAuthorization_gameLiftAwsAccountId :: Lens' CreateVpcPeeringAuthorization Text
createVpcPeeringAuthorization_peerVpcId :: Lens' CreateVpcPeeringAuthorization Text
data CreateVpcPeeringAuthorizationResponse = CreateVpcPeeringAuthorizationResponse' {
- vpcPeeringAuthorization :: Maybe VpcPeeringAuthorization
- httpStatus :: Int
}
newCreateVpcPeeringAuthorizationResponse :: Int -> CreateVpcPeeringAuthorizationResponse
createVpcPeeringAuthorizationResponse_vpcPeeringAuthorization :: Lens' CreateVpcPeeringAuthorizationResponse (Maybe VpcPeeringAuthorization)
createVpcPeeringAuthorizationResponse_httpStatus :: Lens' CreateVpcPeeringAuthorizationResponse Int

Creating a Request

data CreateVpcPeeringAuthorization Source #

See: newCreateVpcPeeringAuthorization smart constructor.

Constructors

CreateVpcPeeringAuthorization'

Fields

gameLiftAwsAccountId :: Text
A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.
peerVpcId :: Text
A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.

Instances

Instances details

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

newCreateVpcPeeringAuthorization Source #

Arguments

:: Text	`CreateVpcPeeringAuthorization`
-> Text	`CreateVpcPeeringAuthorization`
-> CreateVpcPeeringAuthorization

Create a value of CreateVpcPeeringAuthorization 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:

CreateVpcPeeringAuthorization, createVpcPeeringAuthorization_gameLiftAwsAccountId - A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.

CreateVpcPeeringAuthorization, createVpcPeeringAuthorization_peerVpcId - A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.

Request Lenses

createVpcPeeringAuthorization_gameLiftAwsAccountId :: Lens' CreateVpcPeeringAuthorization Text Source #

A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.

createVpcPeeringAuthorization_peerVpcId :: Lens' CreateVpcPeeringAuthorization Text Source #

A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.

Destructuring the Response

data CreateVpcPeeringAuthorizationResponse Source #

See: newCreateVpcPeeringAuthorizationResponse smart constructor.

Constructors

CreateVpcPeeringAuthorizationResponse'
Fields vpcPeeringAuthorization :: Maybe VpcPeeringAuthorization Details on the requested VPC peering authorization, including expiration. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateVpcPeeringAuthorizationResponse Source #

Arguments

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

Create a value of CreateVpcPeeringAuthorizationResponse 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:vpcPeeringAuthorization:CreateVpcPeeringAuthorizationResponse', createVpcPeeringAuthorizationResponse_vpcPeeringAuthorization - Details on the requested VPC peering authorization, including expiration.

$sel:httpStatus:CreateVpcPeeringAuthorizationResponse', createVpcPeeringAuthorizationResponse_httpStatus - The response's http status code.

Response Lenses

createVpcPeeringAuthorizationResponse_vpcPeeringAuthorization :: Lens' CreateVpcPeeringAuthorizationResponse (Maybe VpcPeeringAuthorization) Source #

Details on the requested VPC peering authorization, including expiration.

createVpcPeeringAuthorizationResponse_httpStatus :: Lens' CreateVpcPeeringAuthorizationResponse Int Source #

The response's http status code.