Class: AWSCDK::Location::CfnPlaceIndexProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
location/cfn_place_index_props.rb

Overview

Properties for defining a CfnPlaceIndex.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_source:, index_name:, data_source_configuration: nil, description: nil, pricing_plan: nil, tags: nil) ⇒ CfnPlaceIndexProps

Returns a new instance of CfnPlaceIndexProps.

Parameters:

  • data_source (String) —

    Specifies the geospatial data provider for the new place index.

  • index_name (String) —

    The name of the place index resource.

  • data_source_configuration (AWSCDK::IResolvable, AWSCDK::Location::CfnPlaceIndex::DataSourceConfigurationProperty, nil) (defaults to: nil) —

    Specifies the data storage option requesting Places.

  • description (String, nil) (defaults to: nil) —

    The optional description for the place index resource.

  • pricing_plan (String, nil) (defaults to: nil) —

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

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    An array of key-value pairs to apply to this resource.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'location/cfn_place_index_props.rb', line 15

def initialize(data_source:, index_name:, data_source_configuration: nil, description: nil, pricing_plan: nil, tags: nil)
  @data_source = data_source
  Jsii::Type.check_type(@data_source, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataSource")
  @index_name = index_name
  Jsii::Type.check_type(@index_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "indexName")
  @data_source_configuration = data_source_configuration.is_a?(Hash) ? ::AWSCDK::Location::CfnPlaceIndex::DataSourceConfigurationProperty.new(**data_source_configuration.transform_keys(&:to_sym)) : data_source_configuration
  Jsii::Type.check_type(@data_source_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sb2NhdGlvbi5DZm5QbGFjZUluZGV4LkRhdGFTb3VyY2VDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "dataSourceConfiguration") unless @data_source_configuration.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @pricing_plan = pricing_plan
  Jsii::Type.check_type(@pricing_plan, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pricingPlan") unless @pricing_plan.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#data_source ⇒ String (readonly)

Specifies the geospatial data provider for the new place index.

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

Valid values include:

If you specify HERE Technologies ( Here ) as the data provider, you may not store results for locations in Japan. For more information, see the AWS service terms for Amazon Location Service.

For additional information , see Data providers on the Amazon Location Service developer guide .

Returns:

  • (String)

See Also:



46
47
48
 
# File 'location/cfn_place_index_props.rb', line 46

def data_source
  @data_source
end

#data_source_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Specifies the data storage option requesting Places.

Returns:

See Also:



62
63
64
 
# File 'location/cfn_place_index_props.rb', line 62

def data_source_configuration
  @data_source_configuration
end

#description ⇒ String? (readonly)

The optional description for the place index resource.

Returns:

  • (String, nil)

See Also:



67
68
69
 
# File 'location/cfn_place_index_props.rb', line 67

def description
  @description
end

#index_name ⇒ String (readonly)

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)

See Also:



57
58
59
 
# File 'location/cfn_place_index_props.rb', line 57

def index_name
  @index_name
end

#pricing_plan ⇒ String? (readonly)

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

Allowed Values : RequestBasedUsage

Returns:

  • (String, nil)

See Also:



74
75
76
 
# File 'location/cfn_place_index_props.rb', line 74

def pricing_plan
  @pricing_plan
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An array of key-value pairs to apply to this resource.

Returns:

See Also:



79
80
81
 
# File 'location/cfn_place_index_props.rb', line 79

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



81
82
83
84
85
86
87
88
89
90
 
# File 'location/cfn_place_index_props.rb', line 81

def self.jsii_properties
  {
    :data_source => "dataSource",
    :index_name => "indexName",
    :data_source_configuration => "dataSourceConfiguration",
    :description => "description",
    :pricing_plan => "pricingPlan",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'location/cfn_place_index_props.rb', line 92

def to_jsii
  result = {}
  result.merge!({
    "dataSource" => @data_source,
    "indexName" => @index_name,
    "dataSourceConfiguration" => @data_source_configuration,
    "description" => @description,
    "pricingPlan" => @pricing_plan,
    "tags" => @tags,
  })
  result.compact
end