Delete Carrier Gateway

ec2_delete_carrier_gateway

R Documentation

Deletes a carrier gateway¶

Description¶

Deletes a carrier gateway.

If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see delete_route.

Usage¶

ec2_delete_carrier_gateway(CarrierGatewayId, DryRun)

Arguments¶

CarrierGatewayId: [required] The ID of the carrier gateway.
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.

Value¶

A list with the following syntax:

list(
  CarrierGateway = list(
    CarrierGatewayId = "string",
    VpcId = "string",
    State = "pending"|"available"|"deleting"|"deleted",
    OwnerId = "string",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Request syntax¶

svc$delete_carrier_gateway(
  CarrierGatewayId = "string",
  DryRun = TRUE|FALSE
)