Struct aws_sdk_grafana::input::update_workspace_input::Builder

pub struct Builder { /* private fields */ }

A builder for UpdateWorkspaceInput.

Implementations

impl Builder

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.

Examples found in repository

src/client.rs (line 1798)

        pub fn account_access_type(mut self, input: crate::model::AccountAccessType) -> Self {
            self.inner = self.inner.account_access_type(input);
            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.

Examples found in repository

src/client.rs (line 1806)

        pub fn set_account_access_type(
            mut self,
            input: std::option::Option<crate::model::AccountAccessType>,
        ) -> Self {
            self.inner = self.inner.set_account_access_type(input);
            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.

Examples found in repository

src/client.rs (line 1811)

        pub fn organization_role_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.organization_role_name(input.into());
            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.

Examples found in repository

src/client.rs (line 1819)

        pub fn set_organization_role_name(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_organization_role_name(input);
            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

Examples found in repository

src/client.rs (line 1826)

        pub fn permission_type(mut self, input: crate::model::PermissionType) -> Self {
            self.inner = self.inner.permission_type(input);
            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

Examples found in repository

src/client.rs (line 1836)

        pub fn set_permission_type(
            mut self,
            input: std::option::Option<crate::model::PermissionType>,
        ) -> Self {
            self.inner = self.inner.set_permission_type(input);
            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.

Examples found in repository

src/client.rs (line 1841)

        pub fn stack_set_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.stack_set_name(input.into());
            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.

Examples found in repository

src/client.rs (line 1849)

        pub fn set_stack_set_name(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_stack_set_name(input);
            self
        }

pub fn workspace_data_sources(self, input: DataSourceType) -> Self

Appends an item to workspace_data_sources.

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.

Examples found in repository

src/client.rs (line 1859)

        pub fn workspace_data_sources(mut self, input: crate::model::DataSourceType) -> Self {
            self.inner = self.inner.workspace_data_sources(input);
            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.

Examples found in repository

src/client.rs (line 1868)

        pub fn set_workspace_data_sources(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::DataSourceType>>,
        ) -> Self {
            self.inner = self.inner.set_workspace_data_sources(input);
            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.

Examples found in repository

src/client.rs (line 1873)

        pub fn workspace_description(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.workspace_description(input.into());
            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.

Examples found in repository

src/client.rs (line 1881)

        pub fn set_workspace_description(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_workspace_description(input);
            self
        }

pub fn workspace_id(self, input: impl Into<String>) -> Self

The ID of the workspace to update.

Examples found in repository

src/client.rs (line 1886)

        pub fn workspace_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.workspace_id(input.into());
            self
        }

pub fn set_workspace_id(self, input: Option<String>) -> Self

The ID of the workspace to update.

Examples found in repository

src/client.rs (line 1891)

        pub fn set_workspace_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_workspace_id(input);
            self
        }

pub fn workspace_name(self, input: impl Into<String>) -> Self

A new name for the workspace to update.

Examples found in repository

src/client.rs (line 1896)

        pub fn workspace_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.workspace_name(input.into());
            self
        }

pub fn set_workspace_name(self, input: Option<String>) -> Self

A new name for the workspace to update.

Examples found in repository

src/client.rs (line 1904)

        pub fn set_workspace_name(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_workspace_name(input);
            self
        }

pub fn workspace_notification_destinations(
    self,
    input: NotificationDestinationType
) -> Self

Appends an item to workspace_notification_destinations.

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.

Examples found in repository

src/client.rs (line 1916)

        pub fn workspace_notification_destinations(
            mut self,
            input: crate::model::NotificationDestinationType,
        ) -> Self {
            self.inner = self.inner.workspace_notification_destinations(input);
            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.

Examples found in repository

src/client.rs (line 1924)

        pub fn set_workspace_notification_destinations(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::NotificationDestinationType>>,
        ) -> Self {
            self.inner = self.inner.set_workspace_notification_destinations(input);
            self
        }

pub fn workspace_organizational_units(self, input: impl Into<String>) -> Self

Appends an item to workspace_organizational_units.

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.

Examples found in repository

src/client.rs (line 1936)

        pub fn workspace_organizational_units(
            mut self,
            input: impl Into<std::string::String>,
        ) -> Self {
            self.inner = self.inner.workspace_organizational_units(input.into());
            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.

Examples found in repository

src/client.rs (line 1944)

        pub fn set_workspace_organizational_units(
            mut self,
            input: std::option::Option<std::vec::Vec<std::string::String>>,
        ) -> Self {
            self.inner = self.inner.set_workspace_organizational_units(input);
            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.

Examples found in repository

src/client.rs (line 1949)

        pub fn workspace_role_arn(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.workspace_role_arn(input.into());
            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.

Examples found in repository

src/client.rs (line 1957)

        pub fn set_workspace_role_arn(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_workspace_role_arn(input);
            self
        }

pub fn build(self) -> Result<UpdateWorkspaceInput, BuildError>

Consumes the builder and constructs a UpdateWorkspaceInput.

Examples found in repository

src/client.rs (line 1765)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::UpdateWorkspace,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::UpdateWorkspaceError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::UpdateWorkspaceOutput,
            aws_smithy_http::result::SdkError<crate::error::UpdateWorkspaceError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder