Struct aws_sdk_grafana::input::CreateWorkspaceInput
source · #[non_exhaustive]pub struct CreateWorkspaceInput { /* private fields */ }Implementations§
source§impl CreateWorkspaceInput
impl CreateWorkspaceInput
sourcepub async fn make_operation(
self,
_config: &Config
) -> Result<Operation<CreateWorkspace, AwsResponseRetryClassifier>, BuildError>
pub async fn make_operation(
self,
_config: &Config
) -> Result<Operation<CreateWorkspace, AwsResponseRetryClassifier>, BuildError>
Consumes the builder and constructs an Operation<CreateWorkspace>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture CreateWorkspaceInput.
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>
If you specify SERVICE_MANAGED on AWS Grafana console, 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. In the CLI mode, the permissionType SERVICE_MANAGED will not create the IAM role for you. The ability for the Amazon Managed Grafana to create the IAM role on behalf of the user is supported only in the Amazon Managed Grafana AWS console. Use only the CUSTOMER_MANAGED permission type when creating a workspace in the CLI.
If you specify CUSTOMER_MANAGED, you will manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization that 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 to use to generate IAM roles to be used for this workspace.
sourcepub fn workspace_data_sources(&self) -> Option<&[DataSourceType]>
pub fn workspace_data_sources(&self) -> Option<&[DataSourceType]>
Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.
If you don't specify a data source here, you can still add it as a data source in the workspace console later. However, you will then have to manually configure permissions for it.
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
) -> Option<&[NotificationDestinationType]>
pub fn workspace_notification_destinations(
&self
) -> Option<&[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.
sourcepub fn workspace_organizational_units(&self) -> Option<&[String]>
pub fn workspace_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 workspace_role_arn(&self) -> Option<&str>
pub fn workspace_role_arn(&self) -> Option<&str>
The workspace needs an IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. If you already have a role that you want to use, specify it here. The permission type should be set to CUSTOMER_MANAGED.
sourcepub fn authentication_providers(&self) -> Option<&[AuthenticationProviderTypes]>
pub fn authentication_providers(&self) -> Option<&[AuthenticationProviderTypes]>
Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to Single Sign-On), 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.
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 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.
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<CreateWorkspaceInput> for CreateWorkspaceInput
impl PartialEq<CreateWorkspaceInput> for CreateWorkspaceInput
source§fn eq(&self, other: &CreateWorkspaceInput) -> bool
fn eq(&self, other: &CreateWorkspaceInput) -> bool
self and other values to be equal, and is used
by ==.