#[non_exhaustive]pub struct UpdateWorkspaceInput {Show 15 fields
pub account_access_type: Option<AccountAccessType>,
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_id: 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 vpc_configuration: Option<VpcConfiguration>,
pub remove_vpc_configuration: Option<bool>,
pub network_access_control: Option<NetworkAccessConfiguration>,
pub remove_network_access_configuration: Option<bool>,
}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 you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.
organization_role_name: Option<String>The name of an IAM role that already exists to use to access resources through Organizations. This can only be used with a workspace that has the permissionType set to CUSTOMER_MANAGED.
permission_type: Option<PermissionType>Use this parameter if you want to change a workspace from SERVICE_MANAGED to CUSTOMER_MANAGED. This allows you to manage the permissions that the workspace uses to access datasources and notification channels. If the workspace is in a member Amazon Web Services 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.
If you specify this as CUSTOMER_MANAGED, you must also specify a workspaceRoleArn that the workspace will use for accessing Amazon Web Services resources.
For more information on the role and permissions needed, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
Do not use this to convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED. Do not include this parameter if you want to leave the workspace as SERVICE_MANAGED.
You can convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED using the Amazon Managed Grafana console. For more information, see Managing permissions for 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>>This parameter is for internal use only, and should not be used.
workspace_description: Option<String>A description for the workspace. This is used only to help you identify this workspace.
workspace_id: Option<String>The ID of the workspace to update.
workspace_name: Option<String>A new name for the workspace to update.
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>Specifies an IAM role that grants permissions to Amazon Web Services resources that the workspace accesses, such as data sources and notification channels. If this workspace has permissionType CUSTOMER_MANAGED, then this role is required.
vpc_configuration: Option<VpcConfiguration>The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
remove_vpc_configuration: Option<bool>Whether to remove the VPC configuration from the workspace.
Setting this to true and providing a vpcConfiguration to set will return an error.
network_access_control: Option<NetworkAccessConfiguration>The configuration settings for network access to your workspace.
When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.
If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.
remove_network_access_configuration: Option<bool>Whether to remove the network access configuration from the workspace.
Setting this to true and providing a networkAccessControl to set will return an error.
If you remove this configuration by setting this to true, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.
Implementations§
Source§impl UpdateWorkspaceInput
impl UpdateWorkspaceInput
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 you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.
Sourcepub fn organization_role_name(&self) -> Option<&str>
pub fn organization_role_name(&self) -> Option<&str>
The name of an IAM role that already exists to use to access resources through Organizations. This can only be used with a workspace that has the permissionType set to CUSTOMER_MANAGED.
Sourcepub fn permission_type(&self) -> Option<&PermissionType>
pub fn permission_type(&self) -> Option<&PermissionType>
Use this parameter if you want to change a workspace from SERVICE_MANAGED to CUSTOMER_MANAGED. This allows you to manage the permissions that the workspace uses to access datasources and notification channels. If the workspace is in a member Amazon Web Services 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.
If you specify this as CUSTOMER_MANAGED, you must also specify a workspaceRoleArn that the workspace will use for accessing Amazon Web Services resources.
For more information on the role and permissions needed, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
Do not use this to convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED. Do not include this parameter if you want to leave the workspace as SERVICE_MANAGED.
You can convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED using the Amazon Managed Grafana console. For more information, see Managing permissions for 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 to use to generate IAM roles to be used for this workspace.
Sourcepub fn workspace_data_sources(&self) -> &[DataSourceType]
pub fn workspace_data_sources(&self) -> &[DataSourceType]
This parameter is for internal use only, and should not be used.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .workspace_data_sources.is_none().
Sourcepub fn workspace_description(&self) -> Option<&str>
pub fn workspace_description(&self) -> Option<&str>
A description for the workspace. This is used only to help you identify this workspace.
Sourcepub fn workspace_id(&self) -> Option<&str>
pub fn workspace_id(&self) -> Option<&str>
The ID of the workspace to update.
Sourcepub fn workspace_name(&self) -> Option<&str>
pub fn workspace_name(&self) -> Option<&str>
A new name for the workspace to update.
Sourcepub fn workspace_notification_destinations(
&self,
) -> &[NotificationDestinationType]
pub fn workspace_notification_destinations( &self, ) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .workspace_notification_destinations.is_none().
Sourcepub fn workspace_organizational_units(&self) -> &[String]
pub fn workspace_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 .workspace_organizational_units.is_none().
Sourcepub fn workspace_role_arn(&self) -> Option<&str>
pub fn workspace_role_arn(&self) -> Option<&str>
Specifies an IAM role that grants permissions to Amazon Web Services resources that the workspace accesses, such as data sources and notification channels. If this workspace has permissionType CUSTOMER_MANAGED, then this role is required.
Sourcepub fn vpc_configuration(&self) -> Option<&VpcConfiguration>
pub fn vpc_configuration(&self) -> Option<&VpcConfiguration>
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
Sourcepub fn remove_vpc_configuration(&self) -> Option<bool>
pub fn remove_vpc_configuration(&self) -> Option<bool>
Whether to remove the VPC configuration from the workspace.
Setting this to true and providing a vpcConfiguration to set will return an error.
Sourcepub fn network_access_control(&self) -> Option<&NetworkAccessConfiguration>
pub fn network_access_control(&self) -> Option<&NetworkAccessConfiguration>
The configuration settings for network access to your workspace.
When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.
If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.
Sourcepub fn remove_network_access_configuration(&self) -> Option<bool>
pub fn remove_network_access_configuration(&self) -> Option<bool>
Whether to remove the network access configuration from the workspace.
Setting this to true and providing a networkAccessControl to set will return an error.
If you remove this configuration by setting this to true, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.
Source§impl UpdateWorkspaceInput
impl UpdateWorkspaceInput
Sourcepub fn builder() -> UpdateWorkspaceInputBuilder
pub fn builder() -> UpdateWorkspaceInputBuilder
Creates a new builder-style object to manufacture UpdateWorkspaceInput.
Trait Implementations§
Source§impl Clone for UpdateWorkspaceInput
impl Clone for UpdateWorkspaceInput
Source§fn clone(&self) -> UpdateWorkspaceInput
fn clone(&self) -> UpdateWorkspaceInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for UpdateWorkspaceInput
impl Debug for UpdateWorkspaceInput
Source§impl PartialEq for UpdateWorkspaceInput
impl PartialEq for UpdateWorkspaceInput
impl StructuralPartialEq for UpdateWorkspaceInput
Auto Trait Implementations§
impl Freeze for UpdateWorkspaceInput
impl RefUnwindSafe for UpdateWorkspaceInput
impl Send for UpdateWorkspaceInput
impl Sync for UpdateWorkspaceInput
impl Unpin for UpdateWorkspaceInput
impl UnwindSafe for UpdateWorkspaceInput
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);