Struct aws_sdk_grafana::client::fluent_builders::UpdateWorkspace
source · [−]pub struct UpdateWorkspace { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateWorkspace
.
Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any optional parameters, the existing values of those parameters are not changed.
To modify the user authentication methods that the workspace uses, such as SAML or Amazon Web Services SSO, use UpdateWorkspaceAuthentication.
To modify which users in the workspace have the Admin
and Editor
Grafana roles, use UpdatePermissions.
Implementations
sourceimpl UpdateWorkspace
impl UpdateWorkspace
sourcepub async fn send(
self
) -> Result<UpdateWorkspaceOutput, SdkError<UpdateWorkspaceError>>
pub async fn send(
self
) -> Result<UpdateWorkspaceOutput, SdkError<UpdateWorkspaceError>>
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.
sourcepub fn account_access_type(self, input: AccountAccessType) -> Self
pub fn account_access_type(self, input: AccountAccessType) -> Self
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.
sourcepub fn set_account_access_type(self, input: Option<AccountAccessType>) -> Self
pub fn set_account_access_type(self, input: Option<AccountAccessType>) -> Self
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.
sourcepub fn organization_role_name(self, input: impl Into<String>) -> Self
pub fn organization_role_name(self, input: impl Into<String>) -> Self
The name of an IAM role that already exists to use to access resources through Organizations.
sourcepub fn set_organization_role_name(self, input: Option<String>) -> Self
pub fn set_organization_role_name(self, input: Option<String>) -> Self
The name of an IAM role that already exists to use to access resources through Organizations.
sourcepub fn permission_type(self, input: PermissionType) -> Self
pub fn permission_type(self, input: PermissionType) -> Self
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
sourcepub fn set_permission_type(self, input: Option<PermissionType>) -> Self
pub fn set_permission_type(self, input: Option<PermissionType>) -> Self
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
sourcepub fn stack_set_name(self, input: impl Into<String>) -> Self
pub fn stack_set_name(self, input: impl Into<String>) -> Self
The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
sourcepub fn set_stack_set_name(self, input: Option<String>) -> Self
pub fn set_stack_set_name(self, input: Option<String>) -> Self
The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
sourcepub fn workspace_data_sources(self, input: DataSourceType) -> Self
pub fn workspace_data_sources(self, input: DataSourceType) -> Self
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 later in the workspace console. However, you will then have to manually configure permissions for it.
sourcepub fn set_workspace_data_sources(
self,
input: Option<Vec<DataSourceType>>
) -> Self
pub fn set_workspace_data_sources(
self,
input: Option<Vec<DataSourceType>>
) -> Self
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.
sourcepub fn workspace_description(self, input: impl Into<String>) -> Self
pub fn workspace_description(self, input: impl Into<String>) -> Self
A description for the workspace. This is used only to help you identify this workspace.
sourcepub fn set_workspace_description(self, input: Option<String>) -> Self
pub fn set_workspace_description(self, input: Option<String>) -> Self
A description for the workspace. This is used only to help you identify this workspace.
sourcepub fn workspace_id(self, input: impl Into<String>) -> Self
pub fn workspace_id(self, input: impl Into<String>) -> Self
The ID of the workspace to update.
sourcepub fn set_workspace_id(self, input: Option<String>) -> Self
pub fn set_workspace_id(self, input: Option<String>) -> Self
The ID of the workspace to update.
sourcepub fn workspace_name(self, input: impl Into<String>) -> Self
pub fn workspace_name(self, input: impl Into<String>) -> Self
A new name for the workspace to update.
sourcepub fn set_workspace_name(self, input: Option<String>) -> Self
pub fn set_workspace_name(self, input: Option<String>) -> Self
A new name for the workspace to update.
sourcepub fn workspace_notification_destinations(
self,
input: NotificationDestinationType
) -> Self
pub fn workspace_notification_destinations(
self,
input: 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.
sourcepub 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.
sourcepub fn workspace_organizational_units(self, input: impl Into<String>) -> Self
pub fn workspace_organizational_units(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_workspace_organizational_units(
self,
input: Option<Vec<String>>
) -> Self
pub fn set_workspace_organizational_units(
self,
input: Option<Vec<String>>
) -> Self
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.
sourcepub fn workspace_role_arn(self, input: impl Into<String>) -> Self
pub fn workspace_role_arn(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_workspace_role_arn(self, input: Option<String>) -> Self
pub fn set_workspace_role_arn(self, input: Option<String>) -> Self
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.
Trait Implementations
sourceimpl Clone for UpdateWorkspace
impl Clone for UpdateWorkspace
sourcefn clone(&self) -> UpdateWorkspace
fn clone(&self) -> UpdateWorkspace
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for UpdateWorkspace
impl Send for UpdateWorkspace
impl Sync for UpdateWorkspace
impl Unpin for UpdateWorkspace
impl !UnwindSafe for UpdateWorkspace
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more