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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb

Overview

Note:

When making an API call, you may pass CreateSystemInstanceRequest data as a 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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#definitionTypes::DefinitionDocument

A document that defines an entity.



151
152
153
154
155
156
157
158
159
160
161
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 151

class CreateSystemInstanceRequest < Struct.new(
  :tags,
  :definition,
  :target,
  :greengrass_group_name,
  :s3_bucket_name,
  :metrics_configuration,
  :flow_actions_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#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)


151
152
153
154
155
156
157
158
159
160
161
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 151

class CreateSystemInstanceRequest < Struct.new(
  :tags,
  :definition,
  :target,
  :greengrass_group_name,
  :s3_bucket_name,
  :metrics_configuration,
  :flow_actions_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#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)


151
152
153
154
155
156
157
158
159
160
161
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 151

class CreateSystemInstanceRequest < Struct.new(
  :tags,
  :definition,
  :target,
  :greengrass_group_name,
  :s3_bucket_name,
  :metrics_configuration,
  :flow_actions_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#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.



151
152
153
154
155
156
157
158
159
160
161
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 151

class CreateSystemInstanceRequest < Struct.new(
  :tags,
  :definition,
  :target,
  :greengrass_group_name,
  :s3_bucket_name,
  :metrics_configuration,
  :flow_actions_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#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)


151
152
153
154
155
156
157
158
159
160
161
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 151

class CreateSystemInstanceRequest < Struct.new(
  :tags,
  :definition,
  :target,
  :greengrass_group_name,
  :s3_bucket_name,
  :metrics_configuration,
  :flow_actions_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



151
152
153
154
155
156
157
158
159
160
161
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 151

class CreateSystemInstanceRequest < Struct.new(
  :tags,
  :definition,
  :target,
  :greengrass_group_name,
  :s3_bucket_name,
  :metrics_configuration,
  :flow_actions_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#targetString

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

Returns:

  • (String)


151
152
153
154
155
156
157
158
159
160
161
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 151

class CreateSystemInstanceRequest < Struct.new(
  :tags,
  :definition,
  :target,
  :greengrass_group_name,
  :s3_bucket_name,
  :metrics_configuration,
  :flow_actions_role_arn)
  SENSITIVE = []
  include Aws::Structure
end