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 Summary

Modifier and Type	Method and Description
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.
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.
CreateWorkspaceRequest.Builder	authenticationProviders(AuthenticationProviderTypes... authenticationProviders) Specifies whether this workspace uses SAML 2.0, Amazon Web Services Single Sign On, or both to authenticate users for using the Grafana console within a workspace.
CreateWorkspaceRequest.Builder	authenticationProviders(Collection<AuthenticationProviderTypes> authenticationProviders) Specifies whether this workspace uses SAML 2.0, Amazon Web Services Single Sign On, or both to authenticate users for using the Grafana console within a workspace.
CreateWorkspaceRequest.Builder	authenticationProvidersWithStrings(Collection<String> authenticationProviders) Specifies whether this workspace uses SAML 2.0, Amazon Web Services Single Sign On, or both to authenticate users for using the Grafana console within a workspace.
CreateWorkspaceRequest.Builder	authenticationProvidersWithStrings(String... authenticationProviders) Specifies whether this workspace uses SAML 2.0, Amazon Web Services Single Sign On, or both to authenticate users for using the Grafana console within a workspace.
CreateWorkspaceRequest.Builder	clientToken(String clientToken) A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
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.
CreateWorkspaceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateWorkspaceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateWorkspaceRequest.Builder	permissionType(PermissionType permissionType) If you specify SERVICE_MANAGED on AWS Grafana console, 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.
CreateWorkspaceRequest.Builder	permissionType(String permissionType) If you specify SERVICE_MANAGED on AWS Grafana console, 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.
CreateWorkspaceRequest.Builder	stackSetName(String stackSetName) The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
CreateWorkspaceRequest.Builder	tags(Map<String,String> tags) The list of tags associated with the workspace.
CreateWorkspaceRequest.Builder	workspaceDataSources(Collection<DataSourceType> workspaceDataSources) Specify the Amazon Web Services data sources that you want to be queried in this workspace.
CreateWorkspaceRequest.Builder	workspaceDataSources(DataSourceType... workspaceDataSources) Specify the Amazon Web Services data sources that you want to be queried in this workspace.
CreateWorkspaceRequest.Builder	workspaceDataSourcesWithStrings(Collection<String> workspaceDataSources) Specify the Amazon Web Services data sources that you want to be queried in this workspace.
CreateWorkspaceRequest.Builder	workspaceDataSourcesWithStrings(String... workspaceDataSources) Specify the Amazon Web Services data sources that you want to be queried in this workspace.
CreateWorkspaceRequest.Builder	workspaceDescription(String workspaceDescription) A description for the workspace.
CreateWorkspaceRequest.Builder	workspaceName(String workspaceName) The name for the workspace.
CreateWorkspaceRequest.Builder	workspaceNotificationDestinations(Collection<NotificationDestinationType> workspaceNotificationDestinations) Specify the Amazon Web Services notification channels that you plan to use in this workspace.
CreateWorkspaceRequest.Builder	workspaceNotificationDestinations(NotificationDestinationType... workspaceNotificationDestinations) Specify the Amazon Web Services notification channels that you plan to use in this workspace.
CreateWorkspaceRequest.Builder	workspaceNotificationDestinationsWithStrings(Collection<String> workspaceNotificationDestinations) Specify the Amazon Web Services notification channels that you plan to use in this workspace.
CreateWorkspaceRequest.Builder	workspaceNotificationDestinationsWithStrings(String... workspaceNotificationDestinations) Specify the Amazon Web Services notification channels that you plan to use in this workspace.
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.
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.
CreateWorkspaceRequest.Builder	workspaceRoleArn(String workspaceRoleArn) The workspace needs an IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from.

Methods inherited from interface software.amazon.awssdk.services.grafana.model.GrafanaRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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, AccountAccessType

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:

AccountAccessType, AccountAccessType

authenticationProvidersWithStrings

CreateWorkspaceRequest.Builder authenticationProvidersWithStrings(Collection<String> authenticationProviders)

Specifies whether this workspace uses SAML 2.0, Amazon Web Services Single Sign On, 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, Amazon Web Services Single Sign On, 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, Amazon Web Services Single Sign On, 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, Amazon Web Services Single Sign On, 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, Amazon Web Services Single Sign On, 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, Amazon Web Services Single Sign On, 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, Amazon Web Services Single Sign On, 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, Amazon Web Services Single Sign On, 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.

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)

If you specify SERVICE_MANAGED on AWS Grafana console, 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. In CLI mode, the permissionType SERVICE_MANAGED will not create the IAM role for you.

If you specify CUSTOMER_MANAGED, you will manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization that is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED.

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

Parameters:

permissionType - If you specify SERVICE_MANAGED on AWS Grafana console, 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. In CLI mode, the permissionType SERVICE_MANAGED will not create the IAM role for you.

If you specify CUSTOMER_MANAGED, you will manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization that is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED.

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

Returns:

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

See Also:

PermissionType, PermissionType

permissionType

CreateWorkspaceRequest.Builder permissionType(PermissionType permissionType)

If you specify SERVICE_MANAGED on AWS Grafana console, 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. In CLI mode, the permissionType SERVICE_MANAGED will not create the IAM role for you.

If you specify CUSTOMER_MANAGED, you will manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization that is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED.

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

Parameters:

permissionType - If you specify SERVICE_MANAGED on AWS Grafana console, 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. In CLI mode, the permissionType SERVICE_MANAGED will not create the IAM role for you.

If you specify CUSTOMER_MANAGED, you will manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization that is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED.

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

Returns:

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

See Also:

PermissionType, PermissionType

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.

workspaceDataSourcesWithStrings

CreateWorkspaceRequest.Builder workspaceDataSourcesWithStrings(Collection<String> workspaceDataSources)

Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.

If you don't specify a data source here, you can still add it as a data source in the workspace console later. However, you will then have to manually configure permissions for it.

Parameters:

workspaceDataSources - Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.

If you don't specify a data source here, you can still add it as a data source in the workspace console later. However, you will then have to manually configure permissions for it.

Returns:

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

workspaceDataSourcesWithStrings

CreateWorkspaceRequest.Builder workspaceDataSourcesWithStrings(String... workspaceDataSources)

Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.

If you don't specify a data source here, you can still add it as a data source in the workspace console later. However, you will then have to manually configure permissions for it.

Parameters:

workspaceDataSources - Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.

If you don't specify a data source here, you can still add it as a data source in the workspace console later. However, you will then have to manually configure permissions for it.

Returns:

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

workspaceDataSources

CreateWorkspaceRequest.Builder workspaceDataSources(Collection<DataSourceType> workspaceDataSources)

Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.

If you don't specify a data source here, you can still add it as a data source in the workspace console later. However, you will then have to manually configure permissions for it.

Parameters:

workspaceDataSources - Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.

If you don't specify a data source here, you can still add it as a data source in the workspace console later. However, you will then have to manually configure permissions for it.

Returns:

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

workspaceDataSources

CreateWorkspaceRequest.Builder workspaceDataSources(DataSourceType... workspaceDataSources)

Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.

If you don't specify a data source here, you can still add it as a data source in the workspace console later. However, you will then have to manually configure permissions for it.

Parameters:

workspaceDataSources - Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.

If you don't specify a data source here, you can still add it as a data source in the workspace console later. However, you will then have to manually configure permissions for it.

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)

The workspace needs an IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. If you already have a role that you want to use, specify it here. The permission type should be set to CUSTOMER_MANAGED.

Parameters:

workspaceRoleArn - The workspace needs an IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. If you already have a role that you want to use, specify it here. The permission type should be set to CUSTOMER_MANAGED.

Returns:

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

overrideConfiguration

CreateWorkspaceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateWorkspaceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder