Package software.amazon.awssdk.services.grafana.model

Interface WorkspaceDescription.Builder

All Superinterfaces:
Buildable, CopyableBuilder<WorkspaceDescription.Builder,WorkspaceDescription>, SdkBuilder<WorkspaceDescription.Builder,WorkspaceDescription>, SdkPojo
Enclosing class:
WorkspaceDescription
public static interface WorkspaceDescription.Builder extends SdkPojo, CopyableBuilder<WorkspaceDescription.Builder,WorkspaceDescription>

  • Method Details

    • accountAccessType

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

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

    • authentication

      WorkspaceDescription.Builder authentication(AuthenticationSummary authentication)

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

      Parameters:
      authentication - A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • 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 the AuthenticationSummary.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).

      Parameters:
      authentication - a consumer that will call methods on AuthenticationSummary.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • created

      WorkspaceDescription.Builder created(Instant 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.

    • dataSourcesWithStrings

      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.

      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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSourcesWithStrings

      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.

      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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSources

      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.

      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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSources

      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.

      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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      WorkspaceDescription.Builder description(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.

    • endpoint

      WorkspaceDescription.Builder endpoint(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.

    • freeTrialConsumed

      WorkspaceDescription.Builder freeTrialConsumed(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.

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

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • freeTrialExpiration

      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.

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

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

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • grafanaToken

      WorkspaceDescription.Builder grafanaToken(String grafanaToken)

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

      Parameters:
      grafanaToken - The token that ties this workspace to a Grafana Labs account. For more information, see Register with Grafana Labs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • grafanaVersion

      WorkspaceDescription.Builder grafanaVersion(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.

    • id

      WorkspaceDescription.Builder id(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.

    • licenseExpiration

      WorkspaceDescription.Builder licenseExpiration(Instant licenseExpiration)

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

      Parameters:
      licenseExpiration - If this workspace has a full Grafana Enterprise license purchased through Amazon Web Services Marketplace, this specifies when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • licenseType

      WorkspaceDescription.Builder licenseType(String licenseType)

      Specifies whether this workspace has a full Grafana Enterprise license.

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

      Parameters:
      licenseType - Specifies whether this workspace has a full Grafana Enterprise license.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • licenseType

      WorkspaceDescription.Builder licenseType(LicenseType licenseType)

      Specifies whether this workspace has a full Grafana Enterprise license.

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

      Parameters:
      licenseType - Specifies whether this workspace has a full Grafana Enterprise license.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • modified

      WorkspaceDescription.Builder modified(Instant 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.

    • name

      WorkspaceDescription.Builder name(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.

    • networkAccessControl

      WorkspaceDescription.Builder networkAccessControl(NetworkAccessConfiguration networkAccessControl)

      The configuration settings for network access to your workspace.

      Parameters:
      networkAccessControl - The configuration settings for network access to your workspace.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkAccessControl

      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 the NetworkAccessConfiguration.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).

      Parameters:
      networkAccessControl - a consumer that will call methods on NetworkAccessConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • notificationDestinationsWithStrings

      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.

      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.

    • notificationDestinationsWithStrings

      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.

      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.

    • notificationDestinations

      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.

      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.

    • notificationDestinations

      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.

      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.

    • organizationRoleName

      WorkspaceDescription.Builder organizationRoleName(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.

    • organizationalUnits

      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.

      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.

    • organizationalUnits

      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.

      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.

    • permissionType

      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

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • permissionType

      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.

      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

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • stackSetName

      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.

      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.

    • status

      WorkspaceDescription.Builder status(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:

    • status

      WorkspaceDescription.Builder status(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:

    • tags

      WorkspaceDescription.Builder tags(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.

    • vpcConfiguration

      WorkspaceDescription.Builder vpcConfiguration(VpcConfiguration vpcConfiguration)

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

      Parameters:
      vpcConfiguration - The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfiguration

      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 the VpcConfiguration.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).

      Parameters:
      vpcConfiguration - a consumer that will call methods on VpcConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • workspaceRoleArn

      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.

      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.