Class: Aws::LocationService::Types::CreateGeofenceCollectionRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#collection_name ⇒ String

A custom name for the geofence collection.

Requirements:

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

  • Must be a unique geofence collection name.

  • No spaces allowed. For example, ExampleGeofenceCollection.

Returns:

  • (String) 


1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1360

class CreateGeofenceCollectionRequest < Struct.new(
  :collection_name,
  :description,
  :kms_key_id,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

An optional description for the geofence collection.

Returns:

  • (String) 


1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1360

class CreateGeofenceCollectionRequest < Struct.new(
  :collection_name,
  :description,
  :kms_key_id,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

Returns:

  • (String) 


1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1360

class CreateGeofenceCollectionRequest < Struct.new(
  :collection_name,
  :description,
  :kms_key_id,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pricing_plan ⇒ String

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

Returns:

  • (String) 


1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1360

class CreateGeofenceCollectionRequest < Struct.new(
  :collection_name,
  :description,
  :kms_key_id,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pricing_plan_data_source ⇒ String

This parameter is no longer used.

Returns:

  • (String) 


1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1360

class CreateGeofenceCollectionRequest < Struct.new(
  :collection_name,
  :description,
  :kms_key_id,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Applies one or more tags to the geofence collection. 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: + - = . _ : / @.

  • Cannot use "aws:" as a prefix for a key.

Returns:

  • (Hash<String,String>) 


1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1360

class CreateGeofenceCollectionRequest < Struct.new(
  :collection_name,
  :description,
  :kms_key_id,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end