Jump to Content

Interface SystemInstanceDescription

An object that contains a system instance definition and summary information.


  • SystemInstanceDescription


definition?: DefinitionDocument

A document that defines an entity.

flowActionsRoleArn?: string

The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.

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 Amazon Simple Storage Service bucket where information about a system instance is stored.

An object that contains summary information about a system instance.

validatedDependencyRevisions?: DependencyRevision[]

A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.

validatedNamespaceVersion?: number

The version of the user's namespace against which the system instance was validated.