Package 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("software.amazon.awssdk:codegen") public final class UpdateWorkspaceRequest extends GrafanaRequest implements ToCopyableBuilder<UpdateWorkspaceRequest.Builder,UpdateWorkspaceRequest>

  • Method Details

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

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

    • networkAccessControl

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

      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.

    • organizationRoleName

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

      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.

    • permissionType

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

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

    • permissionTypeAsString

      public final String permissionTypeAsString()

      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.

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

    • removeNetworkAccessConfiguration

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

      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.

    • removeVpcConfiguration

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

      Returns:
      Whether to remove the VPC configuration from the workspace.

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

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

    • vpcConfiguration

      public final VpcConfiguration vpcConfiguration()

      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.

    • workspaceDataSources

      public final List<DataSourceType> workspaceDataSources()

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

      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:
      This parameter is for internal use only, and should not be used.

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

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

      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:
      This parameter is for internal use only, and should not be used.

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

      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.

    • toBuilder

      public UpdateWorkspaceRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateWorkspaceRequest.Builder,UpdateWorkspaceRequest>
      Specified by:
      toBuilder in class GrafanaRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.