com.amazonaws.services.managedgrafana.model

Class UpdateWorkspaceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.managedgrafana.model.UpdateWorkspaceRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateWorkspaceRequest
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
UpdateWorkspaceRequest()

Method Summary

Modifier and Type	Method and Description
UpdateWorkspaceRequest	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.
NetworkAccessConfiguration	getNetworkAccessControl() The configuration settings for network access to your workspace.
String	getOrganizationRoleName() The name of an IAM role that already exists to use to access resources through Organizations.
String	getPermissionType() Use this parameter if you want to change a workspace from SERVICE_MANAGED to CUSTOMER_MANAGED.
Boolean	getRemoveNetworkAccessConfiguration() Whether to remove the network access configuration from the workspace.
Boolean	getRemoveVpcConfiguration() Whether to remove the VPC configuration from the workspace.
String	getStackSetName() The name of the CloudFormation stack set to use to generate IAM roles to be used for this 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	getWorkspaceId() The ID of the workspace to update.
String	getWorkspaceName() A new name for the workspace to update.
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() Specifies an IAM role that grants permissions to Amazon Web Services resources that the workspace accesses, such as data sources and notification channels.
int	hashCode()
Boolean	isRemoveNetworkAccessConfiguration() Whether to remove the network access configuration from the workspace.
Boolean	isRemoveVpcConfiguration() Whether to remove the VPC configuration from the workspace.
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	setNetworkAccessControl(NetworkAccessConfiguration networkAccessControl) The configuration settings for network access to your workspace.
void	setOrganizationRoleName(String organizationRoleName) The name of an IAM role that already exists to use to access resources through Organizations.
void	setPermissionType(String permissionType) Use this parameter if you want to change a workspace from SERVICE_MANAGED to CUSTOMER_MANAGED.
void	setRemoveNetworkAccessConfiguration(Boolean removeNetworkAccessConfiguration) Whether to remove the network access configuration from the workspace.
void	setRemoveVpcConfiguration(Boolean removeVpcConfiguration) Whether to remove the VPC configuration from the workspace.
void	setStackSetName(String stackSetName) The name of the CloudFormation stack set to use to generate IAM roles to be used for this 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	setWorkspaceId(String workspaceId) The ID of the workspace to update.
void	setWorkspaceName(String workspaceName) A new name for the workspace to update.
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) Specifies an IAM role that grants permissions to Amazon Web Services resources that the workspace accesses, such as data sources and notification channels.
String	toString() Returns a string representation of this object.
UpdateWorkspaceRequest	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.
UpdateWorkspaceRequest	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.
UpdateWorkspaceRequest	withNetworkAccessControl(NetworkAccessConfiguration networkAccessControl) The configuration settings for network access to your workspace.
UpdateWorkspaceRequest	withOrganizationRoleName(String organizationRoleName) The name of an IAM role that already exists to use to access resources through Organizations.
UpdateWorkspaceRequest	withPermissionType(PermissionType permissionType) Use this parameter if you want to change a workspace from SERVICE_MANAGED to CUSTOMER_MANAGED.
UpdateWorkspaceRequest	withPermissionType(String permissionType) Use this parameter if you want to change a workspace from SERVICE_MANAGED to CUSTOMER_MANAGED.
UpdateWorkspaceRequest	withRemoveNetworkAccessConfiguration(Boolean removeNetworkAccessConfiguration) Whether to remove the network access configuration from the workspace.
UpdateWorkspaceRequest	withRemoveVpcConfiguration(Boolean removeVpcConfiguration) Whether to remove the VPC configuration from the workspace.
UpdateWorkspaceRequest	withStackSetName(String stackSetName) The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
UpdateWorkspaceRequest	withVpcConfiguration(VpcConfiguration vpcConfiguration) The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
UpdateWorkspaceRequest	withWorkspaceDataSources(Collection<String> workspaceDataSources) This parameter is for internal use only, and should not be used.
UpdateWorkspaceRequest	withWorkspaceDataSources(DataSourceType... workspaceDataSources) This parameter is for internal use only, and should not be used.
UpdateWorkspaceRequest	withWorkspaceDataSources(String... workspaceDataSources) This parameter is for internal use only, and should not be used.
UpdateWorkspaceRequest	withWorkspaceDescription(String workspaceDescription) A description for the workspace.
UpdateWorkspaceRequest	withWorkspaceId(String workspaceId) The ID of the workspace to update.
UpdateWorkspaceRequest	withWorkspaceName(String workspaceName) A new name for the workspace to update.
UpdateWorkspaceRequest	withWorkspaceNotificationDestinations(Collection<String> workspaceNotificationDestinations) Specify the Amazon Web Services notification channels that you plan to use in this workspace.
UpdateWorkspaceRequest	withWorkspaceNotificationDestinations(NotificationDestinationType... workspaceNotificationDestinations) Specify the Amazon Web Services notification channels that you plan to use in this workspace.
UpdateWorkspaceRequest	withWorkspaceNotificationDestinations(String... workspaceNotificationDestinations) Specify the Amazon Web Services notification channels that you plan to use in this workspace.
UpdateWorkspaceRequest	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.
UpdateWorkspaceRequest	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.
UpdateWorkspaceRequest	withWorkspaceRoleArn(String workspaceRoleArn) Specifies an IAM role that grants permissions to Amazon Web Services resources that the workspace accesses, such as 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

UpdateWorkspaceRequest

public UpdateWorkspaceRequest()

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 UpdateWorkspaceRequest 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 UpdateWorkspaceRequest 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

setNetworkAccessControl

public void setNetworkAccessControl(NetworkAccessConfiguration networkAccessControl)

The configuration settings 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 - The configuration settings 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()

The configuration settings 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:

The configuration settings 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 UpdateWorkspaceRequest withNetworkAccessControl(NetworkAccessConfiguration networkAccessControl)

The configuration settings 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 - The configuration settings 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 to access resources through Organizations. This can only be used with a workspace that has the permissionType set to CUSTOMER_MANAGED.

Parameters:

organizationRoleName - The name of an IAM role that already exists to use to access resources through Organizations. This can only be used with a workspace that has the permissionType set to CUSTOMER_MANAGED.

getOrganizationRoleName

public String getOrganizationRoleName()

The name of an IAM role that already exists to use to access resources through Organizations. This can only be used with a workspace that has the permissionType set to CUSTOMER_MANAGED.

Returns:

The name of an IAM role that already exists to use to access resources through Organizations. This can only be used with a workspace that has the permissionType set to CUSTOMER_MANAGED.

withOrganizationRoleName

public UpdateWorkspaceRequest withOrganizationRoleName(String organizationRoleName)

The name of an IAM role that already exists to use to access resources through Organizations. This can only be used with a workspace that has the permissionType set to CUSTOMER_MANAGED.

Parameters:

organizationRoleName - The name of an IAM role that already exists to use to access resources through Organizations. This can only be used with a workspace that has the permissionType set to CUSTOMER_MANAGED.

Returns:

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

setPermissionType

public void setPermissionType(String permissionType)

Use this parameter if you want to change a workspace from SERVICE_MANAGED to CUSTOMER_MANAGED. This allows you to manage the permissions that the workspace uses to access datasources and notification channels. If the workspace is in a member Amazon Web Services account of an organization, and that account 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.

If you specify this as CUSTOMER_MANAGED, you must also specify a workspaceRoleArn that the workspace will use for accessing Amazon Web Services resources.

For more information on the role and permissions needed, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

Do not use this to convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED. Do not include this parameter if you want to leave the workspace as SERVICE_MANAGED.

You can convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED using the Amazon Managed Grafana console. For more information, see Managing permissions for data sources and notification channels.

Parameters:

permissionType - Use this parameter if you want to change a workspace from SERVICE_MANAGED to CUSTOMER_MANAGED. This allows you to manage the permissions that the workspace uses to access datasources and notification channels. If the workspace is in a member Amazon Web Services account of an organization, and that account 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.

If you specify this as CUSTOMER_MANAGED, you must also specify a workspaceRoleArn that the workspace will use for accessing Amazon Web Services resources.

For more information on the role and permissions needed, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

Do not use this to convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED. Do not include this parameter if you want to leave the workspace as SERVICE_MANAGED.

You can convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED using the Amazon Managed Grafana console. For more information, see Managing permissions for data sources and notification channels.

See Also:

PermissionType

getPermissionType

public String getPermissionType()

Use this parameter if you want to change a workspace from SERVICE_MANAGED to CUSTOMER_MANAGED. This allows you to manage the permissions that the workspace uses to access datasources and notification channels. If the workspace is in a member Amazon Web Services account of an organization, and that account 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.

If you specify this as CUSTOMER_MANAGED, you must also specify a workspaceRoleArn that the workspace will use for accessing Amazon Web Services resources.

For more information on the role and permissions needed, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

Do not use this to convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED. Do not include this parameter if you want to leave the workspace as SERVICE_MANAGED.

You can convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED using the Amazon Managed Grafana console. For more information, see Managing permissions for data sources and notification channels.

Returns:

Use this parameter if you want to change a workspace from SERVICE_MANAGED to CUSTOMER_MANAGED. This allows you to manage the permissions that the workspace uses to access datasources and notification channels. If the workspace is in a member Amazon Web Services account of an organization, and that account 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.

If you specify this as CUSTOMER_MANAGED, you must also specify a workspaceRoleArn that the workspace will use for accessing Amazon Web Services resources.

For more information on the role and permissions needed, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

Do not use this to convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED. Do not include this parameter if you want to leave the workspace as SERVICE_MANAGED.

You can convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED using the Amazon Managed Grafana console. For more information, see Managing permissions for data sources and notification channels.

See Also:

PermissionType

withPermissionType

public UpdateWorkspaceRequest withPermissionType(String permissionType)

Use this parameter if you want to change a workspace from SERVICE_MANAGED to CUSTOMER_MANAGED. This allows you to manage the permissions that the workspace uses to access datasources and notification channels. If the workspace is in a member Amazon Web Services account of an organization, and that account 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.

If you specify this as CUSTOMER_MANAGED, you must also specify a workspaceRoleArn that the workspace will use for accessing Amazon Web Services resources.

For more information on the role and permissions needed, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

Do not use this to convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED. Do not include this parameter if you want to leave the workspace as SERVICE_MANAGED.

You can convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED using the Amazon Managed Grafana console. For more information, see Managing permissions for data sources and notification channels.

Parameters:

permissionType - Use this parameter if you want to change a workspace from SERVICE_MANAGED to CUSTOMER_MANAGED. This allows you to manage the permissions that the workspace uses to access datasources and notification channels. If the workspace is in a member Amazon Web Services account of an organization, and that account 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.

If you specify this as CUSTOMER_MANAGED, you must also specify a workspaceRoleArn that the workspace will use for accessing Amazon Web Services resources.

For more information on the role and permissions needed, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

Do not use this to convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED. Do not include this parameter if you want to leave the workspace as SERVICE_MANAGED.

You can convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED using the Amazon Managed Grafana console. For more information, see Managing permissions for 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 UpdateWorkspaceRequest withPermissionType(PermissionType permissionType)

Use this parameter if you want to change a workspace from SERVICE_MANAGED to CUSTOMER_MANAGED. This allows you to manage the permissions that the workspace uses to access datasources and notification channels. If the workspace is in a member Amazon Web Services account of an organization, and that account 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.

If you specify this as CUSTOMER_MANAGED, you must also specify a workspaceRoleArn that the workspace will use for accessing Amazon Web Services resources.

For more information on the role and permissions needed, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

Do not use this to convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED. Do not include this parameter if you want to leave the workspace as SERVICE_MANAGED.

You can convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED using the Amazon Managed Grafana console. For more information, see Managing permissions for data sources and notification channels.

Parameters:

permissionType - Use this parameter if you want to change a workspace from SERVICE_MANAGED to CUSTOMER_MANAGED. This allows you to manage the permissions that the workspace uses to access datasources and notification channels. If the workspace is in a member Amazon Web Services account of an organization, and that account 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.

If you specify this as CUSTOMER_MANAGED, you must also specify a workspaceRoleArn that the workspace will use for accessing Amazon Web Services resources.

For more information on the role and permissions needed, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

Do not use this to convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED. Do not include this parameter if you want to leave the workspace as SERVICE_MANAGED.

You can convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED using the Amazon Managed Grafana console. For more information, see Managing permissions for data sources and notification channels.

Returns:

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

See Also:

PermissionType

setRemoveNetworkAccessConfiguration

public void setRemoveNetworkAccessConfiguration(Boolean removeNetworkAccessConfiguration)

Whether to remove the network access configuration from the workspace.

Setting this to true and providing a networkAccessControl to set will return an error.

If you remove this configuration by setting this to true, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.

Parameters:

removeNetworkAccessConfiguration - Whether to remove the network access configuration from the workspace.

Setting this to true and providing a networkAccessControl to set will return an error.

If you remove this configuration by setting this to true, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.

getRemoveNetworkAccessConfiguration

public Boolean getRemoveNetworkAccessConfiguration()

Whether to remove the network access configuration from the workspace.

Setting this to true and providing a networkAccessControl to set will return an error.

If you remove this configuration by setting this to true, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.

Returns:

Whether to remove the network access configuration from the workspace.

Setting this to true and providing a networkAccessControl to set will return an error.

If you remove this configuration by setting this to true, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.

withRemoveNetworkAccessConfiguration

public UpdateWorkspaceRequest withRemoveNetworkAccessConfiguration(Boolean removeNetworkAccessConfiguration)

Whether to remove the network access configuration from the workspace.

Setting this to true and providing a networkAccessControl to set will return an error.

If you remove this configuration by setting this to true, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.

Parameters:

removeNetworkAccessConfiguration - Whether to remove the network access configuration from the workspace.

Setting this to true and providing a networkAccessControl to set will return an error.

If you remove this configuration by setting this to true, 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.

isRemoveNetworkAccessConfiguration

public Boolean isRemoveNetworkAccessConfiguration()

Whether to remove the network access configuration from the workspace.

Setting this to true and providing a networkAccessControl to set will return an error.

If you remove this configuration by setting this to true, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.

Returns:

Whether to remove the network access configuration from the workspace.

Setting this to true and providing a networkAccessControl to set will return an error.

If you remove this configuration by setting this to true, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.

setRemoveVpcConfiguration

public void setRemoveVpcConfiguration(Boolean removeVpcConfiguration)

Whether to remove the VPC configuration from the workspace.

Setting this to true and providing a vpcConfiguration to set will return an error.

Parameters:

removeVpcConfiguration - Whether to remove the VPC configuration from the workspace.

Setting this to true and providing a vpcConfiguration to set will return an error.

getRemoveVpcConfiguration

public Boolean getRemoveVpcConfiguration()

Whether to remove the VPC configuration from the workspace.

Setting this to true and providing a vpcConfiguration to set will return an error.

Returns:

Whether to remove the VPC configuration from the workspace.

Setting this to true and providing a vpcConfiguration to set will return an error.

withRemoveVpcConfiguration

public UpdateWorkspaceRequest withRemoveVpcConfiguration(Boolean removeVpcConfiguration)

Whether to remove the VPC configuration from the workspace.

Setting this to true and providing a vpcConfiguration to set will return an error.

Parameters:

removeVpcConfiguration - Whether to remove the VPC configuration from the workspace.

Setting this to true and providing a vpcConfiguration to set will return an error.

Returns:

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

isRemoveVpcConfiguration

public Boolean isRemoveVpcConfiguration()

Whether to remove the VPC configuration from the workspace.

Setting this to true and providing a vpcConfiguration to set will return an error.

Returns:

Whether to remove the VPC configuration from the workspace.

Setting this to true and providing a vpcConfiguration to set will return an error.

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

setVpcConfiguration

public void setVpcConfiguration(VpcConfiguration vpcConfiguration)

The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

Parameters:

vpcConfiguration - The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

getVpcConfiguration

public VpcConfiguration getVpcConfiguration()

The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

Returns:

The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

withVpcConfiguration

public UpdateWorkspaceRequest withVpcConfiguration(VpcConfiguration vpcConfiguration)

The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

Parameters:

vpcConfiguration - The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

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

Parameters:

workspaceDescription - A description for the workspace. This is used only to help you identify this workspace.

getWorkspaceDescription

public String getWorkspaceDescription()

A description for the workspace. This is used only to help you identify this workspace.

Returns:

A description for the workspace. This is used only to help you identify this workspace.

withWorkspaceDescription

public UpdateWorkspaceRequest withWorkspaceDescription(String workspaceDescription)

A description for the workspace. This is used only to help you identify this workspace.

Parameters:

workspaceDescription - A description for the workspace. This is used only to help you identify this workspace.

Returns:

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

setWorkspaceId

public void setWorkspaceId(String workspaceId)

The ID of the workspace to update.

Parameters:

workspaceId - The ID of the workspace to update.

getWorkspaceId

public String getWorkspaceId()

The ID of the workspace to update.

Returns:

The ID of the workspace to update.

withWorkspaceId

public UpdateWorkspaceRequest withWorkspaceId(String workspaceId)

The ID of the workspace to update.

Parameters:

workspaceId - The ID of the workspace to update.

Returns:

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

setWorkspaceName

public void setWorkspaceName(String workspaceName)

A new name for the workspace to update.

Parameters:

workspaceName - A new name for the workspace to update.

getWorkspaceName

public String getWorkspaceName()

A new name for the workspace to update.

Returns:

A new name for the workspace to update.

withWorkspaceName

public UpdateWorkspaceRequest withWorkspaceName(String workspaceName)

A new name for the workspace to update.

Parameters:

workspaceName - A new name for the workspace to update.

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

Specifies an IAM role that grants permissions to Amazon Web Services resources that the workspace accesses, such as data sources and notification channels. If this workspace has permissionType CUSTOMER_MANAGED, then this role is required.

Parameters:

workspaceRoleArn - Specifies an IAM role that grants permissions to Amazon Web Services resources that the workspace accesses, such as data sources and notification channels. If this workspace has permissionType CUSTOMER_MANAGED, then this role is required.

getWorkspaceRoleArn

public String getWorkspaceRoleArn()

Specifies an IAM role that grants permissions to Amazon Web Services resources that the workspace accesses, such as data sources and notification channels. If this workspace has permissionType CUSTOMER_MANAGED, then this role is required.

Returns:

Specifies an IAM role that grants permissions to Amazon Web Services resources that the workspace accesses, such as data sources and notification channels. If this workspace has permissionType CUSTOMER_MANAGED, then this role is required.

withWorkspaceRoleArn

public UpdateWorkspaceRequest withWorkspaceRoleArn(String workspaceRoleArn)

Specifies an IAM role that grants permissions to Amazon Web Services resources that the workspace accesses, such as data sources and notification channels. If this workspace has permissionType CUSTOMER_MANAGED, then this role is required.

Parameters:

workspaceRoleArn - Specifies an IAM role that grants permissions to Amazon Web Services resources that the workspace accesses, such as data sources and notification channels. If this workspace has permissionType CUSTOMER_MANAGED, then this role is required.

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