Class: Aws::ManagedGrafana::Types::CreateWorkspaceRequest

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

Overview

Note:

When making an API call, you may pass CreateWorkspaceRequest data as a hash:

{
  account_access_type: "CURRENT_ACCOUNT", # required, accepts CURRENT_ACCOUNT, ORGANIZATION
  authentication_providers: ["AWS_SSO"], # required, accepts AWS_SSO, SAML
  client_token: "ClientToken",
  organization_role_name: "OrganizationRoleName",
  permission_type: "CUSTOMER_MANAGED", # required, accepts CUSTOMER_MANAGED, SERVICE_MANAGED
  stack_set_name: "StackSetName",
  workspace_data_sources: ["AMAZON_OPENSEARCH_SERVICE"], # accepts AMAZON_OPENSEARCH_SERVICE, CLOUDWATCH, PROMETHEUS, XRAY, TIMESTREAM, SITEWISE
  workspace_description: "Description",
  workspace_name: "WorkspaceName",
  workspace_notification_destinations: ["SNS"], # accepts SNS
  workspace_organizational_units: ["OrganizationalUnit"],
  workspace_role_arn: "IamRoleArn",
}

Constant Summary collapse

SENSITIVE =
[:organization_role_name, :workspace_description, :workspace_name, :workspace_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 you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.

Returns:

  • (String)


342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 342

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#authentication_providersArray<String>

Specifies whether this workspace uses SAML 2.0, Amazon Web Services Single Sign On, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

Returns:

  • (Array<String>)


342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 342

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#client_tokenString

A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 342

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#organization_role_nameString

The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.

Returns:

  • (String)


342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 342

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#permission_typeString

If you specify 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 you specify CUSTOMER_MANAGED, you will manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization that 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)


342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 342

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#stack_set_nameString

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

Returns:

  • (String)


342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 342

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#workspace_data_sourcesArray<String>

Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.

If you don't specify a data source here, you can still add it as a data source in the workspace console later. However, you will then have to manually configure permissions for it.

Returns:

  • (Array<String>)


342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 342

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#workspace_descriptionString

A description for the workspace. This is used only to help you identify this workspace.

Returns:

  • (String)


342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 342

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#workspace_nameString

The name for the workspace. It does not have to be unique.

Returns:

  • (String)


342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 342

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#workspace_notification_destinationsArray<String>

Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.

Returns:

  • (Array<String>)


342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 342

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

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


342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 342

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end

#workspace_role_arnString

The workspace needs an IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. If you already have a role that you want to use, specify it here. If you omit this field and you specify some Amazon Web Services resources in workspaceDataSources or workspaceNotificationDestinations, a new IAM role with the necessary permissions is automatically created.

Returns:

  • (String)


342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 342

class CreateWorkspaceRequest < Struct.new(
  :account_access_type,
  :authentication_providers,
  :client_token,
  :organization_role_name,
  :permission_type,
  :stack_set_name,
  :workspace_data_sources,
  :workspace_description,
  :workspace_name,
  :workspace_notification_destinations,
  :workspace_organizational_units,
  :workspace_role_arn)
  SENSITIVE = [:organization_role_name, :workspace_description, :workspace_name, :workspace_organizational_units, :workspace_role_arn]
  include Aws::Structure
end