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.EC2.CreateTransitGatewayConnectPeer

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.

The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

For more information, see Connect peers in the Transit Gateways Guide.

Synopsis

Creating a Request

data CreateTransitGatewayConnectPeer Source #

See: newCreateTransitGatewayConnectPeer smart constructor.

Constructors

CreateTransitGatewayConnectPeer'

Fields

bgpOptions :: Maybe TransitGatewayConnectRequestBgpOptions
The BGP options for the Connect peer.
dryRun :: Maybe Bool
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
tagSpecifications :: Maybe [TagSpecification]
The tags to apply to the Connect peer.
transitGatewayAddress :: Maybe Text
The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.
transitGatewayAttachmentId :: Text
The ID of the Connect attachment.
peerAddress :: Text
The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.
insideCidrBlocks :: [Text]
The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.

Instances

Instances details

ToHeaders CreateTransitGatewayConnectPeer Source #
Instance details Defined in Amazonka.EC2.CreateTransitGatewayConnectPeer Methods toHeaders :: CreateTransitGatewayConnectPeer -> [Header] #
ToPath CreateTransitGatewayConnectPeer Source #
Instance details Defined in Amazonka.EC2.CreateTransitGatewayConnectPeer Methods toPath :: CreateTransitGatewayConnectPeer -> ByteString #
ToQuery CreateTransitGatewayConnectPeer Source #
Instance details Defined in Amazonka.EC2.CreateTransitGatewayConnectPeer Methods toQuery :: CreateTransitGatewayConnectPeer -> QueryString #
AWSRequest CreateTransitGatewayConnectPeer Source #
Instance details Defined in Amazonka.EC2.CreateTransitGatewayConnectPeer Associated Types type AWSResponse CreateTransitGatewayConnectPeer # Methods request :: (Service -> Service) -> CreateTransitGatewayConnectPeer -> Request CreateTransitGatewayConnectPeer # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateTransitGatewayConnectPeer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateTransitGatewayConnectPeer))) #
Generic CreateTransitGatewayConnectPeer Source #
Instance details Defined in Amazonka.EC2.CreateTransitGatewayConnectPeer Associated Types type Rep CreateTransitGatewayConnectPeer :: Type -> Type # Methods from :: CreateTransitGatewayConnectPeer -> Rep CreateTransitGatewayConnectPeer x # to :: Rep CreateTransitGatewayConnectPeer x -> CreateTransitGatewayConnectPeer #
Read CreateTransitGatewayConnectPeer Source #
Instance details Defined in Amazonka.EC2.CreateTransitGatewayConnectPeer Methods readsPrec :: Int -> ReadS CreateTransitGatewayConnectPeer # readList :: ReadS [CreateTransitGatewayConnectPeer] # readPrec :: ReadPrec CreateTransitGatewayConnectPeer # readListPrec :: ReadPrec [CreateTransitGatewayConnectPeer] #
Show CreateTransitGatewayConnectPeer Source #
Instance details Defined in Amazonka.EC2.CreateTransitGatewayConnectPeer Methods showsPrec :: Int -> CreateTransitGatewayConnectPeer -> ShowS # show :: CreateTransitGatewayConnectPeer -> String # showList :: [CreateTransitGatewayConnectPeer] -> ShowS #
NFData CreateTransitGatewayConnectPeer Source #
Instance details Defined in Amazonka.EC2.CreateTransitGatewayConnectPeer Methods rnf :: CreateTransitGatewayConnectPeer -> () #
Eq CreateTransitGatewayConnectPeer Source #
Instance details Defined in Amazonka.EC2.CreateTransitGatewayConnectPeer Methods (==) :: CreateTransitGatewayConnectPeer -> CreateTransitGatewayConnectPeer -> Bool # (/=) :: CreateTransitGatewayConnectPeer -> CreateTransitGatewayConnectPeer -> Bool #
Hashable CreateTransitGatewayConnectPeer Source #
Instance details Defined in Amazonka.EC2.CreateTransitGatewayConnectPeer Methods hashWithSalt :: Int -> CreateTransitGatewayConnectPeer -> Int # hash :: CreateTransitGatewayConnectPeer -> Int #
type AWSResponse CreateTransitGatewayConnectPeer Source #
Instance details Defined in Amazonka.EC2.CreateTransitGatewayConnectPeer type AWSResponse CreateTransitGatewayConnectPeer = CreateTransitGatewayConnectPeerResponse
type Rep CreateTransitGatewayConnectPeer Source #
Instance details Defined in Amazonka.EC2.CreateTransitGatewayConnectPeer type Rep CreateTransitGatewayConnectPeer = D1 ('MetaData "CreateTransitGatewayConnectPeer" "Amazonka.EC2.CreateTransitGatewayConnectPeer" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "CreateTransitGatewayConnectPeer'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bgpOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TransitGatewayConnectRequestBgpOptions)) :: (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "tagSpecifications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagSpecification])))) :: ((S1 ('MetaSel ('Just "transitGatewayAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "transitGatewayAttachmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "peerAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "insideCidrBlocks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))))

newCreateTransitGatewayConnectPeer Source #

Arguments

:: Text	`CreateTransitGatewayConnectPeer`
-> Text	`CreateTransitGatewayConnectPeer`
-> CreateTransitGatewayConnectPeer

Create a value of CreateTransitGatewayConnectPeer 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:bgpOptions:CreateTransitGatewayConnectPeer', createTransitGatewayConnectPeer_bgpOptions - The BGP options for the Connect peer.

$sel:dryRun:CreateTransitGatewayConnectPeer', createTransitGatewayConnectPeer_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

CreateTransitGatewayConnectPeer, createTransitGatewayConnectPeer_tagSpecifications - The tags to apply to the Connect peer.

CreateTransitGatewayConnectPeer, createTransitGatewayConnectPeer_transitGatewayAddress - The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.

CreateTransitGatewayConnectPeer, createTransitGatewayConnectPeer_transitGatewayAttachmentId - The ID of the Connect attachment.

CreateTransitGatewayConnectPeer, createTransitGatewayConnectPeer_peerAddress - The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.

CreateTransitGatewayConnectPeer, createTransitGatewayConnectPeer_insideCidrBlocks - The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.

Request Lenses

createTransitGatewayConnectPeer_bgpOptions :: Lens' CreateTransitGatewayConnectPeer (Maybe TransitGatewayConnectRequestBgpOptions) Source #

The BGP options for the Connect peer.

createTransitGatewayConnectPeer_dryRun :: Lens' CreateTransitGatewayConnectPeer (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

createTransitGatewayConnectPeer_tagSpecifications :: Lens' CreateTransitGatewayConnectPeer (Maybe [TagSpecification]) Source #

The tags to apply to the Connect peer.

createTransitGatewayConnectPeer_transitGatewayAddress :: Lens' CreateTransitGatewayConnectPeer (Maybe Text) Source #

The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.

createTransitGatewayConnectPeer_transitGatewayAttachmentId :: Lens' CreateTransitGatewayConnectPeer Text Source #

The ID of the Connect attachment.

createTransitGatewayConnectPeer_peerAddress :: Lens' CreateTransitGatewayConnectPeer Text Source #

The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.

createTransitGatewayConnectPeer_insideCidrBlocks :: Lens' CreateTransitGatewayConnectPeer [Text] Source #

The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.

Destructuring the Response

data CreateTransitGatewayConnectPeerResponse Source #

See: newCreateTransitGatewayConnectPeerResponse smart constructor.

Constructors

CreateTransitGatewayConnectPeerResponse'
Fields transitGatewayConnectPeer :: Maybe TransitGatewayConnectPeer Information about the Connect peer. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateTransitGatewayConnectPeerResponse Source #

Arguments

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

Create a value of CreateTransitGatewayConnectPeerResponse 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:transitGatewayConnectPeer:CreateTransitGatewayConnectPeerResponse', createTransitGatewayConnectPeerResponse_transitGatewayConnectPeer - Information about the Connect peer.

$sel:httpStatus:CreateTransitGatewayConnectPeerResponse', createTransitGatewayConnectPeerResponse_httpStatus - The response's http status code.

Response Lenses

createTransitGatewayConnectPeerResponse_transitGatewayConnectPeer :: Lens' CreateTransitGatewayConnectPeerResponse (Maybe TransitGatewayConnectPeer) Source #

Information about the Connect peer.

createTransitGatewayConnectPeerResponse_httpStatus :: Lens' CreateTransitGatewayConnectPeerResponse Int Source #

The response's http status code.