Struct aws_sdk_grafana::operation::create_workspace::CreateWorkspaceInput

#[non_exhaustive]
pub struct CreateWorkspaceInput {

    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)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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.

tags: Option<HashMap<String, String>>

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

impl CreateWorkspaceInput

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.

pub fn client_token(&self) -> Option<&str>

A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

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.

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.

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.

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().

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}$

pub fn workspace_name(&self) -> Option<&str>

The name for the workspace. It does not have to be unique.

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().

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().

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.

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().

pub fn tags(&self) -> Option<&HashMap<String, String>>

The list of tags associated with the workspace.

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).

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.

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.

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.

impl CreateWorkspaceInput

pub fn builder() -> CreateWorkspaceInputBuilder

Creates a new builder-style object to manufacture CreateWorkspaceInput.

Trait Implementations

impl Clone for CreateWorkspaceInput

fn clone(&self) -> CreateWorkspaceInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateWorkspaceInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateWorkspaceInput

fn eq(&self, other: &CreateWorkspaceInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateWorkspaceInput