software.amazon.awssdk.services.greengrass.model

Interface StartBulkDeploymentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartBulkDeploymentRequest.Builder,StartBulkDeploymentRequest>, GreengrassRequest.Builder, SdkBuilder<StartBulkDeploymentRequest.Builder,StartBulkDeploymentRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartBulkDeploymentRequest

public static interface StartBulkDeploymentRequest.Builder
extends GreengrassRequest.Builder, SdkPojo, CopyableBuilder<StartBulkDeploymentRequest.Builder,StartBulkDeploymentRequest>

Method Summary

Modifier and Type	Method and Description
StartBulkDeploymentRequest.Builder	amznClientToken(String amznClientToken) A client token used to correlate requests and responses.
StartBulkDeploymentRequest.Builder	executionRoleArn(String executionRoleArn) The ARN of the execution role to associate with the bulk deployment operation.
StartBulkDeploymentRequest.Builder	inputFileUri(String inputFileUri) The URI of the input file contained in the S3 bucket.
StartBulkDeploymentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
StartBulkDeploymentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.greengrass.model.GreengrassRequest.Builder

build

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

overrideConfiguration

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

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

amznClientToken

StartBulkDeploymentRequest.Builder amznClientToken(String amznClientToken)

A client token used to correlate requests and responses.

Parameters:

amznClientToken - A client token used to correlate requests and responses.

Returns:

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

executionRoleArn

StartBulkDeploymentRequest.Builder executionRoleArn(String executionRoleArn)

The ARN of the execution role to associate with the bulk deployment operation. This IAM role must allow the ''greengrass:CreateDeployment'' action for all group versions that are listed in the input file. This IAM role must have access to the S3 bucket containing the input file.

Parameters:

executionRoleArn - The ARN of the execution role to associate with the bulk deployment operation. This IAM role must allow the ''greengrass:CreateDeployment'' action for all group versions that are listed in the input file. This IAM role must have access to the S3 bucket containing the input file.

Returns:

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

inputFileUri

StartBulkDeploymentRequest.Builder inputFileUri(String inputFileUri)

The URI of the input file contained in the S3 bucket. The execution role must have ''getObject'' permissions on this bucket to access the input file. The input file is a JSON-serialized, line delimited file with UTF-8 encoding that provides a list of group and version IDs and the deployment type. This file must be less than 100 MB. Currently, AWS IoT Greengrass supports only ''NewDeployment'' deployment types.

Parameters:

inputFileUri - The URI of the input file contained in the S3 bucket. The execution role must have ''getObject'' permissions on this bucket to access the input file. The input file is a JSON-serialized, line delimited file with UTF-8 encoding that provides a list of group and version IDs and the deployment type. This file must be less than 100 MB. Currently, AWS IoT Greengrass supports only ''NewDeployment'' deployment types.

Returns:

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

overrideConfiguration

StartBulkDeploymentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.