@pulumiverse/scaleway/network/getRoute.d.ts

A Pulumi package for creating and managing Scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Gets information about a VPC route.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * // Get info by filters
 * const byFilters = scaleway.network.getRoute({
 *     vpcId: myVpc.id,
 *     tags: ["my-tag"],
 * });
 * ```
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * // Get info by route ID
 * const byId = scaleway.network.getRoute({
 *     routeId: "fr-par/11111111-1111-1111-1111-111111111111",
 * });
 * ```
 */
export declare function getRoute(args?: GetRouteArgs, opts?: pulumi.InvokeOptions): Promise<GetRouteResult>;
/**
 * A collection of arguments for invoking getRoute.
 */
export interface GetRouteArgs {
    /**
     * If true, only routes with an IPv6 destination will be returned.
     */
    isIpv6?: boolean;
    /**
     * The next hop private network ID to filter for. Only routes with a matching next hop private network ID will be returned.
     */
    nexthopPrivateNetworkId?: string;
    /**
     * The next hop resource ID to filter for. Only routes with a matching next hop resource ID will be returned.
     */
    nexthopResourceId?: string;
    /**
     * The next hop resource type to filter for. Only routes with a matching next hop resource type will be returned.
     */
    nexthopResourceType?: string;
    /**
     * `region`). The region in which the route exists.
     *
     * > **Note:** When using filter arguments, the filters must match exactly one route. If zero or multiple routes are found, an error will be returned.
     */
    region?: string;
    /**
     * The ID of the route.
     *
     * The following filter arguments are supported (cannot be used with `routeId`):
     */
    routeId?: string;
    /**
     * List of tags to filter for. Only routes with these exact tags will be returned.
     */
    tags?: string[];
    /**
     * The VPC ID to filter for. Only routes within this VPC will be returned.
     */
    vpcId?: string;
}
/**
 * A collection of values returned by getRoute.
 */
export interface GetRouteResult {
    readonly createdAt: string;
    readonly description: string;
    readonly destination: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly isIpv6?: boolean;
    readonly nexthopPrivateNetworkId?: string;
    readonly nexthopResourceId?: string;
    readonly nexthopResourceType?: string;
    readonly nexthopVpcConnectorId: string;
    readonly region?: string;
    readonly routeId?: string;
    readonly tags?: string[];
    readonly updatedAt: string;
    readonly vpcId?: string;
}
/**
 * Gets information about a VPC route.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * // Get info by filters
 * const byFilters = scaleway.network.getRoute({
 *     vpcId: myVpc.id,
 *     tags: ["my-tag"],
 * });
 * ```
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * // Get info by route ID
 * const byId = scaleway.network.getRoute({
 *     routeId: "fr-par/11111111-1111-1111-1111-111111111111",
 * });
 * ```
 */
export declare function getRouteOutput(args?: GetRouteOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRouteResult>;
/**
 * A collection of arguments for invoking getRoute.
 */
export interface GetRouteOutputArgs {
    /**
     * If true, only routes with an IPv6 destination will be returned.
     */
    isIpv6?: pulumi.Input<boolean | undefined>;
    /**
     * The next hop private network ID to filter for. Only routes with a matching next hop private network ID will be returned.
     */
    nexthopPrivateNetworkId?: pulumi.Input<string | undefined>;
    /**
     * The next hop resource ID to filter for. Only routes with a matching next hop resource ID will be returned.
     */
    nexthopResourceId?: pulumi.Input<string | undefined>;
    /**
     * The next hop resource type to filter for. Only routes with a matching next hop resource type will be returned.
     */
    nexthopResourceType?: pulumi.Input<string | undefined>;
    /**
     * `region`). The region in which the route exists.
     *
     * > **Note:** When using filter arguments, the filters must match exactly one route. If zero or multiple routes are found, an error will be returned.
     */
    region?: pulumi.Input<string | undefined>;
    /**
     * The ID of the route.
     *
     * The following filter arguments are supported (cannot be used with `routeId`):
     */
    routeId?: pulumi.Input<string | undefined>;
    /**
     * List of tags to filter for. Only routes with these exact tags will be returned.
     */
    tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * The VPC ID to filter for. Only routes within this VPC will be returned.
     */
    vpcId?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getRoute.d.ts.map