Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface CreateSystemInstanceCommandInputProtected

Hierarchy

Properties

definition: undefined | DefinitionDocument

A document that defines an entity.

flowActionsRoleArn?: string

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.

greengrassGroupName?: string

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.

metricsConfiguration?: MetricsConfiguration

An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.

s3BucketName?: string

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.

tags?: Tag[]

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

target: undefined | string

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