#[non_exhaustive]pub struct CreateWorkspaceInput {Show 17 fields
pub account_access_type: Option<AccountAccessType>,
pub client_token: Option<String>,
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_name: Option<String>,
pub workspace_notification_destinations: Option<Vec<NotificationDestinationType>>,
pub workspace_organizational_units: Option<Vec<String>>,
pub workspace_role_arn: Option<String>,
pub authentication_providers: Option<Vec<AuthenticationProviderTypes>>,
pub tags: Option<HashMap<String, String>>,
pub vpc_configuration: Option<VpcConfiguration>,
pub configuration: Option<String>,
pub network_access_control: Option<NetworkAccessConfiguration>,
pub grafana_version: Option<String>,
}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.
client_token: Option<String>A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
organization_role_name: Option<String>The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.
permission_type: Option<PermissionType>When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
You must also specify a workspaceRoleArn for a role that you will manage for the workspace to use when accessing those datasources and notification channels.
The ability for Amazon Managed Grafana to create and update IAM roles on behalf of the user is supported only in the Amazon Managed Grafana console, where this value may be set to SERVICE_MANAGED.
Use only the CUSTOMER_MANAGED permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation.
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 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.
Pattern: ^\[\\p{L}\\p{Z}\\p{N}\\p{P}\]{0,2048}$
workspace_name: Option<String>The name for the workspace. It does not have to be unique.
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>Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data sources and notification channels. You are responsible for managing the permissions for this role as new data sources or notification channels are added.
authentication_providers: Option<Vec<AuthenticationProviderTypes>>Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
The list of tags associated with the workspace.
vpc_configuration: Option<VpcConfiguration>The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).
configuration: Option<String>The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
network_access_control: Option<NetworkAccessConfiguration>Configuration 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.
grafana_version: Option<String>Specifies the version of Grafana to support in the new workspace. If not specified, defaults to the latest version (for example, 10.4).
To get a list of supported versions, use the ListVersions operation.
Implementations§
Source§impl CreateWorkspaceInput
impl CreateWorkspaceInput
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 client_token(&self) -> Option<&str>
pub fn client_token(&self) -> Option<&str>
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
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 with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.
Sourcepub fn permission_type(&self) -> Option<&PermissionType>
pub fn permission_type(&self) -> Option<&PermissionType>
When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
You must also specify a workspaceRoleArn for a role that you will manage for the workspace to use when accessing those datasources and notification channels.
The ability for Amazon Managed Grafana to create and update IAM roles on behalf of the user is supported only in the Amazon Managed Grafana console, where this value may be set to SERVICE_MANAGED.
Use only the CUSTOMER_MANAGED permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation.
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 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.
Pattern: ^\[\\p{L}\\p{Z}\\p{N}\\p{P}\]{0,2048}$
Sourcepub fn workspace_name(&self) -> Option<&str>
pub fn workspace_name(&self) -> Option<&str>
The name for the workspace. It does not have to be unique.
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>
Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data sources and notification channels. You are responsible for managing the permissions for this role as new data sources or notification channels are added.
Sourcepub fn authentication_providers(&self) -> &[AuthenticationProviderTypes]
pub fn authentication_providers(&self) -> &[AuthenticationProviderTypes]
Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .authentication_providers.is_none().
The list of tags associated with the workspace.
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.
Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).
Sourcepub fn configuration(&self) -> Option<&str>
pub fn configuration(&self) -> Option<&str>
The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
Sourcepub fn network_access_control(&self) -> Option<&NetworkAccessConfiguration>
pub fn network_access_control(&self) -> Option<&NetworkAccessConfiguration>
Configuration 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 grafana_version(&self) -> Option<&str>
pub fn grafana_version(&self) -> Option<&str>
Specifies the version of Grafana to support in the new workspace. If not specified, defaults to the latest version (for example, 10.4).
To get a list of supported versions, use the ListVersions operation.
Source§impl CreateWorkspaceInput
impl CreateWorkspaceInput
Sourcepub fn builder() -> CreateWorkspaceInputBuilder
pub fn builder() -> CreateWorkspaceInputBuilder
Creates a new builder-style object to manufacture CreateWorkspaceInput.
Trait Implementations§
Source§impl Clone for CreateWorkspaceInput
impl Clone for CreateWorkspaceInput
Source§fn clone(&self) -> CreateWorkspaceInput
fn clone(&self) -> CreateWorkspaceInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CreateWorkspaceInput
impl Debug for CreateWorkspaceInput
Source§impl PartialEq for CreateWorkspaceInput
impl PartialEq for CreateWorkspaceInput
impl StructuralPartialEq for CreateWorkspaceInput
Auto Trait Implementations§
impl Freeze for CreateWorkspaceInput
impl RefUnwindSafe for CreateWorkspaceInput
impl Send for CreateWorkspaceInput
impl Sync for CreateWorkspaceInput
impl Unpin for CreateWorkspaceInput
impl UnwindSafe for CreateWorkspaceInput
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);