CreateRouteRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.ec2.model.CreateRouteRequest

All Implemented Interfaces:

DryRunSupportedRequest<CreateRouteRequest>, Serializable
```
public class CreateRouteRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<CreateRouteRequest>
```
Container for the parameters to the CreateRoute operation.
Creates a route in a route table within a VPC.

You must specify one of the following targets: Internet gateway, NAT instance, or network interface.

When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for 192.0.2.3 , and the route table includes the following two routes:
- 192.0.2.0/24 (goes to some target A)
- 192.0.2.0/28 (goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3 . However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide .
See Also:
AmazonEC2.createRoute(CreateRouteRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateRouteRequest()

Constructors
Constructor and Description
`CreateRouteRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getDestinationCidrBlock()` The CIDR address block used for the destination match.
`Request<CreateRouteRequest>`	`getDryRunRequest()` This method is intended for internal use only.
`String`	`getGatewayId()` The ID of an Internet gateway attached to your VPC.
`String`	`getInstanceId()` The ID of a NAT instance in your VPC.
`String`	`getNetworkInterfaceId()` The ID of a network interface.
`String`	`getRouteTableId()` The ID of the route table for the route.
`int`	`hashCode()`
`void`	`setDestinationCidrBlock(String destinationCidrBlock)` The CIDR address block used for the destination match.
`void`	`setGatewayId(String gatewayId)` The ID of an Internet gateway attached to your VPC.
`void`	`setInstanceId(String instanceId)` The ID of a NAT instance in your VPC.
`void`	`setNetworkInterfaceId(String networkInterfaceId)` The ID of a network interface.
`void`	`setRouteTableId(String routeTableId)` The ID of the route table for the route.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateRouteRequest`	`withDestinationCidrBlock(String destinationCidrBlock)` The CIDR address block used for the destination match.
`CreateRouteRequest`	`withGatewayId(String gatewayId)` The ID of an Internet gateway attached to your VPC.
`CreateRouteRequest`	`withInstanceId(String instanceId)` The ID of a NAT instance in your VPC.
`CreateRouteRequest`	`withNetworkInterfaceId(String networkInterfaceId)` The ID of a network interface.
`CreateRouteRequest`	`withRouteTableId(String routeTableId)` The ID of the route table for the route.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateRouteRequest
```
public CreateRouteRequest()
```
- Method Detail
  - getRouteTableId
```
public String getRouteTableId()
```
    The ID of the route table for the route.
    
    Returns:
    The ID of the route table for the route.
  - setRouteTableId
```
public void setRouteTableId(String routeTableId)
```
    The ID of the route table for the route.
    
    Parameters:
    routeTableId - The ID of the route table for the route.
  - withRouteTableId
```
public CreateRouteRequest withRouteTableId(String routeTableId)
```
    The ID of the route table for the route.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    routeTableId - The ID of the route table for the route.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDestinationCidrBlock
```
public String getDestinationCidrBlock()
```
    The CIDR address block used for the destination match. Routing decisions are based on the most specific match.
    
    Returns:
    The CIDR address block used for the destination match. Routing decisions are based on the most specific match.
  - setDestinationCidrBlock
```
public void setDestinationCidrBlock(String destinationCidrBlock)
```
    The CIDR address block used for the destination match. Routing decisions are based on the most specific match.
    
    Parameters:
    destinationCidrBlock - The CIDR address block used for the destination match. Routing decisions are based on the most specific match.
  - withDestinationCidrBlock
```
public CreateRouteRequest withDestinationCidrBlock(String destinationCidrBlock)
```
    The CIDR address block used for the destination match. Routing decisions are based on the most specific match.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    destinationCidrBlock - The CIDR address block used for the destination match. Routing decisions are based on the most specific match.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getGatewayId
```
public String getGatewayId()
```
    The ID of an Internet gateway attached to your VPC.
    
    Returns:
    The ID of an Internet gateway attached to your VPC.
  - setGatewayId
```
public void setGatewayId(String gatewayId)
```
    The ID of an Internet gateway attached to your VPC.
    
    Parameters:
    gatewayId - The ID of an Internet gateway attached to your VPC.
  - withGatewayId
```
public CreateRouteRequest withGatewayId(String gatewayId)
```
    The ID of an Internet gateway attached to your VPC.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    gatewayId - The ID of an Internet gateway attached to your VPC.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getInstanceId
```
public String getInstanceId()
```
    The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
    
    Returns:
    The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
  - setInstanceId
```
public void setInstanceId(String instanceId)
```
    The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
    
    Parameters:
    instanceId - The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
  - withInstanceId
```
public CreateRouteRequest withInstanceId(String instanceId)
```
    The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    instanceId - The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getNetworkInterfaceId
```
public String getNetworkInterfaceId()
```
    The ID of a network interface.
    
    Returns:
    The ID of a network interface.
  - setNetworkInterfaceId
```
public void setNetworkInterfaceId(String networkInterfaceId)
```
    The ID of a network interface.
    
    Parameters:
    networkInterfaceId - The ID of a network interface.
  - withNetworkInterfaceId
```
public CreateRouteRequest withNetworkInterfaceId(String networkInterfaceId)
```
    The ID of a network interface.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    networkInterfaceId - The ID of a network interface.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDryRunRequest
```
public Request<CreateRouteRequest> getDryRunRequest()
```
    This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.
    
    Specified by:
    
    getDryRunRequest in interface DryRunSupportedRequest<CreateRouteRequest>
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class CreateRouteRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateRouteRequest

Method Detail

getRouteTableId

setRouteTableId

withRouteTableId

getDestinationCidrBlock

setDestinationCidrBlock

withDestinationCidrBlock

getGatewayId

setGatewayId

withGatewayId

getInstanceId

setInstanceId

withInstanceId

getNetworkInterfaceId

setNetworkInterfaceId

withNetworkInterfaceId

getDryRunRequest

toString

hashCode

equals