@pulumi/aws/appmesh/getRoute.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * The App Mesh Route data source allows details of an App Mesh Route to be retrieved by its name, mesh_name, virtual_router_name, and optionally the mesh_owner.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const test = aws.appmesh.getRoute({
 *     name: "test-route",
 *     meshName: "test-mesh",
 *     virtualRouterName: "test-router",
 * });
 * ```
 */
export declare function getRoute(args: GetRouteArgs, opts?: pulumi.InvokeOptions): Promise<GetRouteResult>;
/**
 * A collection of arguments for invoking getRoute.
 */
export interface GetRouteArgs {
    /**
     * Name of the service mesh in which the virtual router exists.
     */
    meshName: string;
    /**
     * AWS account ID of the service mesh's owner.
     */
    meshOwner?: string;
    /**
     * Name of the route.
     */
    name: string;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: string;
    /**
     * Map of tags.
     */
    tags?: {
        [key: string]: string;
    };
    /**
     * Name of the virtual router in which the route exists.
     */
    virtualRouterName: string;
}
/**
 * A collection of values returned by getRoute.
 */
export interface GetRouteResult {
    /**
     * ARN of the route.
     */
    readonly arn: string;
    /**
     * Creation date of the route.
     */
    readonly createdDate: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * Last update date of the route.
     */
    readonly lastUpdatedDate: string;
    readonly meshName: string;
    readonly meshOwner: string;
    readonly name: string;
    readonly region: string;
    /**
     * Resource owner's AWS account ID.
     */
    readonly resourceOwner: string;
    /**
     * Route specification. See the `aws.appmesh.Route` resource for details.
     */
    readonly specs: outputs.appmesh.GetRouteSpec[];
    /**
     * Map of tags.
     */
    readonly tags: {
        [key: string]: string;
    };
    readonly virtualRouterName: string;
}
/**
 * The App Mesh Route data source allows details of an App Mesh Route to be retrieved by its name, mesh_name, virtual_router_name, and optionally the mesh_owner.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const test = aws.appmesh.getRoute({
 *     name: "test-route",
 *     meshName: "test-mesh",
 *     virtualRouterName: "test-router",
 * });
 * ```
 */
export declare function getRouteOutput(args: GetRouteOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRouteResult>;
/**
 * A collection of arguments for invoking getRoute.
 */
export interface GetRouteOutputArgs {
    /**
     * Name of the service mesh in which the virtual router exists.
     */
    meshName: pulumi.Input<string>;
    /**
     * AWS account ID of the service mesh's owner.
     */
    meshOwner?: pulumi.Input<string>;
    /**
     * Name of the route.
     */
    name: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    /**
     * Map of tags.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Name of the virtual router in which the route exists.
     */
    virtualRouterName: pulumi.Input<string>;
}