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

Interface CreateWorkspaceRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateWorkspaceRequest.Builder,CreateWorkspaceRequest>, GrafanaRequest.Builder, SdkBuilder<CreateWorkspaceRequest.Builder,CreateWorkspaceRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateWorkspaceRequest
public static interface CreateWorkspaceRequest.Builder extends GrafanaRequest.Builder, SdkPojo, CopyableBuilder<CreateWorkspaceRequest.Builder,CreateWorkspaceRequest>

  • Method Details

    • accountAccessType

      CreateWorkspaceRequest.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 you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.

      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 you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • accountAccessType

      CreateWorkspaceRequest.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 you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.

      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 you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authenticationProvidersWithStrings

      CreateWorkspaceRequest.Builder authenticationProvidersWithStrings(Collection<String> authenticationProviders)

      Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

      Parameters:
      authenticationProviders - Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authenticationProvidersWithStrings

      CreateWorkspaceRequest.Builder authenticationProvidersWithStrings(String... authenticationProviders)

      Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

      Parameters:
      authenticationProviders - Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authenticationProviders

      CreateWorkspaceRequest.Builder authenticationProviders(Collection<AuthenticationProviderTypes> authenticationProviders)

      Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

      Parameters:
      authenticationProviders - Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authenticationProviders

      CreateWorkspaceRequest.Builder authenticationProviders(AuthenticationProviderTypes... authenticationProviders)

      Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

      Parameters:
      authenticationProviders - Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateWorkspaceRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

      Parameters:
      clientToken - A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      CreateWorkspaceRequest.Builder configuration(String configuration)

      The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.

      Parameters:
      configuration - The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • grafanaVersion

      CreateWorkspaceRequest.Builder grafanaVersion(String grafanaVersion)

      Specifies the version of Grafana to support in the new workspace. If not specified, defaults to the latest version (for example, 10.4).

      To get a list of supported versions, use the ListVersions operation.

      Parameters:
      grafanaVersion - Specifies the version of Grafana to support in the new workspace. If not specified, defaults to the latest version (for example, 10.4).

      To get a list of supported versions, use the ListVersions operation.

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

    • networkAccessControl

      CreateWorkspaceRequest.Builder networkAccessControl(NetworkAccessConfiguration networkAccessControl)

      Configuration for network access to your workspace.

      When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.

      If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.

      Parameters:
      networkAccessControl - Configuration for network access to your workspace.

      When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.

      If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.

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

    • networkAccessControl

      default CreateWorkspaceRequest.Builder networkAccessControl(Consumer<NetworkAccessConfiguration.Builder> networkAccessControl)

      Configuration for network access to your workspace.

      When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.

      If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.

      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:

    • organizationRoleName

      CreateWorkspaceRequest.Builder organizationRoleName(String organizationRoleName)

      The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.

      Parameters:
      organizationRoleName - The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissionType

      CreateWorkspaceRequest.Builder permissionType(String permissionType)

      When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

      You must also specify a workspaceRoleArn for a role that you will manage for the workspace to use when accessing those datasources and notification channels.

      The ability for Amazon Managed Grafana to create and update IAM roles on behalf of the user is supported only in the Amazon Managed Grafana console, where this value may be set to SERVICE_MANAGED.

      Use only the CUSTOMER_MANAGED permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation.

      For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels.

      Parameters:
      permissionType - When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

      You must also specify a workspaceRoleArn for a role that you will manage for the workspace to use when accessing those datasources and notification channels.

      The ability for Amazon Managed Grafana to create and update IAM roles on behalf of the user is supported only in the Amazon Managed Grafana console, where this value may be set to SERVICE_MANAGED.

      Use only the CUSTOMER_MANAGED permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation.

      For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels.

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

    • permissionType

      CreateWorkspaceRequest.Builder permissionType(PermissionType permissionType)

      When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

      You must also specify a workspaceRoleArn for a role that you will manage for the workspace to use when accessing those datasources and notification channels.

      The ability for Amazon Managed Grafana to create and update IAM roles on behalf of the user is supported only in the Amazon Managed Grafana console, where this value may be set to SERVICE_MANAGED.

      Use only the CUSTOMER_MANAGED permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation.

      For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels.

      Parameters:
      permissionType - When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

      You must also specify a workspaceRoleArn for a role that you will manage for the workspace to use when accessing those datasources and notification channels.

      The ability for Amazon Managed Grafana to create and update IAM roles on behalf of the user is supported only in the Amazon Managed Grafana console, where this value may be set to SERVICE_MANAGED.

      Use only the CUSTOMER_MANAGED permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation.

      For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels.

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

    • stackSetName

      CreateWorkspaceRequest.Builder stackSetName(String stackSetName)

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

      Parameters:
      stackSetName - The name of the CloudFormation stack set to use 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.

    • tags

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

      CreateWorkspaceRequest.Builder vpcConfiguration(VpcConfiguration vpcConfiguration)

      The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

      Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).

      Parameters:
      vpcConfiguration - The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

      Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).

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

    • vpcConfiguration

      default CreateWorkspaceRequest.Builder vpcConfiguration(Consumer<VpcConfiguration.Builder> vpcConfiguration)

      The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

      Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).

      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:

    • workspaceDataSourcesWithStrings

      CreateWorkspaceRequest.Builder workspaceDataSourcesWithStrings(Collection<String> workspaceDataSources)

      This parameter is for internal use only, and should not be used.

      Parameters:
      workspaceDataSources - This parameter is for internal use only, and should not be used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceDataSourcesWithStrings

      CreateWorkspaceRequest.Builder workspaceDataSourcesWithStrings(String... workspaceDataSources)

      This parameter is for internal use only, and should not be used.

      Parameters:
      workspaceDataSources - This parameter is for internal use only, and should not be used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceDataSources

      CreateWorkspaceRequest.Builder workspaceDataSources(Collection<DataSourceType> workspaceDataSources)

      This parameter is for internal use only, and should not be used.

      Parameters:
      workspaceDataSources - This parameter is for internal use only, and should not be used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceDataSources

      CreateWorkspaceRequest.Builder workspaceDataSources(DataSourceType... workspaceDataSources)

      This parameter is for internal use only, and should not be used.

      Parameters:
      workspaceDataSources - This parameter is for internal use only, and should not be used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceDescription

      CreateWorkspaceRequest.Builder workspaceDescription(String workspaceDescription)

      A description for the workspace. This is used only to help you identify this workspace.

      Pattern: ^[\\p{L}\\p{Z}\\p{N}\\p{P}]{0,2048}$

      Parameters:
      workspaceDescription - A description for the workspace. This is used only to help you identify this workspace.

      Pattern: ^[\\p{L}\\p{Z}\\p{N}\\p{P}]{0,2048}$

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

    • workspaceName

      CreateWorkspaceRequest.Builder workspaceName(String workspaceName)

      The name for the workspace. It does not have to be unique.

      Parameters:
      workspaceName - The name for the workspace. It does not have to be unique.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceNotificationDestinationsWithStrings

      CreateWorkspaceRequest.Builder workspaceNotificationDestinationsWithStrings(Collection<String> workspaceNotificationDestinations)

      Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.

      Parameters:
      workspaceNotificationDestinations - Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceNotificationDestinationsWithStrings

      CreateWorkspaceRequest.Builder workspaceNotificationDestinationsWithStrings(String... workspaceNotificationDestinations)

      Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.

      Parameters:
      workspaceNotificationDestinations - Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceNotificationDestinations

      CreateWorkspaceRequest.Builder workspaceNotificationDestinations(Collection<NotificationDestinationType> workspaceNotificationDestinations)

      Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.

      Parameters:
      workspaceNotificationDestinations - Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceNotificationDestinations

      CreateWorkspaceRequest.Builder workspaceNotificationDestinations(NotificationDestinationType... workspaceNotificationDestinations)

      Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.

      Parameters:
      workspaceNotificationDestinations - Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceOrganizationalUnits

      CreateWorkspaceRequest.Builder workspaceOrganizationalUnits(Collection<String> workspaceOrganizationalUnits)

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

    • workspaceOrganizationalUnits

      CreateWorkspaceRequest.Builder workspaceOrganizationalUnits(String... workspaceOrganizationalUnits)

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

    • workspaceRoleArn

      CreateWorkspaceRequest.Builder workspaceRoleArn(String workspaceRoleArn)

      Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data sources and notification channels. You are responsible for managing the permissions for this role as new data sources or notification channels are added.

      Parameters:
      workspaceRoleArn - Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data sources and notification channels. You are responsible for managing the permissions for this role as new data sources or notification channels are added.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateWorkspaceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateWorkspaceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.