Interface CreateSystemInstanceRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateSystemInstanceRequest.Builder,
,CreateSystemInstanceRequest> IoTThingsGraphRequest.Builder
,SdkBuilder<CreateSystemInstanceRequest.Builder,
,CreateSystemInstanceRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateSystemInstanceRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefinition
(Consumer<DefinitionDocument.Builder> definition) Sets the value of the Definition property for this object.definition
(DefinitionDocument definition) Sets the value of the Definition property for this object.flowActionsRoleArn
(String flowActionsRoleArn) The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow.greengrassGroupName
(String greengrassGroupName) The name of the Greengrass group where the system instance will be deployed.metricsConfiguration
(Consumer<MetricsConfiguration.Builder> metricsConfiguration) Sets the value of the MetricsConfiguration property for this object.metricsConfiguration
(MetricsConfiguration metricsConfiguration) Sets the value of the MetricsConfiguration property for this object.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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.tags
(Collection<Tag> tags) Metadata, consisting of key-value pairs, that can be used to categorize your system instances.tags
(Consumer<Tag.Builder>... tags) Metadata, consisting of key-value pairs, that can be used to categorize your system instances.Metadata, consisting of key-value pairs, that can be used to categorize your system instances.The target type of the deployment.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, sdkFields
-
Method Details
-
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
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
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 theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theDefinitionDocument.Builder
avoiding the need to create one manually viaDefinitionDocument.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todefinition(DefinitionDocument)
.- Parameters:
definition
- a consumer that will call methods onDefinitionDocument.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
target
The target type of the deployment. Valid values are
GREENGRASS
andCLOUD
.- Parameters:
target
- The target type of the deployment. Valid values areGREENGRASS
andCLOUD
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
target
The target type of the deployment. Valid values are
GREENGRASS
andCLOUD
.- Parameters:
target
- The target type of the deployment. Valid values areGREENGRASS
andCLOUD
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 isGREENGRASS
.- Parameters:
greengrassGroupName
- The name of the Greengrass group where the system instance will be deployed. This value is required if the value of thetarget
parameter isGREENGRASS
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 isGREENGRASS
.- 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 thetarget
parameter isGREENGRASS
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theMetricsConfiguration.Builder
avoiding the need to create one manually viaMetricsConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tometricsConfiguration(MetricsConfiguration)
.- Parameters:
metricsConfiguration
- a consumer that will call methods onMetricsConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 isCLOUD
.- 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 thetarget
parameter isCLOUD
.- 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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-