All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.ec2.model.DescribeRouteTablesRequest Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Amazon EC2 module holds the client classes that are used for communicating with Amazon EC2 Service

There is a newer version: 1.12.772
Show newest version
/*
 * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 * 
 *  http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
package com.amazonaws.services.ec2.model;

import java.io.Serializable;

import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeRouteTablesRequestMarshaller;

/**
 * Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#describeRouteTables(DescribeRouteTablesRequest) DescribeRouteTables operation}.
 * 

* Describes one or more of your route tables. *

*

* Each subnet in your VPC must be associated with a route table. If a * subnet is not explicitly associated with any route table, it is * implicitly associated with the main route table. This command does not * return the subnet ID for implicit associations. *

*

* For more information about route tables, see * Route Tables * in the Amazon Virtual Private Cloud User Guide . *

* * @see com.amazonaws.services.ec2.AmazonEC2#describeRouteTables(DescribeRouteTablesRequest) */ public class DescribeRouteTablesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest { /** * One or more route table IDs.

Default: Describes all your route * tables. */ private com.amazonaws.internal.ListWithAutoConstructFlag routeTableIds; /** * One or more filters.

  • *

    association.route-table-association-id - The ID of an * association ID for the route table.

  • *

    association.route-table-id - The ID of the route table * involved in the association.

  • *

    association.subnet-id - The ID of the subnet involved * in the association.

  • association.main - * Indicates whether the route table is the main route table for the VPC * (true | false).

  • *

    route-table-id - The ID of the route table.

  • *

    route.destination-cidr-block - The CIDR range * specified in a route in the table.

  • *

    route.destination-prefix-list-id - The ID (prefix) of * the AWS service specified in a route in the table.

  • *

    route.gateway-id - The ID of a gateway specified in a * route in the table.

  • route.instance-id - The * ID of an instance specified in a route in the table.

  • *

    route.origin - Describes how the route was created. * CreateRouteTable indicates that the route was * automatically created when the route table was created; * CreateRoute indicates that the route was manually added * to the route table; EnableVgwRoutePropagation indicates * that the route was propagated by route propagation.

  • *

    route.state - The state of a route in the route table * (active | blackhole). The blackhole state * indicates that the route's target isn't available (for example, the * specified gateway isn't attached to the VPC, the specified NAT * instance has been terminated, and so on).

  • *

    route.vpc-peering-connection-id - The ID of a VPC * peering connection specified in a route in the table.

  • *

    tag:key=value - The key/value * combination of a tag assigned to the resource.

  • *

    tag-key - The key of a tag assigned to the resource. * This filter is independent of the tag-value filter. For * example, if you use both the filter "tag-key=Purpose" and the filter * "tag-value=X", you get any resources assigned both the tag key Purpose * (regardless of what the tag's value is), and the tag value X * (regardless of what the tag's key is). If you want to list only * resources where Purpose is X, see the * tag:key=value filter.

  • *

    tag-value - The value of a tag assigned to the * resource. This filter is independent of the tag-key * filter.

  • vpc-id - The ID of the VPC for the * route table.

*/ private com.amazonaws.internal.ListWithAutoConstructFlag filters; /** * One or more route table IDs.

Default: Describes all your route * tables. * * @return One or more route table IDs.

Default: Describes all your route * tables. */ public java.util.List getRouteTableIds() { if (routeTableIds == null) { routeTableIds = new com.amazonaws.internal.ListWithAutoConstructFlag(); routeTableIds.setAutoConstruct(true); } return routeTableIds; } /** * One or more route table IDs.

Default: Describes all your route * tables. * * @param routeTableIds One or more route table IDs.

Default: Describes all your route * tables. */ public void setRouteTableIds(java.util.Collection routeTableIds) { if (routeTableIds == null) { this.routeTableIds = null; return; } com.amazonaws.internal.ListWithAutoConstructFlag routeTableIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(routeTableIds.size()); routeTableIdsCopy.addAll(routeTableIds); this.routeTableIds = routeTableIdsCopy; } /** * One or more route table IDs.

Default: Describes all your route * tables. *

* NOTE: This method appends the values to the existing list (if * any). Use {@link #setRouteTableIds(java.util.Collection)} or {@link * #withRouteTableIds(java.util.Collection)} if you want to override the * existing values. *

* Returns a reference to this object so that method calls can be chained together. * * @param routeTableIds One or more route table IDs.

Default: Describes all your route * tables. * * @return A reference to this updated object so that method calls can be chained * together. */ public DescribeRouteTablesRequest withRouteTableIds(String... routeTableIds) { if (getRouteTableIds() == null) setRouteTableIds(new java.util.ArrayList(routeTableIds.length)); for (String value : routeTableIds) { getRouteTableIds().add(value); } return this; } /** * One or more route table IDs.

Default: Describes all your route * tables. *

* Returns a reference to this object so that method calls can be chained together. * * @param routeTableIds One or more route table IDs.

Default: Describes all your route * tables. * * @return A reference to this updated object so that method calls can be chained * together. */ public DescribeRouteTablesRequest withRouteTableIds(java.util.Collection routeTableIds) { if (routeTableIds == null) { this.routeTableIds = null; } else { com.amazonaws.internal.ListWithAutoConstructFlag routeTableIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(routeTableIds.size()); routeTableIdsCopy.addAll(routeTableIds); this.routeTableIds = routeTableIdsCopy; } return this; } /** * One or more filters.

  • *

    association.route-table-association-id - The ID of an * association ID for the route table.

  • *

    association.route-table-id - The ID of the route table * involved in the association.

  • *

    association.subnet-id - The ID of the subnet involved * in the association.

  • association.main - * Indicates whether the route table is the main route table for the VPC * (true | false).

  • *

    route-table-id - The ID of the route table.

  • *

    route.destination-cidr-block - The CIDR range * specified in a route in the table.

  • *

    route.destination-prefix-list-id - The ID (prefix) of * the AWS service specified in a route in the table.

  • *

    route.gateway-id - The ID of a gateway specified in a * route in the table.

  • route.instance-id - The * ID of an instance specified in a route in the table.

  • *

    route.origin - Describes how the route was created. * CreateRouteTable indicates that the route was * automatically created when the route table was created; * CreateRoute indicates that the route was manually added * to the route table; EnableVgwRoutePropagation indicates * that the route was propagated by route propagation.

  • *

    route.state - The state of a route in the route table * (active | blackhole). The blackhole state * indicates that the route's target isn't available (for example, the * specified gateway isn't attached to the VPC, the specified NAT * instance has been terminated, and so on).

  • *

    route.vpc-peering-connection-id - The ID of a VPC * peering connection specified in a route in the table.

  • *

    tag:key=value - The key/value * combination of a tag assigned to the resource.

  • *

    tag-key - The key of a tag assigned to the resource. * This filter is independent of the tag-value filter. For * example, if you use both the filter "tag-key=Purpose" and the filter * "tag-value=X", you get any resources assigned both the tag key Purpose * (regardless of what the tag's value is), and the tag value X * (regardless of what the tag's key is). If you want to list only * resources where Purpose is X, see the * tag:key=value filter.

  • *

    tag-value - The value of a tag assigned to the * resource. This filter is independent of the tag-key * filter.

  • vpc-id - The ID of the VPC for the * route table.

* * @return One or more filters.
  • *

    association.route-table-association-id - The ID of an * association ID for the route table.

  • *

    association.route-table-id - The ID of the route table * involved in the association.

  • *

    association.subnet-id - The ID of the subnet involved * in the association.

  • association.main - * Indicates whether the route table is the main route table for the VPC * (true | false).

  • *

    route-table-id - The ID of the route table.

  • *

    route.destination-cidr-block - The CIDR range * specified in a route in the table.

  • *

    route.destination-prefix-list-id - The ID (prefix) of * the AWS service specified in a route in the table.

  • *

    route.gateway-id - The ID of a gateway specified in a * route in the table.

  • route.instance-id - The * ID of an instance specified in a route in the table.

  • *

    route.origin - Describes how the route was created. * CreateRouteTable indicates that the route was * automatically created when the route table was created; * CreateRoute indicates that the route was manually added * to the route table; EnableVgwRoutePropagation indicates * that the route was propagated by route propagation.

  • *

    route.state - The state of a route in the route table * (active | blackhole). The blackhole state * indicates that the route's target isn't available (for example, the * specified gateway isn't attached to the VPC, the specified NAT * instance has been terminated, and so on).

  • *

    route.vpc-peering-connection-id - The ID of a VPC * peering connection specified in a route in the table.

  • *

    tag:key=value - The key/value * combination of a tag assigned to the resource.

  • *

    tag-key - The key of a tag assigned to the resource. * This filter is independent of the tag-value filter. For * example, if you use both the filter "tag-key=Purpose" and the filter * "tag-value=X", you get any resources assigned both the tag key Purpose * (regardless of what the tag's value is), and the tag value X * (regardless of what the tag's key is). If you want to list only * resources where Purpose is X, see the * tag:key=value filter.

  • *

    tag-value - The value of a tag assigned to the * resource. This filter is independent of the tag-key * filter.

  • vpc-id - The ID of the VPC for the * route table.

*/ public java.util.List getFilters() { if (filters == null) { filters = new com.amazonaws.internal.ListWithAutoConstructFlag(); filters.setAutoConstruct(true); } return filters; } /** * One or more filters.
  • *

    association.route-table-association-id - The ID of an * association ID for the route table.

  • *

    association.route-table-id - The ID of the route table * involved in the association.

  • *

    association.subnet-id - The ID of the subnet involved * in the association.

  • association.main - * Indicates whether the route table is the main route table for the VPC * (true | false).

  • *

    route-table-id - The ID of the route table.

  • *

    route.destination-cidr-block - The CIDR range * specified in a route in the table.

  • *

    route.destination-prefix-list-id - The ID (prefix) of * the AWS service specified in a route in the table.

  • *

    route.gateway-id - The ID of a gateway specified in a * route in the table.

  • route.instance-id - The * ID of an instance specified in a route in the table.

  • *

    route.origin - Describes how the route was created. * CreateRouteTable indicates that the route was * automatically created when the route table was created; * CreateRoute indicates that the route was manually added * to the route table; EnableVgwRoutePropagation indicates * that the route was propagated by route propagation.

  • *

    route.state - The state of a route in the route table * (active | blackhole). The blackhole state * indicates that the route's target isn't available (for example, the * specified gateway isn't attached to the VPC, the specified NAT * instance has been terminated, and so on).

  • *

    route.vpc-peering-connection-id - The ID of a VPC * peering connection specified in a route in the table.

  • *

    tag:key=value - The key/value * combination of a tag assigned to the resource.

  • *

    tag-key - The key of a tag assigned to the resource. * This filter is independent of the tag-value filter. For * example, if you use both the filter "tag-key=Purpose" and the filter * "tag-value=X", you get any resources assigned both the tag key Purpose * (regardless of what the tag's value is), and the tag value X * (regardless of what the tag's key is). If you want to list only * resources where Purpose is X, see the * tag:key=value filter.

  • *

    tag-value - The value of a tag assigned to the * resource. This filter is independent of the tag-key * filter.

  • vpc-id - The ID of the VPC for the * route table.

* * @param filters One or more filters.
  • *

    association.route-table-association-id - The ID of an * association ID for the route table.

  • *

    association.route-table-id - The ID of the route table * involved in the association.

  • *

    association.subnet-id - The ID of the subnet involved * in the association.

  • association.main - * Indicates whether the route table is the main route table for the VPC * (true | false).

  • *

    route-table-id - The ID of the route table.

  • *

    route.destination-cidr-block - The CIDR range * specified in a route in the table.

  • *

    route.destination-prefix-list-id - The ID (prefix) of * the AWS service specified in a route in the table.

  • *

    route.gateway-id - The ID of a gateway specified in a * route in the table.

  • route.instance-id - The * ID of an instance specified in a route in the table.

  • *

    route.origin - Describes how the route was created. * CreateRouteTable indicates that the route was * automatically created when the route table was created; * CreateRoute indicates that the route was manually added * to the route table; EnableVgwRoutePropagation indicates * that the route was propagated by route propagation.

  • *

    route.state - The state of a route in the route table * (active | blackhole). The blackhole state * indicates that the route's target isn't available (for example, the * specified gateway isn't attached to the VPC, the specified NAT * instance has been terminated, and so on).

  • *

    route.vpc-peering-connection-id - The ID of a VPC * peering connection specified in a route in the table.

  • *

    tag:key=value - The key/value * combination of a tag assigned to the resource.

  • *

    tag-key - The key of a tag assigned to the resource. * This filter is independent of the tag-value filter. For * example, if you use both the filter "tag-key=Purpose" and the filter * "tag-value=X", you get any resources assigned both the tag key Purpose * (regardless of what the tag's value is), and the tag value X * (regardless of what the tag's key is). If you want to list only * resources where Purpose is X, see the * tag:key=value filter.

  • *

    tag-value - The value of a tag assigned to the * resource. This filter is independent of the tag-key * filter.

  • vpc-id - The ID of the VPC for the * route table.

*/ public void setFilters(java.util.Collection filters) { if (filters == null) { this.filters = null; return; } com.amazonaws.internal.ListWithAutoConstructFlag filtersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(filters.size()); filtersCopy.addAll(filters); this.filters = filtersCopy; } /** * One or more filters.
  • *

    association.route-table-association-id - The ID of an * association ID for the route table.

  • *

    association.route-table-id - The ID of the route table * involved in the association.

  • *

    association.subnet-id - The ID of the subnet involved * in the association.

  • association.main - * Indicates whether the route table is the main route table for the VPC * (true | false).

  • *

    route-table-id - The ID of the route table.

  • *

    route.destination-cidr-block - The CIDR range * specified in a route in the table.

  • *

    route.destination-prefix-list-id - The ID (prefix) of * the AWS service specified in a route in the table.

  • *

    route.gateway-id - The ID of a gateway specified in a * route in the table.

  • route.instance-id - The * ID of an instance specified in a route in the table.

  • *

    route.origin - Describes how the route was created. * CreateRouteTable indicates that the route was * automatically created when the route table was created; * CreateRoute indicates that the route was manually added * to the route table; EnableVgwRoutePropagation indicates * that the route was propagated by route propagation.

  • *

    route.state - The state of a route in the route table * (active | blackhole). The blackhole state * indicates that the route's target isn't available (for example, the * specified gateway isn't attached to the VPC, the specified NAT * instance has been terminated, and so on).

  • *

    route.vpc-peering-connection-id - The ID of a VPC * peering connection specified in a route in the table.

  • *

    tag:key=value - The key/value * combination of a tag assigned to the resource.

  • *

    tag-key - The key of a tag assigned to the resource. * This filter is independent of the tag-value filter. For * example, if you use both the filter "tag-key=Purpose" and the filter * "tag-value=X", you get any resources assigned both the tag key Purpose * (regardless of what the tag's value is), and the tag value X * (regardless of what the tag's key is). If you want to list only * resources where Purpose is X, see the * tag:key=value filter.

  • *

    tag-value - The value of a tag assigned to the * resource. This filter is independent of the tag-key * filter.

  • vpc-id - The ID of the VPC for the * route table.

*

* NOTE: This method appends the values to the existing list (if * any). Use {@link #setFilters(java.util.Collection)} or {@link * #withFilters(java.util.Collection)} if you want to override the * existing values. *

* Returns a reference to this object so that method calls can be chained together. * * @param filters One or more filters.

  • *

    association.route-table-association-id - The ID of an * association ID for the route table.

  • *

    association.route-table-id - The ID of the route table * involved in the association.

  • *

    association.subnet-id - The ID of the subnet involved * in the association.

  • association.main - * Indicates whether the route table is the main route table for the VPC * (true | false).

  • *

    route-table-id - The ID of the route table.

  • *

    route.destination-cidr-block - The CIDR range * specified in a route in the table.

  • *

    route.destination-prefix-list-id - The ID (prefix) of * the AWS service specified in a route in the table.

  • *

    route.gateway-id - The ID of a gateway specified in a * route in the table.

  • route.instance-id - The * ID of an instance specified in a route in the table.

  • *

    route.origin - Describes how the route was created. * CreateRouteTable indicates that the route was * automatically created when the route table was created; * CreateRoute indicates that the route was manually added * to the route table; EnableVgwRoutePropagation indicates * that the route was propagated by route propagation.

  • *

    route.state - The state of a route in the route table * (active | blackhole). The blackhole state * indicates that the route's target isn't available (for example, the * specified gateway isn't attached to the VPC, the specified NAT * instance has been terminated, and so on).

  • *

    route.vpc-peering-connection-id - The ID of a VPC * peering connection specified in a route in the table.

  • *

    tag:key=value - The key/value * combination of a tag assigned to the resource.

  • *

    tag-key - The key of a tag assigned to the resource. * This filter is independent of the tag-value filter. For * example, if you use both the filter "tag-key=Purpose" and the filter * "tag-value=X", you get any resources assigned both the tag key Purpose * (regardless of what the tag's value is), and the tag value X * (regardless of what the tag's key is). If you want to list only * resources where Purpose is X, see the * tag:key=value filter.

  • *

    tag-value - The value of a tag assigned to the * resource. This filter is independent of the tag-key * filter.

  • vpc-id - The ID of the VPC for the * route table.

* * @return A reference to this updated object so that method calls can be chained * together. */ public DescribeRouteTablesRequest withFilters(Filter... filters) { if (getFilters() == null) setFilters(new java.util.ArrayList(filters.length)); for (Filter value : filters) { getFilters().add(value); } return this; } /** * One or more filters.
  • *

    association.route-table-association-id - The ID of an * association ID for the route table.

  • *

    association.route-table-id - The ID of the route table * involved in the association.

  • *

    association.subnet-id - The ID of the subnet involved * in the association.

  • association.main - * Indicates whether the route table is the main route table for the VPC * (true | false).

  • *

    route-table-id - The ID of the route table.

  • *

    route.destination-cidr-block - The CIDR range * specified in a route in the table.

  • *

    route.destination-prefix-list-id - The ID (prefix) of * the AWS service specified in a route in the table.

  • *

    route.gateway-id - The ID of a gateway specified in a * route in the table.

  • route.instance-id - The * ID of an instance specified in a route in the table.

  • *

    route.origin - Describes how the route was created. * CreateRouteTable indicates that the route was * automatically created when the route table was created; * CreateRoute indicates that the route was manually added * to the route table; EnableVgwRoutePropagation indicates * that the route was propagated by route propagation.

  • *

    route.state - The state of a route in the route table * (active | blackhole). The blackhole state * indicates that the route's target isn't available (for example, the * specified gateway isn't attached to the VPC, the specified NAT * instance has been terminated, and so on).

  • *

    route.vpc-peering-connection-id - The ID of a VPC * peering connection specified in a route in the table.

  • *

    tag:key=value - The key/value * combination of a tag assigned to the resource.

  • *

    tag-key - The key of a tag assigned to the resource. * This filter is independent of the tag-value filter. For * example, if you use both the filter "tag-key=Purpose" and the filter * "tag-value=X", you get any resources assigned both the tag key Purpose * (regardless of what the tag's value is), and the tag value X * (regardless of what the tag's key is). If you want to list only * resources where Purpose is X, see the * tag:key=value filter.

  • *

    tag-value - The value of a tag assigned to the * resource. This filter is independent of the tag-key * filter.

  • vpc-id - The ID of the VPC for the * route table.

*

* Returns a reference to this object so that method calls can be chained together. * * @param filters One or more filters.

  • *

    association.route-table-association-id - The ID of an * association ID for the route table.

  • *

    association.route-table-id - The ID of the route table * involved in the association.

  • *

    association.subnet-id - The ID of the subnet involved * in the association.

  • association.main - * Indicates whether the route table is the main route table for the VPC * (true | false).

  • *

    route-table-id - The ID of the route table.

  • *

    route.destination-cidr-block - The CIDR range * specified in a route in the table.

  • *

    route.destination-prefix-list-id - The ID (prefix) of * the AWS service specified in a route in the table.

  • *

    route.gateway-id - The ID of a gateway specified in a * route in the table.

  • route.instance-id - The * ID of an instance specified in a route in the table.

  • *

    route.origin - Describes how the route was created. * CreateRouteTable indicates that the route was * automatically created when the route table was created; * CreateRoute indicates that the route was manually added * to the route table; EnableVgwRoutePropagation indicates * that the route was propagated by route propagation.

  • *

    route.state - The state of a route in the route table * (active | blackhole). The blackhole state * indicates that the route's target isn't available (for example, the * specified gateway isn't attached to the VPC, the specified NAT * instance has been terminated, and so on).

  • *

    route.vpc-peering-connection-id - The ID of a VPC * peering connection specified in a route in the table.

  • *

    tag:key=value - The key/value * combination of a tag assigned to the resource.

  • *

    tag-key - The key of a tag assigned to the resource. * This filter is independent of the tag-value filter. For * example, if you use both the filter "tag-key=Purpose" and the filter * "tag-value=X", you get any resources assigned both the tag key Purpose * (regardless of what the tag's value is), and the tag value X * (regardless of what the tag's key is). If you want to list only * resources where Purpose is X, see the * tag:key=value filter.

  • *

    tag-value - The value of a tag assigned to the * resource. This filter is independent of the tag-key * filter.

  • vpc-id - The ID of the VPC for the * route table.

* * @return A reference to this updated object so that method calls can be chained * together. */ public DescribeRouteTablesRequest withFilters(java.util.Collection filters) { if (filters == null) { this.filters = null; } else { com.amazonaws.internal.ListWithAutoConstructFlag filtersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(filters.size()); filtersCopy.addAll(filters); this.filters = filtersCopy; } return this; } /** * This method is intended for internal use only. * Returns the marshaled request configured with additional parameters to * enable operation dry-run. */ @Override public Request getDryRunRequest() { Request request = new DescribeRouteTablesRequestMarshaller().marshall(this); request.addParameter("DryRun", Boolean.toString(true)); return request; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getRouteTableIds() != null) sb.append("RouteTableIds: " + getRouteTableIds() + ","); if (getFilters() != null) sb.append("Filters: " + getFilters() ); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getRouteTableIds() == null) ? 0 : getRouteTableIds().hashCode()); hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DescribeRouteTablesRequest == false) return false; DescribeRouteTablesRequest other = (DescribeRouteTablesRequest)obj; if (other.getRouteTableIds() == null ^ this.getRouteTableIds() == null) return false; if (other.getRouteTableIds() != null && other.getRouteTableIds().equals(this.getRouteTableIds()) == false) return false; if (other.getFilters() == null ^ this.getFilters() == null) return false; if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false) return false; return true; } @Override public DescribeRouteTablesRequest clone() { return (DescribeRouteTablesRequest) super.clone(); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy