public static interface CreateWorkspaceRequest.Builder extends GrafanaRequest.Builder, SdkPojo, CopyableBuilder<CreateWorkspaceRequest.Builder,CreateWorkspaceRequest>
| 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, IAM Identity Center (successor to 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, IAM Identity Center (successor to 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, IAM Identity Center (successor to 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, IAM Identity Center (successor to 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 |
configuration(String configuration)
The configuration string for the workspace that you create.
|
CreateWorkspaceRequest.Builder |
grafanaVersion(String grafanaVersion)
Specifies the version of Grafana to support in the new workspace.
|
default CreateWorkspaceRequest.Builder |
networkAccessControl(Consumer<NetworkAccessConfiguration.Builder> networkAccessControl)
Configuration for network access to your workspace.
|
CreateWorkspaceRequest.Builder |
networkAccessControl(NetworkAccessConfiguration networkAccessControl)
Configuration for network access to your workspace.
|
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)
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.
|
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.
|
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.
|
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.
|
CreateWorkspaceRequest.Builder |
vpcConfiguration(VpcConfiguration vpcConfiguration)
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect
to.
|
CreateWorkspaceRequest.Builder |
workspaceDataSources(Collection<DataSourceType> workspaceDataSources)
This parameter is for internal use only, and should not be used.
|
CreateWorkspaceRequest.Builder |
workspaceDataSources(DataSourceType... workspaceDataSources)
This parameter is for internal use only, and should not be used.
|
CreateWorkspaceRequest.Builder |
workspaceDataSourcesWithStrings(Collection<String> workspaceDataSources)
This parameter is for internal use only, and should not be used.
|
CreateWorkspaceRequest.Builder |
workspaceDataSourcesWithStrings(String... workspaceDataSources)
This parameter is for internal use only, and should not be used.
|
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)
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.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateWorkspaceRequest.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.
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.AccountAccessType,
AccountAccessTypeCreateWorkspaceRequest.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.
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.AccountAccessType,
AccountAccessTypeCreateWorkspaceRequest.Builder authenticationProvidersWithStrings(Collection<String> authenticationProviders)
Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to 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.
authenticationProviders - Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to 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.CreateWorkspaceRequest.Builder authenticationProvidersWithStrings(String... authenticationProviders)
Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to 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.
authenticationProviders - Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to 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.CreateWorkspaceRequest.Builder authenticationProviders(Collection<AuthenticationProviderTypes> authenticationProviders)
Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to 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.
authenticationProviders - Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to 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.CreateWorkspaceRequest.Builder authenticationProviders(AuthenticationProviderTypes... authenticationProviders)
Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to 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.
authenticationProviders - Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to 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.CreateWorkspaceRequest.Builder clientToken(String clientToken)
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
clientToken - A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.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.
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.CreateWorkspaceRequest.Builder grafanaVersion(String grafanaVersion)
Specifies the version of Grafana to support in the new workspace.
To get a list of supported version, use the ListVersions operation.
grafanaVersion - Specifies the version of Grafana to support in the new workspace.
To get a list of supported version, use the ListVersions operation.
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.
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.
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 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)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.
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 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.
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.
PermissionType,
PermissionTypeCreateWorkspaceRequest.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.
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.
PermissionType,
PermissionTypeCreateWorkspaceRequest.Builder stackSetName(String stackSetName)
The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
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.
tags - The list of tags associated with the workspace.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).
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).
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).
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).
vpcConfiguration - a consumer that will call methods on VpcConfiguration.BuildervpcConfiguration(VpcConfiguration)CreateWorkspaceRequest.Builder workspaceDataSourcesWithStrings(Collection<String> workspaceDataSources)
This parameter is for internal use only, and should not be used.
workspaceDataSources - This parameter is for internal use only, and should not be used.CreateWorkspaceRequest.Builder workspaceDataSourcesWithStrings(String... workspaceDataSources)
This parameter is for internal use only, and should not be used.
workspaceDataSources - This parameter is for internal use only, and should not be used.CreateWorkspaceRequest.Builder workspaceDataSources(Collection<DataSourceType> workspaceDataSources)
This parameter is for internal use only, and should not be used.
workspaceDataSources - This parameter is for internal use only, and should not be used.CreateWorkspaceRequest.Builder workspaceDataSources(DataSourceType... workspaceDataSources)
This parameter is for internal use only, and should not be used.
workspaceDataSources - This parameter is for internal use only, and should not be used.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}$
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}$
CreateWorkspaceRequest.Builder workspaceName(String workspaceName)
The name for the workspace. It does not have to be unique.
workspaceName - The name for the workspace. It does not have to be unique.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.
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.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.
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.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.
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.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.
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.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.
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.
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)
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.
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.CreateWorkspaceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateWorkspaceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.