Class WorkspaceDescription

java.lang.Object
software.amazon.awssdk.services.grafana.model.WorkspaceDescription
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<WorkspaceDescription.Builder,WorkspaceDescription>
@Generated("software.amazon.awssdk:codegen") public final class WorkspaceDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WorkspaceDescription.Builder,WorkspaceDescription>

A structure containing information about an Amazon Managed Grafana workspace in your account.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    WorkspaceDescription.Builder
     

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    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.
    final AuthenticationSummary
    authentication()
    A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
    static WorkspaceDescription.Builder
    builder()
     
    final Instant
    created()
    The date that the workspace was created.
    final List<DataSourceType>
    dataSources()
    Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.
    final List<String>
    dataSourcesAsStrings()
    Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.
    final String
    description()
    The user-defined description of the workspace.
    final String
    endpoint()
    The URL that users can use to access the Grafana console in the workspace.
    final boolean
    equals(Object obj)
     
    final boolean
    equalsBySdkFields(Object obj)
    Indicates whether some other object is "equal to" this one by SDK fields.
    final Boolean
    freeTrialConsumed()
    Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
    final Instant
    freeTrialExpiration()
    If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
    final <T> Optional<T>
    getValueForField(String fieldName, Class<T> clazz)
     
    final String
    grafanaToken()
    The token that ties this workspace to a Grafana Labs account.
    final String
    grafanaVersion()
    The version of Grafana supported in this workspace.
    final boolean
    hasDataSources()
    For responses, this returns true if the service returned a value for the DataSources property.
    final int
    hashCode()
     
    final boolean
    hasNotificationDestinations()
    For responses, this returns true if the service returned a value for the NotificationDestinations property.
    final boolean
    hasOrganizationalUnits()
    For responses, this returns true if the service returned a value for the OrganizationalUnits property.
    final boolean
    hasTags()
    For responses, this returns true if the service returned a value for the Tags property.
    final String
    id()
    The unique ID of this workspace.
    final Instant
    licenseExpiration()
    If this workspace has a full Grafana Enterprise license purchased through Amazon Web Services Marketplace, this specifies when the license ends and will need to be renewed.
    final LicenseType
    licenseType()
    Specifies whether this workspace has a full Grafana Enterprise license.
    final String
    licenseTypeAsString()
    Specifies whether this workspace has a full Grafana Enterprise license.
    final Instant
    modified()
    The most recent date that the workspace was modified.
    final String
    name()
    The name of the workspace.
    final NetworkAccessConfiguration
    networkAccessControl()
    The configuration settings for network access to your workspace.
    final List<NotificationDestinationType>
    notificationDestinations()
    The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.
    final List<String>
    notificationDestinationsAsStrings()
    The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.
    final List<String>
    organizationalUnits()
    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.
    final String
    organizationRoleName()
    The name of the IAM role that is used to access resources through Organizations.
    final PermissionType
    permissionType()
    If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then 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.
    final String
    permissionTypeAsString()
    If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then 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.
    final List<SdkField<?>>
    sdkFields()
     
    static Class<? extends WorkspaceDescription.Builder>
    serializableBuilderClass()
     
    final String
    stackSetName()
    The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
    final WorkspaceStatus
    status()
    The current status of the workspace.
    final String
    statusAsString()
    The current status of the workspace.
    final Map<String,String>
    tags()
    The list of tags associated with the workspace.
    WorkspaceDescription.Builder
    toBuilder()
    Take this object and create a builder that contains all of the current property values of this object.
    final String
    toString()
    Returns a string representation of this object.
    final VpcConfiguration
    vpcConfiguration()
    The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
    final String
    workspaceRoleArn()
    The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

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

    copy

  • 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 this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.

      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 this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.
      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 this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.

      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 this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.
      See Also:

    • authentication

      public final AuthenticationSummary authentication()

      A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

      Returns:
      A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

    • created

      public final Instant created()

      The date that the workspace was created.

      Returns:
      The date that the workspace was created.

    • dataSources

      public final List<DataSourceType> dataSources()

      Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.

      This list is only used when the workspace was created through the Amazon Web Services console, and the permissionType is SERVICE_MANAGED.

      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 hasDataSources() method.

      Returns:
      Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.

      This list is only used when the workspace was created through the Amazon Web Services console, and the permissionType is SERVICE_MANAGED.

    • hasDataSources

      public final boolean hasDataSources()
      For responses, this returns true if the service returned a value for the DataSources 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.

    • dataSourcesAsStrings

      public final List<String> dataSourcesAsStrings()

      Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.

      This list is only used when the workspace was created through the Amazon Web Services console, and the permissionType is SERVICE_MANAGED.

      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 hasDataSources() method.

      Returns:
      Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.

      This list is only used when the workspace was created through the Amazon Web Services console, and the permissionType is SERVICE_MANAGED.

    • description

      public final String description()

      The user-defined description of the workspace.

      Returns:
      The user-defined description of the workspace.

    • endpoint

      public final String endpoint()

      The URL that users can use to access the Grafana console in the workspace.

      Returns:
      The URL that users can use to access the Grafana console in the workspace.

    • freeTrialConsumed

      public final Boolean freeTrialConsumed()

      Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.

      Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

      Returns:
      Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.

      Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

    • freeTrialExpiration

      public final Instant freeTrialExpiration()

      If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.

      Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

      Returns:
      If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.

      Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

    • grafanaToken

      public final String grafanaToken()

      The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.

      Returns:
      The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.

    • grafanaVersion

      public final String grafanaVersion()

      The version of Grafana supported in this workspace.

      Returns:
      The version of Grafana supported in this workspace.

    • id

      public final String id()

      The unique ID of this workspace.

      Returns:
      The unique ID of this workspace.

    • licenseExpiration

      public final Instant licenseExpiration()

      If this workspace has a full Grafana Enterprise license purchased through Amazon Web Services Marketplace, this specifies when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed.

      Returns:
      If this workspace has a full Grafana Enterprise license purchased through Amazon Web Services Marketplace, this specifies when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed.

    • licenseType

      public final LicenseType licenseType()

      Specifies whether this workspace has a full Grafana Enterprise license.

      Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

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

      Returns:
      Specifies whether this workspace has a full Grafana Enterprise license.

      Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

      See Also:

    • licenseTypeAsString

      public final String licenseTypeAsString()

      Specifies whether this workspace has a full Grafana Enterprise license.

      Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

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

      Returns:
      Specifies whether this workspace has a full Grafana Enterprise license.

      Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

      See Also:

    • modified

      public final Instant modified()

      The most recent date that the workspace was modified.

      Returns:
      The most recent date that the workspace was modified.

    • name

      public final String name()

      The name of the workspace.

      Returns:
      The name of the workspace.

    • networkAccessControl

      public final NetworkAccessConfiguration networkAccessControl()

      The configuration settings for network access to your workspace.

      Returns:
      The configuration settings for network access to your workspace.

    • notificationDestinations

      public final List<NotificationDestinationType> notificationDestinations()

      The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to 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 hasNotificationDestinations() method.

      Returns:
      The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.

    • hasNotificationDestinations

      public final boolean hasNotificationDestinations()
      For responses, this returns true if the service returned a value for the NotificationDestinations 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.

    • notificationDestinationsAsStrings

      public final List<String> notificationDestinationsAsStrings()

      The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to 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 hasNotificationDestinations() method.

      Returns:
      The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.

    • organizationRoleName

      public final String organizationRoleName()

      The name of the IAM role that is used to access resources through Organizations.

      Returns:
      The name of the IAM role that is used to access resources through Organizations.

    • hasOrganizationalUnits

      public final boolean hasOrganizationalUnits()
      For responses, this returns true if the service returned a value for the OrganizationalUnits 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.

    • organizationalUnits

      public final List<String> organizationalUnits()

      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 hasOrganizationalUnits() 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.

    • permissionType

      public final PermissionType permissionType()

      If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then 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 this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.

      If you are working with a 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, this parameter must be set to CUSTOMER_MANAGED.

      For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, 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 this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then 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 this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.

      If you are working with a 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, this parameter must be set to CUSTOMER_MANAGED.

      For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

      See Also:

    • permissionTypeAsString

      public final String permissionTypeAsString()

      If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then 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 this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.

      If you are working with a 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, this parameter must be set to CUSTOMER_MANAGED.

      For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, 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 this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then 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 this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.

      If you are working with a 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, this parameter must be set to CUSTOMER_MANAGED.

      For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

      See Also:

    • stackSetName

      public final String stackSetName()

      The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.

      Returns:
      The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.

    • status

      public final WorkspaceStatus status()

      The current status of the workspace.

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

      Returns:
      The current status of the workspace.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the workspace.

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

      Returns:
      The current status of the workspace.
      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final Map<String,String> tags()

      The list of tags associated with the workspace.

      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 hasTags() method.

      Returns:
      The list of tags associated with the workspace.

    • vpcConfiguration

      public final VpcConfiguration vpcConfiguration()

      The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).

      Returns:
      The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).

    • workspaceRoleArn

      public final String workspaceRoleArn()

      The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.

      Returns:
      The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.

    • toBuilder

      public WorkspaceDescription.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<WorkspaceDescription.Builder,WorkspaceDescription>
      Returns:
      a builder for type T

    • builder

      public static WorkspaceDescription.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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