We recommend new projects start with resources from the AWS provider.
aws-native.grafana.Workspace
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Definition of AWS::Grafana::Workspace Resource Type
Create Workspace Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Workspace(name: string, args: WorkspaceArgs, opts?: CustomResourceOptions);
@overload
def Workspace(resource_name: str,
args: WorkspaceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Workspace(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_access_type: Optional[WorkspaceAccountAccessType] = None,
authentication_providers: Optional[Sequence[WorkspaceAuthenticationProviderTypes]] = None,
permission_type: Optional[WorkspacePermissionType] = None,
notification_destinations: Optional[Sequence[WorkspaceNotificationDestinationType]] = None,
organizational_units: Optional[Sequence[str]] = None,
grafana_version: Optional[str] = None,
name: Optional[str] = None,
network_access_control: Optional[WorkspaceNetworkAccessControlArgs] = None,
data_sources: Optional[Sequence[WorkspaceDataSourceType]] = None,
organization_role_name: Optional[str] = None,
description: Optional[str] = None,
client_token: Optional[str] = None,
plugin_admin_enabled: Optional[bool] = None,
role_arn: Optional[str] = None,
saml_configuration: Optional[WorkspaceSamlConfigurationArgs] = None,
stack_set_name: Optional[str] = None,
vpc_configuration: Optional[WorkspaceVpcConfigurationArgs] = None)
func NewWorkspace(ctx *Context, name string, args WorkspaceArgs, opts ...ResourceOption) (*Workspace, error)
public Workspace(string name, WorkspaceArgs args, CustomResourceOptions? opts = null)
public Workspace(String name, WorkspaceArgs args)
public Workspace(String name, WorkspaceArgs args, CustomResourceOptions options)
type: aws-native:grafana:Workspace
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args WorkspaceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args WorkspaceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args WorkspaceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WorkspaceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WorkspaceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Workspace Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Workspace resource accepts the following input properties:
- Account
Access Pulumi.Type Aws Native. Grafana. Workspace Account Access Type - Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization. If this is
ORGANIZATION
, theOrganizationalUnits
parameter specifies which organizational units the workspace can access. - Authentication
Providers List<Pulumi.Aws Native. Grafana. Workspace Authentication Provider Types> - List of authentication providers to enable.
- Permission
Type Pulumi.Aws Native. Grafana. Workspace Permission Type 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 AWS 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 AWS 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 AWS data sources and notification channels
- Client
Token string - A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
- Data
Sources List<Pulumi.Aws Native. Grafana. Workspace Data Source Type> - List of data sources on the service managed IAM role.
- Description string
- Description of a workspace.
- string
- The version of Grafana to support in your workspace.
- Name string
- The user friendly name of a workspace.
- Network
Access Pulumi.Control Aws Native. Grafana. Inputs. Workspace Network Access Control - The configuration settings for network access to your workspace.
- Notification
Destinations List<Pulumi.Aws Native. Grafana. Workspace Notification Destination Type> - List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
- Organization
Role stringName - The name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.
- Organizational
Units List<string> - List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
- Plugin
Admin boolEnabled - Allow workspace admins to install plugins
- Role
Arn string - IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
- Saml
Configuration Pulumi.Aws Native. Grafana. Inputs. Workspace Saml Configuration - If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the
Admin
andEditor
roles in the workspace. - Stack
Set stringName - The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
- Vpc
Configuration Pulumi.Aws Native. Grafana. Inputs. Workspace Vpc Configuration 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).
- Account
Access WorkspaceType Account Access Type - Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization. If this is
ORGANIZATION
, theOrganizationalUnits
parameter specifies which organizational units the workspace can access. - Authentication
Providers []WorkspaceAuthentication Provider Types - List of authentication providers to enable.
- Permission
Type WorkspacePermission Type 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 AWS 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 AWS 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 AWS data sources and notification channels
- Client
Token string - A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
- Data
Sources []WorkspaceData Source Type - List of data sources on the service managed IAM role.
- Description string
- Description of a workspace.
- string
- The version of Grafana to support in your workspace.
- Name string
- The user friendly name of a workspace.
- Network
Access WorkspaceControl Network Access Control Args - The configuration settings for network access to your workspace.
- Notification
Destinations []WorkspaceNotification Destination Type - List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
- Organization
Role stringName - The name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.
- Organizational
Units []string - List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
- Plugin
Admin boolEnabled - Allow workspace admins to install plugins
- Role
Arn string - IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
- Saml
Configuration WorkspaceSaml Configuration Args - If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the
Admin
andEditor
roles in the workspace. - Stack
Set stringName - The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
- Vpc
Configuration WorkspaceVpc Configuration Args 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).
- account
Access WorkspaceType Account Access Type - Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization. If this is
ORGANIZATION
, theOrganizationalUnits
parameter specifies which organizational units the workspace can access. - authentication
Providers List<WorkspaceAuthentication Provider Types> - List of authentication providers to enable.
- permission
Type WorkspacePermission Type 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 AWS 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 AWS 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 AWS data sources and notification channels
- client
Token String - A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
- data
Sources List<WorkspaceData Source Type> - List of data sources on the service managed IAM role.
- description String
- Description of a workspace.
- String
- The version of Grafana to support in your workspace.
- name String
- The user friendly name of a workspace.
- network
Access WorkspaceControl Network Access Control - The configuration settings for network access to your workspace.
- notification
Destinations List<WorkspaceNotification Destination Type> - List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
- organization
Role StringName - The name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.
- organizational
Units List<String> - List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
- plugin
Admin BooleanEnabled - Allow workspace admins to install plugins
- role
Arn String - IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
- saml
Configuration WorkspaceSaml Configuration - If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the
Admin
andEditor
roles in the workspace. - stack
Set StringName - The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
- vpc
Configuration WorkspaceVpc Configuration 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).
- account
Access WorkspaceType Account Access Type - Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization. If this is
ORGANIZATION
, theOrganizationalUnits
parameter specifies which organizational units the workspace can access. - authentication
Providers WorkspaceAuthentication Provider Types[] - List of authentication providers to enable.
- permission
Type WorkspacePermission Type 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 AWS 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 AWS 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 AWS data sources and notification channels
- client
Token string - A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
- data
Sources WorkspaceData Source Type[] - List of data sources on the service managed IAM role.
- description string
- Description of a workspace.
- string
- The version of Grafana to support in your workspace.
- name string
- The user friendly name of a workspace.
- network
Access WorkspaceControl Network Access Control - The configuration settings for network access to your workspace.
- notification
Destinations WorkspaceNotification Destination Type[] - List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
- organization
Role stringName - The name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.
- organizational
Units string[] - List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
- plugin
Admin booleanEnabled - Allow workspace admins to install plugins
- role
Arn string - IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
- saml
Configuration WorkspaceSaml Configuration - If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the
Admin
andEditor
roles in the workspace. - stack
Set stringName - The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
- vpc
Configuration WorkspaceVpc Configuration 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).
- account_
access_ Workspacetype Account Access Type - Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization. If this is
ORGANIZATION
, theOrganizationalUnits
parameter specifies which organizational units the workspace can access. - authentication_
providers Sequence[WorkspaceAuthentication Provider Types] - List of authentication providers to enable.
- permission_
type WorkspacePermission Type 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 AWS 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 AWS 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 AWS data sources and notification channels
- client_
token str - A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
- data_
sources Sequence[WorkspaceData Source Type] - List of data sources on the service managed IAM role.
- description str
- Description of a workspace.
- grafana_
version str - The version of Grafana to support in your workspace.
- name str
- The user friendly name of a workspace.
- network_
access_ Workspacecontrol Network Access Control Args - The configuration settings for network access to your workspace.
- notification_
destinations Sequence[WorkspaceNotification Destination Type] - List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
- organization_
role_ strname - The name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.
- organizational_
units Sequence[str] - List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
- plugin_
admin_ boolenabled - Allow workspace admins to install plugins
- role_
arn str - IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
- saml_
configuration WorkspaceSaml Configuration Args - If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the
Admin
andEditor
roles in the workspace. - stack_
set_ strname - The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
- vpc_
configuration WorkspaceVpc Configuration Args 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).
- account
Access "CURRENT_ACCOUNT" | "ORGANIZATION"Type - Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization. If this is
ORGANIZATION
, theOrganizationalUnits
parameter specifies which organizational units the workspace can access. - authentication
Providers List<"AWS_SSO" | "SAML"> - List of authentication providers to enable.
- permission
Type "CUSTOMER_MANAGED" | "SERVICE_MANAGED" 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 AWS 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 AWS 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 AWS data sources and notification channels
- client
Token String - A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
- data
Sources List<"AMAZON_OPENSEARCH_SERVICE" | "CLOUDWATCH" | "PROMETHEUS" | "XRAY" | "TIMESTREAM" | "SITEWISE" | "ATHENA" | "REDSHIFT"> - List of data sources on the service managed IAM role.
- description String
- Description of a workspace.
- String
- The version of Grafana to support in your workspace.
- name String
- The user friendly name of a workspace.
- network
Access Property MapControl - The configuration settings for network access to your workspace.
- notification
Destinations List<"SNS"> - List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
- organization
Role StringName - The name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.
- organizational
Units List<String> - List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
- plugin
Admin BooleanEnabled - Allow workspace admins to install plugins
- role
Arn String - IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
- saml
Configuration Property Map - If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the
Admin
andEditor
roles in the workspace. - stack
Set StringName - The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
- vpc
Configuration Property Map 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).
Outputs
All input properties are implicitly available as output properties. Additionally, the Workspace resource produces the following output properties:
- Aws
Id string - The id that uniquely identifies a Grafana workspace.
- Creation
Timestamp string - Timestamp when the workspace was created.
- Endpoint string
- Endpoint for the Grafana workspace.
- Id string
- The provider-assigned unique ID for this managed resource.
- Modification
Timestamp string - Timestamp when the workspace was last modified
- Saml
Configuration Pulumi.Status Aws Native. Grafana. Workspace Saml Configuration Status Specifies whether the workspace's SAML configuration is complete.
Valid values:
CONFIGURED | NOT_CONFIGURED
Type: String
- Sso
Client stringId - The client ID of the AWS SSO Managed Application.
- Status
Pulumi.
Aws Native. Grafana. Workspace Status The current status of the workspace.
Valid values:
ACTIVE | CREATING | DELETING | FAILED | UPDATING | UPGRADING | DELETION_FAILED | CREATION_FAILED | UPDATE_FAILED | UPGRADE_FAILED | LICENSE_REMOVAL_FAILED
Type: String
- Aws
Id string - The id that uniquely identifies a Grafana workspace.
- Creation
Timestamp string - Timestamp when the workspace was created.
- Endpoint string
- Endpoint for the Grafana workspace.
- Id string
- The provider-assigned unique ID for this managed resource.
- Modification
Timestamp string - Timestamp when the workspace was last modified
- Saml
Configuration WorkspaceStatus Saml Configuration Status Specifies whether the workspace's SAML configuration is complete.
Valid values:
CONFIGURED | NOT_CONFIGURED
Type: String
- Sso
Client stringId - The client ID of the AWS SSO Managed Application.
- Status
Workspace
Status The current status of the workspace.
Valid values:
ACTIVE | CREATING | DELETING | FAILED | UPDATING | UPGRADING | DELETION_FAILED | CREATION_FAILED | UPDATE_FAILED | UPGRADE_FAILED | LICENSE_REMOVAL_FAILED
Type: String
- aws
Id String - The id that uniquely identifies a Grafana workspace.
- creation
Timestamp String - Timestamp when the workspace was created.
- endpoint String
- Endpoint for the Grafana workspace.
- id String
- The provider-assigned unique ID for this managed resource.
- modification
Timestamp String - Timestamp when the workspace was last modified
- saml
Configuration WorkspaceStatus Saml Configuration Status Specifies whether the workspace's SAML configuration is complete.
Valid values:
CONFIGURED | NOT_CONFIGURED
Type: String
- sso
Client StringId - The client ID of the AWS SSO Managed Application.
- status
Workspace
Status The current status of the workspace.
Valid values:
ACTIVE | CREATING | DELETING | FAILED | UPDATING | UPGRADING | DELETION_FAILED | CREATION_FAILED | UPDATE_FAILED | UPGRADE_FAILED | LICENSE_REMOVAL_FAILED
Type: String
- aws
Id string - The id that uniquely identifies a Grafana workspace.
- creation
Timestamp string - Timestamp when the workspace was created.
- endpoint string
- Endpoint for the Grafana workspace.
- id string
- The provider-assigned unique ID for this managed resource.
- modification
Timestamp string - Timestamp when the workspace was last modified
- saml
Configuration WorkspaceStatus Saml Configuration Status Specifies whether the workspace's SAML configuration is complete.
Valid values:
CONFIGURED | NOT_CONFIGURED
Type: String
- sso
Client stringId - The client ID of the AWS SSO Managed Application.
- status
Workspace
Status The current status of the workspace.
Valid values:
ACTIVE | CREATING | DELETING | FAILED | UPDATING | UPGRADING | DELETION_FAILED | CREATION_FAILED | UPDATE_FAILED | UPGRADE_FAILED | LICENSE_REMOVAL_FAILED
Type: String
- aws_
id str - The id that uniquely identifies a Grafana workspace.
- creation_
timestamp str - Timestamp when the workspace was created.
- endpoint str
- Endpoint for the Grafana workspace.
- id str
- The provider-assigned unique ID for this managed resource.
- modification_
timestamp str - Timestamp when the workspace was last modified
- saml_
configuration_ Workspacestatus Saml Configuration Status Specifies whether the workspace's SAML configuration is complete.
Valid values:
CONFIGURED | NOT_CONFIGURED
Type: String
- sso_
client_ strid - The client ID of the AWS SSO Managed Application.
- status
Workspace
Status The current status of the workspace.
Valid values:
ACTIVE | CREATING | DELETING | FAILED | UPDATING | UPGRADING | DELETION_FAILED | CREATION_FAILED | UPDATE_FAILED | UPGRADE_FAILED | LICENSE_REMOVAL_FAILED
Type: String
- aws
Id String - The id that uniquely identifies a Grafana workspace.
- creation
Timestamp String - Timestamp when the workspace was created.
- endpoint String
- Endpoint for the Grafana workspace.
- id String
- The provider-assigned unique ID for this managed resource.
- modification
Timestamp String - Timestamp when the workspace was last modified
- saml
Configuration "CONFIGURED" | "NOT_CONFIGURED"Status Specifies whether the workspace's SAML configuration is complete.
Valid values:
CONFIGURED | NOT_CONFIGURED
Type: String
- sso
Client StringId - The client ID of the AWS SSO Managed Application.
- status "ACTIVE" | "CREATING" | "DELETING" | "FAILED" | "UPDATING" | "UPGRADING" | "VERSION_UPDATING" | "DELETION_FAILED" | "CREATION_FAILED" | "UPDATE_FAILED" | "UPGRADE_FAILED" | "LICENSE_REMOVAL_FAILED" | "VERSION_UPDATE_FAILED"
The current status of the workspace.
Valid values:
ACTIVE | CREATING | DELETING | FAILED | UPDATING | UPGRADING | DELETION_FAILED | CREATION_FAILED | UPDATE_FAILED | UPGRADE_FAILED | LICENSE_REMOVAL_FAILED
Type: String
Supporting Types
WorkspaceAccountAccessType, WorkspaceAccountAccessTypeArgs
- Current
Account - CURRENT_ACCOUNT
- Organization
- ORGANIZATION
- Workspace
Account Access Type Current Account - CURRENT_ACCOUNT
- Workspace
Account Access Type Organization - ORGANIZATION
- Current
Account - CURRENT_ACCOUNT
- Organization
- ORGANIZATION
- Current
Account - CURRENT_ACCOUNT
- Organization
- ORGANIZATION
- CURRENT_ACCOUNT
- CURRENT_ACCOUNT
- ORGANIZATION
- ORGANIZATION
- "CURRENT_ACCOUNT"
- CURRENT_ACCOUNT
- "ORGANIZATION"
- ORGANIZATION
WorkspaceAssertionAttributes, WorkspaceAssertionAttributesArgs
- Email string
- Name of the attribute within the SAML assert to use as the users email in Grafana.
- Groups string
- Name of the attribute within the SAML assert to use as the users groups in Grafana.
- Login string
- Name of the attribute within the SAML assert to use as the users login handle in Grafana.
- Name string
- Name of the attribute within the SAML assert to use as the users name in Grafana.
- Org string
- Name of the attribute within the SAML assert to use as the users organizations in Grafana.
- Role string
- Name of the attribute within the SAML assert to use as the users roles in Grafana.
- Email string
- Name of the attribute within the SAML assert to use as the users email in Grafana.
- Groups string
- Name of the attribute within the SAML assert to use as the users groups in Grafana.
- Login string
- Name of the attribute within the SAML assert to use as the users login handle in Grafana.
- Name string
- Name of the attribute within the SAML assert to use as the users name in Grafana.
- Org string
- Name of the attribute within the SAML assert to use as the users organizations in Grafana.
- Role string
- Name of the attribute within the SAML assert to use as the users roles in Grafana.
- email String
- Name of the attribute within the SAML assert to use as the users email in Grafana.
- groups String
- Name of the attribute within the SAML assert to use as the users groups in Grafana.
- login String
- Name of the attribute within the SAML assert to use as the users login handle in Grafana.
- name String
- Name of the attribute within the SAML assert to use as the users name in Grafana.
- org String
- Name of the attribute within the SAML assert to use as the users organizations in Grafana.
- role String
- Name of the attribute within the SAML assert to use as the users roles in Grafana.
- email string
- Name of the attribute within the SAML assert to use as the users email in Grafana.
- groups string
- Name of the attribute within the SAML assert to use as the users groups in Grafana.
- login string
- Name of the attribute within the SAML assert to use as the users login handle in Grafana.
- name string
- Name of the attribute within the SAML assert to use as the users name in Grafana.
- org string
- Name of the attribute within the SAML assert to use as the users organizations in Grafana.
- role string
- Name of the attribute within the SAML assert to use as the users roles in Grafana.
- email str
- Name of the attribute within the SAML assert to use as the users email in Grafana.
- groups str
- Name of the attribute within the SAML assert to use as the users groups in Grafana.
- login str
- Name of the attribute within the SAML assert to use as the users login handle in Grafana.
- name str
- Name of the attribute within the SAML assert to use as the users name in Grafana.
- org str
- Name of the attribute within the SAML assert to use as the users organizations in Grafana.
- role str
- Name of the attribute within the SAML assert to use as the users roles in Grafana.
- email String
- Name of the attribute within the SAML assert to use as the users email in Grafana.
- groups String
- Name of the attribute within the SAML assert to use as the users groups in Grafana.
- login String
- Name of the attribute within the SAML assert to use as the users login handle in Grafana.
- name String
- Name of the attribute within the SAML assert to use as the users name in Grafana.
- org String
- Name of the attribute within the SAML assert to use as the users organizations in Grafana.
- role String
- Name of the attribute within the SAML assert to use as the users roles in Grafana.
WorkspaceAuthenticationProviderTypes, WorkspaceAuthenticationProviderTypesArgs
- Aws
Sso - AWS_SSO
- Saml
- SAML
- Workspace
Authentication Provider Types Aws Sso - AWS_SSO
- Workspace
Authentication Provider Types Saml - SAML
- Aws
Sso - AWS_SSO
- Saml
- SAML
- Aws
Sso - AWS_SSO
- Saml
- SAML
- AWS_SSO
- AWS_SSO
- SAML
- SAML
- "AWS_SSO"
- AWS_SSO
- "SAML"
- SAML
WorkspaceDataSourceType, WorkspaceDataSourceTypeArgs
- Amazon
Opensearch Service - AMAZON_OPENSEARCH_SERVICE
- Cloudwatch
- CLOUDWATCH
- Prometheus
- PROMETHEUS
- Xray
- XRAY
- Timestream
- TIMESTREAM
- Sitewise
- SITEWISE
- Athena
- ATHENA
- Redshift
- REDSHIFT
- Workspace
Data Source Type Amazon Opensearch Service - AMAZON_OPENSEARCH_SERVICE
- Workspace
Data Source Type Cloudwatch - CLOUDWATCH
- Workspace
Data Source Type Prometheus - PROMETHEUS
- Workspace
Data Source Type Xray - XRAY
- Workspace
Data Source Type Timestream - TIMESTREAM
- Workspace
Data Source Type Sitewise - SITEWISE
- Workspace
Data Source Type Athena - ATHENA
- Workspace
Data Source Type Redshift - REDSHIFT
- Amazon
Opensearch Service - AMAZON_OPENSEARCH_SERVICE
- Cloudwatch
- CLOUDWATCH
- Prometheus
- PROMETHEUS
- Xray
- XRAY
- Timestream
- TIMESTREAM
- Sitewise
- SITEWISE
- Athena
- ATHENA
- Redshift
- REDSHIFT
- Amazon
Opensearch Service - AMAZON_OPENSEARCH_SERVICE
- Cloudwatch
- CLOUDWATCH
- Prometheus
- PROMETHEUS
- Xray
- XRAY
- Timestream
- TIMESTREAM
- Sitewise
- SITEWISE
- Athena
- ATHENA
- Redshift
- REDSHIFT
- AMAZON_OPENSEARCH_SERVICE
- AMAZON_OPENSEARCH_SERVICE
- CLOUDWATCH
- CLOUDWATCH
- PROMETHEUS
- PROMETHEUS
- XRAY
- XRAY
- TIMESTREAM
- TIMESTREAM
- SITEWISE
- SITEWISE
- ATHENA
- ATHENA
- REDSHIFT
- REDSHIFT
- "AMAZON_OPENSEARCH_SERVICE"
- AMAZON_OPENSEARCH_SERVICE
- "CLOUDWATCH"
- CLOUDWATCH
- "PROMETHEUS"
- PROMETHEUS
- "XRAY"
- XRAY
- "TIMESTREAM"
- TIMESTREAM
- "SITEWISE"
- SITEWISE
- "ATHENA"
- ATHENA
- "REDSHIFT"
- REDSHIFT
WorkspaceIdpMetadata, WorkspaceIdpMetadataArgs
WorkspaceNetworkAccessControl, WorkspaceNetworkAccessControlArgs
- Prefix
List List<string>Ids - The list of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration then no IP addresses will be allowed to access the workspace.
- Vpce
Ids List<string> - The list of Amazon VPC endpoint IDs for the workspace. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here will be allowed to access the workspace.
- Prefix
List []stringIds - The list of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration then no IP addresses will be allowed to access the workspace.
- Vpce
Ids []string - The list of Amazon VPC endpoint IDs for the workspace. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here will be allowed to access the workspace.
- prefix
List List<String>Ids - The list of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration then no IP addresses will be allowed to access the workspace.
- vpce
Ids List<String> - The list of Amazon VPC endpoint IDs for the workspace. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here will be allowed to access the workspace.
- prefix
List string[]Ids - The list of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration then no IP addresses will be allowed to access the workspace.
- vpce
Ids string[] - The list of Amazon VPC endpoint IDs for the workspace. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here will be allowed to access the workspace.
- prefix_
list_ Sequence[str]ids - The list of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration then no IP addresses will be allowed to access the workspace.
- vpce_
ids Sequence[str] - The list of Amazon VPC endpoint IDs for the workspace. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here will be allowed to access the workspace.
- prefix
List List<String>Ids - The list of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration then no IP addresses will be allowed to access the workspace.
- vpce
Ids List<String> - The list of Amazon VPC endpoint IDs for the workspace. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here will be allowed to access the workspace.
WorkspaceNotificationDestinationType, WorkspaceNotificationDestinationTypeArgs
- Sns
- SNS
- Workspace
Notification Destination Type Sns - SNS
- Sns
- SNS
- Sns
- SNS
- SNS
- SNS
- "SNS"
- SNS
WorkspacePermissionType, WorkspacePermissionTypeArgs
- Customer
Managed - CUSTOMER_MANAGED
- Service
Managed - SERVICE_MANAGED
- Workspace
Permission Type Customer Managed - CUSTOMER_MANAGED
- Workspace
Permission Type Service Managed - SERVICE_MANAGED
- Customer
Managed - CUSTOMER_MANAGED
- Service
Managed - SERVICE_MANAGED
- Customer
Managed - CUSTOMER_MANAGED
- Service
Managed - SERVICE_MANAGED
- CUSTOMER_MANAGED
- CUSTOMER_MANAGED
- SERVICE_MANAGED
- SERVICE_MANAGED
- "CUSTOMER_MANAGED"
- CUSTOMER_MANAGED
- "SERVICE_MANAGED"
- SERVICE_MANAGED
WorkspaceRoleValues, WorkspaceRoleValuesArgs
WorkspaceSamlConfiguration, WorkspaceSamlConfigurationArgs
- Idp
Metadata Pulumi.Aws Native. Grafana. Inputs. Workspace Idp Metadata - A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
- Allowed
Organizations List<string> - List of SAML organizations allowed to access Grafana.
- Assertion
Attributes Pulumi.Aws Native. Grafana. Inputs. Workspace Assertion Attributes - A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.
- Login
Validity doubleDuration - The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.
- Role
Values Pulumi.Aws Native. Grafana. Inputs. Workspace Role Values - A structure containing arrays that map group names in the SAML assertion to the Grafana
Admin
andEditor
roles in the workspace.
- Idp
Metadata WorkspaceIdp Metadata - A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
- Allowed
Organizations []string - List of SAML organizations allowed to access Grafana.
- Assertion
Attributes WorkspaceAssertion Attributes - A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.
- Login
Validity float64Duration - The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.
- Role
Values WorkspaceRole Values - A structure containing arrays that map group names in the SAML assertion to the Grafana
Admin
andEditor
roles in the workspace.
- idp
Metadata WorkspaceIdp Metadata - A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
- allowed
Organizations List<String> - List of SAML organizations allowed to access Grafana.
- assertion
Attributes WorkspaceAssertion Attributes - A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.
- login
Validity DoubleDuration - The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.
- role
Values WorkspaceRole Values - A structure containing arrays that map group names in the SAML assertion to the Grafana
Admin
andEditor
roles in the workspace.
- idp
Metadata WorkspaceIdp Metadata - A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
- allowed
Organizations string[] - List of SAML organizations allowed to access Grafana.
- assertion
Attributes WorkspaceAssertion Attributes - A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.
- login
Validity numberDuration - The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.
- role
Values WorkspaceRole Values - A structure containing arrays that map group names in the SAML assertion to the Grafana
Admin
andEditor
roles in the workspace.
- idp_
metadata WorkspaceIdp Metadata - A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
- allowed_
organizations Sequence[str] - List of SAML organizations allowed to access Grafana.
- assertion_
attributes WorkspaceAssertion Attributes - A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.
- login_
validity_ floatduration - The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.
- role_
values WorkspaceRole Values - A structure containing arrays that map group names in the SAML assertion to the Grafana
Admin
andEditor
roles in the workspace.
- idp
Metadata Property Map - A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
- allowed
Organizations List<String> - List of SAML organizations allowed to access Grafana.
- assertion
Attributes Property Map - A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.
- login
Validity NumberDuration - The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.
- role
Values Property Map - A structure containing arrays that map group names in the SAML assertion to the Grafana
Admin
andEditor
roles in the workspace.
WorkspaceSamlConfigurationStatus, WorkspaceSamlConfigurationStatusArgs
- Configured
- CONFIGURED
- Not
Configured - NOT_CONFIGURED
- Workspace
Saml Configuration Status Configured - CONFIGURED
- Workspace
Saml Configuration Status Not Configured - NOT_CONFIGURED
- Configured
- CONFIGURED
- Not
Configured - NOT_CONFIGURED
- Configured
- CONFIGURED
- Not
Configured - NOT_CONFIGURED
- CONFIGURED
- CONFIGURED
- NOT_CONFIGURED
- NOT_CONFIGURED
- "CONFIGURED"
- CONFIGURED
- "NOT_CONFIGURED"
- NOT_CONFIGURED
WorkspaceStatus, WorkspaceStatusArgs
- Active
- ACTIVE
- Creating
- CREATING
- Deleting
- DELETING
- Failed
- FAILED
- Updating
- UPDATING
- Upgrading
- UPGRADING
- Version
Updating - VERSION_UPDATING
- Deletion
Failed - DELETION_FAILED
- Creation
Failed - CREATION_FAILED
- Update
Failed - UPDATE_FAILED
- Upgrade
Failed - UPGRADE_FAILED
- License
Removal Failed - LICENSE_REMOVAL_FAILED
- Version
Update Failed - VERSION_UPDATE_FAILED
- Workspace
Status Active - ACTIVE
- Workspace
Status Creating - CREATING
- Workspace
Status Deleting - DELETING
- Workspace
Status Failed - FAILED
- Workspace
Status Updating - UPDATING
- Workspace
Status Upgrading - UPGRADING
- Workspace
Status Version Updating - VERSION_UPDATING
- Workspace
Status Deletion Failed - DELETION_FAILED
- Workspace
Status Creation Failed - CREATION_FAILED
- Workspace
Status Update Failed - UPDATE_FAILED
- Workspace
Status Upgrade Failed - UPGRADE_FAILED
- Workspace
Status License Removal Failed - LICENSE_REMOVAL_FAILED
- Workspace
Status Version Update Failed - VERSION_UPDATE_FAILED
- Active
- ACTIVE
- Creating
- CREATING
- Deleting
- DELETING
- Failed
- FAILED
- Updating
- UPDATING
- Upgrading
- UPGRADING
- Version
Updating - VERSION_UPDATING
- Deletion
Failed - DELETION_FAILED
- Creation
Failed - CREATION_FAILED
- Update
Failed - UPDATE_FAILED
- Upgrade
Failed - UPGRADE_FAILED
- License
Removal Failed - LICENSE_REMOVAL_FAILED
- Version
Update Failed - VERSION_UPDATE_FAILED
- Active
- ACTIVE
- Creating
- CREATING
- Deleting
- DELETING
- Failed
- FAILED
- Updating
- UPDATING
- Upgrading
- UPGRADING
- Version
Updating - VERSION_UPDATING
- Deletion
Failed - DELETION_FAILED
- Creation
Failed - CREATION_FAILED
- Update
Failed - UPDATE_FAILED
- Upgrade
Failed - UPGRADE_FAILED
- License
Removal Failed - LICENSE_REMOVAL_FAILED
- Version
Update Failed - VERSION_UPDATE_FAILED
- ACTIVE
- ACTIVE
- CREATING
- CREATING
- DELETING
- DELETING
- FAILED
- FAILED
- UPDATING
- UPDATING
- UPGRADING
- UPGRADING
- VERSION_UPDATING
- VERSION_UPDATING
- DELETION_FAILED
- DELETION_FAILED
- CREATION_FAILED
- CREATION_FAILED
- UPDATE_FAILED
- UPDATE_FAILED
- UPGRADE_FAILED
- UPGRADE_FAILED
- LICENSE_REMOVAL_FAILED
- LICENSE_REMOVAL_FAILED
- VERSION_UPDATE_FAILED
- VERSION_UPDATE_FAILED
- "ACTIVE"
- ACTIVE
- "CREATING"
- CREATING
- "DELETING"
- DELETING
- "FAILED"
- FAILED
- "UPDATING"
- UPDATING
- "UPGRADING"
- UPGRADING
- "VERSION_UPDATING"
- VERSION_UPDATING
- "DELETION_FAILED"
- DELETION_FAILED
- "CREATION_FAILED"
- CREATION_FAILED
- "UPDATE_FAILED"
- UPDATE_FAILED
- "UPGRADE_FAILED"
- UPGRADE_FAILED
- "LICENSE_REMOVAL_FAILED"
- LICENSE_REMOVAL_FAILED
- "VERSION_UPDATE_FAILED"
- VERSION_UPDATE_FAILED
WorkspaceVpcConfiguration, WorkspaceVpcConfigurationArgs
- Security
Group List<string>Ids - The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
- Subnet
Ids List<string> - The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
- Security
Group []stringIds - The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
- Subnet
Ids []string - The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
- security
Group List<String>Ids - The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
- subnet
Ids List<String> - The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
- security
Group string[]Ids - The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
- subnet
Ids string[] - The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
- security_
group_ Sequence[str]ids - The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
- subnet_
ids Sequence[str] - The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
- security
Group List<String>Ids - The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
- subnet
Ids List<String> - The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.