Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates a workspace. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.
Don't use CreateWorkspace
to modify an existing workspace. Instead,
use
UpdateWorkspace.
Synopsis
- data CreateWorkspace = CreateWorkspace' {
- clientToken :: Maybe Text
- configuration :: Maybe Text
- organizationRoleName :: Maybe (Sensitive Text)
- stackSetName :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- vpcConfiguration :: Maybe VpcConfiguration
- workspaceDataSources :: Maybe [DataSourceType]
- workspaceDescription :: Maybe (Sensitive Text)
- workspaceName :: Maybe (Sensitive Text)
- workspaceNotificationDestinations :: Maybe [NotificationDestinationType]
- workspaceOrganizationalUnits :: Maybe (Sensitive [Text])
- workspaceRoleArn :: Maybe (Sensitive Text)
- accountAccessType :: AccountAccessType
- authenticationProviders :: [AuthenticationProviderTypes]
- permissionType :: PermissionType
- newCreateWorkspace :: AccountAccessType -> PermissionType -> CreateWorkspace
- createWorkspace_clientToken :: Lens' CreateWorkspace (Maybe Text)
- createWorkspace_configuration :: Lens' CreateWorkspace (Maybe Text)
- createWorkspace_organizationRoleName :: Lens' CreateWorkspace (Maybe Text)
- createWorkspace_stackSetName :: Lens' CreateWorkspace (Maybe Text)
- createWorkspace_tags :: Lens' CreateWorkspace (Maybe (HashMap Text Text))
- createWorkspace_vpcConfiguration :: Lens' CreateWorkspace (Maybe VpcConfiguration)
- createWorkspace_workspaceDataSources :: Lens' CreateWorkspace (Maybe [DataSourceType])
- createWorkspace_workspaceDescription :: Lens' CreateWorkspace (Maybe Text)
- createWorkspace_workspaceName :: Lens' CreateWorkspace (Maybe Text)
- createWorkspace_workspaceNotificationDestinations :: Lens' CreateWorkspace (Maybe [NotificationDestinationType])
- createWorkspace_workspaceOrganizationalUnits :: Lens' CreateWorkspace (Maybe [Text])
- createWorkspace_workspaceRoleArn :: Lens' CreateWorkspace (Maybe Text)
- createWorkspace_accountAccessType :: Lens' CreateWorkspace AccountAccessType
- createWorkspace_authenticationProviders :: Lens' CreateWorkspace [AuthenticationProviderTypes]
- createWorkspace_permissionType :: Lens' CreateWorkspace PermissionType
- data CreateWorkspaceResponse = CreateWorkspaceResponse' {}
- newCreateWorkspaceResponse :: Int -> WorkspaceDescription -> CreateWorkspaceResponse
- createWorkspaceResponse_httpStatus :: Lens' CreateWorkspaceResponse Int
- createWorkspaceResponse_workspace :: Lens' CreateWorkspaceResponse WorkspaceDescription
Creating a Request
data CreateWorkspace Source #
See: newCreateWorkspace
smart constructor.
CreateWorkspace' | |
|
Instances
Create a value of CreateWorkspace
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateWorkspace'
, createWorkspace_clientToken
- A unique, case-sensitive, user-provided identifier to ensure the
idempotency of the request.
CreateWorkspace
, createWorkspace_configuration
- The configuration string for the workspace that you create. For more
information about the format and configuration options available, see
Working in your Grafana workspace.
CreateWorkspace
, createWorkspace_organizationRoleName
- 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.
CreateWorkspace
, createWorkspace_stackSetName
- The name of the CloudFormation stack set to use to generate IAM roles to
be used for this workspace.
CreateWorkspace
, createWorkspace_tags
- The list of tags associated with the workspace.
CreateWorkspace
, createWorkspace_vpcConfiguration
- The configuration settings for an Amazon VPC that contains data sources
for your Grafana workspace to connect to.
$sel:workspaceDataSources:CreateWorkspace'
, createWorkspace_workspaceDataSources
- 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.
$sel:workspaceDescription:CreateWorkspace'
, createWorkspace_workspaceDescription
- A description for the workspace. This is used only to help you identify
this workspace.
Pattern: ^[\\p{L}\\p{Z}\\p{N}\\p{P}]{0,2048}$
$sel:workspaceName:CreateWorkspace'
, createWorkspace_workspaceName
- The name for the workspace. It does not have to be unique.
$sel:workspaceNotificationDestinations:CreateWorkspace'
, createWorkspace_workspaceNotificationDestinations
- 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.
$sel:workspaceOrganizationalUnits:CreateWorkspace'
, createWorkspace_workspaceOrganizationalUnits
- 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.
CreateWorkspace
, createWorkspace_workspaceRoleArn
- 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. The
permission type should be set to CUSTOMER_MANAGED
.
CreateWorkspace
, createWorkspace_accountAccessType
- 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.
$sel:authenticationProviders:CreateWorkspace'
, createWorkspace_authenticationProviders
- Specifies whether this workspace uses SAML 2.0, IAM Identity Center
(successor to 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.
CreateWorkspace
, createWorkspace_permissionType
- If you specify SERVICE_MANAGED
on AWS Grafana console, 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. In the CLI mode, the permissionType
SERVICE_MANAGED
will not create the IAM role for you. The ability for
the Amazon Managed Grafana to create the IAM role on behalf of the user
is supported only in the Amazon Managed Grafana AWS console. Use only
the CUSTOMER_MANAGED
permission type when creating a workspace in the
CLI.
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.
Request Lenses
createWorkspace_clientToken :: Lens' CreateWorkspace (Maybe Text) Source #
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
createWorkspace_configuration :: Lens' CreateWorkspace (Maybe Text) Source #
The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
createWorkspace_organizationRoleName :: Lens' CreateWorkspace (Maybe Text) Source #
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.
createWorkspace_stackSetName :: Lens' CreateWorkspace (Maybe Text) Source #
The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
createWorkspace_tags :: Lens' CreateWorkspace (Maybe (HashMap Text Text)) Source #
The list of tags associated with the workspace.
createWorkspace_vpcConfiguration :: Lens' CreateWorkspace (Maybe VpcConfiguration) Source #
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
createWorkspace_workspaceDataSources :: Lens' CreateWorkspace (Maybe [DataSourceType]) Source #
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.
createWorkspace_workspaceDescription :: Lens' CreateWorkspace (Maybe Text) Source #
A description for the workspace. This is used only to help you identify this workspace.
Pattern: ^[\\p{L}\\p{Z}\\p{N}\\p{P}]{0,2048}$
createWorkspace_workspaceName :: Lens' CreateWorkspace (Maybe Text) Source #
The name for the workspace. It does not have to be unique.
createWorkspace_workspaceNotificationDestinations :: Lens' CreateWorkspace (Maybe [NotificationDestinationType]) Source #
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.
createWorkspace_workspaceOrganizationalUnits :: Lens' CreateWorkspace (Maybe [Text]) Source #
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.
createWorkspace_workspaceRoleArn :: Lens' CreateWorkspace (Maybe Text) Source #
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. The
permission type should be set to CUSTOMER_MANAGED
.
createWorkspace_accountAccessType :: Lens' CreateWorkspace AccountAccessType Source #
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.
createWorkspace_authenticationProviders :: Lens' CreateWorkspace [AuthenticationProviderTypes] Source #
Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to 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.
createWorkspace_permissionType :: Lens' CreateWorkspace PermissionType Source #
If you specify SERVICE_MANAGED
on AWS Grafana console, 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. In the CLI mode, the permissionType
SERVICE_MANAGED
will not create the IAM role for you. The ability for
the Amazon Managed Grafana to create the IAM role on behalf of the user
is supported only in the Amazon Managed Grafana AWS console. Use only
the CUSTOMER_MANAGED
permission type when creating a workspace in the
CLI.
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.
Destructuring the Response
data CreateWorkspaceResponse Source #
See: newCreateWorkspaceResponse
smart constructor.
CreateWorkspaceResponse' | |
|
Instances
newCreateWorkspaceResponse Source #
Create a value of CreateWorkspaceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateWorkspaceResponse'
, createWorkspaceResponse_httpStatus
- The response's http status code.
$sel:workspace:CreateWorkspaceResponse'
, createWorkspaceResponse_workspace
- A structure containing data about the workspace that was created.
Response Lenses
createWorkspaceResponse_httpStatus :: Lens' CreateWorkspaceResponse Int Source #
The response's http status code.
createWorkspaceResponse_workspace :: Lens' CreateWorkspaceResponse WorkspaceDescription Source #
A structure containing data about the workspace that was created.