software.amazon.awssdk.services.grafana.model

Class UpdateWorkspaceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.grafana.model.GrafanaRequest

software.amazon.awssdk.services.grafana.model.UpdateWorkspaceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateWorkspaceRequest.Builder,UpdateWorkspaceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateWorkspaceRequest
extends GrafanaRequest
implements ToCopyableBuilder<UpdateWorkspaceRequest.Builder,UpdateWorkspaceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateWorkspaceRequest.Builder

Method Summary

Modifier and Type	Method and Description
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.
String	accountAccessTypeAsString() 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.
static UpdateWorkspaceRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasWorkspaceDataSources() For responses, this returns true if the service returned a value for the WorkspaceDataSources property.
boolean	hasWorkspaceNotificationDestinations() For responses, this returns true if the service returned a value for the WorkspaceNotificationDestinations property.
boolean	hasWorkspaceOrganizationalUnits() For responses, this returns true if the service returned a value for the WorkspaceOrganizationalUnits property.
String	organizationRoleName() The name of an IAM role that already exists to use to access resources through Organizations.
PermissionType	permissionType() If you specify Service Managed, Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
String	permissionTypeAsString() If you specify Service Managed, Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateWorkspaceRequest.Builder>	serializableBuilderClass()
String	stackSetName() The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
UpdateWorkspaceRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<DataSourceType>	workspaceDataSources() Specify the Amazon Web Services data sources that you want to be queried in this workspace.
List<String>	workspaceDataSourcesAsStrings() Specify the Amazon Web Services data sources that you want to be queried in this workspace.
String	workspaceDescription() A description for the workspace.
String	workspaceId() The ID of the workspace to update.
String	workspaceName() A new name for the workspace to update.
List<NotificationDestinationType>	workspaceNotificationDestinations() Specify the Amazon Web Services notification channels that you plan to use in this workspace.
List<String>	workspaceNotificationDestinationsAsStrings() Specify the Amazon Web Services notification channels that you plan to use in this workspace.
List<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.
String	workspaceRoleArn() The workspace needs an IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

accountAccessType

public final 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.

If the service returns an enum value that is not available in the current SDK version, accountAccessType will return AccountAccessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accountAccessTypeAsString().

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

accountAccessTypeAsString

public final String accountAccessTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, accountAccessType will return AccountAccessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accountAccessTypeAsString().

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

organizationRoleName

public final String organizationRoleName()

The name of an IAM role that already exists to use to access resources through Organizations.

Returns:

The name of an IAM role that already exists to use to access resources through Organizations.

permissionType

public final PermissionType permissionType()

If you specify Service Managed, Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

If you specify CUSTOMER_MANAGED, you will manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization 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.

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

If the service returns an enum value that is not available in the current SDK version, permissionType will return PermissionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from permissionTypeAsString().

Returns:

If you specify Service Managed, Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

If you specify CUSTOMER_MANAGED, you will manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization 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.

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

See Also:

PermissionType

permissionTypeAsString

public final String permissionTypeAsString()

If you specify Service Managed, Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

If you specify CUSTOMER_MANAGED, you will manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization 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.

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

If the service returns an enum value that is not available in the current SDK version, permissionType will return PermissionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from permissionTypeAsString().

Returns:

If you specify Service Managed, Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

If you specify CUSTOMER_MANAGED, you will manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization 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.

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

See Also:

PermissionType

stackSetName

public final String stackSetName()

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.

workspaceDataSources

public final List<DataSourceType> workspaceDataSources()

Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.

If you don't specify a data source here, you can still add it as a data source later in the workspace console. However, you will then have to manually configure permissions for it.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWorkspaceDataSources() method.

Returns:

Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.

If you don't specify a data source here, you can still add it as a data source later in the workspace console. However, you will then have to manually configure permissions for it.

hasWorkspaceDataSources

public final boolean hasWorkspaceDataSources()

For responses, this returns true if the service returned a value for the WorkspaceDataSources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

workspaceDataSourcesAsStrings

public final List<String> workspaceDataSourcesAsStrings()

Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.

If you don't specify a data source here, you can still add it as a data source later in the workspace console. However, you will then have to manually configure permissions for it.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWorkspaceDataSources() method.

Returns:

Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.

If you don't specify a data source here, you can still add it as a data source later in the workspace console. However, you will then have to manually configure permissions for it.

workspaceDescription

public final String workspaceDescription()

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.

workspaceId

public final String workspaceId()

The ID of the workspace to update.

Returns:

The ID of the workspace to update.

workspaceName

public final String workspaceName()

A new name for the workspace to update.

Returns:

A new name for the workspace to update.

workspaceNotificationDestinations

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWorkspaceNotificationDestinations() method.

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.

hasWorkspaceNotificationDestinations

public final boolean hasWorkspaceNotificationDestinations()

For responses, this returns true if the service returned a value for the WorkspaceNotificationDestinations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

workspaceNotificationDestinationsAsStrings

public final List<String> workspaceNotificationDestinationsAsStrings()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWorkspaceNotificationDestinations() method.

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.

hasWorkspaceOrganizationalUnits

public final boolean hasWorkspaceOrganizationalUnits()

For responses, this returns true if the service returned a value for the WorkspaceOrganizationalUnits property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

workspaceOrganizationalUnits

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWorkspaceOrganizationalUnits() method.

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.

workspaceRoleArn

public final String workspaceRoleArn()

The workspace needs an IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. If you already have a role that you want to use, specify it here. If you omit this field and you specify some Amazon Web Services resources in workspaceDataSources or workspaceNotificationDestinations, a new IAM role with the necessary permissions is automatically created.

Returns:

The workspace needs an IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. If you already have a role that you want to use, specify it here. If you omit this field and you specify some Amazon Web Services resources in workspaceDataSources or workspaceNotificationDestinations, a new IAM role with the necessary permissions is automatically created.

toBuilder

public UpdateWorkspaceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateWorkspaceRequest.Builder,UpdateWorkspaceRequest>

Specified by:

toBuilder in class GrafanaRequest

builder

public static UpdateWorkspaceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateWorkspaceRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo