CreateTransitGatewayPrefixListReference
Creates a reference (route) to a prefix list in a specified transit gateway route table.
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.
- Blackhole
-
Indicates whether to drop traffic that matches this route.
Type: Boolean
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 isUnauthorizedOperation.Type: Boolean
Required: No
- PrefixListId
-
The ID of the prefix list that is used for destination matches.
Type: String
Required: Yes
- TransitGatewayAttachmentId
-
The ID of the attachment to which traffic is routed.
Type: String
Required: No
- TransitGatewayRouteTableId
-
The ID of the transit gateway route table.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- requestId
-
The ID of the request.
Type: String
- transitGatewayPrefixListReference
-
Information about the prefix list reference.
Type: TransitGatewayPrefixListReference object
Errors
For information about the errors that are common to all actions, see Common client error codes.
Examples
Example
This example creates a reference to a prefix list in the specified transit gateway route table.
Sample Request
https://ec2.amazonaws.com/?Action=CreateTransitGatewayPrefixListReference
&TransitGatewayRouteTableId=tgw-rtb-0f98a0a5d09abcabc
&PrefixListId=pl-001122334455aabbc
&TransitGatewayAttachmentId=tgw-attach-01234567abcabcabc
&AUTHPARAMSSample Response
<CreateTransitGatewayPrefixListReferenceResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>326fdc31-cd8d-491a-824a-example</requestId>
<transitGatewayPrefixListReference>
<blackhole>false</blackhole>
<prefixListId>pl-001122334455aabbc</prefixListId>
<prefixListOwnerId>123456789012</prefixListOwnerId>
<state>pending</state>
<transitGatewayAttachment>
<resourceId>vpn-12312312312312312</resourceId>
<resourceType>vpn</resourceType>
<transitGatewayAttachmentId>tgw-attach-01234567abcabcabc</transitGatewayAttachmentId>
</transitGatewayAttachment>
<transitGatewayRouteTableId>tgw-rtb-0f98a0a5d09abcabc</transitGatewayRouteTableId>
</transitGatewayPrefixListReference>
</CreateTransitGatewayPrefixListReferenceResponse>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
