Package software.amazon.awssdk.services.iot.model

Interface CreateProvisioningTemplateRequest.Builder

    • Method Detail

      • templateName

        CreateProvisioningTemplateRequest.Builder templateName​(String templateName)

        The name of the provisioning template.

        Parameters:
        templateName - The name of the provisioning template.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CreateProvisioningTemplateRequest.Builder description​(String description)

        The description of the provisioning template.

        Parameters:
        description - The description of the provisioning template.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • templateBody

        CreateProvisioningTemplateRequest.Builder templateBody​(String templateBody)

        The JSON formatted contents of the provisioning template.

        Parameters:
        templateBody - The JSON formatted contents of the provisioning template.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enabled

        CreateProvisioningTemplateRequest.Builder enabled​(Boolean enabled)

        True to enable the provisioning template, otherwise false.

        Parameters:
        enabled - True to enable the provisioning template, otherwise false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • provisioningRoleArn

        CreateProvisioningTemplateRequest.Builder provisioningRoleArn​(String provisioningRoleArn)

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

        Parameters:
        provisioningRoleArn - The role ARN for the role associated with the provisioning template. This IoT role grants permission to provision a device.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • preProvisioningHook

        CreateProvisioningTemplateRequest.Builder preProvisioningHook​(ProvisioningHook preProvisioningHook)

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

        Parameters:
        preProvisioningHook - Creates a pre-provisioning hook template. Only supports template of type FLEET_PROVISIONING. For more information about provisioning template types, see type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateProvisioningTemplateRequest.Builder tags​(Collection<Tag> tags)

        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..."

        Parameters:
        tags - 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:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateProvisioningTemplateRequest.Builder tags​(Tag... tags)

        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..."

        Parameters:
        tags - 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:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateProvisioningTemplateRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        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..."

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • type

        CreateProvisioningTemplateRequest.Builder type​(String type)

        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.

        Parameters:
        type - 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:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TemplateType, TemplateType

      • type

        CreateProvisioningTemplateRequest.Builder type​(TemplateType type)

        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.

        Parameters:
        type - 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:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TemplateType, TemplateType