1. Packages
  2. AWS Native
  3. API Docs
  4. grafana
  5. Workspace

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

aws-native.grafana.Workspace

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

    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:

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

    ClientToken string
    A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
    DataSources List<Pulumi.AwsNative.Grafana.WorkspaceDataSourceType>
    List of data sources on the service managed IAM role.
    Description string
    Description of a workspace.
    GrafanaVersion string
    The version of Grafana to support in your workspace.
    Name string
    The user friendly name of a workspace.
    NetworkAccessControl Pulumi.AwsNative.Grafana.Inputs.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.
    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.Inputs.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.
    StackSetName string
    The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
    VpcConfiguration Pulumi.AwsNative.Grafana.Inputs.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.
    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

    ClientToken string
    A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
    DataSources []WorkspaceDataSourceType
    List of data sources on the service managed IAM role.
    Description string
    Description of a workspace.
    GrafanaVersion string
    The version of Grafana to support in your workspace.
    Name string
    The user friendly name of a workspace.
    NetworkAccessControl WorkspaceNetworkAccessControlArgs
    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.
    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 WorkspaceSamlConfigurationArgs
    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.
    StackSetName string
    The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
    VpcConfiguration WorkspaceVpcConfigurationArgs

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

    clientToken String
    A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
    dataSources List<WorkspaceDataSourceType>
    List of data sources on the service managed IAM role.
    description String
    Description of a workspace.
    grafanaVersion String
    The version of Grafana to support in your workspace.
    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.
    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.
    stackSetName String
    The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
    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.
    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

    clientToken string
    A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
    dataSources WorkspaceDataSourceType[]
    List of data sources on the service managed IAM role.
    description string
    Description of a workspace.
    grafanaVersion string
    The version of Grafana to support in your workspace.
    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.
    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.
    stackSetName string
    The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
    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.
    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

    client_token str
    A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
    data_sources Sequence[WorkspaceDataSourceType]
    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_control WorkspaceNetworkAccessControlArgs
    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.
    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 WorkspaceSamlConfigurationArgs
    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.
    stack_set_name str
    The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
    vpc_configuration WorkspaceVpcConfigurationArgs

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

    clientToken String
    A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
    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.
    grafanaVersion String
    The version of Grafana to support in your workspace.
    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.
    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.
    stackSetName String
    The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
    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).

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Workspace resource produces the following output properties:

    AwsId string
    The id that uniquely identifies a Grafana workspace.
    CreationTimestamp 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.
    ModificationTimestamp string
    Timestamp when the workspace was last modified
    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.
    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

    AwsId string
    The id that uniquely identifies a Grafana workspace.
    CreationTimestamp 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.
    ModificationTimestamp string
    Timestamp when the workspace was last modified
    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.
    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

    awsId String
    The id that uniquely identifies a Grafana workspace.
    creationTimestamp 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.
    modificationTimestamp String
    Timestamp when the workspace was last modified
    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.
    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

    awsId string
    The id that uniquely identifies a Grafana workspace.
    creationTimestamp 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.
    modificationTimestamp string
    Timestamp when the workspace was last modified
    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.
    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

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

    awsId String
    The id that uniquely identifies a Grafana workspace.
    creationTimestamp 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.
    modificationTimestamp String
    Timestamp when the workspace was last modified
    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.
    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

    CurrentAccount
    CURRENT_ACCOUNT
    Organization
    ORGANIZATION
    WorkspaceAccountAccessTypeCurrentAccount
    CURRENT_ACCOUNT
    WorkspaceAccountAccessTypeOrganization
    ORGANIZATION
    CurrentAccount
    CURRENT_ACCOUNT
    Organization
    ORGANIZATION
    CurrentAccount
    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

    AwsSso
    AWS_SSO
    Saml
    SAML
    WorkspaceAuthenticationProviderTypesAwsSso
    AWS_SSO
    WorkspaceAuthenticationProviderTypesSaml
    SAML
    AwsSso
    AWS_SSO
    Saml
    SAML
    AwsSso
    AWS_SSO
    Saml
    SAML
    AWS_SSO
    AWS_SSO
    SAML
    SAML
    "AWS_SSO"
    AWS_SSO
    "SAML"
    SAML

    WorkspaceDataSourceType, WorkspaceDataSourceTypeArgs

    AmazonOpensearchService
    AMAZON_OPENSEARCH_SERVICE
    Cloudwatch
    CLOUDWATCH
    Prometheus
    PROMETHEUS
    Xray
    XRAY
    Timestream
    TIMESTREAM
    Sitewise
    SITEWISE
    Athena
    ATHENA
    Redshift
    REDSHIFT
    WorkspaceDataSourceTypeAmazonOpensearchService
    AMAZON_OPENSEARCH_SERVICE
    WorkspaceDataSourceTypeCloudwatch
    CLOUDWATCH
    WorkspaceDataSourceTypePrometheus
    PROMETHEUS
    WorkspaceDataSourceTypeXray
    XRAY
    WorkspaceDataSourceTypeTimestream
    TIMESTREAM
    WorkspaceDataSourceTypeSitewise
    SITEWISE
    WorkspaceDataSourceTypeAthena
    ATHENA
    WorkspaceDataSourceTypeRedshift
    REDSHIFT
    AmazonOpensearchService
    AMAZON_OPENSEARCH_SERVICE
    Cloudwatch
    CLOUDWATCH
    Prometheus
    PROMETHEUS
    Xray
    XRAY
    Timestream
    TIMESTREAM
    Sitewise
    SITEWISE
    Athena
    ATHENA
    Redshift
    REDSHIFT
    AmazonOpensearchService
    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

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

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

    Sns
    SNS
    WorkspaceNotificationDestinationTypeSns
    SNS
    Sns
    SNS
    Sns
    SNS
    SNS
    SNS
    "SNS"
    SNS

    WorkspacePermissionType, WorkspacePermissionTypeArgs

    CustomerManaged
    CUSTOMER_MANAGED
    ServiceManaged
    SERVICE_MANAGED
    WorkspacePermissionTypeCustomerManaged
    CUSTOMER_MANAGED
    WorkspacePermissionTypeServiceManaged
    SERVICE_MANAGED
    CustomerManaged
    CUSTOMER_MANAGED
    ServiceManaged
    SERVICE_MANAGED
    CustomerManaged
    CUSTOMER_MANAGED
    ServiceManaged
    SERVICE_MANAGED
    CUSTOMER_MANAGED
    CUSTOMER_MANAGED
    SERVICE_MANAGED
    SERVICE_MANAGED
    "CUSTOMER_MANAGED"
    CUSTOMER_MANAGED
    "SERVICE_MANAGED"
    SERVICE_MANAGED

    WorkspaceRoleValues, WorkspaceRoleValuesArgs

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

    IdpMetadata 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 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 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 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 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 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, WorkspaceSamlConfigurationStatusArgs

    Configured
    CONFIGURED
    NotConfigured
    NOT_CONFIGURED
    WorkspaceSamlConfigurationStatusConfigured
    CONFIGURED
    WorkspaceSamlConfigurationStatusNotConfigured
    NOT_CONFIGURED
    Configured
    CONFIGURED
    NotConfigured
    NOT_CONFIGURED
    Configured
    CONFIGURED
    NotConfigured
    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
    VersionUpdating
    VERSION_UPDATING
    DeletionFailed
    DELETION_FAILED
    CreationFailed
    CREATION_FAILED
    UpdateFailed
    UPDATE_FAILED
    UpgradeFailed
    UPGRADE_FAILED
    LicenseRemovalFailed
    LICENSE_REMOVAL_FAILED
    VersionUpdateFailed
    VERSION_UPDATE_FAILED
    WorkspaceStatusActive
    ACTIVE
    WorkspaceStatusCreating
    CREATING
    WorkspaceStatusDeleting
    DELETING
    WorkspaceStatusFailed
    FAILED
    WorkspaceStatusUpdating
    UPDATING
    WorkspaceStatusUpgrading
    UPGRADING
    WorkspaceStatusVersionUpdating
    VERSION_UPDATING
    WorkspaceStatusDeletionFailed
    DELETION_FAILED
    WorkspaceStatusCreationFailed
    CREATION_FAILED
    WorkspaceStatusUpdateFailed
    UPDATE_FAILED
    WorkspaceStatusUpgradeFailed
    UPGRADE_FAILED
    WorkspaceStatusLicenseRemovalFailed
    LICENSE_REMOVAL_FAILED
    WorkspaceStatusVersionUpdateFailed
    VERSION_UPDATE_FAILED
    Active
    ACTIVE
    Creating
    CREATING
    Deleting
    DELETING
    Failed
    FAILED
    Updating
    UPDATING
    Upgrading
    UPGRADING
    VersionUpdating
    VERSION_UPDATING
    DeletionFailed
    DELETION_FAILED
    CreationFailed
    CREATION_FAILED
    UpdateFailed
    UPDATE_FAILED
    UpgradeFailed
    UPGRADE_FAILED
    LicenseRemovalFailed
    LICENSE_REMOVAL_FAILED
    VersionUpdateFailed
    VERSION_UPDATE_FAILED
    Active
    ACTIVE
    Creating
    CREATING
    Deleting
    DELETING
    Failed
    FAILED
    Updating
    UPDATING
    Upgrading
    UPGRADING
    VersionUpdating
    VERSION_UPDATING
    DeletionFailed
    DELETION_FAILED
    CreationFailed
    CREATION_FAILED
    UpdateFailed
    UPDATE_FAILED
    UpgradeFailed
    UPGRADE_FAILED
    LicenseRemovalFailed
    LICENSE_REMOVAL_FAILED
    VersionUpdateFailed
    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

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

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

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi