com.amazonaws.services.iotthingsgraph.model

Class CreateSystemInstanceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iotthingsgraph.model.CreateSystemInstanceRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateSystemInstanceRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateSystemInstanceRequest()

Method Summary

Modifier and Type	Method and Description
CreateSystemInstanceRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
DefinitionDocument	getDefinition()
String	getFlowActionsRoleArn() The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow.
String	getGreengrassGroupName() The name of the Greengrass group where the system instance will be deployed.
MetricsConfiguration	getMetricsConfiguration()
String	getS3BucketName() The name of the Amazon Simple Storage Service bucket that will be used to store and deploy the system instance's resource file.
List<Tag>	getTags() Metadata, consisting of key-value pairs, that can be used to categorize your system instances.
String	getTarget() The target type of the deployment.
int	hashCode()
void	setDefinition(DefinitionDocument definition)
void	setFlowActionsRoleArn(String flowActionsRoleArn) The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow.
void	setGreengrassGroupName(String greengrassGroupName) The name of the Greengrass group where the system instance will be deployed.
void	setMetricsConfiguration(MetricsConfiguration metricsConfiguration)
void	setS3BucketName(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.
void	setTags(Collection<Tag> tags) Metadata, consisting of key-value pairs, that can be used to categorize your system instances.
void	setTarget(String target) The target type of the deployment.
String	toString() Returns a string representation of this object.
CreateSystemInstanceRequest	withDefinition(DefinitionDocument definition)
CreateSystemInstanceRequest	withFlowActionsRoleArn(String flowActionsRoleArn) The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow.
CreateSystemInstanceRequest	withGreengrassGroupName(String greengrassGroupName) The name of the Greengrass group where the system instance will be deployed.
CreateSystemInstanceRequest	withMetricsConfiguration(MetricsConfiguration metricsConfiguration)
CreateSystemInstanceRequest	withS3BucketName(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	withTags(Collection<Tag> tags) Metadata, consisting of key-value pairs, that can be used to categorize your system instances.
CreateSystemInstanceRequest	withTags(Tag... tags) Metadata, consisting of key-value pairs, that can be used to categorize your system instances.
CreateSystemInstanceRequest	withTarget(DeploymentTarget target) The target type of the deployment.
CreateSystemInstanceRequest	withTarget(String target) The target type of the deployment.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateSystemInstanceRequest

public CreateSystemInstanceRequest()

Method Detail

getTags

public List<Tag> getTags()

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

Returns:

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

setTags

public void setTags(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.

withTags

public CreateSystemInstanceRequest withTags(Tag... tags)

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

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

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.

withTags

public CreateSystemInstanceRequest withTags(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.

setDefinition

public void setDefinition(DefinitionDocument definition)

Parameters:

definition -

getDefinition

public DefinitionDocument getDefinition()

Returns:

withDefinition

public CreateSystemInstanceRequest withDefinition(DefinitionDocument definition)

Parameters:

definition -

Returns:

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

setTarget

public void setTarget(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.

See Also:

DeploymentTarget

getTarget

public String getTarget()

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

Returns:

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

See Also:

DeploymentTarget

withTarget

public CreateSystemInstanceRequest withTarget(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

withTarget

public CreateSystemInstanceRequest withTarget(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

setGreengrassGroupName

public void setGreengrassGroupName(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.

getGreengrassGroupName

public String getGreengrassGroupName()

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.

withGreengrassGroupName

public CreateSystemInstanceRequest withGreengrassGroupName(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.

setS3BucketName

public void setS3BucketName(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.

getS3BucketName

public String getS3BucketName()

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.

withS3BucketName

public CreateSystemInstanceRequest withS3BucketName(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.

setMetricsConfiguration

public void setMetricsConfiguration(MetricsConfiguration metricsConfiguration)

Parameters:

metricsConfiguration -

getMetricsConfiguration

public MetricsConfiguration getMetricsConfiguration()

Returns:

withMetricsConfiguration

public CreateSystemInstanceRequest withMetricsConfiguration(MetricsConfiguration metricsConfiguration)

Parameters:

metricsConfiguration -

Returns:

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

setFlowActionsRoleArn

public void setFlowActionsRoleArn(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.

getFlowActionsRoleArn

public String getFlowActionsRoleArn()

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.

withFlowActionsRoleArn

public CreateSystemInstanceRequest withFlowActionsRoleArn(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateSystemInstanceRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()