Struct aws_sdk_grafana::input::CreateWorkspaceInput

#[non_exhaustive]
pub struct CreateWorkspaceInput {
    pub account_access_type: Option<AccountAccessType>,
    pub client_token: Option<String>,
    pub organization_role_name: Option<String>,
    pub permission_type: Option<PermissionType>,
    pub stack_set_name: Option<String>,
    pub workspace_data_sources: Option<Vec<DataSourceType>>,
    pub workspace_description: Option<String>,
    pub workspace_name: Option<String>,
    pub workspace_notification_destinations: Option<Vec<NotificationDestinationType>>,
    pub workspace_organizational_units: Option<Vec<String>>,
    pub workspace_role_arn: Option<String>,
    pub authentication_providers: Option<Vec<AuthenticationProviderTypes>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

account_access_type: Option<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.

client_token: Option<String>

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

organization_role_name: Option<String>

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.

permission_type: Option<PermissionType>

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

stack_set_name: Option<String>

The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.

workspace_data_sources: Option<Vec<DataSourceType>>

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.

workspace_description: Option<String>

A description for the workspace. This is used only to help you identify this workspace.

workspace_name: Option<String>

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

workspace_notification_destinations: Option<Vec<NotificationDestinationType>>

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.

workspace_organizational_units: Option<Vec<String>>

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.

workspace_role_arn: Option<String>

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.

authentication_providers: Option<Vec<AuthenticationProviderTypes>>

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.

Implementations

impl CreateWorkspaceInput

pub async fn make_operation(
    self,
    _config: &Config
) -> Result<Operation<CreateWorkspace, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<CreateWorkspace>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateWorkspaceInput

impl CreateWorkspaceInput

pub fn account_access_type(&self) -> Option<&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.

pub fn client_token(&self) -> Option<&str>

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

pub fn organization_role_name(&self) -> Option<&str>

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.

pub fn permission_type(&self) -> Option<&PermissionType>

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

pub fn stack_set_name(&self) -> Option<&str>

The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.

pub fn workspace_data_sources(&self) -> Option<&[DataSourceType]>

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.

pub fn workspace_description(&self) -> Option<&str>

A description for the workspace. This is used only to help you identify this workspace.

pub fn workspace_name(&self) -> Option<&str>

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

pub fn workspace_notification_destinations(
    &self
) -> Option<&[NotificationDestinationType]>

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 workspace_organizational_units(&self) -> Option<&[String]>

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.

pub fn workspace_role_arn(&self) -> Option<&str>

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.

pub fn authentication_providers(&self) -> Option<&[AuthenticationProviderTypes]>

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

impl Clone for CreateWorkspaceInput

fn clone(&self) -> CreateWorkspaceInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateWorkspaceInput

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

Formats the value using the given formatter.

impl PartialEq<CreateWorkspaceInput> for CreateWorkspaceInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for CreateWorkspaceInput