Class: Aws::IoT1ClickProjects::Types::CreateProjectRequest

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

Overview

Note:

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

{
  project_name: "ProjectName", # required
  description: "Description",
  placement_template: {
    default_attributes: {
      "AttributeName" => "AttributeDefaultValue",
    },
    device_templates: {
      "DeviceTemplateName" => {
        device_type: "DeviceType",
        callback_overrides: {
          "DeviceCallbackKey" => "DeviceCallbackValue",
        },
      },
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

An optional description for the project.

Returns:

  • (String)


137
138
139
140
141
142
143
144
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/types.rb', line 137

class CreateProjectRequest < Struct.new(
  :project_name,
  :description,
  :placement_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#placement_templateTypes::PlacementTemplate

The schema defining the placement to be created. A placement template defines placement default attributes and device templates. You cannot add or remove device templates after the project has been created. However, you can update callbackOverrides for the device templates using the UpdateProject API.



137
138
139
140
141
142
143
144
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/types.rb', line 137

class CreateProjectRequest < Struct.new(
  :project_name,
  :description,
  :placement_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#project_nameString

The name of the project to create.

Returns:

  • (String)


137
138
139
140
141
142
143
144
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/types.rb', line 137

class CreateProjectRequest < Struct.new(
  :project_name,
  :description,
  :placement_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

Optional tags (metadata key/value pairs) to be associated with the project. For example, \{ \{"key1": "value1", "key2": "value2"\} \}. For more information, see AWS Tagging Strategies.

Returns:

  • (Hash<String,String>)


137
138
139
140
141
142
143
144
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/types.rb', line 137

class CreateProjectRequest < Struct.new(
  :project_name,
  :description,
  :placement_template,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end