Class: Aws::LocationService::Types::CreatePlaceIndexRequest

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 CreatePlaceIndexRequest data as a hash:

{
  data_source: "String", # required
  data_source_configuration: {
    intended_use: "SingleUse", # accepts SingleUse, Storage
  },
  description: "ResourceDescription",
  index_name: "ResourceName", # required
  pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
  tags: {
    "TagKey" => "TagValue",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_sourceString

Specifies the data provider of geospatial data.

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

Valid values include:

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

Returns:

  • (String)


1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1374

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

#data_source_configurationTypes::DataSourceConfiguration

Specifies the data storage option requesting Places.



1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1374

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

#descriptionString

The optional description for the place index resource.

Returns:

  • (String)


1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1374

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

#index_nameString

The name of the place index resource.

Requirements:

  • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

  • Must be a unique place index resource name.

  • No spaces allowed. For example, ExamplePlaceIndex.

Returns:

  • (String)


1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1374

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

#pricing_planString

Specifies the pricing plan for your place index resource.

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

Returns:

  • (String)


1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1374

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

#tagsHash<String,String>

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

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


1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1374

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