Class: Aws::IoT::Types::UpdateProvisioningTemplateRequest

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

Overview

Note:

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

{
  template_name: "TemplateName", # required
  description: "TemplateDescription",
  enabled: false,
  default_version_id: 1,
  provisioning_role_arn: "RoleArn",
  pre_provisioning_hook: {
    payload_version: "PayloadVersion",
    target_arn: "TargetArn", # required
  },
  remove_pre_provisioning_hook: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#default_version_idInteger

The ID of the default provisioning template version.

Returns:

  • (Integer)


19604
19605
19606
19607
19608
19609
19610
19611
19612
19613
19614
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19604

class UpdateProvisioningTemplateRequest < Struct.new(
  :template_name,
  :description,
  :enabled,
  :default_version_id,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :remove_pre_provisioning_hook)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the fleet provisioning template.

Returns:

  • (String)


19604
19605
19606
19607
19608
19609
19610
19611
19612
19613
19614
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19604

class UpdateProvisioningTemplateRequest < Struct.new(
  :template_name,
  :description,
  :enabled,
  :default_version_id,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :remove_pre_provisioning_hook)
  SENSITIVE = []
  include Aws::Structure
end

#enabledBoolean

True to enable the fleet provisioning template, otherwise false.

Returns:

  • (Boolean)


19604
19605
19606
19607
19608
19609
19610
19611
19612
19613
19614
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19604

class UpdateProvisioningTemplateRequest < Struct.new(
  :template_name,
  :description,
  :enabled,
  :default_version_id,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :remove_pre_provisioning_hook)
  SENSITIVE = []
  include Aws::Structure
end

#pre_provisioning_hookTypes::ProvisioningHook

Updates the pre-provisioning hook template.



19604
19605
19606
19607
19608
19609
19610
19611
19612
19613
19614
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19604

class UpdateProvisioningTemplateRequest < Struct.new(
  :template_name,
  :description,
  :enabled,
  :default_version_id,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :remove_pre_provisioning_hook)
  SENSITIVE = []
  include Aws::Structure
end

#provisioning_role_arnString

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

Returns:

  • (String)


19604
19605
19606
19607
19608
19609
19610
19611
19612
19613
19614
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19604

class UpdateProvisioningTemplateRequest < Struct.new(
  :template_name,
  :description,
  :enabled,
  :default_version_id,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :remove_pre_provisioning_hook)
  SENSITIVE = []
  include Aws::Structure
end

#remove_pre_provisioning_hookBoolean

Removes pre-provisioning hook template.

Returns:

  • (Boolean)


19604
19605
19606
19607
19608
19609
19610
19611
19612
19613
19614
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19604

class UpdateProvisioningTemplateRequest < Struct.new(
  :template_name,
  :description,
  :enabled,
  :default_version_id,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :remove_pre_provisioning_hook)
  SENSITIVE = []
  include Aws::Structure
end

#template_nameString

The name of the fleet provisioning template.

Returns:

  • (String)


19604
19605
19606
19607
19608
19609
19610
19611
19612
19613
19614
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19604

class UpdateProvisioningTemplateRequest < Struct.new(
  :template_name,
  :description,
  :enabled,
  :default_version_id,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :remove_pre_provisioning_hook)
  SENSITIVE = []
  include Aws::Structure
end