Class: Aws::ManagedGrafana::Types::WorkspaceDescription

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

Overview

A structure containing information about an Amazon Managed Grafana workspace in your account.

Constant Summary collapse

SENSITIVE =
[:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]

Instance Attribute Summary collapse

Instance Attribute Details

#account_access_typeString

Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.

Returns:

  • (String)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#authenticationTypes::AuthenticationSummary

A structure that describes whether the workspace uses SAML, Amazon Web Services SSO, or both methods for user authentication.



1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#createdTime

The date that the workspace was created.

Returns:

  • (Time)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#data_sourcesArray<String>

Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.

Returns:

  • (Array<String>)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#descriptionString

The user-defined description of the workspace.

Returns:

  • (String)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#endpointString

The URL that users can use to access the Grafana console in the workspace.

Returns:

  • (String)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#free_trial_consumedBoolean

Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.

Returns:

  • (Boolean)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#free_trial_expirationTime

If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.

Returns:

  • (Time)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#grafana_versionString

The version of Grafana supported in this workspace.

Returns:

  • (String)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#idString

The unique ID of this workspace.

Returns:

  • (String)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#license_expirationTime

If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.

Returns:

  • (Time)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#license_typeString

Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.

Returns:

  • (String)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#modifiedTime

The most recent date that the workspace was modified.

Returns:

  • (Time)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#nameString

The name of the workspace.

Returns:

  • (String)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  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, to allow Amazon Managed Grafana to use these channels.

Returns:

  • (Array<String>)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#organization_role_nameString

The name of the IAM role that is used to access resources through Organizations.

Returns:

  • (String)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#organizational_unitsArray<String>

Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.

Returns:

  • (Array<String>)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#permission_typeString

If this is Service Managed, Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

If this is CUSTOMER_MANAGED, you manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED.

For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

Returns:

  • (String)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#stack_set_nameString

The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.

Returns:

  • (String)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#statusString

The current status of the workspace.

Returns:

  • (String)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#workspace_role_arnString

The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.

Returns:

  • (String)


1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 1433

class WorkspaceDescription < Struct.new(
  :account_access_type,
  :authentication,
  :created,
  :data_sources,
  :description,
  :endpoint,
  :free_trial_consumed,
  :free_trial_expiration,
  :grafana_version,
  :id,
  :license_expiration,
  :license_type,
  :modified,
  :name,
  :notification_destinations,
  :organization_role_name,
  :organizational_units,
  :permission_type,
  :stack_set_name,
  :status,
  :workspace_role_arn)
  SENSITIVE = [:description, :name, :organization_role_name, :organizational_units, :workspace_role_arn]
  include Aws::Structure
end