Interface UpdateProvisioningTemplateRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateProvisioningTemplateRequest.Builder,
,UpdateProvisioningTemplateRequest> IotRequest.Builder
,SdkBuilder<UpdateProvisioningTemplateRequest.Builder,
,UpdateProvisioningTemplateRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateProvisioningTemplateRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefaultVersionId
(Integer defaultVersionId) The ID of the default provisioning template version.description
(String description) The description of the provisioning template.True to enable the provisioning template, otherwise false.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.preProvisioningHook
(Consumer<ProvisioningHook.Builder> preProvisioningHook) Updates the pre-provisioning hook template.preProvisioningHook
(ProvisioningHook preProvisioningHook) Updates the pre-provisioning hook template.provisioningRoleArn
(String provisioningRoleArn) The ARN of the role associated with the provisioning template.removePreProvisioningHook
(Boolean removePreProvisioningHook) Removes pre-provisioning hook template.templateName
(String templateName) The name of the provisioning template.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.iot.model.IotRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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.
-
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.
-
defaultVersionId
The ID of the default provisioning template version.
- Parameters:
defaultVersionId
- The ID of the default provisioning template version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
provisioningRoleArn
The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.
- Parameters:
provisioningRoleArn
- The ARN of 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
Updates the pre-provisioning hook template. Only supports template of type
FLEET_PROVISIONING
. For more information about provisioning template types, see type.- Parameters:
preProvisioningHook
- Updates the pre-provisioning hook template. Only supports template of typeFLEET_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 UpdateProvisioningTemplateRequest.Builder preProvisioningHook(Consumer<ProvisioningHook.Builder> preProvisioningHook) Updates the pre-provisioning hook template. Only supports template of type
This is a convenience method that creates an instance of theFLEET_PROVISIONING
. For more information about provisioning template types, see type.ProvisioningHook.Builder
avoiding the need to create one manually viaProvisioningHook.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topreProvisioningHook(ProvisioningHook)
.- Parameters:
preProvisioningHook
- a consumer that will call methods onProvisioningHook.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
removePreProvisioningHook
UpdateProvisioningTemplateRequest.Builder removePreProvisioningHook(Boolean removePreProvisioningHook) Removes pre-provisioning hook template.
- Parameters:
removePreProvisioningHook
- Removes pre-provisioning hook template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
UpdateProvisioningTemplateRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateProvisioningTemplateRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-