Class: Aws::IoTThingsGraph::Types::SystemInstanceDescription

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

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#definitionTypes::DefinitionDocument

A document that defines an entity.



1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1611

class SystemInstanceDescription < Struct.new(
  :summary,
  :definition,
  :s3_bucket_name,
  :metrics_configuration,
  :validated_namespace_version,
  :validated_dependency_revisions,
  :flow_actions_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#flow_actions_role_arnString

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.

Returns:

  • (String)


1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1611

class SystemInstanceDescription < Struct.new(
  :summary,
  :definition,
  :s3_bucket_name,
  :metrics_configuration,
  :validated_namespace_version,
  :validated_dependency_revisions,
  :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.



1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1611

class SystemInstanceDescription < Struct.new(
  :summary,
  :definition,
  :s3_bucket_name,
  :metrics_configuration,
  :validated_namespace_version,
  :validated_dependency_revisions,
  :flow_actions_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket_nameString

The Amazon Simple Storage Service bucket where information about a system instance is stored.

Returns:

  • (String)


1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1611

class SystemInstanceDescription < Struct.new(
  :summary,
  :definition,
  :s3_bucket_name,
  :metrics_configuration,
  :validated_namespace_version,
  :validated_dependency_revisions,
  :flow_actions_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#summaryTypes::SystemInstanceSummary

An object that contains summary information about a system instance.



1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1611

class SystemInstanceDescription < Struct.new(
  :summary,
  :definition,
  :s3_bucket_name,
  :metrics_configuration,
  :validated_namespace_version,
  :validated_dependency_revisions,
  :flow_actions_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#validated_dependency_revisionsArray<Types::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.

Returns:



1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1611

class SystemInstanceDescription < Struct.new(
  :summary,
  :definition,
  :s3_bucket_name,
  :metrics_configuration,
  :validated_namespace_version,
  :validated_dependency_revisions,
  :flow_actions_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#validated_namespace_versionInteger

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

Returns:

  • (Integer)


1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1611

class SystemInstanceDescription < Struct.new(
  :summary,
  :definition,
  :s3_bucket_name,
  :metrics_configuration,
  :validated_namespace_version,
  :validated_dependency_revisions,
  :flow_actions_role_arn)
  SENSITIVE = []
  include Aws::Structure
end