Struct aws_sdk_grafana::client::fluent_builders::CreateWorkspace [−][src]
pub struct CreateWorkspace<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to CreateWorkspace
.
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.
Implementations
impl<C, M, R> CreateWorkspace<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> CreateWorkspace<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<CreateWorkspaceOutput, SdkError<CreateWorkspaceError>> where
R::Policy: SmithyRetryPolicy<CreateWorkspaceInputOperationOutputAlias, CreateWorkspaceOutput, CreateWorkspaceError, CreateWorkspaceInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<CreateWorkspaceOutput, SdkError<CreateWorkspaceError>> where
R::Policy: SmithyRetryPolicy<CreateWorkspaceInputOperationOutputAlias, CreateWorkspaceOutput, CreateWorkspaceError, CreateWorkspaceInputOperationRetryAlias>,
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
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.
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.
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
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.
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.
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
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
The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
Appends an item to workspaceDataSources
.
To override the contents of this collection use set_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 in the workspace console later. However, you will then have to manually configure permissions for it.
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.
A description for the workspace. This is used only to help you identify this workspace.
A description for the workspace. This is used only to help you identify this workspace.
The name for the workspace. It does not have to be unique.
The name for the workspace. It does not have to be unique.
pub fn workspace_notification_destinations(
self,
inp: impl Into<NotificationDestinationType>
) -> Self
pub fn workspace_notification_destinations(
self,
inp: impl Into<NotificationDestinationType>
) -> Self
Appends an item to workspaceNotificationDestinations
.
To override the contents of this collection use set_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.
pub fn set_workspace_notification_destinations(
self,
input: Option<Vec<NotificationDestinationType>>
) -> Self
pub fn set_workspace_notification_destinations(
self,
input: Option<Vec<NotificationDestinationType>>
) -> Self
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.
Appends an item to workspaceOrganizationalUnits
.
To override the contents of this collection use set_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.
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.
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.
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.
Appends an item to authenticationProviders
.
To override the contents of this collection use set_authentication_providers
.
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.
pub fn set_authentication_providers(
self,
input: Option<Vec<AuthenticationProviderTypes>>
) -> Self
pub fn set_authentication_providers(
self,
input: Option<Vec<AuthenticationProviderTypes>>
) -> Self
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.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !RefUnwindSafe for CreateWorkspace<C, M, R>
impl<C, M, R> Send for CreateWorkspace<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for CreateWorkspace<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for CreateWorkspace<C, M, R>
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !UnwindSafe for CreateWorkspace<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more