Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. location
  5. getRouteCalculator

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.location.getRouteCalculator

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::Location::RouteCalculator Resource Type

    Using getRouteCalculator

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRouteCalculator(args: GetRouteCalculatorArgs, opts?: InvokeOptions): Promise<GetRouteCalculatorResult>
function getRouteCalculatorOutput(args: GetRouteCalculatorOutputArgs, opts?: InvokeOptions): Output<GetRouteCalculatorResult>
    def get_route_calculator(calculator_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetRouteCalculatorResult
def get_route_calculator_output(calculator_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetRouteCalculatorResult]
    func LookupRouteCalculator(ctx *Context, args *LookupRouteCalculatorArgs, opts ...InvokeOption) (*LookupRouteCalculatorResult, error)
func LookupRouteCalculatorOutput(ctx *Context, args *LookupRouteCalculatorOutputArgs, opts ...InvokeOption) LookupRouteCalculatorResultOutput

    > Note: This function is named LookupRouteCalculator in the Go SDK.

    public static class GetRouteCalculator 
{
    public static Task<GetRouteCalculatorResult> InvokeAsync(GetRouteCalculatorArgs args, InvokeOptions? opts = null)
    public static Output<GetRouteCalculatorResult> Invoke(GetRouteCalculatorInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRouteCalculatorResult> getRouteCalculator(GetRouteCalculatorArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:location:getRouteCalculator
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CalculatorName string

    The name of the route calculator resource.

    Requirements:

    • Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
    • Must be a unique Route calculator resource name.
    • No spaces allowed. For example, ExampleRouteCalculator .
    CalculatorName string

    The name of the route calculator resource.

    Requirements:

    • Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
    • Must be a unique Route calculator resource name.
    • No spaces allowed. For example, ExampleRouteCalculator .
    calculatorName String

    The name of the route calculator resource.

    Requirements:

    • Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
    • Must be a unique Route calculator resource name.
    • No spaces allowed. For example, ExampleRouteCalculator .
    calculatorName string

    The name of the route calculator resource.

    Requirements:

    • Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
    • Must be a unique Route calculator resource name.
    • No spaces allowed. For example, ExampleRouteCalculator .
    calculator_name str

    The name of the route calculator resource.

    Requirements:

    • Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
    • Must be a unique Route calculator resource name.
    • No spaces allowed. For example, ExampleRouteCalculator .
    calculatorName String

    The name of the route calculator resource.

    Requirements:

    • Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
    • Must be a unique Route calculator resource name.
    • No spaces allowed. For example, ExampleRouteCalculator .

    getRouteCalculator Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
    CalculatorArn string
    Synonym for Arn . The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
    CreateTime string
    The timestamp for when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    Description string
    The optional description for the route calculator resource.
    PricingPlan Pulumi.AwsNative.Location.RouteCalculatorPricingPlan

    No longer used. If included, the only allowed value is RequestBasedUsage .

    Allowed Values : RequestBasedUsage

    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    UpdateTime string
    The timestamp for when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    Arn string
    The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
    CalculatorArn string
    Synonym for Arn . The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
    CreateTime string
    The timestamp for when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    Description string
    The optional description for the route calculator resource.
    PricingPlan RouteCalculatorPricingPlan

    No longer used. If included, the only allowed value is RequestBasedUsage .

    Allowed Values : RequestBasedUsage

    Tags Tag
    An array of key-value pairs to apply to this resource.
    UpdateTime string
    The timestamp for when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn String
    The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
    calculatorArn String
    Synonym for Arn . The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
    createTime String
    The timestamp for when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    description String
    The optional description for the route calculator resource.
    pricingPlan RouteCalculatorPricingPlan

    No longer used. If included, the only allowed value is RequestBasedUsage .

    Allowed Values : RequestBasedUsage

    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    updateTime String
    The timestamp for when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn string
    The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
    calculatorArn string
    Synonym for Arn . The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
    createTime string
    The timestamp for when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    description string
    The optional description for the route calculator resource.
    pricingPlan RouteCalculatorPricingPlan

    No longer used. If included, the only allowed value is RequestBasedUsage .

    Allowed Values : RequestBasedUsage

    tags Tag[]
    An array of key-value pairs to apply to this resource.
    updateTime string
    The timestamp for when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn str
    The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
    calculator_arn str
    Synonym for Arn . The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
    create_time str
    The timestamp for when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    description str
    The optional description for the route calculator resource.
    pricing_plan RouteCalculatorPricingPlan

    No longer used. If included, the only allowed value is RequestBasedUsage .

    Allowed Values : RequestBasedUsage

    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    update_time str
    The timestamp for when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn String
    The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
    calculatorArn String
    Synonym for Arn . The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS .

    • Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
    createTime String
    The timestamp for when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    description String
    The optional description for the route calculator resource.
    pricingPlan "RequestBasedUsage"

    No longer used. If included, the only allowed value is RequestBasedUsage .

    Allowed Values : RequestBasedUsage

    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    updateTime String
    The timestamp for when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    Supporting Types

    RouteCalculatorPricingPlan

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native