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.



1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1874

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

#createdTime

The date that the workspace was created.

Returns:

  • (Time)


1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1874

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

#descriptionString

The customer-entered description of the workspace.

Returns:

  • (String)


1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1874

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

#endpointString

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

Returns:

  • (String)


1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1874

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_tokenString

The token that ties this workspace to a Grafana Labs account. For more information, see Register with Grafana Labs.

Returns:

  • (String)


1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1874

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_versionString

The Grafana version that the workspace is running.

Returns:

  • (String)


1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1874

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

#idString

The unique ID of the workspace.

Returns:

  • (String)


1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1874

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_typeString

Specifies whether this workspace has a full Grafana Enterprise license.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

Returns:

  • (String)


1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1874

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

#modifiedTime

The most recent date that the workspace was modified.

Returns:

  • (Time)


1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1874

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

#nameString

The name of the workspace.

Returns:

  • (String)


1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1874

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


1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1874

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

#statusString

The current status of the workspace.

Returns:

  • (String)


1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1874

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

#tagsHash<String,String>

The list of tags associated with the workspace.

Returns:

  • (Hash<String,String>)


1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1874

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