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

Inherits:

Struct

• Object
• Struct
• Aws::IoTThingsGraph::Types::SystemInstanceDescription

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

SENSITIVE =

[]

Instance Attribute Summary

• #definition ⇒ Types::DefinitionDocument

  A document that defines an entity.

• #flow_actions_role_arn ⇒ String

  The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment.

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

• #s3_bucket_name ⇒ String

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

• #summary ⇒ Types::SystemInstanceSummary

  An object that contains summary information about a system instance.

• #validated_dependency_revisions ⇒ Array<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.

• #validated_namespace_version ⇒ Integer

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

Instance Attribute Details

#definition ⇒ Types::DefinitionDocument

A document that defines an entity.

Returns:

• (Types::DefinitionDocument)

# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1313

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

Returns:

• (String)

# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1313

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_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:

• (Types::MetricsConfiguration)

# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1313

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

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

Returns:

• (String)

# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1313

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

#summary ⇒ Types::SystemInstanceSummary

An object that contains summary information about a system instance.

Returns:

• (Types::SystemInstanceSummary)

# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1313

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_revisions ⇒ Array<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:

• (Array<Types::DependencyRevision>)

# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1313

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_version ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1313

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