Class: Aws::ManagedGrafana::Types::WorkspaceSummary

Inherits:

Struct

• Object
• Struct
• Aws::ManagedGrafana::Types::WorkspaceSummary

Includes:

Structure

Defined in:

lib/aws-sdk-managedgrafana/types.rb

Overview

A structure that contains some information about one workspace in the account.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:description, :name]

Instance Attribute Summary

• #authentication ⇒ Types::AuthenticationSummary

  A structure containing information about the authentication methods used in the workspace.

• #created ⇒ Time

  The date that the workspace was created.

• #description ⇒ String

  The customer-entered description of the workspace.

• #endpoint ⇒ String

  The URL endpoint to use to access the Grafana console in the workspace.

• #grafana_token ⇒ String

  The token that ties this workspace to a Grafana Labs account.

• #grafana_version ⇒ String

  The Grafana version that the workspace is running.

• #id ⇒ String

  The unique ID of the workspace.

• #license_type ⇒ String

  Specifies whether this workspace has a full Grafana Enterprise license.

• #modified ⇒ Time

  The most recent date that the workspace was modified.

• #name ⇒ String

  The name of the workspace.

• #notification_destinations ⇒ Array<String>

  The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, which allows Amazon Managed Grafana to use these channels.

• #status ⇒ String

  The current status of the workspace.

• #tags ⇒ Hash<String,String>

  The list of tags associated with the workspace.

Instance Attribute Details

#authentication ⇒ Types::AuthenticationSummary

A structure containing information about the authentication methods used in the workspace.

Returns:

• (Types::AuthenticationSummary)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 2265

class WorkspaceSummary < Struct.new(
  :authentication,
  :created,
  :description,
  :endpoint,
  :grafana_token,
  :grafana_version,
  :id,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :status,
  :tags)
  SENSITIVE = [:description, :name]
  include Aws::Structure
end

#created ⇒ Time

The date that the workspace was created.

Returns:

• (Time)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 2265

class WorkspaceSummary < Struct.new(
  :authentication,
  :created,
  :description,
  :endpoint,
  :grafana_token,
  :grafana_version,
  :id,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :status,
  :tags)
  SENSITIVE = [:description, :name]
  include Aws::Structure
end

#description ⇒ String

The customer-entered description of the workspace.

Returns:

• (String)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 2265

class WorkspaceSummary < Struct.new(
  :authentication,
  :created,
  :description,
  :endpoint,
  :grafana_token,
  :grafana_version,
  :id,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :status,
  :tags)
  SENSITIVE = [:description, :name]
  include Aws::Structure
end

#endpoint ⇒ String

The URL endpoint to use to access the Grafana console in the workspace.

Returns:

• (String)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 2265

class WorkspaceSummary < Struct.new(
  :authentication,
  :created,
  :description,
  :endpoint,
  :grafana_token,
  :grafana_version,
  :id,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :status,
  :tags)
  SENSITIVE = [:description, :name]
  include Aws::Structure
end

#grafana_token ⇒ String

The token that ties this workspace to a Grafana Labs account. For more information, see [Link your account with Grafana Labs].

[1]: docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise

Returns:

• (String)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 2265

class WorkspaceSummary < Struct.new(
  :authentication,
  :created,
  :description,
  :endpoint,
  :grafana_token,
  :grafana_version,
  :id,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :status,
  :tags)
  SENSITIVE = [:description, :name]
  include Aws::Structure
end

#grafana_version ⇒ String

The Grafana version that the workspace is running.

Returns:

• (String)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 2265

class WorkspaceSummary < Struct.new(
  :authentication,
  :created,
  :description,
  :endpoint,
  :grafana_token,
  :grafana_version,
  :id,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :status,
  :tags)
  SENSITIVE = [:description, :name]
  include Aws::Structure
end

#id ⇒ String

The unique ID of the workspace.

Returns:

• (String)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 2265

class WorkspaceSummary < Struct.new(
  :authentication,
  :created,
  :description,
  :endpoint,
  :grafana_token,
  :grafana_version,
  :id,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :status,
  :tags)
  SENSITIVE = [:description, :name]
  include Aws::Structure
end

#license_type ⇒ String

Specifies whether this workspace has a full Grafana Enterprise license.

<note markdown=“1”> Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 2265

class WorkspaceSummary < Struct.new(
  :authentication,
  :created,
  :description,
  :endpoint,
  :grafana_token,
  :grafana_version,
  :id,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :status,
  :tags)
  SENSITIVE = [:description, :name]
  include Aws::Structure
end

#modified ⇒ Time

The most recent date that the workspace was modified.

Returns:

• (Time)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 2265

class WorkspaceSummary < Struct.new(
  :authentication,
  :created,
  :description,
  :endpoint,
  :grafana_token,
  :grafana_version,
  :id,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :status,
  :tags)
  SENSITIVE = [:description, :name]
  include Aws::Structure
end

#name ⇒ String

The name of the workspace.

Returns:

• (String)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 2265

class WorkspaceSummary < Struct.new(
  :authentication,
  :created,
  :description,
  :endpoint,
  :grafana_token,
  :grafana_version,
  :id,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :status,
  :tags)
  SENSITIVE = [:description, :name]
  include Aws::Structure
end

#notification_destinations ⇒ Array<String>

The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, which allows Amazon Managed Grafana to use these channels.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 2265

class WorkspaceSummary < Struct.new(
  :authentication,
  :created,
  :description,
  :endpoint,
  :grafana_token,
  :grafana_version,
  :id,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :status,
  :tags)
  SENSITIVE = [:description, :name]
  include Aws::Structure
end

#status ⇒ String

The current status of the workspace.

Returns:

• (String)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 2265

class WorkspaceSummary < Struct.new(
  :authentication,
  :created,
  :description,
  :endpoint,
  :grafana_token,
  :grafana_version,
  :id,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :status,
  :tags)
  SENSITIVE = [:description, :name]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The list of tags associated with the workspace.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-managedgrafana/types.rb', line 2265

class WorkspaceSummary < Struct.new(
  :authentication,
  :created,
  :description,
  :endpoint,
  :grafana_token,
  :grafana_version,
  :id,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :status,
  :tags)
  SENSITIVE = [:description, :name]
  include Aws::Structure
end