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

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.RouteCalculator

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

    Create RouteCalculator Resource

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

    Constructor syntax

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

@overload
def RouteCalculator(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    data_source: Optional[str] = None,
                    calculator_name: Optional[str] = None,
                    description: Optional[str] = None,
                    pricing_plan: Optional[RouteCalculatorPricingPlan] = None,
                    tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewRouteCalculator(ctx *Context, name string, args RouteCalculatorArgs, opts ...ResourceOption) (*RouteCalculator, error)
    public RouteCalculator(string name, RouteCalculatorArgs args, CustomResourceOptions? opts = null)
    public RouteCalculator(String name, RouteCalculatorArgs args)
public RouteCalculator(String name, RouteCalculatorArgs args, CustomResourceOptions options)

    type: aws-native:location:RouteCalculator
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 RouteCalculatorArgs
    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 RouteCalculatorArgs
    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 RouteCalculatorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RouteCalculatorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RouteCalculatorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    RouteCalculator 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 RouteCalculator resource accepts the following input properties:

    DataSource string

    Specifies the data provider of traffic and road network data.

    This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

    Valid values include:

    Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km.

    For additional information , see Data providers on the Amazon Location Service Developer Guide .

    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 .
    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.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    DataSource string

    Specifies the data provider of traffic and road network data.

    This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

    Valid values include:

    Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km.

    For additional information , see Data providers on the Amazon Location Service Developer Guide .

    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 .
    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 TagArgs
    An array of key-value pairs to apply to this resource.
    dataSource String

    Specifies the data provider of traffic and road network data.

    This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

    Valid values include:

    Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km.

    For additional information , see Data providers on the Amazon Location Service Developer Guide .

    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 .
    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.
    dataSource string

    Specifies the data provider of traffic and road network data.

    This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

    Valid values include:

    Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km.

    For additional information , see Data providers on the Amazon Location Service Developer Guide .

    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 .
    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.
    data_source str

    Specifies the data provider of traffic and road network data.

    This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

    Valid values include:

    Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km.

    For additional information , see Data providers on the Amazon Location Service Developer Guide .

    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 .
    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[TagArgs]
    An array of key-value pairs to apply to this resource.
    dataSource String

    Specifies the data provider of traffic and road network data.

    This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

    Valid values include:

    Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km.

    For additional information , see Data providers on the Amazon Location Service Developer Guide .

    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 .
    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.

    Outputs

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

    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 .
    Id string
    The provider-assigned unique ID for this managed 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 .
    Id string
    The provider-assigned unique ID for this managed 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 .
    id String
    The provider-assigned unique ID for this managed 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 .
    id string
    The provider-assigned unique ID for this managed 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 .
    id str
    The provider-assigned unique ID for this managed 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 .
    id String
    The provider-assigned unique ID for this managed 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, RouteCalculatorPricingPlanArgs

    RequestBasedUsage
    RequestBasedUsage
    RouteCalculatorPricingPlanRequestBasedUsage
    RequestBasedUsage
    RequestBasedUsage
    RequestBasedUsage
    RequestBasedUsage
    RequestBasedUsage
    REQUEST_BASED_USAGE
    RequestBasedUsage
    "RequestBasedUsage"
    RequestBasedUsage

    Tag, TagArgs

    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