Class: Aws::LocationService::Types::CreateRouteCalculatorRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb

Overview

Note:

When making an API call, you may pass CreateRouteCalculatorRequest data as a hash:

{
  calculator_name: "ResourceName", # required
  data_source: "String", # required
  description: "ResourceDescription",
  pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
  tags: {
    "TagKey" => "TagValue",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#calculator_nameString

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.

Returns:

  • (String)


1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1519

class CreateRouteCalculatorRequest < Struct.new(
  :calculator_name,
  :data_source,
  :description,
  :pricing_plan,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#data_sourceString

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. Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km.

Valid values include:

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

Returns:

  • (String)


1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1519

class CreateRouteCalculatorRequest < Struct.new(
  :calculator_name,
  :data_source,
  :description,
  :pricing_plan,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The optional description for the route calculator resource.

Returns:

  • (String)


1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1519

class CreateRouteCalculatorRequest < Struct.new(
  :calculator_name,
  :data_source,
  :description,
  :pricing_plan,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pricing_planString

Specifies the pricing plan for your route calculator resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

Returns:

  • (String)


1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1519

class CreateRouteCalculatorRequest < Struct.new(
  :calculator_name,
  :data_source,
  :description,
  :pricing_plan,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

  • For example: \{ "tag1" : "value1", "tag2" : "value2"\}

^

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

Returns:

  • (Hash<String,String>)


1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1519

class CreateRouteCalculatorRequest < Struct.new(
  :calculator_name,
  :data_source,
  :description,
  :pricing_plan,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end