AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoTThingsGraph::Types::CreateSystemInstanceRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateSystemInstanceRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  definition: { # required
    language: "GRAPHQL", # required, accepts GRAPHQL
    text: "DefinitionText", # required
  },
  target: "GREENGRASS", # required, accepts GREENGRASS, CLOUD
  greengrass_group_name: "GroupName",
  s3_bucket_name: "S3BucketName",
  metrics_configuration: {
    cloud_metric_enabled: false,
    metric_rule_role_arn: "RoleArn",
  },
  flow_actions_role_arn: "RoleArn",
}

Instance Attribute Summary collapse

Instance Attribute Details

#definitionTypes::DefinitionDocument

A document that defines an entity.

Returns:

#flow_actions_role_arnString

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:

  • (String)

    The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow.

#greengrass_group_nameString

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:

  • (String)

    The name of the Greengrass group where the system instance will be deployed.

#metrics_configurationTypes::MetricsConfiguration

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

Returns:

  • (Types::MetricsConfiguration)

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

    .

#s3_bucket_nameString

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:

  • (String)

    The name of the Amazon Simple Storage Service bucket that will be used to store and deploy the system instance\'s resource file.

#tagsArray<Types::Tag>

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

Returns:

  • (Array<Types::Tag>)

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

#targetString

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

Possible values:

  • GREENGRASS
  • CLOUD

Returns:

  • (String)

    The target type of the deployment.