Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. grafana
  5. getWorkspace

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.grafana.getWorkspace

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Definition of AWS::Grafana::Workspace Resource Type

Using getWorkspace

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getWorkspace(args: GetWorkspaceArgs, opts?: InvokeOptions): Promise<GetWorkspaceResult>
function getWorkspaceOutput(args: GetWorkspaceOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceResult>
Copy
def get_workspace(id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetWorkspaceResult
def get_workspace_output(id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceResult]
Copy
func LookupWorkspace(ctx *Context, args *LookupWorkspaceArgs, opts ...InvokeOption) (*LookupWorkspaceResult, error)
func LookupWorkspaceOutput(ctx *Context, args *LookupWorkspaceOutputArgs, opts ...InvokeOption) LookupWorkspaceResultOutput
Copy

> Note: This function is named LookupWorkspace in the Go SDK.

public static class GetWorkspace 
{
    public static Task<GetWorkspaceResult> InvokeAsync(GetWorkspaceArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceResult> Invoke(GetWorkspaceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
public static Output<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:grafana:getWorkspace
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The id that uniquely identifies a Grafana workspace.
Id This property is required. string
The id that uniquely identifies a Grafana workspace.
id This property is required. String
The id that uniquely identifies a Grafana workspace.
id This property is required. string
The id that uniquely identifies a Grafana workspace.
id This property is required. str
The id that uniquely identifies a Grafana workspace.
id This property is required. String
The id that uniquely identifies a Grafana workspace.

getWorkspace Result

The following output properties are available:

AccountAccessType Pulumi.AwsNative.Grafana.WorkspaceAccountAccessType
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 , the OrganizationalUnits parameter specifies which organizational units the workspace can access.
AuthenticationProviders List<Pulumi.AwsNative.Grafana.WorkspaceAuthenticationProviderTypes>
List of authentication providers to enable.
CreationTimestamp string
Timestamp when the workspace was created.
DataSources List<Pulumi.AwsNative.Grafana.WorkspaceDataSourceType>
List of data sources on the service managed IAM role.
Description string
Description of a workspace.
Endpoint string
Endpoint for the Grafana workspace.
GrafanaVersion string
The version of Grafana to support in your workspace.
Id string
The id that uniquely identifies a Grafana workspace.
ModificationTimestamp string
Timestamp when the workspace was last modified
Name string
The user friendly name of a workspace.
NetworkAccessControl Pulumi.AwsNative.Grafana.Outputs.WorkspaceNetworkAccessControl
The configuration settings for network access to your workspace.
NotificationDestinations List<Pulumi.AwsNative.Grafana.WorkspaceNotificationDestinationType>
List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
OrganizationRoleName string
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.
OrganizationalUnits List<string>
List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
PermissionType Pulumi.AwsNative.Grafana.WorkspacePermissionType

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

PluginAdminEnabled bool
Allow workspace admins to install plugins
RoleArn string
IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
SamlConfiguration Pulumi.AwsNative.Grafana.Outputs.WorkspaceSamlConfiguration
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 and Editor roles in the workspace.
SamlConfigurationStatus Pulumi.AwsNative.Grafana.WorkspaceSamlConfigurationStatus

Specifies whether the workspace's SAML configuration is complete.

Valid values: CONFIGURED | NOT_CONFIGURED

Type: String

SsoClientId string
The client ID of the AWS SSO Managed Application.
StackSetName string
The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
Status Pulumi.AwsNative.Grafana.WorkspaceStatus

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

VpcConfiguration Pulumi.AwsNative.Grafana.Outputs.WorkspaceVpcConfiguration

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

AccountAccessType WorkspaceAccountAccessType
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 , the OrganizationalUnits parameter specifies which organizational units the workspace can access.
AuthenticationProviders []WorkspaceAuthenticationProviderTypes
List of authentication providers to enable.
CreationTimestamp string
Timestamp when the workspace was created.
DataSources []WorkspaceDataSourceType
List of data sources on the service managed IAM role.
Description string
Description of a workspace.
Endpoint string
Endpoint for the Grafana workspace.
GrafanaVersion string
The version of Grafana to support in your workspace.
Id string
The id that uniquely identifies a Grafana workspace.
ModificationTimestamp string
Timestamp when the workspace was last modified
Name string
The user friendly name of a workspace.
NetworkAccessControl WorkspaceNetworkAccessControl
The configuration settings for network access to your workspace.
NotificationDestinations []WorkspaceNotificationDestinationType
List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
OrganizationRoleName string
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.
OrganizationalUnits []string
List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
PermissionType WorkspacePermissionType

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

PluginAdminEnabled bool
Allow workspace admins to install plugins
RoleArn string
IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
SamlConfiguration WorkspaceSamlConfiguration
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 and Editor roles in the workspace.
SamlConfigurationStatus WorkspaceSamlConfigurationStatus

Specifies whether the workspace's SAML configuration is complete.

Valid values: CONFIGURED | NOT_CONFIGURED

Type: String

SsoClientId string
The client ID of the AWS SSO Managed Application.
StackSetName string
The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
Status WorkspaceStatus

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

VpcConfiguration WorkspaceVpcConfiguration

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

accountAccessType WorkspaceAccountAccessType
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 , the OrganizationalUnits parameter specifies which organizational units the workspace can access.
authenticationProviders List<WorkspaceAuthenticationProviderTypes>
List of authentication providers to enable.
creationTimestamp String
Timestamp when the workspace was created.
dataSources List<WorkspaceDataSourceType>
List of data sources on the service managed IAM role.
description String
Description of a workspace.
endpoint String
Endpoint for the Grafana workspace.
grafanaVersion String
The version of Grafana to support in your workspace.
id String
The id that uniquely identifies a Grafana workspace.
modificationTimestamp String
Timestamp when the workspace was last modified
name String
The user friendly name of a workspace.
networkAccessControl WorkspaceNetworkAccessControl
The configuration settings for network access to your workspace.
notificationDestinations List<WorkspaceNotificationDestinationType>
List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
organizationRoleName String
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.
organizationalUnits List<String>
List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
permissionType WorkspacePermissionType

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

pluginAdminEnabled Boolean
Allow workspace admins to install plugins
roleArn String
IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
samlConfiguration WorkspaceSamlConfiguration
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 and Editor roles in the workspace.
samlConfigurationStatus WorkspaceSamlConfigurationStatus

Specifies whether the workspace's SAML configuration is complete.

Valid values: CONFIGURED | NOT_CONFIGURED

Type: String

ssoClientId String
The client ID of the AWS SSO Managed Application.
stackSetName String
The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
status WorkspaceStatus

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

vpcConfiguration WorkspaceVpcConfiguration

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

accountAccessType WorkspaceAccountAccessType
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 , the OrganizationalUnits parameter specifies which organizational units the workspace can access.
authenticationProviders WorkspaceAuthenticationProviderTypes[]
List of authentication providers to enable.
creationTimestamp string
Timestamp when the workspace was created.
dataSources WorkspaceDataSourceType[]
List of data sources on the service managed IAM role.
description string
Description of a workspace.
endpoint string
Endpoint for the Grafana workspace.
grafanaVersion string
The version of Grafana to support in your workspace.
id string
The id that uniquely identifies a Grafana workspace.
modificationTimestamp string
Timestamp when the workspace was last modified
name string
The user friendly name of a workspace.
networkAccessControl WorkspaceNetworkAccessControl
The configuration settings for network access to your workspace.
notificationDestinations WorkspaceNotificationDestinationType[]
List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
organizationRoleName string
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.
organizationalUnits string[]
List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
permissionType WorkspacePermissionType

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

pluginAdminEnabled boolean
Allow workspace admins to install plugins
roleArn string
IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
samlConfiguration WorkspaceSamlConfiguration
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 and Editor roles in the workspace.
samlConfigurationStatus WorkspaceSamlConfigurationStatus

Specifies whether the workspace's SAML configuration is complete.

Valid values: CONFIGURED | NOT_CONFIGURED

Type: String

ssoClientId string
The client ID of the AWS SSO Managed Application.
stackSetName string
The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
status WorkspaceStatus

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

vpcConfiguration WorkspaceVpcConfiguration

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_type WorkspaceAccountAccessType
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 , the OrganizationalUnits parameter specifies which organizational units the workspace can access.
authentication_providers Sequence[WorkspaceAuthenticationProviderTypes]
List of authentication providers to enable.
creation_timestamp str
Timestamp when the workspace was created.
data_sources Sequence[WorkspaceDataSourceType]
List of data sources on the service managed IAM role.
description str
Description of a workspace.
endpoint str
Endpoint for the Grafana workspace.
grafana_version str
The version of Grafana to support in your workspace.
id str
The id that uniquely identifies a Grafana workspace.
modification_timestamp str
Timestamp when the workspace was last modified
name str
The user friendly name of a workspace.
network_access_control WorkspaceNetworkAccessControl
The configuration settings for network access to your workspace.
notification_destinations Sequence[WorkspaceNotificationDestinationType]
List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
organization_role_name str
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.
permission_type WorkspacePermissionType

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

plugin_admin_enabled bool
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 WorkspaceSamlConfiguration
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 and Editor roles in the workspace.
saml_configuration_status WorkspaceSamlConfigurationStatus

Specifies whether the workspace's SAML configuration is complete.

Valid values: CONFIGURED | NOT_CONFIGURED

Type: String

sso_client_id str
The client ID of the AWS SSO Managed Application.
stack_set_name str
The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
status WorkspaceStatus

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

vpc_configuration WorkspaceVpcConfiguration

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

accountAccessType "CURRENT_ACCOUNT" | "ORGANIZATION"
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 , the OrganizationalUnits parameter specifies which organizational units the workspace can access.
authenticationProviders List<"AWS_SSO" | "SAML">
List of authentication providers to enable.
creationTimestamp String
Timestamp when the workspace was created.
dataSources 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.
endpoint String
Endpoint for the Grafana workspace.
grafanaVersion String
The version of Grafana to support in your workspace.
id String
The id that uniquely identifies a Grafana workspace.
modificationTimestamp String
Timestamp when the workspace was last modified
name String
The user friendly name of a workspace.
networkAccessControl Property Map
The configuration settings for network access to your workspace.
notificationDestinations List<"SNS">
List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
organizationRoleName String
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.
organizationalUnits List<String>
List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
permissionType "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

pluginAdminEnabled Boolean
Allow workspace admins to install plugins
roleArn String
IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
samlConfiguration 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 and Editor roles in the workspace.
samlConfigurationStatus "CONFIGURED" | "NOT_CONFIGURED"

Specifies whether the workspace's SAML configuration is complete.

Valid values: CONFIGURED | NOT_CONFIGURED

Type: String

ssoClientId String
The client ID of the AWS SSO Managed Application.
stackSetName String
The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
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

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

Supporting Types

WorkspaceAccountAccessType

WorkspaceAssertionAttributes

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

WorkspaceDataSourceType

WorkspaceIdpMetadata

Url string
URL that vends the IdPs metadata.
Xml string
XML blob of the IdPs metadata.
Url string
URL that vends the IdPs metadata.
Xml string
XML blob of the IdPs metadata.
url String
URL that vends the IdPs metadata.
xml String
XML blob of the IdPs metadata.
url string
URL that vends the IdPs metadata.
xml string
XML blob of the IdPs metadata.
url str
URL that vends the IdPs metadata.
xml str
XML blob of the IdPs metadata.
url String
URL that vends the IdPs metadata.
xml String
XML blob of the IdPs metadata.

WorkspaceNetworkAccessControl

PrefixListIds List<string>
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.
VpceIds 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.
PrefixListIds []string
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.
VpceIds []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.
prefixListIds List<String>
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.
vpceIds 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.
prefixListIds string[]
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.
vpceIds 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_ids Sequence[str]
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.
prefixListIds List<String>
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.
vpceIds 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

WorkspacePermissionType

WorkspaceRoleValues

Admin List<string>
List of SAML roles which will be mapped into the Grafana Admin role.
Editor List<string>
List of SAML roles which will be mapped into the Grafana Editor role.
Admin []string
List of SAML roles which will be mapped into the Grafana Admin role.
Editor []string
List of SAML roles which will be mapped into the Grafana Editor role.
admin List<String>
List of SAML roles which will be mapped into the Grafana Admin role.
editor List<String>
List of SAML roles which will be mapped into the Grafana Editor role.
admin string[]
List of SAML roles which will be mapped into the Grafana Admin role.
editor string[]
List of SAML roles which will be mapped into the Grafana Editor role.
admin Sequence[str]
List of SAML roles which will be mapped into the Grafana Admin role.
editor Sequence[str]
List of SAML roles which will be mapped into the Grafana Editor role.
admin List<String>
List of SAML roles which will be mapped into the Grafana Admin role.
editor List<String>
List of SAML roles which will be mapped into the Grafana Editor role.

WorkspaceSamlConfiguration

IdpMetadata This property is required. Pulumi.AwsNative.Grafana.Inputs.WorkspaceIdpMetadata
A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
AllowedOrganizations List<string>
List of SAML organizations allowed to access Grafana.
AssertionAttributes Pulumi.AwsNative.Grafana.Inputs.WorkspaceAssertionAttributes
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.
LoginValidityDuration double
The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.
RoleValues Pulumi.AwsNative.Grafana.Inputs.WorkspaceRoleValues
A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.
IdpMetadata This property is required. WorkspaceIdpMetadata
A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
AllowedOrganizations []string
List of SAML organizations allowed to access Grafana.
AssertionAttributes WorkspaceAssertionAttributes
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.
LoginValidityDuration float64
The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.
RoleValues WorkspaceRoleValues
A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.
idpMetadata This property is required. WorkspaceIdpMetadata
A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
allowedOrganizations List<String>
List of SAML organizations allowed to access Grafana.
assertionAttributes WorkspaceAssertionAttributes
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.
loginValidityDuration Double
The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.
roleValues WorkspaceRoleValues
A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.
idpMetadata This property is required. WorkspaceIdpMetadata
A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
allowedOrganizations string[]
List of SAML organizations allowed to access Grafana.
assertionAttributes WorkspaceAssertionAttributes
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.
loginValidityDuration number
The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.
roleValues WorkspaceRoleValues
A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.
idp_metadata This property is required. WorkspaceIdpMetadata
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 WorkspaceAssertionAttributes
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_duration float
The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.
role_values WorkspaceRoleValues
A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.
idpMetadata This property is required. Property Map
A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
allowedOrganizations List<String>
List of SAML organizations allowed to access Grafana.
assertionAttributes 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.
loginValidityDuration Number
The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.
roleValues Property Map
A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.

WorkspaceSamlConfigurationStatus

WorkspaceStatus

WorkspaceVpcConfiguration

SecurityGroupIds This property is required. List<string>
The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
SubnetIds This property is required. List<string>
The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
SecurityGroupIds This property is required. []string
The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
SubnetIds This property is required. []string
The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
securityGroupIds This property is required. List<String>
The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
subnetIds This property is required. List<String>
The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
securityGroupIds This property is required. string[]
The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
subnetIds This property is required. string[]
The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
security_group_ids This property is required. Sequence[str]
The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
subnet_ids This property is required. Sequence[str]
The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
securityGroupIds This property is required. List<String>
The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
subnetIds This property is required. 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.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native