Class Route
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.Route
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Route.Builder,Route>
@Generated("software.amazon.awssdk:codegen") public final class Route extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Route.Builder,Route>
Describes a route in a route table.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Route.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Route.Builder
builder()
String
carrierGatewayId()
The ID of the carrier gateway.String
coreNetworkArn()
The Amazon Resource Name (ARN) of the core network.String
destinationCidrBlock()
The IPv4 CIDR block used for the destination match.String
destinationIpv6CidrBlock()
The IPv6 CIDR block used for the destination match.String
destinationPrefixListId()
The prefix of the Amazon Web Service.String
egressOnlyInternetGatewayId()
The ID of the egress-only internet gateway.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
gatewayId()
The ID of a gateway attached to your VPC.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
instanceId()
The ID of a NAT instance in your VPC.String
instanceOwnerId()
The ID of Amazon Web Services account that owns the instance.String
localGatewayId()
The ID of the local gateway.String
natGatewayId()
The ID of a NAT gateway.String
networkInterfaceId()
The ID of the network interface.RouteOrigin
origin()
Describes how the route was created.String
originAsString()
Describes how the route was created.List<SdkField<?>>
sdkFields()
static Class<? extends Route.Builder>
serializableBuilderClass()
RouteState
state()
The state of the route.String
stateAsString()
The state of the route.Route.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
transitGatewayId()
The ID of a transit gateway.String
vpcPeeringConnectionId()
The ID of a VPC peering connection.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
destinationCidrBlock
public final String destinationCidrBlock()
The IPv4 CIDR block used for the destination match.
- Returns:
- The IPv4 CIDR block used for the destination match.
-
destinationIpv6CidrBlock
public final String destinationIpv6CidrBlock()
The IPv6 CIDR block used for the destination match.
- Returns:
- The IPv6 CIDR block used for the destination match.
-
destinationPrefixListId
public final String destinationPrefixListId()
The prefix of the Amazon Web Service.
- Returns:
- The prefix of the Amazon Web Service.
-
egressOnlyInternetGatewayId
public final String egressOnlyInternetGatewayId()
The ID of the egress-only internet gateway.
- Returns:
- The ID of the egress-only internet gateway.
-
gatewayId
public final String gatewayId()
The ID of a gateway attached to your VPC.
- Returns:
- The ID of a gateway attached to your VPC.
-
instanceId
public final String instanceId()
The ID of a NAT instance in your VPC.
- Returns:
- The ID of a NAT instance in your VPC.
-
instanceOwnerId
public final String instanceOwnerId()
The ID of Amazon Web Services account that owns the instance.
- Returns:
- The ID of Amazon Web Services account that owns the instance.
-
natGatewayId
public final String natGatewayId()
The ID of a NAT gateway.
- Returns:
- The ID of a NAT gateway.
-
transitGatewayId
public final String transitGatewayId()
The ID of a transit gateway.
- Returns:
- The ID of a transit gateway.
-
localGatewayId
public final String localGatewayId()
The ID of the local gateway.
- Returns:
- The ID of the local gateway.
-
carrierGatewayId
public final String carrierGatewayId()
The ID of the carrier gateway.
- Returns:
- The ID of the carrier gateway.
-
networkInterfaceId
public final String networkInterfaceId()
The ID of the network interface.
- Returns:
- The ID of the network interface.
-
origin
public final RouteOrigin origin()
Describes how the route was created.
-
CreateRouteTable
- The route was automatically created when the route table was created. -
CreateRoute
- The route was manually added to the route table. -
EnableVgwRoutePropagation
- The route was propagated by route propagation.
If the service returns an enum value that is not available in the current SDK version,
origin
will returnRouteOrigin.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoriginAsString()
.- Returns:
- Describes how the route was created.
-
CreateRouteTable
- The route was automatically created when the route table was created. -
CreateRoute
- The route was manually added to the route table. -
EnableVgwRoutePropagation
- The route was propagated by route propagation.
-
- See Also:
RouteOrigin
-
-
originAsString
public final String originAsString()
Describes how the route was created.
-
CreateRouteTable
- The route was automatically created when the route table was created. -
CreateRoute
- The route was manually added to the route table. -
EnableVgwRoutePropagation
- The route was propagated by route propagation.
If the service returns an enum value that is not available in the current SDK version,
origin
will returnRouteOrigin.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoriginAsString()
.- Returns:
- Describes how the route was created.
-
CreateRouteTable
- The route was automatically created when the route table was created. -
CreateRoute
- The route was manually added to the route table. -
EnableVgwRoutePropagation
- The route was propagated by route propagation.
-
- See Also:
RouteOrigin
-
-
state
public final RouteState state()
The state of the route. The
blackhole
state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).If the service returns an enum value that is not available in the current SDK version,
state
will returnRouteState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the route. The
blackhole
state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated). - See Also:
RouteState
-
stateAsString
public final String stateAsString()
The state of the route. The
blackhole
state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).If the service returns an enum value that is not available in the current SDK version,
state
will returnRouteState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the route. The
blackhole
state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated). - See Also:
RouteState
-
vpcPeeringConnectionId
public final String vpcPeeringConnectionId()
The ID of a VPC peering connection.
- Returns:
- The ID of a VPC peering connection.
-
coreNetworkArn
public final String coreNetworkArn()
The Amazon Resource Name (ARN) of the core network.
- Returns:
- The Amazon Resource Name (ARN) of the core network.
-
toBuilder
public Route.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<Route.Builder,Route>
-
builder
public static Route.Builder builder()
-
serializableBuilderClass
public static Class<? extends Route.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-