Struct aws_sdk_grafana::types::WorkspaceDescription

#[non_exhaustive]
pub struct WorkspaceDescription {

    pub account_access_type: Option<AccountAccessType>,
    pub created: DateTime,
    pub data_sources: Vec<DataSourceType>,
    pub description: Option<String>,
    pub endpoint: String,
    pub grafana_version: String,
    pub id: String,
    pub modified: DateTime,
    pub name: Option<String>,
    pub organization_role_name: Option<String>,
    pub notification_destinations: Option<Vec<NotificationDestinationType>>,
    pub organizational_units: Option<Vec<String>>,
    pub permission_type: Option<PermissionType>,
    pub stack_set_name: Option<String>,
    pub status: WorkspaceStatus,
    pub workspace_role_arn: Option<String>,
    pub license_type: Option<LicenseType>,
    pub free_trial_consumed: Option<bool>,
    pub license_expiration: Option<DateTime>,
    pub free_trial_expiration: Option<DateTime>,
    pub authentication: Option<AuthenticationSummary>,
    pub tags: Option<HashMap<String, String>>,
    pub vpc_configuration: Option<VpcConfiguration>,
    pub network_access_control: Option<NetworkAccessConfiguration>,
    pub grafana_token: Option<String>,
}

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

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

created: DateTime

The date that the workspace was created.

data_sources: Vec<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.

description: Option<String>

The user-defined description of the workspace.

endpoint: String

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

grafana_version: String

The version of Grafana supported in this workspace.

id: String

The unique ID of this workspace.

modified: DateTime

The most recent date that the workspace was modified.

name: Option<String>

The name of the workspace.

organization_role_name: Option<String>

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

notification_destinations: Option<Vec<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.

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.

permission_type: 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

stack_set_name: Option<String>

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

status: WorkspaceStatus

The current status of the workspace.

workspace_role_arn: Option<String>

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

license_type: Option<LicenseType>

Specifies whether this workspace has a full Grafana Enterprise license.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

free_trial_consumed: Option<bool>

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

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

license_expiration: Option<DateTime>

If this workspace has a full Grafana Enterprise license purchased through Amazon Web Services Marketplace, this specifies when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed.

free_trial_expiration: Option<DateTime>

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

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

authentication: Option<AuthenticationSummary>

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

tags: Option<HashMap<String, String>>

The list of tags associated with the workspace.

vpc_configuration: Option<VpcConfiguration>

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

network_access_control: Option<NetworkAccessConfiguration>

The configuration settings for network access to your workspace.

grafana_token: Option<String>

The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.

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) -> &DateTime

The date that the workspace was created.

pub fn data_sources(&self) -> &[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) -> &str

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

pub fn grafana_version(&self) -> &str

The version of Grafana supported in this workspace.

pub fn id(&self) -> &str

The unique ID of this workspace.

pub fn modified(&self) -> &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) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .notification_destinations.is_none().

pub fn organizational_units(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .organizational_units.is_none().

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) -> &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.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

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

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

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

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

If this workspace has a full Grafana Enterprise license purchased through Amazon Web Services Marketplace, this specifies when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed.

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.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

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.

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

The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.

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