Struct aws_sdk_grafana::operation::create_workspace::builders::CreateWorkspaceInputBuilder

#[non_exhaustive]
pub struct CreateWorkspaceInputBuilder { /* private fields */ }

A builder for CreateWorkspaceInput.

Implementations

impl CreateWorkspaceInputBuilder

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 you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.

This field is required.

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 you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.

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 you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.

pub fn client_token(self, input: impl Into<String>) -> Self

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

pub fn set_client_token(self, input: Option<String>) -> Self

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

pub fn get_client_token(&self) -> &Option<String>

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

pub fn organization_role_name(self, input: impl Into<String>) -> Self

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 set_organization_role_name(self, input: Option<String>) -> Self

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 get_organization_role_name(&self) -> &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.

pub fn permission_type(self, input: PermissionType) -> Self

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.

This field is required.

pub fn set_permission_type(self, input: Option<PermissionType>) -> Self

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 get_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, input: impl Into<String>) -> Self

The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.

pub fn set_stack_set_name(self, input: Option<String>) -> Self

The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.

pub fn get_stack_set_name(&self) -> &Option<String>

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, input: DataSourceType) -> Self

Appends an item to workspace_data_sources.

To override the contents of this collection use set_workspace_data_sources.

This parameter is for internal use only, and should not be used.

pub fn set_workspace_data_sources( self, input: Option<Vec<DataSourceType>> ) -> Self

This parameter is for internal use only, and should not be used.

pub fn get_workspace_data_sources(&self) -> &Option<Vec<DataSourceType>>

This parameter is for internal use only, and should not be used.

pub fn workspace_description(self, input: impl Into<String>) -> Self

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 set_workspace_description(self, input: Option<String>) -> Self

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 get_workspace_description(&self) -> &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}$

pub fn workspace_name(self, input: impl Into<String>) -> Self

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

pub fn set_workspace_name(self, input: Option<String>) -> Self

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

pub fn get_workspace_name(&self) -> &Option<String>

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

pub fn workspace_notification_destinations( self, input: NotificationDestinationType ) -> Self

Appends an item to workspace_notification_destinations.

To override the contents of this collection use set_workspace_notification_destinations.

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.

pub fn set_workspace_notification_destinations( self, input: Option<Vec<NotificationDestinationType>> ) -> Self

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.

pub fn get_workspace_notification_destinations( &self ) -> &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.

pub fn workspace_organizational_units(self, input: impl Into<String>) -> Self

Appends an item to workspace_organizational_units.

To override the contents of this collection use set_workspace_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.

pub fn set_workspace_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.

pub fn get_workspace_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.

pub fn workspace_role_arn(self, input: impl Into<String>) -> Self

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 set_workspace_role_arn(self, input: Option<String>) -> Self

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 get_workspace_role_arn(&self) -> &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.

pub fn authentication_providers( self, input: AuthenticationProviderTypes ) -> Self

Appends an item to authentication_providers.

To override the contents of this collection use set_authentication_providers.

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.

pub fn set_authentication_providers( self, input: Option<Vec<AuthenticationProviderTypes>> ) -> Self

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.

pub fn get_authentication_providers( &self ) -> &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.

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

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.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

The list of tags associated with the workspace.

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

The list of tags associated with the workspace.

pub fn vpc_configuration(self, input: VpcConfiguration) -> Self

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 set_vpc_configuration(self, input: Option<VpcConfiguration>) -> Self

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 get_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, input: impl Into<String>) -> Self

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 set_configuration(self, input: Option<String>) -> Self

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 get_configuration(&self) -> &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.

pub fn network_access_control(self, input: NetworkAccessConfiguration) -> Self

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 set_network_access_control( self, input: Option<NetworkAccessConfiguration> ) -> Self

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 get_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, input: impl Into<String>) -> Self

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.

pub fn set_grafana_version(self, input: Option<String>) -> Self

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.

pub fn get_grafana_version(&self) -> &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.

pub fn build(self) -> Result<CreateWorkspaceInput, BuildError>

Consumes the builder and constructs a CreateWorkspaceInput.

impl CreateWorkspaceInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<CreateWorkspaceOutput, SdkError<CreateWorkspaceError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for CreateWorkspaceInputBuilder

fn clone(&self) -> CreateWorkspaceInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateWorkspaceInputBuilder

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

Formats the value using the given formatter.

impl Default for CreateWorkspaceInputBuilder

fn default() -> CreateWorkspaceInputBuilder

Returns the “default value” for a type.

impl PartialEq for CreateWorkspaceInputBuilder

fn eq(&self, other: &CreateWorkspaceInputBuilder) -> 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 CreateWorkspaceInputBuilder