@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.
Constructor and Description |
---|
WorkspaceDescription() |
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, IAM Identity Center, 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 |
getGrafanaToken()
The token that ties this workspace to a Grafana Labs account.
|
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 purchased through Amazon Web Services Marketplace, this
specifies when the license ends and will need to be renewed.
|
String |
getLicenseType()
Specifies whether this workspace has a full Grafana Enterprise license.
|
Date |
getModified()
The most recent date that the workspace was modified.
|
String |
getName()
The name of the workspace.
|
NetworkAccessConfiguration |
getNetworkAccessControl()
The configuration settings for network access to your 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 , 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. |
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.
|
VpcConfiguration |
getVpcConfiguration()
The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
|
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, IAM Identity Center, 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 |
setGrafanaToken(String grafanaToken)
The token that ties this workspace to a Grafana Labs account.
|
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 purchased through Amazon Web Services Marketplace, 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.
|
void |
setModified(Date modified)
The most recent date that the workspace was modified.
|
void |
setName(String name)
The name of the workspace.
|
void |
setNetworkAccessControl(NetworkAccessConfiguration networkAccessControl)
The configuration settings for network access to your 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 , 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. |
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 |
setVpcConfiguration(VpcConfiguration vpcConfiguration)
The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
|
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, IAM Identity Center, 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 |
withGrafanaToken(String grafanaToken)
The token that ties this workspace to a Grafana Labs account.
|
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 purchased through Amazon Web Services Marketplace, 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.
|
WorkspaceDescription |
withLicenseType(String licenseType)
Specifies whether this workspace has a full Grafana Enterprise license.
|
WorkspaceDescription |
withModified(Date modified)
The most recent date that the workspace was modified.
|
WorkspaceDescription |
withName(String name)
The name of the workspace.
|
WorkspaceDescription |
withNetworkAccessControl(NetworkAccessConfiguration networkAccessControl)
The configuration settings for network access to your 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 , 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. |
WorkspaceDescription |
withPermissionType(String 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. |
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 |
withVpcConfiguration(VpcConfiguration vpcConfiguration)
The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
|
WorkspaceDescription |
withWorkspaceRoleArn(String workspaceRoleArn)
The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from.
|
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.
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.AccountAccessType
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.
ORGANIZATION
, the workspaceOrganizationalUnits
parameter specifies which organizational units the workspace can access.AccountAccessType
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.
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.AccountAccessType
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.
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.AccountAccessType
public void setAuthentication(AuthenticationSummary authentication)
A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
authentication
- A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user
authentication.public AuthenticationSummary getAuthentication()
A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
public WorkspaceDescription withAuthentication(AuthenticationSummary authentication)
A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
authentication
- A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user
authentication.public void setCreated(Date created)
The date that the workspace was created.
created
- The date that the workspace was created.public Date getCreated()
The date that the workspace was created.
public WorkspaceDescription withCreated(Date created)
The date that the workspace was created.
created
- The date that the workspace was created.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.
This list is only used when the workspace was created through the Amazon Web Services console, and the
permissionType
is SERVICE_MANAGED
.
This list is only used when the workspace was created through the Amazon Web Services console, and the
permissionType
is SERVICE_MANAGED
.
DataSourceType
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.
This list is only used when the workspace was created through the Amazon Web Services console, and the
permissionType
is SERVICE_MANAGED
.
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
.
DataSourceType
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.
This list is only used when the workspace was created through the Amazon Web Services console, and the
permissionType
is SERVICE_MANAGED
.
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.
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
.
DataSourceType
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.
This list is only used when the workspace was created through the Amazon Web Services console, and the
permissionType
is SERVICE_MANAGED
.
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
.
DataSourceType
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.
This list is only used when the workspace was created through the Amazon Web Services console, and the
permissionType
is SERVICE_MANAGED
.
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
.
DataSourceType
public void setDescription(String description)
The user-defined description of the workspace.
description
- The user-defined description of the workspace.public String getDescription()
The user-defined description of the workspace.
public WorkspaceDescription withDescription(String description)
The user-defined description of the workspace.
description
- The user-defined description of the workspace.public void setEndpoint(String endpoint)
The URL that users can use to access the Grafana console in the workspace.
endpoint
- The URL that users can use to access the Grafana console in the workspace.public String getEndpoint()
The URL that users can use to access the Grafana console in the workspace.
public WorkspaceDescription withEndpoint(String endpoint)
The URL that users can use to access the Grafana console in the workspace.
endpoint
- The URL that users can use to access the Grafana console in the workspace.public void setFreeTrialConsumed(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.
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.
public Boolean getFreeTrialConsumed()
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.
Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
public WorkspaceDescription withFreeTrialConsumed(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.
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.
public Boolean isFreeTrialConsumed()
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.
Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
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.
Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
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.
public Date getFreeTrialExpiration()
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.
Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
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.
Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
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.
public void setGrafanaToken(String grafanaToken)
The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.
grafanaToken
- The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.public String getGrafanaToken()
The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.
public WorkspaceDescription withGrafanaToken(String grafanaToken)
The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.
grafanaToken
- The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.public void setGrafanaVersion(String grafanaVersion)
The version of Grafana supported in this workspace.
grafanaVersion
- The version of Grafana supported in this workspace.public String getGrafanaVersion()
The version of Grafana supported in this workspace.
public WorkspaceDescription withGrafanaVersion(String grafanaVersion)
The version of Grafana supported in this workspace.
grafanaVersion
- The version of Grafana supported in this workspace.public void setId(String id)
The unique ID of this workspace.
id
- The unique ID of this workspace.public String getId()
The unique ID of this workspace.
public WorkspaceDescription withId(String id)
The unique ID of this workspace.
id
- The unique ID of this workspace.public void setLicenseExpiration(Date 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.
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.public Date getLicenseExpiration()
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.
public WorkspaceDescription withLicenseExpiration(Date 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.
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.public void setLicenseType(String licenseType)
Specifies whether this workspace has a full Grafana Enterprise license.
Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
licenseType
- Specifies whether this workspace has a full Grafana Enterprise license. Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
LicenseType
public String getLicenseType()
Specifies whether this workspace has a full Grafana Enterprise license.
Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
LicenseType
public WorkspaceDescription withLicenseType(String licenseType)
Specifies whether this workspace has a full Grafana Enterprise license.
Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
licenseType
- Specifies whether this workspace has a full Grafana Enterprise license. Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
LicenseType
public WorkspaceDescription withLicenseType(LicenseType licenseType)
Specifies whether this workspace has a full Grafana Enterprise license.
Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
licenseType
- Specifies whether this workspace has a full Grafana Enterprise license. Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
LicenseType
public void setModified(Date modified)
The most recent date that the workspace was modified.
modified
- The most recent date that the workspace was modified.public Date getModified()
The most recent date that the workspace was modified.
public WorkspaceDescription withModified(Date modified)
The most recent date that the workspace was modified.
modified
- The most recent date that the workspace was modified.public void setName(String name)
The name of the workspace.
name
- The name of the workspace.public String getName()
The name of the workspace.
public WorkspaceDescription withName(String name)
The name of the workspace.
name
- The name of the workspace.public void setNetworkAccessControl(NetworkAccessConfiguration networkAccessControl)
The configuration settings for network access to your workspace.
networkAccessControl
- The configuration settings for network access to your workspace.public NetworkAccessConfiguration getNetworkAccessControl()
The configuration settings for network access to your workspace.
public WorkspaceDescription withNetworkAccessControl(NetworkAccessConfiguration networkAccessControl)
The configuration settings for network access to your workspace.
networkAccessControl
- The configuration settings for network access to your workspace.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.
NotificationDestinationType
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.
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.NotificationDestinationType
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.
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.NotificationDestinationType
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.
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.NotificationDestinationType
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.
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.NotificationDestinationType
public void setOrganizationRoleName(String organizationRoleName)
The name of the IAM role that is used to access resources through Organizations.
organizationRoleName
- The name of the IAM role that is used to access resources through Organizations.public String getOrganizationRoleName()
The name of the IAM role that is used to access resources through Organizations.
public WorkspaceDescription withOrganizationRoleName(String organizationRoleName)
The name of the IAM role that is used to access resources through Organizations.
organizationRoleName
- The name of the IAM role that is used to access resources through Organizations.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.
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.
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.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.
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.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.
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.public void setPermissionType(String 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
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
PermissionType
public String getPermissionType()
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
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
PermissionType
public WorkspaceDescription withPermissionType(String 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
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
PermissionType
public WorkspaceDescription withPermissionType(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
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
PermissionType
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.
stackSetName
- The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.public String getStackSetName()
The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
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.
stackSetName
- The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.public void setStatus(String status)
The current status of the workspace.
status
- The current status of the workspace.WorkspaceStatus
public String getStatus()
The current status of the workspace.
WorkspaceStatus
public WorkspaceDescription withStatus(String status)
The current status of the workspace.
status
- The current status of the workspace.WorkspaceStatus
public WorkspaceDescription withStatus(WorkspaceStatus status)
The current status of the workspace.
status
- The current status of the workspace.WorkspaceStatus
public Map<String,String> getTags()
The list of tags associated with the workspace.
public void setTags(Map<String,String> tags)
The list of tags associated with the workspace.
tags
- The list of tags associated with the workspace.public WorkspaceDescription withTags(Map<String,String> tags)
The list of tags associated with the workspace.
tags
- The list of tags associated with the workspace.public WorkspaceDescription addTagsEntry(String key, String value)
public WorkspaceDescription clearTagsEntries()
public void setVpcConfiguration(VpcConfiguration vpcConfiguration)
The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
vpcConfiguration
- The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).public VpcConfiguration getVpcConfiguration()
The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
public WorkspaceDescription withVpcConfiguration(VpcConfiguration vpcConfiguration)
The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
vpcConfiguration
- The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).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.
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.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.
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.
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.public String toString()
toString
in class Object
Object.toString()
public WorkspaceDescription clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.