software.amazon.awssdk.services.grafana.model

Interface UpdateWorkspaceRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateWorkspaceRequest.Builder,UpdateWorkspaceRequest>, GrafanaRequest.Builder, SdkBuilder<UpdateWorkspaceRequest.Builder,UpdateWorkspaceRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateWorkspaceRequest

public static interface UpdateWorkspaceRequest.Builder
extends GrafanaRequest.Builder, SdkPojo, CopyableBuilder<UpdateWorkspaceRequest.Builder,UpdateWorkspaceRequest>

Method Summary

Modifier and Type	Method and Description
UpdateWorkspaceRequest.Builder	accountAccessType(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.Builder	accountAccessType(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.Builder	organizationRoleName(String organizationRoleName) The name of an IAM role that already exists to use to access resources through Organizations.
UpdateWorkspaceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateWorkspaceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateWorkspaceRequest.Builder	permissionType(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.
UpdateWorkspaceRequest.Builder	permissionType(String 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.
UpdateWorkspaceRequest.Builder	stackSetName(String stackSetName) The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
UpdateWorkspaceRequest.Builder	workspaceDataSources(Collection<DataSourceType> workspaceDataSources) Specify the Amazon Web Services data sources that you want to be queried in this workspace.
UpdateWorkspaceRequest.Builder	workspaceDataSources(DataSourceType... workspaceDataSources) Specify the Amazon Web Services data sources that you want to be queried in this workspace.
UpdateWorkspaceRequest.Builder	workspaceDataSourcesWithStrings(Collection<String> workspaceDataSources) Specify the Amazon Web Services data sources that you want to be queried in this workspace.
UpdateWorkspaceRequest.Builder	workspaceDataSourcesWithStrings(String... workspaceDataSources) Specify the Amazon Web Services data sources that you want to be queried in this workspace.
UpdateWorkspaceRequest.Builder	workspaceDescription(String workspaceDescription) A description for the workspace.
UpdateWorkspaceRequest.Builder	workspaceId(String workspaceId) The ID of the workspace to update.
UpdateWorkspaceRequest.Builder	workspaceName(String workspaceName) A new name for the workspace to update.
UpdateWorkspaceRequest.Builder	workspaceNotificationDestinations(Collection<NotificationDestinationType> workspaceNotificationDestinations) Specify the Amazon Web Services notification channels that you plan to use in this workspace.
UpdateWorkspaceRequest.Builder	workspaceNotificationDestinations(NotificationDestinationType... workspaceNotificationDestinations) Specify the Amazon Web Services notification channels that you plan to use in this workspace.
UpdateWorkspaceRequest.Builder	workspaceNotificationDestinationsWithStrings(Collection<String> workspaceNotificationDestinations) Specify the Amazon Web Services notification channels that you plan to use in this workspace.
UpdateWorkspaceRequest.Builder	workspaceNotificationDestinationsWithStrings(String... workspaceNotificationDestinations) Specify the Amazon Web Services notification channels that you plan to use in this workspace.
UpdateWorkspaceRequest.Builder	workspaceOrganizationalUnits(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.Builder	workspaceOrganizationalUnits(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.Builder	workspaceRoleArn(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 interface software.amazon.awssdk.services.grafana.model.GrafanaRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

accountAccessType

UpdateWorkspaceRequest.Builder accountAccessType(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, AccountAccessType

accountAccessType

UpdateWorkspaceRequest.Builder accountAccessType(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, AccountAccessType

organizationRoleName

UpdateWorkspaceRequest.Builder organizationRoleName(String organizationRoleName)

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

Parameters:

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

Returns:

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

permissionType

UpdateWorkspaceRequest.Builder permissionType(String 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

Parameters:

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

Returns:

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

See Also:

PermissionType, PermissionType

permissionType

UpdateWorkspaceRequest.Builder permissionType(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

Parameters:

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

Returns:

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

See Also:

PermissionType, PermissionType

stackSetName

UpdateWorkspaceRequest.Builder stackSetName(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.

workspaceDataSourcesWithStrings

UpdateWorkspaceRequest.Builder workspaceDataSourcesWithStrings(Collection<String> 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.

Parameters:

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.

Returns:

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

workspaceDataSourcesWithStrings

UpdateWorkspaceRequest.Builder workspaceDataSourcesWithStrings(String... 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.

Parameters:

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.

Returns:

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

workspaceDataSources

UpdateWorkspaceRequest.Builder workspaceDataSources(Collection<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.

Parameters:

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.

Returns:

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

workspaceDataSources

UpdateWorkspaceRequest.Builder workspaceDataSources(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.

Parameters:

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.

Returns:

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

workspaceDescription

UpdateWorkspaceRequest.Builder workspaceDescription(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.

workspaceId

UpdateWorkspaceRequest.Builder workspaceId(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.

workspaceName

UpdateWorkspaceRequest.Builder workspaceName(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.

workspaceNotificationDestinationsWithStrings

UpdateWorkspaceRequest.Builder workspaceNotificationDestinationsWithStrings(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.

workspaceNotificationDestinationsWithStrings

UpdateWorkspaceRequest.Builder workspaceNotificationDestinationsWithStrings(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.

workspaceNotificationDestinations

UpdateWorkspaceRequest.Builder workspaceNotificationDestinations(Collection<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.

workspaceNotificationDestinations

UpdateWorkspaceRequest.Builder workspaceNotificationDestinations(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.

workspaceOrganizationalUnits

UpdateWorkspaceRequest.Builder workspaceOrganizationalUnits(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.

workspaceOrganizationalUnits

UpdateWorkspaceRequest.Builder workspaceOrganizationalUnits(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.

workspaceRoleArn

UpdateWorkspaceRequest.Builder workspaceRoleArn(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.

Parameters:

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:

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

overrideConfiguration

UpdateWorkspaceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateWorkspaceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder