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

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::CreateProvisioningTemplateRequest

Defined in:

gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  The description of the provisioning template.

• #enabled ⇒ Boolean

  True to enable the provisioning template, otherwise false.

• #pre_provisioning_hook ⇒ Types::ProvisioningHook

  Creates a pre-provisioning hook template.

• #provisioning_role_arn ⇒ String

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

• #tags ⇒ Array<Types::Tag>

  Metadata which can be used to manage the provisioning template.

• #template_body ⇒ String

  The JSON formatted contents of the provisioning template.

• #template_name ⇒ String

  The name of the provisioning template.

• #type ⇒ String

  The type you define in a provisioning template.

Instance Attribute Details

#description ⇒ String

The description of the provisioning template.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4141

class CreateProvisioningTemplateRequest < Struct.new(
  :template_name,
  :description,
  :template_body,
  :enabled,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#enabled ⇒ Boolean

True to enable the provisioning template, otherwise false.

Returns:

• (Boolean)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4141

class CreateProvisioningTemplateRequest < Struct.new(
  :template_name,
  :description,
  :template_body,
  :enabled,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#pre_provisioning_hook ⇒ Types::ProvisioningHook

Creates a pre-provisioning hook template. Only supports template of type FLEET_PROVISIONING. For more information about provisioning template types, see type.

Returns:

• (Types::ProvisioningHook)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4141

class CreateProvisioningTemplateRequest < Struct.new(
  :template_name,
  :description,
  :template_body,
  :enabled,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#provisioning_role_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4141

class CreateProvisioningTemplateRequest < Struct.new(
  :template_name,
  :description,
  :template_body,
  :enabled,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Metadata which can be used to manage the 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>)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4141

class CreateProvisioningTemplateRequest < Struct.new(
  :template_name,
  :description,
  :template_body,
  :enabled,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#template_body ⇒ String

The JSON formatted contents of the provisioning template.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4141

class CreateProvisioningTemplateRequest < Struct.new(
  :template_name,
  :description,
  :template_body,
  :enabled,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#template_name ⇒ String

The name of the provisioning template.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4141

class CreateProvisioningTemplateRequest < Struct.new(
  :template_name,
  :description,
  :template_body,
  :enabled,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type you define in a provisioning template. You can create a template with only one type. You can't change the template type after its creation. The default value is FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning template.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4141

class CreateProvisioningTemplateRequest < Struct.new(
  :template_name,
  :description,
  :template_body,
  :enabled,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end