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

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

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#definition ⇒ Types::DefinitionDocument

A document that defines an entity.

Returns:



107
108
109
110
111
112
113
114
115
116
117
 
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 107

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_arn ⇒ 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.

Returns:

  • (String) 


107
108
109
110
111
112
113
114
115
116
117
 
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 107

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_name ⇒ 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.

Returns:

  • (String) 


107
108
109
110
111
112
113
114
115
116
117
 
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 107

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_configuration ⇒ Types::MetricsConfiguration

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

Returns:



107
108
109
110
111
112
113
114
115
116
117
 
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 107

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_name ⇒ 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.

Returns:

  • (String) 


107
108
109
110
111
112
113
114
115
116
117
 
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 107

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

#tags ⇒ Array<Types::Tag>

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

Returns:



107
108
109
110
111
112
113
114
115
116
117
 
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 107

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

#target ⇒ String

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

Returns:

  • (String) 


107
108
109
110
111
112
113
114
115
116
117
 
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 107

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