public static interface WorkspaceDescription.Builder extends SdkPojo, CopyableBuilder<WorkspaceDescription.Builder,WorkspaceDescription>
| Modifier and Type | Method and Description |
|---|---|
WorkspaceDescription.Builder |
accountAccessType(AccountAccessType accountAccessType)
Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account
only, or whether it can also access Amazon Web Services resources in other accounts in the same organization.
|
WorkspaceDescription.Builder |
accountAccessType(String accountAccessType)
Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account
only, or whether it can also access Amazon Web Services resources in other accounts in the same organization.
|
WorkspaceDescription.Builder |
authentication(AuthenticationSummary authentication)
A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user
authentication.
|
default WorkspaceDescription.Builder |
authentication(Consumer<AuthenticationSummary.Builder> authentication)
A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user
authentication.
|
WorkspaceDescription.Builder |
created(Instant created)
The date that the workspace was created.
|
WorkspaceDescription.Builder |
dataSources(Collection<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.Builder |
dataSources(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.Builder |
dataSourcesWithStrings(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.Builder |
dataSourcesWithStrings(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.Builder |
description(String description)
The user-defined description of the workspace.
|
WorkspaceDescription.Builder |
endpoint(String endpoint)
The URL that users can use to access the Grafana console in the workspace.
|
WorkspaceDescription.Builder |
freeTrialConsumed(Boolean freeTrialConsumed)
Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
|
WorkspaceDescription.Builder |
freeTrialExpiration(Instant freeTrialExpiration)
If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when
that free trial ends.
|
WorkspaceDescription.Builder |
grafanaVersion(String grafanaVersion)
The version of Grafana supported in this workspace.
|
WorkspaceDescription.Builder |
id(String id)
The unique ID of this workspace.
|
WorkspaceDescription.Builder |
licenseExpiration(Instant licenseExpiration)
If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need
to be renewed.
|
WorkspaceDescription.Builder |
licenseType(LicenseType licenseType)
Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
|
WorkspaceDescription.Builder |
licenseType(String licenseType)
Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
|
WorkspaceDescription.Builder |
modified(Instant modified)
The most recent date that the workspace was modified.
|
WorkspaceDescription.Builder |
name(String name)
The name of the workspace.
|
default WorkspaceDescription.Builder |
networkAccessControl(Consumer<NetworkAccessConfiguration.Builder> networkAccessControl)
The configuration settings for network access to your workspace.
|
WorkspaceDescription.Builder |
networkAccessControl(NetworkAccessConfiguration networkAccessControl)
The configuration settings for network access to your workspace.
|
WorkspaceDescription.Builder |
notificationDestinations(Collection<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.Builder |
notificationDestinations(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.Builder |
notificationDestinationsWithStrings(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.Builder |
notificationDestinationsWithStrings(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.Builder |
organizationalUnits(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.Builder |
organizationalUnits(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.Builder |
organizationRoleName(String organizationRoleName)
The name of the IAM role that is used to access resources through Organizations.
|
WorkspaceDescription.Builder |
permissionType(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.Builder |
permissionType(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.Builder |
stackSetName(String stackSetName)
The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
|
WorkspaceDescription.Builder |
status(String status)
The current status of the workspace.
|
WorkspaceDescription.Builder |
status(WorkspaceStatus status)
The current status of the workspace.
|
WorkspaceDescription.Builder |
tags(Map<String,String> tags)
The list of tags associated with the workspace.
|
default WorkspaceDescription.Builder |
vpcConfiguration(Consumer<VpcConfiguration.Builder> vpcConfiguration)
The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
|
WorkspaceDescription.Builder |
vpcConfiguration(VpcConfiguration vpcConfiguration)
The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
|
WorkspaceDescription.Builder |
workspaceRoleArn(String workspaceRoleArn)
The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data
from.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildWorkspaceDescription.Builder accountAccessType(String accountAccessType)
Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account
only, or whether it can also access Amazon Web Services resources in other accounts in the same organization.
If 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,
AccountAccessTypeWorkspaceDescription.Builder accountAccessType(AccountAccessType accountAccessType)
Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account
only, or whether it can also access Amazon Web Services resources in other accounts in the same organization.
If 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,
AccountAccessTypeWorkspaceDescription.Builder authentication(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.default WorkspaceDescription.Builder authentication(Consumer<AuthenticationSummary.Builder> authentication)
A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
This is a convenience method that creates an instance of theAuthenticationSummary.Builder avoiding
the need to create one manually via AuthenticationSummary.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to authentication(AuthenticationSummary).
authentication - a consumer that will call methods on AuthenticationSummary.Builderauthentication(AuthenticationSummary)WorkspaceDescription.Builder created(Instant created)
The date that the workspace was created.
created - The date that the workspace was created.WorkspaceDescription.Builder dataSourcesWithStrings(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.
WorkspaceDescription.Builder dataSourcesWithStrings(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.
WorkspaceDescription.Builder dataSources(Collection<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.
WorkspaceDescription.Builder dataSources(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.
WorkspaceDescription.Builder description(String description)
The user-defined description of the workspace.
description - The user-defined description of the workspace.WorkspaceDescription.Builder endpoint(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.WorkspaceDescription.Builder freeTrialConsumed(Boolean freeTrialConsumed)
Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
freeTrialConsumed - Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.WorkspaceDescription.Builder freeTrialExpiration(Instant freeTrialExpiration)
If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
freeTrialExpiration - If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies
when that free trial ends.WorkspaceDescription.Builder grafanaVersion(String grafanaVersion)
The version of Grafana supported in this workspace.
grafanaVersion - The version of Grafana supported in this workspace.WorkspaceDescription.Builder id(String id)
The unique ID of this workspace.
id - The unique ID of this workspace.WorkspaceDescription.Builder licenseExpiration(Instant licenseExpiration)
If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
licenseExpiration - If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will
need to be renewed.WorkspaceDescription.Builder licenseType(String licenseType)
Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
licenseType - Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.LicenseType,
LicenseTypeWorkspaceDescription.Builder licenseType(LicenseType licenseType)
Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
licenseType - Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.LicenseType,
LicenseTypeWorkspaceDescription.Builder modified(Instant modified)
The most recent date that the workspace was modified.
modified - The most recent date that the workspace was modified.WorkspaceDescription.Builder name(String name)
The name of the workspace.
name - The name of the workspace.WorkspaceDescription.Builder networkAccessControl(NetworkAccessConfiguration networkAccessControl)
The configuration settings for network access to your workspace.
networkAccessControl - The configuration settings for network access to your workspace.default WorkspaceDescription.Builder networkAccessControl(Consumer<NetworkAccessConfiguration.Builder> networkAccessControl)
The configuration settings for network access to your workspace.
This is a convenience method that creates an instance of theNetworkAccessConfiguration.Builder
avoiding the need to create one manually via NetworkAccessConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to networkAccessControl(NetworkAccessConfiguration).
networkAccessControl - a consumer that will call methods on NetworkAccessConfiguration.BuildernetworkAccessControl(NetworkAccessConfiguration)WorkspaceDescription.Builder notificationDestinationsWithStrings(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.WorkspaceDescription.Builder notificationDestinationsWithStrings(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.WorkspaceDescription.Builder notificationDestinations(Collection<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.WorkspaceDescription.Builder notificationDestinations(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.WorkspaceDescription.Builder organizationRoleName(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.WorkspaceDescription.Builder organizationalUnits(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.WorkspaceDescription.Builder organizationalUnits(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.WorkspaceDescription.Builder permissionType(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,
PermissionTypeWorkspaceDescription.Builder permissionType(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,
PermissionTypeWorkspaceDescription.Builder stackSetName(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.WorkspaceDescription.Builder status(String status)
The current status of the workspace.
status - The current status of the workspace.WorkspaceStatus,
WorkspaceStatusWorkspaceDescription.Builder status(WorkspaceStatus status)
The current status of the workspace.
status - The current status of the workspace.WorkspaceStatus,
WorkspaceStatusWorkspaceDescription.Builder tags(Map<String,String> tags)
The list of tags associated with the workspace.
tags - The list of tags associated with the workspace.WorkspaceDescription.Builder vpcConfiguration(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).default WorkspaceDescription.Builder vpcConfiguration(Consumer<VpcConfiguration.Builder> vpcConfiguration)
The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
This is a convenience method that creates an instance of theVpcConfiguration.Builder avoiding the
need to create one manually via VpcConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to vpcConfiguration(VpcConfiguration).
vpcConfiguration - a consumer that will call methods on VpcConfiguration.BuildervpcConfiguration(VpcConfiguration)WorkspaceDescription.Builder workspaceRoleArn(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.Copyright © 2023. All rights reserved.