AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Overview

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

Constant Summary collapse

SENSITIVE =
[:description, :name]

Instance Attribute Summary collapse

Instance Attribute Details

#authenticationTypes::AuthenticationSummary

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



1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1508

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

#createdTime

The date that the workspace was created.

Returns:

  • (Time)


1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1508

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

#descriptionString

The customer-entered description of the workspace.

Returns:

  • (String)


1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1508

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

#endpointString

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

Returns:

  • (String)


1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1508

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

#grafana_versionString

The Grafana version that the workspace is running.

Returns:

  • (String)


1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1508

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

#idString

The unique ID of the workspace.

Returns:

  • (String)


1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1508

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

#modifiedTime

The most recent date that the workspace was modified.

Returns:

  • (Time)


1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1508

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

#nameString

The name of the workspace.

Returns:

  • (String)


1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1508

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

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


1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1508

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

#statusString

The current status of the workspace.

Returns:

  • (String)


1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1508

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