@pulumi/yandex
Version:
A Pulumi package for creating and managing yandex cloud resources.
161 lines (160 loc) • 5.59 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import { input as inputs, output as outputs } from "./types";
/**
* Manages a route table within the Yandex.Cloud. For more information, see
* [the official documentation](https://cloud.yandex.com/docs/vpc/concepts).
*
* * How-to Guides
* * [Cloud Networking](https://cloud.yandex.com/docs/vpc/)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as yandex from "@pulumi/yandex";
*
* const lab_net = new yandex.VpcNetwork("lab-net", {});
* const lab_rt_a = new yandex.VpcRouteTable("lab-rt-a", {
* networkId: lab_net.id,
* staticRoutes: [{
* destinationPrefix: "10.2.0.0/16",
* nextHopAddress: "172.16.10.10",
* }],
* });
* ```
*
* ## Import
*
* A route table can be imported using the `id` of the resource, e.g.
*
* ```sh
* $ pulumi import yandex:index/vpcRouteTable:VpcRouteTable default route_table_id
* ```
*/
export declare class VpcRouteTable extends pulumi.CustomResource {
/**
* Get an existing VpcRouteTable resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VpcRouteTableState, opts?: pulumi.CustomResourceOptions): VpcRouteTable;
/**
* Returns true if the given object is an instance of VpcRouteTable. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is VpcRouteTable;
/**
* Creation timestamp of the route table.
*/
readonly createdAt: pulumi.Output<string>;
/**
* An optional description of the route table. Provide this property when
* you create the resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The ID of the folder to which the resource belongs.
* If omitted, the provider folder is used.
*/
readonly folderId: pulumi.Output<string>;
/**
* Labels to assign to this route table. A list of key/value pairs.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
}>;
/**
* Name of the route table. Provided by the client when the route table is created.
*/
readonly name: pulumi.Output<string>;
/**
* ID of the network this route table belongs to.
*/
readonly networkId: pulumi.Output<string>;
/**
* A list of static route records for the route table. The structure is documented below.
*/
readonly staticRoutes: pulumi.Output<outputs.VpcRouteTableStaticRoute[] | undefined>;
/**
* Create a VpcRouteTable resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: VpcRouteTableArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering VpcRouteTable resources.
*/
export interface VpcRouteTableState {
/**
* Creation timestamp of the route table.
*/
createdAt?: pulumi.Input<string>;
/**
* An optional description of the route table. Provide this property when
* you create the resource.
*/
description?: pulumi.Input<string>;
/**
* The ID of the folder to which the resource belongs.
* If omitted, the provider folder is used.
*/
folderId?: pulumi.Input<string>;
/**
* Labels to assign to this route table. A list of key/value pairs.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the route table. Provided by the client when the route table is created.
*/
name?: pulumi.Input<string>;
/**
* ID of the network this route table belongs to.
*/
networkId?: pulumi.Input<string>;
/**
* A list of static route records for the route table. The structure is documented below.
*/
staticRoutes?: pulumi.Input<pulumi.Input<inputs.VpcRouteTableStaticRoute>[]>;
}
/**
* The set of arguments for constructing a VpcRouteTable resource.
*/
export interface VpcRouteTableArgs {
/**
* An optional description of the route table. Provide this property when
* you create the resource.
*/
description?: pulumi.Input<string>;
/**
* The ID of the folder to which the resource belongs.
* If omitted, the provider folder is used.
*/
folderId?: pulumi.Input<string>;
/**
* Labels to assign to this route table. A list of key/value pairs.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the route table. Provided by the client when the route table is created.
*/
name?: pulumi.Input<string>;
/**
* ID of the network this route table belongs to.
*/
networkId: pulumi.Input<string>;
/**
* A list of static route records for the route table. The structure is documented below.
*/
staticRoutes?: pulumi.Input<pulumi.Input<inputs.VpcRouteTableStaticRoute>[]>;
}