WorkspaceDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.managedgrafana.model.WorkspaceDescription

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class WorkspaceDescription
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A structure containing information about an Amazon Managed Grafana workspace in your account.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WorkspaceDescription()

Constructors
Constructor and Description
`WorkspaceDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkspaceDescription`	`addTagsEntry(String key, String value)` Add a single Tags entry
`WorkspaceDescription`	`clearTagsEntries()` Removes all the entries added into Tags.
`WorkspaceDescription`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAccountAccessType()` 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.
`AuthenticationSummary`	`getAuthentication()` A structure that describes whether the workspace uses SAML, Amazon Web Services SSO, or both methods for user authentication.
`Date`	`getCreated()` The date that the workspace was created.
`List<String>`	`getDataSources()` 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.
`String`	`getDescription()` The user-defined description of the workspace.
`String`	`getEndpoint()` The URL that users can use to access the Grafana console in the workspace.
`Boolean`	`getFreeTrialConsumed()` Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
`Date`	`getFreeTrialExpiration()` If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
`String`	`getGrafanaVersion()` The version of Grafana supported in this workspace.
`String`	`getId()` The unique ID of this workspace.
`Date`	`getLicenseExpiration()` If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
`String`	`getLicenseType()` Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
`Date`	`getModified()` The most recent date that the workspace was modified.
`String`	`getName()` The name of the workspace.
`List<String>`	`getNotificationDestinations()` 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.
`List<String>`	`getOrganizationalUnits()` Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.
`String`	`getOrganizationRoleName()` The name of the IAM role that is used to access resources through Organizations.
`String`	`getPermissionType()` If this is `Service Managed`, Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
`String`	`getStackSetName()` The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
`String`	`getStatus()` The current status of the workspace.
`Map<String,String>`	`getTags()` The list of tags associated with the workspace.
`String`	`getWorkspaceRoleArn()` The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from.
`int`	`hashCode()`
`Boolean`	`isFreeTrialConsumed()` Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAccountAccessType(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.
`void`	`setAuthentication(AuthenticationSummary authentication)` A structure that describes whether the workspace uses SAML, Amazon Web Services SSO, or both methods for user authentication.
`void`	`setCreated(Date created)` The date that the workspace was created.
`void`	`setDataSources(Collection<String> 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.
`void`	`setDescription(String description)` The user-defined description of the workspace.
`void`	`setEndpoint(String endpoint)` The URL that users can use to access the Grafana console in the workspace.
`void`	`setFreeTrialConsumed(Boolean freeTrialConsumed)` Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
`void`	`setFreeTrialExpiration(Date freeTrialExpiration)` If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
`void`	`setGrafanaVersion(String grafanaVersion)` The version of Grafana supported in this workspace.
`void`	`setId(String id)` The unique ID of this workspace.
`void`	`setLicenseExpiration(Date licenseExpiration)` If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
`void`	`setLicenseType(String licenseType)` Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
`void`	`setModified(Date modified)` The most recent date that the workspace was modified.
`void`	`setName(String name)` The name of the workspace.
`void`	`setNotificationDestinations(Collection<String> 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.
`void`	`setOrganizationalUnits(Collection<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.
`void`	`setOrganizationRoleName(String organizationRoleName)` The name of the IAM role that is used to access resources through Organizations.
`void`	`setPermissionType(String permissionType)` If this is `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.
`void`	`setStackSetName(String stackSetName)` The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
`void`	`setStatus(String status)` The current status of the workspace.
`void`	`setTags(Map<String,String> tags)` The list of tags associated with the workspace.
`void`	`setWorkspaceRoleArn(String workspaceRoleArn)` The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from.
`String`	`toString()` Returns a string representation of this object.
`WorkspaceDescription`	`withAccountAccessType(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.
`WorkspaceDescription`	`withAccountAccessType(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.
`WorkspaceDescription`	`withAuthentication(AuthenticationSummary authentication)` A structure that describes whether the workspace uses SAML, Amazon Web Services SSO, or both methods for user authentication.
`WorkspaceDescription`	`withCreated(Date created)` The date that the workspace was created.
`WorkspaceDescription`	`withDataSources(Collection<String> 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.
`WorkspaceDescription`	`withDataSources(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.
`WorkspaceDescription`	`withDataSources(String... 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.
`WorkspaceDescription`	`withDescription(String description)` The user-defined description of the workspace.
`WorkspaceDescription`	`withEndpoint(String endpoint)` The URL that users can use to access the Grafana console in the workspace.
`WorkspaceDescription`	`withFreeTrialConsumed(Boolean freeTrialConsumed)` Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
`WorkspaceDescription`	`withFreeTrialExpiration(Date freeTrialExpiration)` If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
`WorkspaceDescription`	`withGrafanaVersion(String grafanaVersion)` The version of Grafana supported in this workspace.
`WorkspaceDescription`	`withId(String id)` The unique ID of this workspace.
`WorkspaceDescription`	`withLicenseExpiration(Date licenseExpiration)` If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
`WorkspaceDescription`	`withLicenseType(LicenseType licenseType)` Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
`WorkspaceDescription`	`withLicenseType(String licenseType)` Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
`WorkspaceDescription`	`withModified(Date modified)` The most recent date that the workspace was modified.
`WorkspaceDescription`	`withName(String name)` The name of the workspace.
`WorkspaceDescription`	`withNotificationDestinations(Collection<String> 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.
`WorkspaceDescription`	`withNotificationDestinations(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.
`WorkspaceDescription`	`withNotificationDestinations(String... 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.
`WorkspaceDescription`	`withOrganizationalUnits(Collection<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.
`WorkspaceDescription`	`withOrganizationalUnits(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.
`WorkspaceDescription`	`withOrganizationRoleName(String organizationRoleName)` The name of the IAM role that is used to access resources through Organizations.
`WorkspaceDescription`	`withPermissionType(PermissionType permissionType)` If this is `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.
`WorkspaceDescription`	`withPermissionType(String permissionType)` If this is `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.
`WorkspaceDescription`	`withStackSetName(String stackSetName)` The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
`WorkspaceDescription`	`withStatus(String status)` The current status of the workspace.
`WorkspaceDescription`	`withStatus(WorkspaceStatus status)` The current status of the workspace.
`WorkspaceDescription`	`withTags(Map<String,String> tags)` The list of tags associated with the workspace.
`WorkspaceDescription`	`withWorkspaceRoleArn(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

- Constructor Detail
  - WorkspaceDescription
```
public WorkspaceDescription()
```
- Method Detail
  - setAccountAccessType
```
public void setAccountAccessType(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 this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.
    
    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 this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.
    
    See Also:
    
    AccountAccessType
  - getAccountAccessType
```
public String getAccountAccessType()
```
    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.
    
    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:
    
    AccountAccessType
  - withAccountAccessType
```
public WorkspaceDescription withAccountAccessType(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 this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.
    
    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 this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AccountAccessType
  - withAccountAccessType
```
public WorkspaceDescription withAccountAccessType(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.
    
    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 this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AccountAccessType
  - setAuthentication
```
public void setAuthentication(AuthenticationSummary authentication)
```
    A structure that describes whether the workspace uses SAML, Amazon Web Services SSO, or both methods for user authentication.
    
    Parameters:
    
    authentication - A structure that describes whether the workspace uses SAML, Amazon Web Services SSO, or both methods for user authentication.
  - getAuthentication
```
public AuthenticationSummary getAuthentication()
```
    A structure that describes whether the workspace uses SAML, Amazon Web Services SSO, or both methods for user authentication.
    
    Returns:
    
    A structure that describes whether the workspace uses SAML, Amazon Web Services SSO, or both methods for user authentication.
  - withAuthentication
```
public WorkspaceDescription withAuthentication(AuthenticationSummary authentication)
```
    A structure that describes whether the workspace uses SAML, Amazon Web Services SSO, or both methods for user authentication.
    
    Parameters:
    
    authentication - A structure that describes whether the workspace uses SAML, Amazon Web Services SSO, or both methods for user authentication.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreated
```
public void setCreated(Date created)
```
    The date that the workspace was created.
    
    Parameters:
    
    created - The date that the workspace was created.
  - getCreated
```
public Date getCreated()
```
    The date that the workspace was created.
    
    Returns:
    
    The date that the workspace was created.
  - withCreated
```
public WorkspaceDescription withCreated(Date created)
```
    The date that the workspace was created.
    
    Parameters:
    
    created - The date that the workspace was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDataSources
```
public List<String> getDataSources()
```
    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.
    
    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.
    
    See Also:
    
    DataSourceType
  - setDataSources
```
public void setDataSources(Collection<String> 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    DataSourceType
  - withDataSources
```
public WorkspaceDescription withDataSources(String... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setDataSources(java.util.Collection) or withDataSources(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DataSourceType
  - withDataSources
```
public WorkspaceDescription withDataSources(Collection<String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DataSourceType
  - withDataSources
```
public WorkspaceDescription withDataSources(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DataSourceType
  - setDescription
```
public void setDescription(String description)
```
    The user-defined description of the workspace.
    
    Parameters:
    
    description - The user-defined description of the workspace.
  - getDescription
```
public String getDescription()
```
    The user-defined description of the workspace.
    
    Returns:
    
    The user-defined description of the workspace.
  - withDescription
```
public WorkspaceDescription withDescription(String description)
```
    The user-defined description of the workspace.
    
    Parameters:
    
    description - The user-defined description of the workspace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    The URL that users can use to access the Grafana console in the workspace.
    
    Parameters:
    
    endpoint - The URL that users can use to access the Grafana console in the workspace.
  - getEndpoint
```
public String getEndpoint()
```
    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.
  - withEndpoint
```
public WorkspaceDescription withEndpoint(String endpoint)
```
    The URL that users can use to access the Grafana console in the workspace.
    
    Parameters:
    
    endpoint - The URL that users can use to access the Grafana console in the workspace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFreeTrialConsumed
```
public void setFreeTrialConsumed(Boolean freeTrialConsumed)
```
    Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
    
    Parameters:
    
    freeTrialConsumed - Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
  - getFreeTrialConsumed
```
public Boolean getFreeTrialConsumed()
```
    Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
    
    Returns:
    
    Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
  - withFreeTrialConsumed
```
public WorkspaceDescription withFreeTrialConsumed(Boolean freeTrialConsumed)
```
    Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
    
    Parameters:
    
    freeTrialConsumed - Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isFreeTrialConsumed
```
public Boolean isFreeTrialConsumed()
```
    Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
    
    Returns:
    
    Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
  - setFreeTrialExpiration
```
public void setFreeTrialExpiration(Date freeTrialExpiration)
```
    If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
    
    Parameters:
    
    freeTrialExpiration - If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
  - getFreeTrialExpiration
```
public Date getFreeTrialExpiration()
```
    If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
    
    Returns:
    
    If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
  - withFreeTrialExpiration
```
public WorkspaceDescription withFreeTrialExpiration(Date freeTrialExpiration)
```
    If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
    
    Parameters:
    
    freeTrialExpiration - If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGrafanaVersion
```
public void setGrafanaVersion(String grafanaVersion)
```
    The version of Grafana supported in this workspace.
    
    Parameters:
    
    grafanaVersion - The version of Grafana supported in this workspace.
  - getGrafanaVersion
```
public String getGrafanaVersion()
```
    The version of Grafana supported in this workspace.
    
    Returns:
    
    The version of Grafana supported in this workspace.
  - withGrafanaVersion
```
public WorkspaceDescription withGrafanaVersion(String grafanaVersion)
```
    The version of Grafana supported in this workspace.
    
    Parameters:
    
    grafanaVersion - The version of Grafana supported in this workspace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    The unique ID of this workspace.
    
    Parameters:
    
    id - The unique ID of this workspace.
  - getId
```
public String getId()
```
    The unique ID of this workspace.
    
    Returns:
    
    The unique ID of this workspace.
  - withId
```
public WorkspaceDescription withId(String id)
```
    The unique ID of this workspace.
    
    Parameters:
    
    id - The unique ID of this workspace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLicenseExpiration
```
public void setLicenseExpiration(Date licenseExpiration)
```
    If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
    
    Parameters:
    
    licenseExpiration - If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
  - getLicenseExpiration
```
public Date getLicenseExpiration()
```
    If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
    
    Returns:
    
    If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
  - withLicenseExpiration
```
public WorkspaceDescription withLicenseExpiration(Date licenseExpiration)
```
    If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
    
    Parameters:
    
    licenseExpiration - If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLicenseType
```
public void setLicenseType(String licenseType)
```
    Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
    
    Parameters:
    
    licenseType - Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
    
    See Also:
    
    LicenseType
  - getLicenseType
```
public String getLicenseType()
```
    Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
    
    Returns:
    
    Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
    
    See Also:
    
    LicenseType
  - withLicenseType
```
public WorkspaceDescription withLicenseType(String licenseType)
```
    Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
    
    Parameters:
    
    licenseType - Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LicenseType
  - withLicenseType
```
public WorkspaceDescription withLicenseType(LicenseType licenseType)
```
    Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
    
    Parameters:
    
    licenseType - Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LicenseType
  - setModified
```
public void setModified(Date modified)
```
    The most recent date that the workspace was modified.
    
    Parameters:
    
    modified - The most recent date that the workspace was modified.
  - getModified
```
public Date getModified()
```
    The most recent date that the workspace was modified.
    
    Returns:
    
    The most recent date that the workspace was modified.
  - withModified
```
public WorkspaceDescription withModified(Date modified)
```
    The most recent date that the workspace was modified.
    
    Parameters:
    
    modified - The most recent date that the workspace was modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the workspace.
    
    Parameters:
    
    name - The name of the workspace.
  - getName
```
public String getName()
```
    The name of the workspace.
    
    Returns:
    
    The name of the workspace.
  - withName
```
public WorkspaceDescription withName(String name)
```
    The name of the workspace.
    
    Parameters:
    
    name - The name of the workspace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getNotificationDestinations
```
public List<String> getNotificationDestinations()
```
    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.
    
    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.
    
    See Also:
    
    NotificationDestinationType
  - setNotificationDestinations
```
public void setNotificationDestinations(Collection<String> 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    NotificationDestinationType
  - withNotificationDestinations
```
public WorkspaceDescription withNotificationDestinations(String... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setNotificationDestinations(java.util.Collection) or withNotificationDestinations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NotificationDestinationType
  - withNotificationDestinations
```
public WorkspaceDescription withNotificationDestinations(Collection<String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NotificationDestinationType
  - withNotificationDestinations
```
public WorkspaceDescription withNotificationDestinations(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NotificationDestinationType
  - setOrganizationRoleName
```
public void setOrganizationRoleName(String organizationRoleName)
```
    The name of the IAM role that is used to access resources through Organizations.
    
    Parameters:
    
    organizationRoleName - The name of the IAM role that is used to access resources through Organizations.
  - getOrganizationRoleName
```
public String getOrganizationRoleName()
```
    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.
  - withOrganizationRoleName
```
public WorkspaceDescription withOrganizationRoleName(String organizationRoleName)
```
    The name of the IAM role that is used to access resources through Organizations.
    
    Parameters:
    
    organizationRoleName - The name of the IAM role that is used to access resources through Organizations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getOrganizationalUnits
```
public List<String> getOrganizationalUnits()
```
    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:
    
    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.
  - setOrganizationalUnits
```
public void setOrganizationalUnits(Collection<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.
    
    Parameters:
    
    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.
  - withOrganizationalUnits
```
public WorkspaceDescription withOrganizationalUnits(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setOrganizationalUnits(java.util.Collection) or withOrganizationalUnits(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withOrganizationalUnits
```
public WorkspaceDescription withOrganizationalUnits(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPermissionType
```
public void setPermissionType(String permissionType)
```
    If this is 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 this is CUSTOMER_MANAGED, you 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 this is 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 this is CUSTOMER_MANAGED, you manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED.
    
    For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
    
    See Also:
    
    PermissionType
  - getPermissionType
```
public String getPermissionType()
```
    If this is 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 this is CUSTOMER_MANAGED, you 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:
    
    If this is 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 this is CUSTOMER_MANAGED, you manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED.
    
    For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
    
    See Also:
    
    PermissionType
  - withPermissionType
```
public WorkspaceDescription withPermissionType(String permissionType)
```
    If this is 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 this is CUSTOMER_MANAGED, you 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 this is 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 this is CUSTOMER_MANAGED, you 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
  - withPermissionType
```
public WorkspaceDescription withPermissionType(PermissionType permissionType)
```
    If this is 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 this is CUSTOMER_MANAGED, you 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 this is 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 this is CUSTOMER_MANAGED, you 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
  - setStackSetName
```
public void setStackSetName(String stackSetName)
```
    The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
    
    Parameters:
    
    stackSetName - The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
  - getStackSetName
```
public String getStackSetName()
```
    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.
  - withStackSetName
```
public WorkspaceDescription withStackSetName(String stackSetName)
```
    The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
    
    Parameters:
    
    stackSetName - The name of the CloudFormation stack set that is used 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.
  - setStatus
```
public void setStatus(String status)
```
    The current status of the workspace.
    
    Parameters:
    
    status - The current status of the workspace.
    
    See Also:
    
    WorkspaceStatus
  - getStatus
```
public String getStatus()
```
    The current status of the workspace.
    
    Returns:
    
    The current status of the workspace.
    
    See Also:
    
    WorkspaceStatus
  - withStatus
```
public WorkspaceDescription withStatus(String status)
```
    The current status of the workspace.
    
    Parameters:
    
    status - The current status of the workspace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkspaceStatus
  - withStatus
```
public WorkspaceDescription withStatus(WorkspaceStatus status)
```
    The current status of the workspace.
    
    Parameters:
    
    status - The current status of the workspace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkspaceStatus
  - getTags
```
public Map<String,String> getTags()
```
    The list of tags associated with the workspace.
    
    Returns:
    
    The list of tags associated with the workspace.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The list of tags associated with the workspace.
    
    Parameters:
    
    tags - The list of tags associated with the workspace.
  - withTags
```
public WorkspaceDescription withTags(Map<String,String> tags)
```
    The list of tags associated with the workspace.
    
    Parameters:
    
    tags - The list of tags associated with the workspace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public WorkspaceDescription addTagsEntry(String key,
                                         String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public WorkspaceDescription clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWorkspaceRoleArn
```
public void setWorkspaceRoleArn(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.
    
    Parameters:
    
    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.
  - getWorkspaceRoleArn
```
public String getWorkspaceRoleArn()
```
    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.
  - withWorkspaceRoleArn
```
public WorkspaceDescription withWorkspaceRoleArn(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public WorkspaceDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class WorkspaceDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkspaceDescription

Method Detail

setAccountAccessType

getAccountAccessType

withAccountAccessType

withAccountAccessType

setAuthentication

getAuthentication

withAuthentication

setCreated

getCreated

withCreated

getDataSources

setDataSources

withDataSources

withDataSources

withDataSources

setDescription

getDescription

withDescription

setEndpoint

getEndpoint

withEndpoint

setFreeTrialConsumed

getFreeTrialConsumed

withFreeTrialConsumed

isFreeTrialConsumed

setFreeTrialExpiration

getFreeTrialExpiration

withFreeTrialExpiration

setGrafanaVersion

getGrafanaVersion

withGrafanaVersion

setId

getId

withId

setLicenseExpiration

getLicenseExpiration

withLicenseExpiration

setLicenseType

getLicenseType

withLicenseType

withLicenseType

setModified

getModified

withModified

setName

getName

withName

getNotificationDestinations

setNotificationDestinations

withNotificationDestinations

withNotificationDestinations

withNotificationDestinations

setOrganizationRoleName

getOrganizationRoleName

withOrganizationRoleName

getOrganizationalUnits

setOrganizationalUnits

withOrganizationalUnits

withOrganizationalUnits

setPermissionType

getPermissionType

withPermissionType

withPermissionType

setStackSetName

getStackSetName

withStackSetName

setStatus

getStatus

withStatus

withStatus

getTags

setTags