Struct aws_sdk_grafana::input::create_workspace_input::Builder

pub struct Builder { /* private fields */ }

A builder for CreateWorkspaceInput.

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 463)

        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 471)

        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 client_token(self, input: impl Into<String>) -> Self

A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

Examples found in repository

src/client.rs (line 476)

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

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

A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

Examples found in repository

src/client.rs (line 481)

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

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

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.

Examples found in repository

src/client.rs (line 486)

        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 with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.

Examples found in repository

src/client.rs (line 494)

        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 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 CLI mode, the permissionType SERVICE_MANAGED will not create the IAM role for you.

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.

Examples found in repository

src/client.rs (line 501)

        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 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 CLI mode, the permissionType SERVICE_MANAGED will not create the IAM role for you.

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.

Examples found in repository

src/client.rs (line 511)

        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 516)

        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 524)

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

Examples found in repository

src/client.rs (line 534)

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

Examples found in repository

src/client.rs (line 543)

        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.

Pattern: ^[\\p{L}\\p{Z}\\p{N}\\p{P}]{0,2048}$

Examples found in repository

src/client.rs (line 549)

        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.

Pattern: ^[\\p{L}\\p{Z}\\p{N}\\p{P}]{0,2048}$

Examples found in repository

src/client.rs (line 558)

        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_name(self, input: impl Into<String>) -> Self

The name for the workspace. It does not have to be unique.

Examples found in repository

src/client.rs (line 563)

        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

The name for the workspace. It does not have to be unique.

Examples found in repository

src/client.rs (line 571)

        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 583)

        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 591)

        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 603)

        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 611)

        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. The permission type should be set to CUSTOMER_MANAGED.

Examples found in repository

src/client.rs (line 616)

        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. The permission type should be set to CUSTOMER_MANAGED.

Examples found in repository

src/client.rs (line 624)

        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 authentication_providers(self, input: AuthenticationProviderTypes) -> Self

Appends an item to authentication_providers.

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.

Examples found in repository

src/client.rs (line 636)

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

Examples found in repository

src/client.rs (line 644)

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

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

The list of tags associated with the workspace.

Examples found in repository

src/client.rs (line 657)

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

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

The list of tags associated with the workspace.

Examples found in repository

src/client.rs (line 667)

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

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

Consumes the builder and constructs a CreateWorkspaceInput.

Examples found in repository

src/client.rs (line 430)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::CreateWorkspace,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::CreateWorkspaceError>,
        > {
            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::CreateWorkspaceOutput,
            aws_smithy_http::result::SdkError<crate::error::CreateWorkspaceError>,
        > {
            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