You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoT::Types::CreateProvisioningTemplateRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateProvisioningTemplateRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  template_name: "TemplateName", # required
  description: "TemplateDescription",
  template_body: "TemplateBody", # required
  enabled: false,
  provisioning_role_arn: "RoleArn", # required
  pre_provisioning_hook: {
    payload_version: "PayloadVersion",
    target_arn: "TargetArn", # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

The description of the fleet provisioning template.

Returns:

  • (String) —

    The description of the fleet provisioning template.

#enabled ⇒ Boolean

True to enable the fleet provisioning template, otherwise false.

Returns:

  • (Boolean) —

    True to enable the fleet provisioning template, otherwise false.

#pre_provisioning_hook ⇒ Types::ProvisioningHook

Creates a pre-provisioning hook template.

Returns:

#provisioning_role_arn ⇒ String

The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.

Returns:

  • (String) —

    The role ARN for the role associated with the fleet provisioning template.

#tags ⇒ Array<Types::Tag>

Metadata which can be used to manage the fleet provisioning template.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags \"key1=value1&key2=value2...\"

For the cli-input-json file use format: \"tags\": \"key1=value1&key2=value2...\"

Returns:

  • (Array<Types::Tag>) —

    Metadata which can be used to manage the fleet provisioning template.

#template_body ⇒ String

The JSON formatted contents of the fleet provisioning template.

Returns:

  • (String) —

    The JSON formatted contents of the fleet provisioning template.

#template_name ⇒ String

The name of the fleet provisioning template.

Returns:

  • (String) —

    The name of the fleet provisioning template.