This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Grafana::Workspace
<a name="aws-resource-grafana-workspace"></a>

Specifies a *workspace*. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.

## Syntax
<a name="aws-resource-grafana-workspace-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-grafana-workspace-syntax.json"></a>

```
{
  "Type" : "AWS::Grafana::Workspace",
  "Properties" : {
      "[AccountAccessType](#cfn-grafana-workspace-accountaccesstype)" : String,
      "[AuthenticationProviders](#cfn-grafana-workspace-authenticationproviders)" : [ String, ... ],
      "[ClientToken](#cfn-grafana-workspace-clienttoken)" : String,
      "[DataSources](#cfn-grafana-workspace-datasources)" : [ String, ... ],
      "[Description](#cfn-grafana-workspace-description)" : String,
      "[GrafanaVersion](#cfn-grafana-workspace-grafanaversion)" : String,
      "[Name](#cfn-grafana-workspace-name)" : String,
      "[NetworkAccessControl](#cfn-grafana-workspace-networkaccesscontrol)" : NetworkAccessControl,
      "[NotificationDestinations](#cfn-grafana-workspace-notificationdestinations)" : [ String, ... ],
      "[OrganizationalUnits](#cfn-grafana-workspace-organizationalunits)" : [ String, ... ],
      "[OrganizationRoleName](#cfn-grafana-workspace-organizationrolename)" : String,
      "[PermissionType](#cfn-grafana-workspace-permissiontype)" : String,
      "[PluginAdminEnabled](#cfn-grafana-workspace-pluginadminenabled)" : Boolean,
      "[RoleArn](#cfn-grafana-workspace-rolearn)" : String,
      "[SamlConfiguration](#cfn-grafana-workspace-samlconfiguration)" : SamlConfiguration,
      "[StackSetName](#cfn-grafana-workspace-stacksetname)" : String,
      "[VpcConfiguration](#cfn-grafana-workspace-vpcconfiguration)" : VpcConfiguration
    }
}
```

### YAML
<a name="aws-resource-grafana-workspace-syntax.yaml"></a>

```
Type: AWS::Grafana::Workspace
Properties:
  [AccountAccessType](#cfn-grafana-workspace-accountaccesstype): String
  [AuthenticationProviders](#cfn-grafana-workspace-authenticationproviders): 
    - String
  [ClientToken](#cfn-grafana-workspace-clienttoken): String
  [DataSources](#cfn-grafana-workspace-datasources): 
    - String
  [Description](#cfn-grafana-workspace-description): String
  [GrafanaVersion](#cfn-grafana-workspace-grafanaversion): String
  [Name](#cfn-grafana-workspace-name): String
  [NetworkAccessControl](#cfn-grafana-workspace-networkaccesscontrol): 
    NetworkAccessControl
  [NotificationDestinations](#cfn-grafana-workspace-notificationdestinations): 
    - String
  [OrganizationalUnits](#cfn-grafana-workspace-organizationalunits): 
    - String
  [OrganizationRoleName](#cfn-grafana-workspace-organizationrolename): String
  [PermissionType](#cfn-grafana-workspace-permissiontype): String
  [PluginAdminEnabled](#cfn-grafana-workspace-pluginadminenabled): Boolean
  [RoleArn](#cfn-grafana-workspace-rolearn): String
  [SamlConfiguration](#cfn-grafana-workspace-samlconfiguration): 
    SamlConfiguration
  [StackSetName](#cfn-grafana-workspace-stacksetname): String
  [VpcConfiguration](#cfn-grafana-workspace-vpcconfiguration): 
    VpcConfiguration
```

## Properties
<a name="aws-resource-grafana-workspace-properties"></a>

`AccountAccessType`  <a name="cfn-grafana-workspace-accountaccesstype"></a>
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.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `CURRENT_ACCOUNT | ORGANIZATION`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AuthenticationProviders`  <a name="cfn-grafana-workspace-authenticationproviders"></a>
Specifies whether this workspace uses SAML 2.0, AWS IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see [User authentication in Amazon Managed Grafana](https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html).  
*Allowed Values*: `AWS_SSO | SAML`  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClientToken`  <a name="cfn-grafana-workspace-clienttoken"></a>
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.  
*Required*: No  
*Type*: String  
*Pattern*: `^[!-~]{1,64}$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DataSources`  <a name="cfn-grafana-workspace-datasources"></a>
Specifies the AWS data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.  
This list is only used when the workspace was created through the AWS console, and the `permissionType` is `SERVICE_MANAGED`.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-grafana-workspace-description"></a>
The user-defined description of the workspace.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GrafanaVersion`  <a name="cfn-grafana-workspace-grafanaversion"></a>
Specifies the version of Grafana to support in the workspace. Defaults to the latest version on create (for example, 9.4), or the current version of the workspace on update.  
Can only be used to upgrade (for example, from 8.4 to 9.4), not downgrade (for example, from 9.4 to 8.4).  
To know what versions are available to upgrade to for a specific workspace, see the [ListVersions](https://docs.aws.amazon.com/grafana/latest/APIReference/API_ListVersions.html) operation.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-grafana-workspace-name"></a>
The name of the workspace.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9-._~]{1,255}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NetworkAccessControl`  <a name="cfn-grafana-workspace-networkaccesscontrol"></a>
The configuration settings for network access to your workspace.  
*Required*: No  
*Type*: [NetworkAccessControl](aws-properties-grafana-workspace-networkaccesscontrol.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NotificationDestinations`  <a name="cfn-grafana-workspace-notificationdestinations"></a>
The AWS notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.  
*AllowedValues*: `SNS`  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OrganizationalUnits`  <a name="cfn-grafana-workspace-organizationalunits"></a>
Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OrganizationRoleName`  <a name="cfn-grafana-workspace-organizationrolename"></a>
The name of the IAM role that is used to access resources through Organizations.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PermissionType`  <a name="cfn-grafana-workspace-permissiontype"></a>
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](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html). 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](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html)  
*Required*: Yes  
*Type*: String  
*Allowed values*: `CUSTOMER_MANAGED | SERVICE_MANAGED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PluginAdminEnabled`  <a name="cfn-grafana-workspace-pluginadminenabled"></a>
Whether plugin administration is enabled in the workspace. Setting to `true` allows workspace admins to install, uninstall, and update plugins from within the Grafana workspace.  
This option is only valid for workspaces that support Grafana version 9 or newer.
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleArn`  <a name="cfn-grafana-workspace-rolearn"></a>
The IAM role that grants permissions to the AWS resources that the workspace will view data from. This role must already exist.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SamlConfiguration`  <a name="cfn-grafana-workspace-samlconfiguration"></a>
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.  
*Required*: No  
*Type*: [SamlConfiguration](aws-properties-grafana-workspace-samlconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StackSetName`  <a name="cfn-grafana-workspace-stacksetname"></a>
The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcConfiguration`  <a name="cfn-grafana-workspace-vpcconfiguration"></a>
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).
*Required*: No  
*Type*: [VpcConfiguration](aws-properties-grafana-workspace-vpcconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-grafana-workspace-return-values"></a>

### Ref
<a name="aws-resource-grafana-workspace-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:

 `{ "Ref": "Id" }` 

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-grafana-workspace-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-grafana-workspace-return-values-fn--getatt-fn--getatt"></a>

`CreationTimestamp`  <a name="CreationTimestamp-fn::getatt"></a>
The date that the workspace was created.  
Type: Timestamp

`Endpoint`  <a name="Endpoint-fn::getatt"></a>
The URL that users can use to access the Grafana console in the workspace.  
Type: String

`GrafanaVersion`  <a name="GrafanaVersion-fn::getatt"></a>
Specifies the version of Grafana supported by this workspace.  
Type: String

`Id`  <a name="Id-fn::getatt"></a>
The unique ID of this workspace.  
Type: String

`ModificationTimestamp`  <a name="ModificationTimestamp-fn::getatt"></a>
The most recent date that the workspace was modified.  
Type: Timestamp

`SamlConfigurationStatus`  <a name="SamlConfigurationStatus-fn::getatt"></a>
Specifies whether the workspace's SAML configuration is complete.  
Valid values: `CONFIGURED | NOT_CONFIGURED`  
Type: String

`SsoClientId`  <a name="SsoClientId-fn::getatt"></a>
The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana.  
Type: String

`Status`  <a name="Status-fn::getatt"></a>
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

## Examples
<a name="aws-resource-grafana-workspace--examples"></a>



### Create a workspace
<a name="aws-resource-grafana-workspace--examples--Create_a_workspace"></a>

Create an Amazon Managed Grafana workspace using CloudFormation

#### JSON
<a name="aws-resource-grafana-workspace--examples--Create_a_workspace--json"></a>

```
{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Description": "Amazon Grafana workspace stack",
    "Resources": {
        "AmazonGrafanaWorkspaceIAMRole": {
            "Type": "AWS::IAM::Role",
            "Properties": {
                "ManagedPolicyArns": ["arn:aws:iam::aws:policy/service-role/AmazonGrafanaAthenaAccess"],
                "AssumeRolePolicyDocument": {
                    "Version": "2012-10-17",		 	 	 
                    "Statement": [{
                        "Effect": "Allow",
                        "Principal": {
                            "Service": [
                                "grafana.amazonaws.com"
                            ]
                        },
                        "Action": [
                            "sts:AssumeRole"
                        ]
                    }]
                }
            }
        },
        "AmazonGrafanaWorkspace": {
            "Type": "AWS::Grafana::Workspace",
            "Properties": {
                "AccountAccessType": "CURRENT_ACCOUNT",
                "Name": "AmazonGrafanaWorkspace",
                "Description": "Amazon Grafana Workspace",
                "AuthenticationProviders": ["SAML"],
                "PermissionType": "CUSTOMER_MANAGED",
                "GrafanaVersion": "9.4",
                "RoleArn": {
                    "Fn::GetAtt": [
                        "AmazonGrafanaWorkspaceIAMRole",
                        "Arn"
                    ]
                },
                "SamlConfiguration": {
                    "IdpMetadata": {
                        "Xml": "<md:EntityDescriptor xmlns:md='urn:oasis:names:tc:SAML:2.0:metadata' entityID='entityId'>DATA</md:EntityDescriptor>"
                    },
                    "AssertionAttributes": {
                        "Name": "displayName",
                        "Login": "login",
                        "Email": "email",
                        "Groups": "group",
                        "Role": "role",
                        "Org": "org"
                    },
                    "RoleValues": {
                        "Editor": ["editor1"],
                        "Admin": ["admin1"]
                    },
                    "AllowedOrganizations": ["org1"],
                    "LoginValidityDuration": 60
                }
            }
        }
    },
    "Outputs": {
        "WorkspaceEndpoint": {
            "Value": {
                "Fn::GetAtt": [
                    "AmazonGrafanaWorkspace",
                    "Endpoint"
                ]
            }
        },
        "WorkspaceStatus": {
            "Value": {
                "Fn::GetAtt": [
                    "AmazonGrafanaWorkspace",
                    "Status"
                ]
            }
        },
        "WorkspaceId": {
            "Value": {
                "Ref": "AmazonGrafanaWorkspace"
            }
        },
        "GrafanaVersion": {
            "Value": {
                "Fn::GetAtt": [
                    "AmazonGrafanaWorkspace",
                    "GrafanaVersion"
                ]
            }
        }
    }
}
```

#### YAML
<a name="aws-resource-grafana-workspace--examples--Create_a_workspace--yaml"></a>

```
Description: Amazon Grafana workspace stack
Resources:
  AmazonGrafanaWorkspaceIAMRole:
    Type: 'AWS::IAM::Role'
    Properties:
      ManagedPolicyArns:
        - 'arn:aws:iam::aws:policy/service-role/AmazonGrafanaAthenaAccess'
      AssumeRolePolicyDocument:
        Version: 2012-10-17		 	 	 
        Statement:
          - Effect: Allow
            Principal:
              Service:
                - grafana.amazonaws.com
            Action:
              - 'sts:AssumeRole'

  AmazonGrafanaWorkspace:
    Type: 'AWS::Grafana::Workspace'
    Properties:
      AccountAccessType: CURRENT_ACCOUNT
      Name: AmazonGrafanaWorkspace
      Description: Amazon Grafana Workspace
      AuthenticationProviders:
        - SAML
      PermissionType: CUSTOMER_MANAGED
      GrafanaVersion: '9.4'
      RoleArn: !GetAtt 
        - AmazonGrafanaWorkspaceIAMRole
        - Arn
      SamlConfiguration:
        IdpMetadata:
          Xml: >-
            <md:EntityDescriptor xmlns:md='urn:oasis:names:tc:SAML:2.0:metadata'
            entityID='entityId'>DATA</md:EntityDescriptor>
        AssertionAttributes:
          Name: displayName
          Login: login
          Email: email
          Groups: group
          Role: role
          Org: org
        RoleValues:
          Editor:
            - editor1
          Admin:
            - admin1
        AllowedOrganizations:
          - org1
        LoginValidityDuration: 60

Outputs:
  WorkspaceEndpoint:
    Value: !GetAtt 
      - AmazonGrafanaWorkspace
      - Endpoint
  WorkspaceStatus:
    Value: !GetAtt 
      - AmazonGrafanaWorkspace
      - Status
  WorkspaceId:
    Value: !Ref AmazonGrafanaWorkspace
  GrafanaVersion:
    Value: !GetAtt 
      - AmazonGrafanaWorkspace
      - GrafanaVersion
```

# AWS::Grafana::Workspace AssertionAttributes
<a name="aws-properties-grafana-workspace-assertionattributes"></a>

A structure that defines which attributes in the IdP assertion are to be used to define information about the users authenticated by the IdP to use the workspace.

## Syntax
<a name="aws-properties-grafana-workspace-assertionattributes-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-grafana-workspace-assertionattributes-syntax.json"></a>

```
{
  "[Email](#cfn-grafana-workspace-assertionattributes-email)" : String,
  "[Groups](#cfn-grafana-workspace-assertionattributes-groups)" : String,
  "[Login](#cfn-grafana-workspace-assertionattributes-login)" : String,
  "[Name](#cfn-grafana-workspace-assertionattributes-name)" : String,
  "[Org](#cfn-grafana-workspace-assertionattributes-org)" : String,
  "[Role](#cfn-grafana-workspace-assertionattributes-role)" : String
}
```

### YAML
<a name="aws-properties-grafana-workspace-assertionattributes-syntax.yaml"></a>

```
  [Email](#cfn-grafana-workspace-assertionattributes-email): String
  [Groups](#cfn-grafana-workspace-assertionattributes-groups): String
  [Login](#cfn-grafana-workspace-assertionattributes-login): String
  [Name](#cfn-grafana-workspace-assertionattributes-name): String
  [Org](#cfn-grafana-workspace-assertionattributes-org): String
  [Role](#cfn-grafana-workspace-assertionattributes-role): String
```

## Properties
<a name="aws-properties-grafana-workspace-assertionattributes-properties"></a>

`Email`  <a name="cfn-grafana-workspace-assertionattributes-email"></a>
The name of the attribute within the SAML assertion to use as the email names for SAML users.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Groups`  <a name="cfn-grafana-workspace-assertionattributes-groups"></a>
The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Login`  <a name="cfn-grafana-workspace-assertionattributes-login"></a>
The name of the attribute within the SAML assertion to use as the login names for SAML users.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-grafana-workspace-assertionattributes-name"></a>
The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Org`  <a name="cfn-grafana-workspace-assertionattributes-org"></a>
The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Role`  <a name="cfn-grafana-workspace-assertionattributes-role"></a>
The name of the attribute within the SAML assertion to use as the user roles.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Grafana::Workspace IdpMetadata
<a name="aws-properties-grafana-workspace-idpmetadata"></a>

A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace. You can specify the metadata either by providing a URL to its location in the `url` parameter, or by specifying the full metadata in XML format in the `xml` parameter. Specifying both will cause an error.

## Syntax
<a name="aws-properties-grafana-workspace-idpmetadata-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-grafana-workspace-idpmetadata-syntax.json"></a>

```
{
  "[Url](#cfn-grafana-workspace-idpmetadata-url)" : String,
  "[Xml](#cfn-grafana-workspace-idpmetadata-xml)" : String
}
```

### YAML
<a name="aws-properties-grafana-workspace-idpmetadata-syntax.yaml"></a>

```
  [Url](#cfn-grafana-workspace-idpmetadata-url): String
  [Xml](#cfn-grafana-workspace-idpmetadata-xml): String
```

## Properties
<a name="aws-properties-grafana-workspace-idpmetadata-properties"></a>

`Url`  <a name="cfn-grafana-workspace-idpmetadata-url"></a>
The URL of the location containing the IdP metadata.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Xml`  <a name="cfn-grafana-workspace-idpmetadata-xml"></a>
The full IdP metadata, in XML format.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Grafana::Workspace NetworkAccessControl
<a name="aws-properties-grafana-workspace-networkaccesscontrol"></a>

The configuration settings for in-bound network access to your workspace.

When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization are still required.

Access is granted to a caller that is in either the IP address list or the VPC endpoint list - they do not need to be in both.

If this is not configured, or is removed, then all IP addresses and VPC endpoints are allowed. Standard Grafana authentication and authorization are still required.

**Note**  
While both `prefixListIds` and `vpceIds` are required, you can pass in an empty array of strings for either parameter if you do not want to allow any of that type.  
If both are passed as empty arrays, no traffic is allowed to the workspace, because only *explicitly* allowed connections are accepted.

## Syntax
<a name="aws-properties-grafana-workspace-networkaccesscontrol-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-grafana-workspace-networkaccesscontrol-syntax.json"></a>

```
{
  "[PrefixListIds](#cfn-grafana-workspace-networkaccesscontrol-prefixlistids)" : [ String, ... ],
  "[VpceIds](#cfn-grafana-workspace-networkaccesscontrol-vpceids)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-grafana-workspace-networkaccesscontrol-syntax.yaml"></a>

```
  [PrefixListIds](#cfn-grafana-workspace-networkaccesscontrol-prefixlistids): 
    - String
  [VpceIds](#cfn-grafana-workspace-networkaccesscontrol-vpceids): 
    - String
```

## Properties
<a name="aws-properties-grafana-workspace-networkaccesscontrol-properties"></a>

`PrefixListIds`  <a name="cfn-grafana-workspace-networkaccesscontrol-prefixlistids"></a>
An array 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 (passed an empty array) then no IP addresses are allowed to access the workspace. You create a prefix list using the Amazon VPC console.  
Prefix list IDs have the format `pl-1a2b3c4d`.  
For more information about prefix lists, see [Group CIDR blocks using managed prefix lists](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html)in the *Amazon Virtual Private Cloud User Guide*.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1 | 0`  
*Maximum*: `5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpceIds`  <a name="cfn-grafana-workspace-networkaccesscontrol-vpceids"></a>
An array of Amazon VPC endpoint IDs for the workspace. You can create VPC endpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a `NetworkAccessConfiguration` is specified then only VPC endpoints specified here are allowed to access the workspace. If you pass in an empty array of strings, then no VPCs are allowed to access the workspace.  
VPC endpoint IDs have the format `vpce-1a2b3c4d`.  
For more information about creating an interface VPC endpoint, see [Interface VPC endpoints](https://docs.aws.amazon.com/grafana/latest/userguide/VPC-endpoints) in the *Amazon Managed Grafana User Guide*.  
The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the `com.amazonaws.[region].grafana-workspace` service endpoint). Other VPC endpoints are ignored.
*Required*: No  
*Type*: Array of String  
*Minimum*: `1 | 0`  
*Maximum*: `5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Grafana::Workspace RoleValues
<a name="aws-properties-grafana-workspace-rolevalues"></a>

This structure defines which groups defined in the SAML assertion attribute are to be mapped to the Grafana `Admin` and `Editor` roles in the workspace. SAML authenticated users not part of `Admin` or `Editor` role groups have `Viewer` permission over the workspace.

## Syntax
<a name="aws-properties-grafana-workspace-rolevalues-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-grafana-workspace-rolevalues-syntax.json"></a>

```
{
  "[Admin](#cfn-grafana-workspace-rolevalues-admin)" : [ String, ... ],
  "[Editor](#cfn-grafana-workspace-rolevalues-editor)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-grafana-workspace-rolevalues-syntax.yaml"></a>

```
  [Admin](#cfn-grafana-workspace-rolevalues-admin): 
    - String
  [Editor](#cfn-grafana-workspace-rolevalues-editor): 
    - String
```

## Properties
<a name="aws-properties-grafana-workspace-rolevalues-properties"></a>

`Admin`  <a name="cfn-grafana-workspace-rolevalues-admin"></a>
A list of groups from the SAML assertion attribute to grant the Grafana `Admin` role to.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Editor`  <a name="cfn-grafana-workspace-rolevalues-editor"></a>
A list of groups from the SAML assertion attribute to grant the Grafana `Editor` role to.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Grafana::Workspace SamlConfiguration
<a name="aws-properties-grafana-workspace-samlconfiguration"></a>

A structure containing information about how this workspace works with SAML. 

## Syntax
<a name="aws-properties-grafana-workspace-samlconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-grafana-workspace-samlconfiguration-syntax.json"></a>

```
{
  "[AllowedOrganizations](#cfn-grafana-workspace-samlconfiguration-allowedorganizations)" : [ String, ... ],
  "[AssertionAttributes](#cfn-grafana-workspace-samlconfiguration-assertionattributes)" : AssertionAttributes,
  "[IdpMetadata](#cfn-grafana-workspace-samlconfiguration-idpmetadata)" : IdpMetadata,
  "[LoginValidityDuration](#cfn-grafana-workspace-samlconfiguration-loginvalidityduration)" : Number,
  "[RoleValues](#cfn-grafana-workspace-samlconfiguration-rolevalues)" : RoleValues
}
```

### YAML
<a name="aws-properties-grafana-workspace-samlconfiguration-syntax.yaml"></a>

```
  [AllowedOrganizations](#cfn-grafana-workspace-samlconfiguration-allowedorganizations): 
    - String
  [AssertionAttributes](#cfn-grafana-workspace-samlconfiguration-assertionattributes): 
    AssertionAttributes
  [IdpMetadata](#cfn-grafana-workspace-samlconfiguration-idpmetadata): 
    IdpMetadata
  [LoginValidityDuration](#cfn-grafana-workspace-samlconfiguration-loginvalidityduration): Number
  [RoleValues](#cfn-grafana-workspace-samlconfiguration-rolevalues): 
    RoleValues
```

## Properties
<a name="aws-properties-grafana-workspace-samlconfiguration-properties"></a>

`AllowedOrganizations`  <a name="cfn-grafana-workspace-samlconfiguration-allowedorganizations"></a>
Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AssertionAttributes`  <a name="cfn-grafana-workspace-samlconfiguration-assertionattributes"></a>
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.  
*Required*: No  
*Type*: [AssertionAttributes](aws-properties-grafana-workspace-assertionattributes.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IdpMetadata`  <a name="cfn-grafana-workspace-samlconfiguration-idpmetadata"></a>
A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.  
*Required*: Yes  
*Type*: [IdpMetadata](aws-properties-grafana-workspace-idpmetadata.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LoginValidityDuration`  <a name="cfn-grafana-workspace-samlconfiguration-loginvalidityduration"></a>
How long a sign-on session by a SAML user is valid, before the user has to sign on again.  
*Required*: No  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleValues`  <a name="cfn-grafana-workspace-samlconfiguration-rolevalues"></a>
A structure containing arrays that map group names in the SAML assertion to the Grafana `Admin` and `Editor` roles in the workspace.  
*Required*: No  
*Type*: [RoleValues](aws-properties-grafana-workspace-rolevalues.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Grafana::Workspace VpcConfiguration
<a name="aws-properties-grafana-workspace-vpcconfiguration"></a>

The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

**Note**  
Provided `securityGroupIds` and `subnetIds` must be part of the same VPC.  
Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).

## Syntax
<a name="aws-properties-grafana-workspace-vpcconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-grafana-workspace-vpcconfiguration-syntax.json"></a>

```
{
  "[SecurityGroupIds](#cfn-grafana-workspace-vpcconfiguration-securitygroupids)" : [ String, ... ],
  "[SubnetIds](#cfn-grafana-workspace-vpcconfiguration-subnetids)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-grafana-workspace-vpcconfiguration-syntax.yaml"></a>

```
  [SecurityGroupIds](#cfn-grafana-workspace-vpcconfiguration-securitygroupids): 
    - String
  [SubnetIds](#cfn-grafana-workspace-vpcconfiguration-subnetids): 
    - String
```

## Properties
<a name="aws-properties-grafana-workspace-vpcconfiguration-properties"></a>

`SecurityGroupIds`  <a name="cfn-grafana-workspace-vpcconfiguration-securitygroupids"></a>
The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.  
*Array Members*: Minimum number of 1 items. Maximum number of 5 items.  
*Length*: Minimum length of 0. Maximum length of 255.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1 | 1`  
*Maximum*: `255 | 5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SubnetIds`  <a name="cfn-grafana-workspace-vpcconfiguration-subnetids"></a>
The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.  
*Array Members*: Minimum number of 2 items. Maximum number of 6 items.  
*Length*: Minimum length of 0. Maximum length of 255.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1 | 2`  
*Maximum*: `255 | 6`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)