| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.GameLift.CreateVpcPeeringAuthorization
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 AWS account. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. Once you've received authorization, call 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 AWS 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 AWS 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 AWS 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 AWS 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 AWS account that you use to manage Amazon GameLift.
The authorization remains valid for 24 hours unless it is canceled by a call to DeleteVpcPeeringAuthorization. You must create or delete the peering connection while the authorization is valid.
Related actions
CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task
Synopsis
- data CreateVpcPeeringAuthorization = CreateVpcPeeringAuthorization' {}
- newCreateVpcPeeringAuthorization :: Text -> Text -> CreateVpcPeeringAuthorization
- createVpcPeeringAuthorization_gameLiftAwsAccountId :: Lens' CreateVpcPeeringAuthorization Text
- createVpcPeeringAuthorization_peerVpcId :: Lens' CreateVpcPeeringAuthorization Text
- data CreateVpcPeeringAuthorizationResponse = CreateVpcPeeringAuthorizationResponse' {}
- newCreateVpcPeeringAuthorizationResponse :: Int -> CreateVpcPeeringAuthorizationResponse
- createVpcPeeringAuthorizationResponse_vpcPeeringAuthorization :: Lens' CreateVpcPeeringAuthorizationResponse (Maybe VpcPeeringAuthorization)
- createVpcPeeringAuthorizationResponse_httpStatus :: Lens' CreateVpcPeeringAuthorizationResponse Int
Creating a Request
data CreateVpcPeeringAuthorization Source #
Represents the input for a request operation.
See: newCreateVpcPeeringAuthorization smart constructor.
Constructors
| CreateVpcPeeringAuthorization' | |
Fields
| |
Instances
newCreateVpcPeeringAuthorization Source #
Arguments
| :: Text | |
| -> Text | |
| -> 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:
$sel:gameLiftAwsAccountId:CreateVpcPeeringAuthorization', createVpcPeeringAuthorization_gameLiftAwsAccountId - A unique identifier for the AWS account that you use to manage your
GameLift fleet. You can find your Account ID in the AWS Management
Console under account settings.
$sel:peerVpcId: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 AWS
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 AWS account that you use to manage your GameLift fleet. You can find your Account ID in the AWS 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 AWS Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.
Destructuring the Response
data CreateVpcPeeringAuthorizationResponse Source #
Represents the returned data in response to a request operation.
See: newCreateVpcPeeringAuthorizationResponse smart constructor.
Constructors
| CreateVpcPeeringAuthorizationResponse' | |
Fields
| |
Instances
newCreateVpcPeeringAuthorizationResponse Source #
Arguments
| :: Int | |
| -> 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.