@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
168 lines (167 loc) • 6.5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a Location Service Route Calculator.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.location.RouteCalculation("example", {
* calculatorName: "example",
* dataSource: "Here",
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import `aws_location_route_calculator` using the route calculator name. For example:
*
* ```sh
* $ pulumi import aws:location/routeCalculation:RouteCalculation example example
* ```
*/
export declare class RouteCalculation extends pulumi.CustomResource {
/**
* Get an existing RouteCalculation 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?: RouteCalculationState, opts?: pulumi.CustomResourceOptions): RouteCalculation;
/**
* Returns true if the given object is an instance of RouteCalculation. 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 RouteCalculation;
/**
* The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.
*/
readonly calculatorArn: pulumi.Output<string>;
/**
* The name of the route calculator resource.
*/
readonly calculatorName: pulumi.Output<string>;
/**
* The timestamp for when the route calculator resource was created in ISO 8601 format.
*/
readonly createTime: pulumi.Output<string>;
/**
* Specifies the data provider of traffic and road network data.
*
* The following arguments are optional:
*/
readonly dataSource: pulumi.Output<string>;
/**
* The optional description for the route calculator resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly region: pulumi.Output<string>;
/**
* Key-value tags for the route calculator. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* The timestamp for when the route calculator resource was last update in ISO 8601.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a RouteCalculation 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: RouteCalculationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RouteCalculation resources.
*/
export interface RouteCalculationState {
/**
* The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.
*/
calculatorArn?: pulumi.Input<string>;
/**
* The name of the route calculator resource.
*/
calculatorName?: pulumi.Input<string>;
/**
* The timestamp for when the route calculator resource was created in ISO 8601 format.
*/
createTime?: pulumi.Input<string>;
/**
* Specifies the data provider of traffic and road network data.
*
* The following arguments are optional:
*/
dataSource?: pulumi.Input<string>;
/**
* The optional description for the route calculator resource.
*/
description?: 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>;
/**
* Key-value tags for the route calculator. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The timestamp for when the route calculator resource was last update in ISO 8601.
*/
updateTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a RouteCalculation resource.
*/
export interface RouteCalculationArgs {
/**
* The name of the route calculator resource.
*/
calculatorName: pulumi.Input<string>;
/**
* Specifies the data provider of traffic and road network data.
*
* The following arguments are optional:
*/
dataSource: pulumi.Input<string>;
/**
* The optional description for the route calculator resource.
*/
description?: 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>;
/**
* Key-value tags for the route calculator. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}