Package software.amazon.awssdk.services.iotthingsgraph.model

Class CreateSystemInstanceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotthingsgraph.model.IoTThingsGraphRequest

software.amazon.awssdk.services.iotthingsgraph.model.CreateSystemInstanceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateSystemInstanceRequest.Builder,CreateSystemInstanceRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateSystemInstanceRequest
extends IoTThingsGraphRequest
implements ToCopyableBuilder<CreateSystemInstanceRequest.Builder,CreateSystemInstanceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateSystemInstanceRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateSystemInstanceRequest.Builder	builder()
DefinitionDocument	definition()	Returns the value of the Definition property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	flowActionsRoleArn()	The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	greengrassGroupName()	The name of the Greengrass group where the system instance will be deployed.
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
MetricsConfiguration	metricsConfiguration()	Returns the value of the MetricsConfiguration property for this object.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateSystemInstanceRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	Metadata, consisting of key-value pairs, that can be used to categorize your system instances.
DeploymentTarget	target()	The target type of the deployment.
String	targetAsString()	The target type of the deployment.
CreateSystemInstanceRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

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

definition

public final DefinitionDocument definition()

Returns the value of the Definition property for this object.

Returns:

The value of the Definition property for this object.

target

public final DeploymentTarget target()

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

If the service returns an enum value that is not available in the current SDK version, target will return DeploymentTarget.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetAsString().

Returns:

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

See Also:

DeploymentTarget

targetAsString

public final String targetAsString()

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

If the service returns an enum value that is not available in the current SDK version, target will return DeploymentTarget.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetAsString().

Returns:

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

See Also:

DeploymentTarget

greengrassGroupName

public final 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.

Returns:

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.

s3BucketName

public final 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.

Returns:

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.

metricsConfiguration

public final MetricsConfiguration metricsConfiguration()

Returns the value of the MetricsConfiguration property for this object.

Returns:

The value of the MetricsConfiguration property for this object.

flowActionsRoleArn

public final 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.

Returns:

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.

toBuilder

public CreateSystemInstanceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateSystemInstanceRequest.Builder,CreateSystemInstanceRequest>

Specified by:

toBuilder in class IoTThingsGraphRequest

builder

public static CreateSystemInstanceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateSystemInstanceRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo