Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateSystemInstanceCommandInput

Hierarchy

Index

Properties

definition

definition: DefinitionDocument | undefined

A document that defines an entity.

Optional flowActionsRoleArn

flowActionsRoleArn: undefined | 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.

Optional greengrassGroupName

greengrassGroupName: undefined | 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.

Optional metricsConfiguration

metricsConfiguration: MetricsConfiguration

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

Optional s3BucketName

s3BucketName: undefined | 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.

Optional tags

tags: Tag[]

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

target

target: DeploymentTarget | string | undefined

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