software.amazon.awssdk.services.iot.model

Interface CreateProvisioningTemplateRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateProvisioningTemplateRequest.Builder,CreateProvisioningTemplateRequest>, IotRequest.Builder, SdkBuilder<CreateProvisioningTemplateRequest.Builder,CreateProvisioningTemplateRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateProvisioningTemplateRequest

public static interface CreateProvisioningTemplateRequest.Builder
extends IotRequest.Builder, SdkPojo, CopyableBuilder<CreateProvisioningTemplateRequest.Builder,CreateProvisioningTemplateRequest>

Method Summary

Modifier and Type	Method and Description
CreateProvisioningTemplateRequest.Builder	description(String description) The description of the provisioning template.
CreateProvisioningTemplateRequest.Builder	enabled(Boolean enabled) True to enable the provisioning template, otherwise false.
CreateProvisioningTemplateRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateProvisioningTemplateRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
default CreateProvisioningTemplateRequest.Builder	preProvisioningHook(Consumer<ProvisioningHook.Builder> preProvisioningHook) Creates a pre-provisioning hook template.
CreateProvisioningTemplateRequest.Builder	preProvisioningHook(ProvisioningHook preProvisioningHook) Creates a pre-provisioning hook template.
CreateProvisioningTemplateRequest.Builder	provisioningRoleArn(String provisioningRoleArn) The role ARN for the role associated with the provisioning template.
CreateProvisioningTemplateRequest.Builder	tags(Collection<Tag> tags) Metadata which can be used to manage the provisioning template.
CreateProvisioningTemplateRequest.Builder	tags(Consumer<Tag.Builder>... tags) Metadata which can be used to manage the provisioning template.
CreateProvisioningTemplateRequest.Builder	tags(Tag... tags) Metadata which can be used to manage the provisioning template.
CreateProvisioningTemplateRequest.Builder	templateBody(String templateBody) The JSON formatted contents of the provisioning template.
CreateProvisioningTemplateRequest.Builder	templateName(String templateName) The name of the provisioning template.
CreateProvisioningTemplateRequest.Builder	type(String type) The type you define in a provisioning template.
CreateProvisioningTemplateRequest.Builder	type(TemplateType type) The type you define in a provisioning template.

Methods inherited from interface software.amazon.awssdk.services.iot.model.IotRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

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.

preProvisioningHook

default CreateProvisioningTemplateRequest.Builder preProvisioningHook(Consumer<ProvisioningHook.Builder> preProvisioningHook)

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

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to preProvisioningHook(ProvisioningHook).

Parameters:

preProvisioningHook - a consumer that will call methods on ProvisioningHook.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

preProvisioningHook(ProvisioningHook)

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

overrideConfiguration

CreateProvisioningTemplateRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateProvisioningTemplateRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder