Interface CreateSystemInstanceRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateSystemInstanceRequest.Builder,CreateSystemInstanceRequest>, IoTThingsGraphRequest.Builder, SdkBuilder<CreateSystemInstanceRequest.Builder,CreateSystemInstanceRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateSystemInstanceRequest

@Mutable
@NotThreadSafe
public static interface CreateSystemInstanceRequest.Builder
extends IoTThingsGraphRequest.Builder, SdkPojo, CopyableBuilder<CreateSystemInstanceRequest.Builder,CreateSystemInstanceRequest>

Method Summary

Modifier and Type	Method	Description
default CreateSystemInstanceRequest.Builder	definition(Consumer<DefinitionDocument.Builder> definition)	Sets the value of the Definition property for this object.
CreateSystemInstanceRequest.Builder	definition(DefinitionDocument definition)	Sets the value of the Definition property for this object.
CreateSystemInstanceRequest.Builder	flowActionsRoleArn(String flowActionsRoleArn)	The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow.
CreateSystemInstanceRequest.Builder	greengrassGroupName(String greengrassGroupName)	The name of the Greengrass group where the system instance will be deployed.
default CreateSystemInstanceRequest.Builder	metricsConfiguration(Consumer<MetricsConfiguration.Builder> metricsConfiguration)	Sets the value of the MetricsConfiguration property for this object.
CreateSystemInstanceRequest.Builder	metricsConfiguration(MetricsConfiguration metricsConfiguration)	Sets the value of the MetricsConfiguration property for this object.
CreateSystemInstanceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateSystemInstanceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateSystemInstanceRequest.Builder	s3BucketName(String s3BucketName)	The name of the Amazon Simple Storage Service bucket that will be used to store and deploy the system instance's resource file.
CreateSystemInstanceRequest.Builder	tags(Collection<Tag> tags)	Metadata, consisting of key-value pairs, that can be used to categorize your system instances.
CreateSystemInstanceRequest.Builder	tags(Consumer<Tag.Builder>... tags)	Metadata, consisting of key-value pairs, that can be used to categorize your system instances.
CreateSystemInstanceRequest.Builder	tags(Tag... tags)	Metadata, consisting of key-value pairs, that can be used to categorize your system instances.
CreateSystemInstanceRequest.Builder	target(String target)	The target type of the deployment.
CreateSystemInstanceRequest.Builder	target(DeploymentTarget target)	The target type of the deployment.

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.iotthingsgraph.model.IoTThingsGraphRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

tags

CreateSystemInstanceRequest.Builder tags(Collection<Tag> tags)

Metadata, consisting of key-value pairs, that can be used to categorize your system instances.

Parameters:

tags - Metadata, consisting of key-value pairs, that can be used to categorize your system instances.

Returns:

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

tags

CreateSystemInstanceRequest.Builder tags(Tag... tags)

Metadata, consisting of key-value pairs, that can be used to categorize your system instances.

Parameters:

tags - Metadata, consisting of key-value pairs, that can be used to categorize your system instances.

Returns:

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

tags

CreateSystemInstanceRequest.Builder tags(Consumer<Tag.Builder>... tags)

Metadata, consisting of key-value pairs, that can be used to categorize your system instances.

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<Tag>).

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<Tag>)

definition

CreateSystemInstanceRequest.Builder definition(DefinitionDocument definition)

Sets the value of the Definition property for this object.

Parameters:

definition - The new value for the Definition property for this object.

Returns:

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

definition

default CreateSystemInstanceRequest.Builder definition(Consumer<DefinitionDocument.Builder> definition)

Sets the value of the Definition property for this object. This is a convenience method that creates an instance of the DefinitionDocument.Builder avoiding the need to create one manually via DefinitionDocument.builder().

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

Parameters:

definition - a consumer that will call methods on DefinitionDocument.Builder

Returns:

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

See Also:

• definition(DefinitionDocument)

target

CreateSystemInstanceRequest.Builder target(String target)

The target type of the deployment. Valid values are GREENGRASS and CLOUD.

Parameters:

target - The target type of the deployment. Valid values are GREENGRASS and CLOUD.

Returns:

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

See Also:

• DeploymentTarget
• DeploymentTarget

target

CreateSystemInstanceRequest.Builder target(DeploymentTarget target)

The target type of the deployment. Valid values are GREENGRASS and CLOUD.

Parameters:

target - The target type of the deployment. Valid values are GREENGRASS and CLOUD.

Returns:

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

See Also:

• DeploymentTarget
• DeploymentTarget

greengrassGroupName

CreateSystemInstanceRequest.Builder greengrassGroupName(String greengrassGroupName)

The name of the Greengrass group where the system instance will be deployed. This value is required if the value of the target parameter is GREENGRASS.

Parameters:

greengrassGroupName - The name of the Greengrass group where the system instance will be deployed. This value is required if the value of the target parameter is GREENGRASS.

Returns:

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

s3BucketName

CreateSystemInstanceRequest.Builder s3BucketName(String s3BucketName)

The name of the Amazon Simple Storage Service bucket that will be used to store and deploy the system instance's resource file. This value is required if the value of the target parameter is GREENGRASS.

Parameters:

s3BucketName - The name of the Amazon Simple Storage Service bucket that will be used to store and deploy the system instance's resource file. This value is required if the value of the target parameter is GREENGRASS.

Returns:

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

metricsConfiguration

CreateSystemInstanceRequest.Builder metricsConfiguration(MetricsConfiguration metricsConfiguration)

Sets the value of the MetricsConfiguration property for this object.

Parameters:

metricsConfiguration - The new value for the MetricsConfiguration property for this object.

Returns:

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

metricsConfiguration

default CreateSystemInstanceRequest.Builder metricsConfiguration(Consumer<MetricsConfiguration.Builder> metricsConfiguration)

Sets the value of the MetricsConfiguration property for this object. This is a convenience method that creates an instance of the MetricsConfiguration.Builder avoiding the need to create one manually via MetricsConfiguration.builder().

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

Parameters:

metricsConfiguration - a consumer that will call methods on MetricsConfiguration.Builder

Returns:

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

See Also:

• metricsConfiguration(MetricsConfiguration)

flowActionsRoleArn

CreateSystemInstanceRequest.Builder flowActionsRoleArn(String flowActionsRoleArn)

The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow. This role must have read and write access to AWS Lambda and AWS IoT and any other AWS services that the flow uses when it executes. This value is required if the value of the target parameter is CLOUD.

Parameters:

flowActionsRoleArn - The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow. This role must have read and write access to AWS Lambda and AWS IoT and any other AWS services that the flow uses when it executes. This value is required if the value of the target parameter is CLOUD.

Returns:

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

overrideConfiguration

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

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