Package 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 Details

    • 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

      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:

    • networkAccessControl

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

    • networkAccessControl

      default UpdateWorkspaceRequest.Builder networkAccessControl(Consumer<NetworkAccessConfiguration.Builder> 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.

      This is a convenience method that creates an instance of the NetworkAccessConfiguration.Builder avoiding the need to create one manually via NetworkAccessConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to networkAccessControl(NetworkAccessConfiguration).

      Parameters:
      networkAccessControl - a consumer that will call methods on NetworkAccessConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • organizationRoleName

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

    • permissionType

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

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

    • removeNetworkAccessConfiguration

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

    • removeVpcConfiguration

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

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

    • vpcConfiguration

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

    • vpcConfiguration

      default UpdateWorkspaceRequest.Builder vpcConfiguration(Consumer<VpcConfiguration.Builder> vpcConfiguration)

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

      This is a convenience method that creates an instance of the VpcConfiguration.Builder avoiding the need to create one manually via VpcConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfiguration(VpcConfiguration).

      Parameters:
      vpcConfiguration - a consumer that will call methods on VpcConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • workspaceDataSourcesWithStrings

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

    • workspaceDataSourcesWithStrings

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

    • workspaceDataSources

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

    • workspaceDataSources

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

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

      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.

    • overrideConfiguration

      UpdateWorkspaceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateWorkspaceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.