class Aws::ManagedGrafana::Types::UpdateWorkspaceRequest

@note When making an API call, you may pass UpdateWorkspaceRequest

data as a hash:

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

@!attribute [rw] account_access_type

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.
@return [String]

@!attribute [rw] organization_role_name

The name of an IAM role that already exists to use to access
resources through Organizations.
@return [String]

@!attribute [rw] permission_type

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 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][1]

[1]: https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html
@return [String]

@!attribute [rw] stack_set_name

The name of the CloudFormation stack set to use to generate IAM
roles to be used for this workspace.
@return [String]

@!attribute [rw] workspace_data_sources

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 later in the workspace console. However, you will then
have to manually configure permissions for it.
@return [Array<String>]

@!attribute [rw] workspace_description

A description for the workspace. This is used only to help you
identify this workspace.
@return [String]

@!attribute [rw] workspace_id

The ID of the workspace to update.
@return [String]

@!attribute [rw] workspace_name

A new name for the workspace to update.
@return [String]

@!attribute [rw] workspace_notification_destinations

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.
@return [Array<String>]

@!attribute [rw] workspace_organizational_units

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.
@return [Array<String>]

@!attribute [rw] workspace_role_arn

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.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/UpdateWorkspaceRequest AWS API Documentation

Constants

SENSITIVE