Struct aws_sdk_grafana::types::WorkspaceDescription

#[non_exhaustive]
pub struct WorkspaceDescription { /* private fields */ }

A structure containing information about an Amazon Managed Grafana workspace in your account.

Implementations

impl WorkspaceDescription

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 this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.

pub fn created(&self) -> Option<&DateTime>

The date that the workspace was created.

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

Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.

This list is only used when the workspace was created through the Amazon Web Services console, and the permissionType is SERVICE_MANAGED.

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

The user-defined description of the workspace.

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

The URL that users can use to access the Grafana console in the workspace.

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

The version of Grafana supported in this workspace.

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

The unique ID of this workspace.

pub fn modified(&self) -> Option<&DateTime>

The most recent date that the workspace was modified.

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

The name of the workspace.

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

The name of the IAM role that is used to access resources through Organizations.

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

The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.

pub fn 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 permission_type(&self) -> Option<&PermissionType>

If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then 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 this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.

If you are working with a 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, this parameter must be set to CUSTOMER_MANAGED.

For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, 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 that is used to generate IAM roles to be used for this workspace.

pub fn status(&self) -> Option<&WorkspaceStatus>

The current status of the workspace.

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

The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.

pub fn license_type(&self) -> Option<&LicenseType>

Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.

pub fn free_trial_consumed(&self) -> Option<bool>

Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.

pub fn license_expiration(&self) -> Option<&DateTime>

If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.

pub fn free_trial_expiration(&self) -> Option<&DateTime>

If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.

pub fn authentication(&self) -> Option<&AuthenticationSummary>

A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

pub fn tags(&self) -> Option<&HashMap<String, String>>

The list of tags associated with the workspace.

pub fn vpc_configuration(&self) -> Option<&VpcConfiguration>

The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).

pub fn network_access_control(&self) -> Option<&NetworkAccessConfiguration>

The configuration settings for network access to your workspace.

impl WorkspaceDescription

pub fn builder() -> WorkspaceDescriptionBuilder

Creates a new builder-style object to manufacture WorkspaceDescription.

Trait Implementations

impl Clone for WorkspaceDescription

fn clone(&self) -> WorkspaceDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WorkspaceDescription

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

Formats the value using the given formatter.

impl PartialEq<WorkspaceDescription> for WorkspaceDescription

fn eq(&self, other: &WorkspaceDescription) -> 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 WorkspaceDescription