View a markdown version of this page

CreateTransitGatewayNetworkFunctionAttachment - Amazon Elastic Compute Cloud

CreateTransitGatewayNetworkFunctionAttachment

Creates a network function attachment that connects the specified transit gateway to a Gateway Load Balancer endpoint service. Traffic that you route to the attachment is sent to the network function appliances behind the endpoint service. To use this operation, you must be the owner of the transit gateway.

You can create one network function attachment for each combination of transit gateway and endpoint service. The attachment remains in the pendingAcceptance state until the endpoint service owner accepts the endpoint connection.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

AvailabilityZone.N

The names of the Availability Zones for the attachment. You must specify at least one Availability Zone, using this parameter, AvailabilityZoneIds, or both. Each Availability Zone must be supported by both the transit gateway and the endpoint service.

Type: Array of strings

Required: No

AvailabilityZoneId.N

The IDs of the Availability Zones for the attachment. You must specify at least one Availability Zone, using this parameter, AvailabilityZones, or both. Each Availability Zone must be supported by both the transit gateway and the endpoint service.

Type: Array of strings

Required: No

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.

Type: Boolean

Required: No

ServiceName

The name of the Gateway Load Balancer endpoint service.

Type: String

Required: Yes

TagSpecification.N

The tags to apply to the network function attachment.

Type: Array of TagSpecification objects

Required: No

TransitGatewayId

The ID of the transit gateway. The transit gateway must be in the available state.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

transitGatewayNetworkFunctionAttachment

Information about the network function attachment.

Type: TransitGatewayNetworkFunctionAttachment object

Errors

For information about the errors that are common to all actions, see Common Error Types.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: