#[non_exhaustive]pub struct WorkspaceDescriptionBuilder { /* private fields */ }
Expand description
A builder for WorkspaceDescription
.
Implementations§
source§impl WorkspaceDescriptionBuilder
impl WorkspaceDescriptionBuilder
sourcepub fn account_access_type(self, input: AccountAccessType) -> Self
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 this is ORGANIZATION
, the workspaceOrganizationalUnits
parameter specifies which organizational units the workspace can access.
sourcepub fn set_account_access_type(self, input: Option<AccountAccessType>) -> 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 this is ORGANIZATION
, the workspaceOrganizationalUnits
parameter specifies which organizational units the workspace can access.
sourcepub fn get_account_access_type(&self) -> &Option<AccountAccessType>
pub fn get_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 created(self, input: DateTime) -> Self
pub fn created(self, input: DateTime) -> Self
The date that the workspace was created.
This field is required.sourcepub fn set_created(self, input: Option<DateTime>) -> Self
pub fn set_created(self, input: Option<DateTime>) -> Self
The date that the workspace was created.
sourcepub fn get_created(&self) -> &Option<DateTime>
pub fn get_created(&self) -> &Option<DateTime>
The date that the workspace was created.
sourcepub fn data_sources(self, input: DataSourceType) -> Self
pub fn data_sources(self, input: DataSourceType) -> Self
Appends an item to data_sources
.
To override the contents of this collection use set_data_sources
.
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
.
sourcepub fn set_data_sources(self, input: Option<Vec<DataSourceType>>) -> Self
pub fn set_data_sources(self, input: Option<Vec<DataSourceType>>) -> Self
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
.
sourcepub fn get_data_sources(&self) -> &Option<Vec<DataSourceType>>
pub fn get_data_sources(&self) -> &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.
This list is only used when the workspace was created through the Amazon Web Services console, and the permissionType
is SERVICE_MANAGED
.
sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The user-defined description of the workspace.
sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The user-defined description of the workspace.
sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The user-defined description of the workspace.
sourcepub fn endpoint(self, input: impl Into<String>) -> Self
pub fn endpoint(self, input: impl Into<String>) -> Self
The URL that users can use to access the Grafana console in the workspace.
This field is required.sourcepub fn set_endpoint(self, input: Option<String>) -> Self
pub fn set_endpoint(self, input: Option<String>) -> Self
The URL that users can use to access the Grafana console in the workspace.
sourcepub fn get_endpoint(&self) -> &Option<String>
pub fn get_endpoint(&self) -> &Option<String>
The URL that users can use to access the Grafana console in the workspace.
sourcepub fn grafana_version(self, input: impl Into<String>) -> Self
pub fn grafana_version(self, input: impl Into<String>) -> Self
The version of Grafana supported in this workspace.
This field is required.sourcepub fn set_grafana_version(self, input: Option<String>) -> Self
pub fn set_grafana_version(self, input: Option<String>) -> Self
The version of Grafana supported in this workspace.
sourcepub fn get_grafana_version(&self) -> &Option<String>
pub fn get_grafana_version(&self) -> &Option<String>
The version of Grafana supported in this workspace.
sourcepub fn id(self, input: impl Into<String>) -> Self
pub fn id(self, input: impl Into<String>) -> Self
The unique ID of this workspace.
This field is required.sourcepub fn modified(self, input: DateTime) -> Self
pub fn modified(self, input: DateTime) -> Self
The most recent date that the workspace was modified.
This field is required.sourcepub fn set_modified(self, input: Option<DateTime>) -> Self
pub fn set_modified(self, input: Option<DateTime>) -> Self
The most recent date that the workspace was modified.
sourcepub fn get_modified(&self) -> &Option<DateTime>
pub fn get_modified(&self) -> &Option<DateTime>
The most recent date that the workspace was modified.
sourcepub fn organization_role_name(self, input: impl Into<String>) -> Self
pub fn organization_role_name(self, input: impl Into<String>) -> Self
The name of the IAM role that is used to access resources through Organizations.
sourcepub fn set_organization_role_name(self, input: Option<String>) -> Self
pub fn set_organization_role_name(self, input: Option<String>) -> Self
The name of the IAM role that is used to access resources through Organizations.
sourcepub fn get_organization_role_name(&self) -> &Option<String>
pub fn get_organization_role_name(&self) -> &Option<String>
The name of the IAM role that is used to access resources through Organizations.
sourcepub fn notification_destinations(
self,
input: NotificationDestinationType,
) -> Self
pub fn notification_destinations( self, input: NotificationDestinationType, ) -> Self
Appends an item to notification_destinations
.
To override the contents of this collection use set_notification_destinations
.
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 set_notification_destinations(
self,
input: Option<Vec<NotificationDestinationType>>,
) -> Self
pub fn set_notification_destinations( self, input: Option<Vec<NotificationDestinationType>>, ) -> Self
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 get_notification_destinations(
&self,
) -> &Option<Vec<NotificationDestinationType>>
pub fn get_notification_destinations( &self, ) -> &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.
sourcepub fn organizational_units(self, input: impl Into<String>) -> Self
pub fn organizational_units(self, input: impl Into<String>) -> Self
Appends an item to organizational_units
.
To override the contents of this collection use set_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.
sourcepub fn set_organizational_units(self, input: Option<Vec<String>>) -> Self
pub fn set_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.
sourcepub fn get_organizational_units(&self) -> &Option<Vec<String>>
pub fn get_organizational_units(&self) -> &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.
sourcepub fn permission_type(self, input: PermissionType) -> Self
pub fn permission_type(self, input: PermissionType) -> Self
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
sourcepub fn set_permission_type(self, input: Option<PermissionType>) -> Self
pub fn set_permission_type(self, input: Option<PermissionType>) -> Self
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
sourcepub fn get_permission_type(&self) -> &Option<PermissionType>
pub fn get_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
sourcepub fn stack_set_name(self, input: impl Into<String>) -> Self
pub fn stack_set_name(self, input: impl Into<String>) -> Self
The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
sourcepub fn set_stack_set_name(self, input: Option<String>) -> Self
pub fn set_stack_set_name(self, input: Option<String>) -> Self
The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
sourcepub fn get_stack_set_name(&self) -> &Option<String>
pub fn get_stack_set_name(&self) -> &Option<String>
The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
sourcepub fn status(self, input: WorkspaceStatus) -> Self
pub fn status(self, input: WorkspaceStatus) -> Self
The current status of the workspace.
This field is required.sourcepub fn set_status(self, input: Option<WorkspaceStatus>) -> Self
pub fn set_status(self, input: Option<WorkspaceStatus>) -> Self
The current status of the workspace.
sourcepub fn get_status(&self) -> &Option<WorkspaceStatus>
pub fn get_status(&self) -> &Option<WorkspaceStatus>
The current status of the workspace.
sourcepub fn workspace_role_arn(self, input: impl Into<String>) -> Self
pub fn workspace_role_arn(self, input: impl Into<String>) -> Self
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 set_workspace_role_arn(self, input: Option<String>) -> Self
pub fn set_workspace_role_arn(self, input: Option<String>) -> Self
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 get_workspace_role_arn(&self) -> &Option<String>
pub fn get_workspace_role_arn(&self) -> &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.
sourcepub fn license_type(self, input: LicenseType) -> Self
pub fn license_type(self, input: LicenseType) -> Self
Specifies whether this workspace has a full Grafana Enterprise license.
Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
sourcepub fn set_license_type(self, input: Option<LicenseType>) -> Self
pub fn set_license_type(self, input: Option<LicenseType>) -> Self
Specifies whether this workspace has a full Grafana Enterprise license.
Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
sourcepub fn get_license_type(&self) -> &Option<LicenseType>
pub fn get_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.
sourcepub fn free_trial_consumed(self, input: bool) -> Self
pub fn free_trial_consumed(self, input: bool) -> Self
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.
sourcepub fn set_free_trial_consumed(self, input: Option<bool>) -> Self
pub fn set_free_trial_consumed(self, input: Option<bool>) -> Self
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.
sourcepub fn get_free_trial_consumed(&self) -> &Option<bool>
pub fn get_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.
sourcepub fn license_expiration(self, input: DateTime) -> Self
pub fn license_expiration(self, input: DateTime) -> Self
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.
sourcepub fn set_license_expiration(self, input: Option<DateTime>) -> Self
pub fn set_license_expiration(self, input: Option<DateTime>) -> Self
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.
sourcepub fn get_license_expiration(&self) -> &Option<DateTime>
pub fn get_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.
sourcepub fn free_trial_expiration(self, input: DateTime) -> Self
pub fn free_trial_expiration(self, input: DateTime) -> Self
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.
sourcepub fn set_free_trial_expiration(self, input: Option<DateTime>) -> Self
pub fn set_free_trial_expiration(self, input: Option<DateTime>) -> Self
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.
sourcepub fn get_free_trial_expiration(&self) -> &Option<DateTime>
pub fn get_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.
sourcepub fn authentication(self, input: AuthenticationSummary) -> Self
pub fn authentication(self, input: AuthenticationSummary) -> Self
A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
This field is required.sourcepub fn set_authentication(self, input: Option<AuthenticationSummary>) -> Self
pub fn set_authentication(self, input: Option<AuthenticationSummary>) -> Self
A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
sourcepub fn get_authentication(&self) -> &Option<AuthenticationSummary>
pub fn get_authentication(&self) -> &Option<AuthenticationSummary>
A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
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.
The list of tags associated with the workspace.
The list of tags associated with the workspace.
sourcepub fn vpc_configuration(self, input: VpcConfiguration) -> Self
pub fn vpc_configuration(self, input: VpcConfiguration) -> Self
The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
sourcepub fn set_vpc_configuration(self, input: Option<VpcConfiguration>) -> Self
pub fn set_vpc_configuration(self, input: Option<VpcConfiguration>) -> Self
The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
sourcepub fn get_vpc_configuration(&self) -> &Option<VpcConfiguration>
pub fn get_vpc_configuration(&self) -> &Option<VpcConfiguration>
The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
sourcepub fn network_access_control(self, input: NetworkAccessConfiguration) -> Self
pub fn network_access_control(self, input: NetworkAccessConfiguration) -> Self
The configuration settings for network access to your workspace.
sourcepub fn set_network_access_control(
self,
input: Option<NetworkAccessConfiguration>,
) -> Self
pub fn set_network_access_control( self, input: Option<NetworkAccessConfiguration>, ) -> Self
The configuration settings for network access to your workspace.
sourcepub fn get_network_access_control(&self) -> &Option<NetworkAccessConfiguration>
pub fn get_network_access_control(&self) -> &Option<NetworkAccessConfiguration>
The configuration settings for network access to your workspace.
sourcepub fn grafana_token(self, input: impl Into<String>) -> Self
pub fn grafana_token(self, input: impl Into<String>) -> Self
The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.
sourcepub fn set_grafana_token(self, input: Option<String>) -> Self
pub fn set_grafana_token(self, input: Option<String>) -> Self
The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.
sourcepub fn get_grafana_token(&self) -> &Option<String>
pub fn get_grafana_token(&self) -> &Option<String>
The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.
sourcepub fn build(self) -> Result<WorkspaceDescription, BuildError>
pub fn build(self) -> Result<WorkspaceDescription, BuildError>
Consumes the builder and constructs a WorkspaceDescription
.
This method will fail if any of the following fields are not set:
Trait Implementations§
source§impl Clone for WorkspaceDescriptionBuilder
impl Clone for WorkspaceDescriptionBuilder
source§fn clone(&self) -> WorkspaceDescriptionBuilder
fn clone(&self) -> WorkspaceDescriptionBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for WorkspaceDescriptionBuilder
impl Debug for WorkspaceDescriptionBuilder
source§impl Default for WorkspaceDescriptionBuilder
impl Default for WorkspaceDescriptionBuilder
source§fn default() -> WorkspaceDescriptionBuilder
fn default() -> WorkspaceDescriptionBuilder
source§impl PartialEq for WorkspaceDescriptionBuilder
impl PartialEq for WorkspaceDescriptionBuilder
source§fn eq(&self, other: &WorkspaceDescriptionBuilder) -> bool
fn eq(&self, other: &WorkspaceDescriptionBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for WorkspaceDescriptionBuilder
Auto Trait Implementations§
impl Freeze for WorkspaceDescriptionBuilder
impl RefUnwindSafe for WorkspaceDescriptionBuilder
impl Send for WorkspaceDescriptionBuilder
impl Sync for WorkspaceDescriptionBuilder
impl Unpin for WorkspaceDescriptionBuilder
impl UnwindSafe for WorkspaceDescriptionBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more