com.amazonaws.services.managedgrafana.model

Class CreateWorkspaceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.managedgrafana.model.CreateWorkspaceRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateWorkspaceRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateWorkspaceRequest()

Method Summary

Modifier and Type	Method and Description
CreateWorkspaceRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateWorkspaceRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateWorkspaceRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAccountAccessType() 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.
List<String>	getAuthenticationProviders() Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace.
String	getClientToken() A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
String	getConfiguration() The configuration string for the workspace that you create.
String	getGrafanaVersion() Specifies the version of Grafana to support in the new workspace.
NetworkAccessConfiguration	getNetworkAccessControl() Configuration for network access to your workspace.
String	getOrganizationRoleName() 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.
String	getPermissionType() 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.
String	getStackSetName() The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
Map<String,String>	getTags() The list of tags associated with the workspace.
VpcConfiguration	getVpcConfiguration() The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
List<String>	getWorkspaceDataSources() This parameter is for internal use only, and should not be used.
String	getWorkspaceDescription() A description for the workspace.
String	getWorkspaceName() The name for the workspace.
List<String>	getWorkspaceNotificationDestinations() Specify the Amazon Web Services notification channels that you plan to use in this workspace.
List<String>	getWorkspaceOrganizationalUnits() 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.
String	getWorkspaceRoleArn() 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.
int	hashCode()
void	setAccountAccessType(String 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.
void	setAuthenticationProviders(Collection<String> authenticationProviders) Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace.
void	setClientToken(String clientToken) A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
void	setConfiguration(String configuration) The configuration string for the workspace that you create.
void	setGrafanaVersion(String grafanaVersion) Specifies the version of Grafana to support in the new workspace.
void	setNetworkAccessControl(NetworkAccessConfiguration networkAccessControl) Configuration for network access to your workspace.
void	setOrganizationRoleName(String organizationRoleName) 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.
void	setPermissionType(String 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.
void	setStackSetName(String stackSetName) The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
void	setTags(Map<String,String> tags) The list of tags associated with the workspace.
void	setVpcConfiguration(VpcConfiguration vpcConfiguration) The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
void	setWorkspaceDataSources(Collection<String> workspaceDataSources) This parameter is for internal use only, and should not be used.
void	setWorkspaceDescription(String workspaceDescription) A description for the workspace.
void	setWorkspaceName(String workspaceName) The name for the workspace.
void	setWorkspaceNotificationDestinations(Collection<String> workspaceNotificationDestinations) Specify the Amazon Web Services notification channels that you plan to use in this workspace.
void	setWorkspaceOrganizationalUnits(Collection<String> workspaceOrganizationalUnits) 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.
void	setWorkspaceRoleArn(String workspaceRoleArn) 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.
String	toString() Returns a string representation of this object.
CreateWorkspaceRequest	withAccountAccessType(AccountAccessType 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.
CreateWorkspaceRequest	withAccountAccessType(String 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.
CreateWorkspaceRequest	withAuthenticationProviders(AuthenticationProviderTypes... authenticationProviders) Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace.
CreateWorkspaceRequest	withAuthenticationProviders(Collection<String> authenticationProviders) Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace.
CreateWorkspaceRequest	withAuthenticationProviders(String... authenticationProviders) Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace.
CreateWorkspaceRequest	withClientToken(String clientToken) A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
CreateWorkspaceRequest	withConfiguration(String configuration) The configuration string for the workspace that you create.
CreateWorkspaceRequest	withGrafanaVersion(String grafanaVersion) Specifies the version of Grafana to support in the new workspace.
CreateWorkspaceRequest	withNetworkAccessControl(NetworkAccessConfiguration networkAccessControl) Configuration for network access to your workspace.
CreateWorkspaceRequest	withOrganizationRoleName(String organizationRoleName) 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.
CreateWorkspaceRequest	withPermissionType(PermissionType 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.
CreateWorkspaceRequest	withPermissionType(String 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.
CreateWorkspaceRequest	withStackSetName(String stackSetName) The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
CreateWorkspaceRequest	withTags(Map<String,String> tags) The list of tags associated with the workspace.
CreateWorkspaceRequest	withVpcConfiguration(VpcConfiguration vpcConfiguration) The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
CreateWorkspaceRequest	withWorkspaceDataSources(Collection<String> workspaceDataSources) This parameter is for internal use only, and should not be used.
CreateWorkspaceRequest	withWorkspaceDataSources(DataSourceType... workspaceDataSources) This parameter is for internal use only, and should not be used.
CreateWorkspaceRequest	withWorkspaceDataSources(String... workspaceDataSources) This parameter is for internal use only, and should not be used.
CreateWorkspaceRequest	withWorkspaceDescription(String workspaceDescription) A description for the workspace.
CreateWorkspaceRequest	withWorkspaceName(String workspaceName) The name for the workspace.
CreateWorkspaceRequest	withWorkspaceNotificationDestinations(Collection<String> workspaceNotificationDestinations) Specify the Amazon Web Services notification channels that you plan to use in this workspace.
CreateWorkspaceRequest	withWorkspaceNotificationDestinations(NotificationDestinationType... workspaceNotificationDestinations) Specify the Amazon Web Services notification channels that you plan to use in this workspace.
CreateWorkspaceRequest	withWorkspaceNotificationDestinations(String... workspaceNotificationDestinations) Specify the Amazon Web Services notification channels that you plan to use in this workspace.
CreateWorkspaceRequest	withWorkspaceOrganizationalUnits(Collection<String> workspaceOrganizationalUnits) 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.
CreateWorkspaceRequest	withWorkspaceOrganizationalUnits(String... workspaceOrganizationalUnits) 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.
CreateWorkspaceRequest	withWorkspaceRoleArn(String workspaceRoleArn) 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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateWorkspaceRequest

public CreateWorkspaceRequest()

Method Detail

setAccountAccessType

public void setAccountAccessType(String 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.

Parameters:

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.

See Also:

AccountAccessType

getAccountAccessType

public String getAccountAccessType()

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.

Returns:

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.

See Also:

AccountAccessType

withAccountAccessType

public CreateWorkspaceRequest withAccountAccessType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AccountAccessType

withAccountAccessType

public CreateWorkspaceRequest withAccountAccessType(AccountAccessType 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AccountAccessType

getAuthenticationProviders

public List<String> getAuthenticationProviders()

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.

Returns:

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.

See Also:

AuthenticationProviderTypes

setAuthenticationProviders

public void setAuthenticationProviders(Collection<String> authenticationProviders)

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.

Parameters:

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

See Also:

AuthenticationProviderTypes

withAuthenticationProviders

public CreateWorkspaceRequest withAuthenticationProviders(String... authenticationProviders)

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.

NOTE: This method appends the values to the existing list (if any). Use setAuthenticationProviders(java.util.Collection) or withAuthenticationProviders(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthenticationProviderTypes

withAuthenticationProviders

public CreateWorkspaceRequest withAuthenticationProviders(Collection<String> authenticationProviders)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthenticationProviderTypes

withAuthenticationProviders

public CreateWorkspaceRequest withAuthenticationProviders(AuthenticationProviderTypes... authenticationProviders)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthenticationProviderTypes

setClientToken

public void setClientToken(String clientToken)

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

Parameters:

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

getClientToken

public String getClientToken()

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

Returns:

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

withClientToken

public CreateWorkspaceRequest withClientToken(String clientToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setConfiguration

public void setConfiguration(String configuration)

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.

This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Parameters:

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

getConfiguration

public String getConfiguration()

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.

This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.

Returns:

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.

withConfiguration

public CreateWorkspaceRequest withConfiguration(String configuration)

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.

This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setGrafanaVersion

public void setGrafanaVersion(String grafanaVersion)

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.

Parameters:

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

getGrafanaVersion

public String getGrafanaVersion()

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.

Returns:

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.

withGrafanaVersion

public CreateWorkspaceRequest withGrafanaVersion(String grafanaVersion)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setNetworkAccessControl

public void setNetworkAccessControl(NetworkAccessConfiguration networkAccessControl)

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.

Parameters:

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

getNetworkAccessControl

public NetworkAccessConfiguration getNetworkAccessControl()

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.

Returns:

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.

withNetworkAccessControl

public CreateWorkspaceRequest withNetworkAccessControl(NetworkAccessConfiguration networkAccessControl)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setOrganizationRoleName

public void setOrganizationRoleName(String organizationRoleName)

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.

Parameters:

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

getOrganizationRoleName

public String getOrganizationRoleName()

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.

Returns:

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.

withOrganizationRoleName

public CreateWorkspaceRequest withOrganizationRoleName(String organizationRoleName)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setPermissionType

public void setPermissionType(String 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.

Parameters:

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.

See Also:

PermissionType

getPermissionType

public String getPermissionType()

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.

Returns:

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.

See Also:

PermissionType

withPermissionType

public CreateWorkspaceRequest withPermissionType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PermissionType

withPermissionType

public CreateWorkspaceRequest withPermissionType(PermissionType 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PermissionType

setStackSetName

public void setStackSetName(String stackSetName)

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

Parameters:

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

getStackSetName

public String getStackSetName()

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

Returns:

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

withStackSetName

public CreateWorkspaceRequest withStackSetName(String stackSetName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public Map<String,String> getTags()

The list of tags associated with the workspace.

Returns:

The list of tags associated with the workspace.

setTags

public void setTags(Map<String,String> tags)

The list of tags associated with the workspace.

Parameters:

tags - The list of tags associated with the workspace.

withTags

public CreateWorkspaceRequest withTags(Map<String,String> tags)

The list of tags associated with the workspace.

Parameters:

tags - The list of tags associated with the workspace.

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public CreateWorkspaceRequest addTagsEntry(String key,
                                           String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateWorkspaceRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVpcConfiguration

public void setVpcConfiguration(VpcConfiguration 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).

Parameters:

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

getVpcConfiguration

public VpcConfiguration getVpcConfiguration()

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

Returns:

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

withVpcConfiguration

public CreateWorkspaceRequest withVpcConfiguration(VpcConfiguration 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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getWorkspaceDataSources

public List<String> getWorkspaceDataSources()

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

Returns:

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

See Also:

DataSourceType

setWorkspaceDataSources

public void setWorkspaceDataSources(Collection<String> workspaceDataSources)

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

Parameters:

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

See Also:

DataSourceType

withWorkspaceDataSources

public CreateWorkspaceRequest withWorkspaceDataSources(String... workspaceDataSources)

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

NOTE: This method appends the values to the existing list (if any). Use setWorkspaceDataSources(java.util.Collection) or withWorkspaceDataSources(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DataSourceType

withWorkspaceDataSources

public CreateWorkspaceRequest withWorkspaceDataSources(Collection<String> workspaceDataSources)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DataSourceType

withWorkspaceDataSources

public CreateWorkspaceRequest withWorkspaceDataSources(DataSourceType... workspaceDataSources)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DataSourceType

setWorkspaceDescription

public void setWorkspaceDescription(String workspaceDescription)

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

Parameters:

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

getWorkspaceDescription

public String getWorkspaceDescription()

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

Returns:

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

withWorkspaceDescription

public CreateWorkspaceRequest withWorkspaceDescription(String workspaceDescription)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setWorkspaceName

public void setWorkspaceName(String workspaceName)

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

Parameters:

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

getWorkspaceName

public String getWorkspaceName()

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

Returns:

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

withWorkspaceName

public CreateWorkspaceRequest withWorkspaceName(String workspaceName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getWorkspaceNotificationDestinations

public List<String> getWorkspaceNotificationDestinations()

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.

Returns:

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.

See Also:

NotificationDestinationType

setWorkspaceNotificationDestinations

public void setWorkspaceNotificationDestinations(Collection<String> workspaceNotificationDestinations)

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.

Parameters:

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

See Also:

NotificationDestinationType

withWorkspaceNotificationDestinations

public CreateWorkspaceRequest withWorkspaceNotificationDestinations(String... workspaceNotificationDestinations)

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.

NOTE: This method appends the values to the existing list (if any). Use setWorkspaceNotificationDestinations(java.util.Collection) or withWorkspaceNotificationDestinations(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NotificationDestinationType

withWorkspaceNotificationDestinations

public CreateWorkspaceRequest withWorkspaceNotificationDestinations(Collection<String> workspaceNotificationDestinations)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NotificationDestinationType

withWorkspaceNotificationDestinations

public CreateWorkspaceRequest withWorkspaceNotificationDestinations(NotificationDestinationType... workspaceNotificationDestinations)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NotificationDestinationType

getWorkspaceOrganizationalUnits

public List<String> getWorkspaceOrganizationalUnits()

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.

Returns:

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.

setWorkspaceOrganizationalUnits

public void setWorkspaceOrganizationalUnits(Collection<String> workspaceOrganizationalUnits)

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.

Parameters:

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

withWorkspaceOrganizationalUnits

public CreateWorkspaceRequest withWorkspaceOrganizationalUnits(String... workspaceOrganizationalUnits)

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.

NOTE: This method appends the values to the existing list (if any). Use setWorkspaceOrganizationalUnits(java.util.Collection) or withWorkspaceOrganizationalUnits(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withWorkspaceOrganizationalUnits

public CreateWorkspaceRequest withWorkspaceOrganizationalUnits(Collection<String> workspaceOrganizationalUnits)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setWorkspaceRoleArn

public void setWorkspaceRoleArn(String workspaceRoleArn)

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.

Parameters:

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

getWorkspaceRoleArn

public String getWorkspaceRoleArn()

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.

Returns:

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.

withWorkspaceRoleArn

public CreateWorkspaceRequest withWorkspaceRoleArn(String workspaceRoleArn)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateWorkspaceRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()