Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. location
  5. RouteCalculation

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.location.RouteCalculation

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a Location Service Route Calculator.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.location.RouteCalculation("example", {
    calculatorName: "example",
    dataSource: "Here",
});

    import pulumi
import pulumi_aws as aws

example = aws.location.RouteCalculation("example",
    calculator_name="example",
    data_source="Here")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/location"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := location.NewRouteCalculation(ctx, "example", &location.RouteCalculationArgs{
			CalculatorName: pulumi.String("example"),
			DataSource:     pulumi.String("Here"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Location.RouteCalculation("example", new()
    {
        CalculatorName = "example",
        DataSource = "Here",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.location.RouteCalculation;
import com.pulumi.aws.location.RouteCalculationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new RouteCalculation("example", RouteCalculationArgs.builder()
            .calculatorName("example")
            .dataSource("Here")
            .build());

    }
}

    resources:
  example:
    type: aws:location:RouteCalculation
    properties:
      calculatorName: example
      dataSource: Here

    Create RouteCalculation Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RouteCalculation(name: string, args: RouteCalculationArgs, opts?: CustomResourceOptions);
    @overload
def RouteCalculation(resource_name: str,
                     args: RouteCalculationArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def RouteCalculation(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     calculator_name: Optional[str] = None,
                     data_source: Optional[str] = None,
                     description: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None)
    func NewRouteCalculation(ctx *Context, name string, args RouteCalculationArgs, opts ...ResourceOption) (*RouteCalculation, error)
    public RouteCalculation(string name, RouteCalculationArgs args, CustomResourceOptions? opts = null)
    public RouteCalculation(String name, RouteCalculationArgs args)
public RouteCalculation(String name, RouteCalculationArgs args, CustomResourceOptions options)

    type: aws:location:RouteCalculation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args RouteCalculationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RouteCalculationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RouteCalculationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RouteCalculationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RouteCalculationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var routeCalculationResource = new Aws.Location.RouteCalculation("routeCalculationResource", new()
{
    CalculatorName = "string",
    DataSource = "string",
    Description = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := location.NewRouteCalculation(ctx, "routeCalculationResource", &location.RouteCalculationArgs{
	CalculatorName: pulumi.String("string"),
	DataSource:     pulumi.String("string"),
	Description:    pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var routeCalculationResource = new RouteCalculation("routeCalculationResource", RouteCalculationArgs.builder()
    .calculatorName("string")
    .dataSource("string")
    .description("string")
    .tags(Map.of("string", "string"))
    .build());

    route_calculation_resource = aws.location.RouteCalculation("routeCalculationResource",
    calculator_name="string",
    data_source="string",
    description="string",
    tags={
        "string": "string",
    })

    const routeCalculationResource = new aws.location.RouteCalculation("routeCalculationResource", {
    calculatorName: "string",
    dataSource: "string",
    description: "string",
    tags: {
        string: "string",
    },
});

    type: aws:location:RouteCalculation
properties:
    calculatorName: string
    dataSource: string
    description: string
    tags:
        string: string

    RouteCalculation Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The RouteCalculation resource accepts the following input properties:

    CalculatorName string
    The name of the route calculator resource.
    DataSource string

    Specifies the data provider of traffic and road network data.

    The following arguments are optional:

    Description string
    The optional description for the route calculator resource.
    Tags Dictionary<string, string>
    Key-value tags for the route calculator. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    CalculatorName string
    The name of the route calculator resource.
    DataSource string

    Specifies the data provider of traffic and road network data.

    The following arguments are optional:

    Description string
    The optional description for the route calculator resource.
    Tags map[string]string
    Key-value tags for the route calculator. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    calculatorName String
    The name of the route calculator resource.
    dataSource String

    Specifies the data provider of traffic and road network data.

    The following arguments are optional:

    description String
    The optional description for the route calculator resource.
    tags Map<String,String>
    Key-value tags for the route calculator. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    calculatorName string
    The name of the route calculator resource.
    dataSource string

    Specifies the data provider of traffic and road network data.

    The following arguments are optional:

    description string
    The optional description for the route calculator resource.
    tags {[key: string]: string}
    Key-value tags for the route calculator. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    calculator_name str
    The name of the route calculator resource.
    data_source str

    Specifies the data provider of traffic and road network data.

    The following arguments are optional:

    description str
    The optional description for the route calculator resource.
    tags Mapping[str, str]
    Key-value tags for the route calculator. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    calculatorName String
    The name of the route calculator resource.
    dataSource String

    Specifies the data provider of traffic and road network data.

    The following arguments are optional:

    description String
    The optional description for the route calculator resource.
    tags Map<String>
    Key-value tags for the route calculator. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RouteCalculation resource produces the following output properties:

    CalculatorArn string
    The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.
    CreateTime string
    The timestamp for when the route calculator resource was created in ISO 8601 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UpdateTime string
    The timestamp for when the route calculator resource was last update in ISO 8601.
    CalculatorArn string
    The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.
    CreateTime string
    The timestamp for when the route calculator resource was created in ISO 8601 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UpdateTime string
    The timestamp for when the route calculator resource was last update in ISO 8601.
    calculatorArn String
    The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.
    createTime String
    The timestamp for when the route calculator resource was created in ISO 8601 format.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    updateTime String
    The timestamp for when the route calculator resource was last update in ISO 8601.
    calculatorArn string
    The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.
    createTime string
    The timestamp for when the route calculator resource was created in ISO 8601 format.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    updateTime string
    The timestamp for when the route calculator resource was last update in ISO 8601.
    calculator_arn str
    The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.
    create_time str
    The timestamp for when the route calculator resource was created in ISO 8601 format.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    update_time str
    The timestamp for when the route calculator resource was last update in ISO 8601.
    calculatorArn String
    The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.
    createTime String
    The timestamp for when the route calculator resource was created in ISO 8601 format.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    updateTime String
    The timestamp for when the route calculator resource was last update in ISO 8601.

    Look up Existing RouteCalculation Resource

    Get an existing RouteCalculation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RouteCalculationState, opts?: CustomResourceOptions): RouteCalculation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        calculator_arn: Optional[str] = None,
        calculator_name: Optional[str] = None,
        create_time: Optional[str] = None,
        data_source: Optional[str] = None,
        description: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        update_time: Optional[str] = None) -> RouteCalculation
    func GetRouteCalculation(ctx *Context, name string, id IDInput, state *RouteCalculationState, opts ...ResourceOption) (*RouteCalculation, error)
    public static RouteCalculation Get(string name, Input<string> id, RouteCalculationState? state, CustomResourceOptions? opts = null)
    public static RouteCalculation get(String name, Output<String> id, RouteCalculationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CalculatorArn string
    The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.
    CalculatorName string
    The name of the route calculator resource.
    CreateTime string
    The timestamp for when the route calculator resource was created in ISO 8601 format.
    DataSource string

    Specifies the data provider of traffic and road network data.

    The following arguments are optional:

    Description string
    The optional description for the route calculator resource.
    Tags Dictionary<string, string>
    Key-value tags for the route calculator. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UpdateTime string
    The timestamp for when the route calculator resource was last update in ISO 8601.
    CalculatorArn string
    The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.
    CalculatorName string
    The name of the route calculator resource.
    CreateTime string
    The timestamp for when the route calculator resource was created in ISO 8601 format.
    DataSource string

    Specifies the data provider of traffic and road network data.

    The following arguments are optional:

    Description string
    The optional description for the route calculator resource.
    Tags map[string]string
    Key-value tags for the route calculator. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UpdateTime string
    The timestamp for when the route calculator resource was last update in ISO 8601.
    calculatorArn String
    The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.
    calculatorName String
    The name of the route calculator resource.
    createTime String
    The timestamp for when the route calculator resource was created in ISO 8601 format.
    dataSource String

    Specifies the data provider of traffic and road network data.

    The following arguments are optional:

    description String
    The optional description for the route calculator resource.
    tags Map<String,String>
    Key-value tags for the route calculator. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    updateTime String
    The timestamp for when the route calculator resource was last update in ISO 8601.
    calculatorArn string
    The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.
    calculatorName string
    The name of the route calculator resource.
    createTime string
    The timestamp for when the route calculator resource was created in ISO 8601 format.
    dataSource string

    Specifies the data provider of traffic and road network data.

    The following arguments are optional:

    description string
    The optional description for the route calculator resource.
    tags {[key: string]: string}
    Key-value tags for the route calculator. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    updateTime string
    The timestamp for when the route calculator resource was last update in ISO 8601.
    calculator_arn str
    The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.
    calculator_name str
    The name of the route calculator resource.
    create_time str
    The timestamp for when the route calculator resource was created in ISO 8601 format.
    data_source str

    Specifies the data provider of traffic and road network data.

    The following arguments are optional:

    description str
    The optional description for the route calculator resource.
    tags Mapping[str, str]
    Key-value tags for the route calculator. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    update_time str
    The timestamp for when the route calculator resource was last update in ISO 8601.
    calculatorArn String
    The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.
    calculatorName String
    The name of the route calculator resource.
    createTime String
    The timestamp for when the route calculator resource was created in ISO 8601 format.
    dataSource String

    Specifies the data provider of traffic and road network data.

    The following arguments are optional:

    description String
    The optional description for the route calculator resource.
    tags Map<String>
    Key-value tags for the route calculator. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    updateTime String
    The timestamp for when the route calculator resource was last update in ISO 8601.

    Import

    Using pulumi import, import aws_location_route_calculator using the route calculator name. For example:

    $ pulumi import aws:location/routeCalculation:RouteCalculation example example

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws