Struct aws_sdk_grafana::model::WorkspaceDescription
source · [−]#[non_exhaustive]pub struct WorkspaceDescription {Show 22 fields
pub account_access_type: Option<AccountAccessType>,
pub created: Option<DateTime>,
pub data_sources: Option<Vec<DataSourceType>>,
pub description: Option<String>,
pub endpoint: Option<String>,
pub grafana_version: Option<String>,
pub id: Option<String>,
pub modified: Option<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: Option<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>>,
}
Expand description
A structure containing information about an Amazon Managed Grafana workspace in your account.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
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: Option<DateTime>
The date that the workspace was created.
data_sources: Option<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.
description: Option<String>
The user-defined description of the workspace.
endpoint: Option<String>
The URL that users can use to access the Grafana console in the workspace.
grafana_version: Option<String>
The version of Grafana supported in this workspace.
id: Option<String>
The unique ID of this workspace.
modified: Option<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
, 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 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
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: Option<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 or a free trial license.
free_trial_consumed: Option<bool>
Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
license_expiration: Option<DateTime>
If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
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.
authentication: Option<AuthenticationSummary>
A structure that describes whether the workspace uses SAML, Amazon Web Services SSO, or both methods for user authentication.
The list of tags associated with the workspace.
Implementations
sourceimpl WorkspaceDescription
impl WorkspaceDescription
sourcepub fn account_access_type(&self) -> Option<&AccountAccessType>
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.
sourcepub fn data_sources(&self) -> Option<&[DataSourceType]>
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.
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The user-defined description of the workspace.
sourcepub fn endpoint(&self) -> Option<&str>
pub fn endpoint(&self) -> Option<&str>
The URL that users can use to access the Grafana console in the workspace.
sourcepub fn grafana_version(&self) -> Option<&str>
pub fn grafana_version(&self) -> Option<&str>
The version of Grafana supported in this workspace.
sourcepub fn modified(&self) -> Option<&DateTime>
pub fn modified(&self) -> Option<&DateTime>
The most recent date that the workspace was modified.
sourcepub fn organization_role_name(&self) -> Option<&str>
pub fn organization_role_name(&self) -> Option<&str>
The name of the IAM role that is used to access resources through Organizations.
sourcepub fn notification_destinations(
&self
) -> Option<&[NotificationDestinationType]>
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.
sourcepub fn organizational_units(&self) -> Option<&[String]>
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.
sourcepub fn permission_type(&self) -> Option<&PermissionType>
pub fn permission_type(&self) -> Option<&PermissionType>
If this is 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 this is CUSTOMER_MANAGED
, you 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
sourcepub fn stack_set_name(&self) -> Option<&str>
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.
sourcepub fn status(&self) -> Option<&WorkspaceStatus>
pub fn status(&self) -> Option<&WorkspaceStatus>
The current status of the workspace.
sourcepub fn workspace_role_arn(&self) -> Option<&str>
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.
sourcepub fn license_type(&self) -> Option<&LicenseType>
pub fn license_type(&self) -> Option<&LicenseType>
Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
sourcepub fn free_trial_consumed(&self) -> Option<bool>
pub fn free_trial_consumed(&self) -> Option<bool>
Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
sourcepub fn license_expiration(&self) -> Option<&DateTime>
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.
sourcepub fn free_trial_expiration(&self) -> Option<&DateTime>
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.
sourcepub fn authentication(&self) -> Option<&AuthenticationSummary>
pub fn authentication(&self) -> Option<&AuthenticationSummary>
A structure that describes whether the workspace uses SAML, Amazon Web Services SSO, or both methods for user authentication.
The list of tags associated with the workspace.
sourceimpl WorkspaceDescription
impl WorkspaceDescription
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture WorkspaceDescription
Trait Implementations
sourceimpl Clone for WorkspaceDescription
impl Clone for WorkspaceDescription
sourcefn clone(&self) -> WorkspaceDescription
fn clone(&self) -> WorkspaceDescription
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for WorkspaceDescription
impl Debug for WorkspaceDescription
sourceimpl PartialEq<WorkspaceDescription> for WorkspaceDescription
impl PartialEq<WorkspaceDescription> for WorkspaceDescription
sourcefn eq(&self, other: &WorkspaceDescription) -> bool
fn eq(&self, other: &WorkspaceDescription) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &WorkspaceDescription) -> bool
fn ne(&self, other: &WorkspaceDescription) -> bool
This method tests for !=
.
impl StructuralPartialEq for WorkspaceDescription
Auto Trait Implementations
impl RefUnwindSafe for WorkspaceDescription
impl Send for WorkspaceDescription
impl Sync for WorkspaceDescription
impl Unpin for WorkspaceDescription
impl UnwindSafe for WorkspaceDescription
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more