# CfnWorkspace

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.

Extends: [Construct](https://docs.aws.amazon.com/cdk/api/v2/docs/constructs.Construct.html) › [CfnElement](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.CfnElement.html) › [CfnRefElement](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.CfnRefElement.html) › [CfnResource](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.CfnResource.html) › CfnWorkspace
Implements: [IInspectable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IInspectable.html), [ITaggableV2](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.ITaggableV2.html), [IEnvironmentAware](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.interfaces.IEnvironmentAware.html), [IWorkspaceRef](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_grafana.IWorkspaceRef.html), IConstruct, IDependable

- CloudFormation: [`AWS::Grafana::Workspace`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-grafana-workspace.html)
- Source: Generated at build time
- Type last changed: v2.264.0 · 10 Aug 2026

## Example

TypeScript:

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_grafana as grafana } from 'aws-cdk-lib';
const cfnWorkspace = new grafana.CfnWorkspace(this, 'MyCfnWorkspace', {
  accountAccessType: 'accountAccessType',
  authenticationProviders: ['authenticationProviders'],
  permissionType: 'permissionType',

  // the properties below are optional
  clientToken: 'clientToken',
  dataSources: ['dataSources'],
  description: 'description',
  grafanaVersion: 'grafanaVersion',
  name: 'name',
  networkAccessControl: {
    prefixListIds: ['prefixListIds'],
    vpceIds: ['vpceIds'],
  },
  notificationDestinations: ['notificationDestinations'],
  organizationalUnits: ['organizationalUnits'],
  organizationRoleName: 'organizationRoleName',
  pluginAdminEnabled: false,
  roleArn: 'roleArn',
  samlConfiguration: {
    idpMetadata: {
      url: 'url',
      xml: 'xml',
    },

    // the properties below are optional
    allowedOrganizations: ['allowedOrganizations'],
    assertionAttributes: {
      email: 'email',
      groups: 'groups',
      login: 'login',
      name: 'name',
      org: 'org',
      role: 'role',
    },
    loginValidityDuration: 123,
    roleValues: {
      admin: ['admin'],
      editor: ['editor'],
    },
  },
  stackSetName: 'stackSetName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vpcConfiguration: {
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
  },
});
```

Python:

```python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_grafana as grafana

cfn_workspace = grafana.CfnWorkspace(self, "MyCfnWorkspace",
    account_access_type="accountAccessType",
    authentication_providers=["authenticationProviders"],
    permission_type="permissionType",

    # the properties below are optional
    client_token="clientToken",
    data_sources=["dataSources"],
    description="description",
    grafana_version="grafanaVersion",
    name="name",
    network_access_control=grafana.CfnWorkspace.NetworkAccessControlProperty(
        prefix_list_ids=["prefixListIds"],
        vpce_ids=["vpceIds"]
    ),
    notification_destinations=["notificationDestinations"],
    organizational_units=["organizationalUnits"],
    organization_role_name="organizationRoleName",
    plugin_admin_enabled=False,
    role_arn="roleArn",
    saml_configuration=grafana.CfnWorkspace.SamlConfigurationProperty(
        idp_metadata=grafana.CfnWorkspace.IdpMetadataProperty(
            url="url",
            xml="xml"
        ),

        # the properties below are optional
        allowed_organizations=["allowedOrganizations"],
        assertion_attributes=grafana.CfnWorkspace.AssertionAttributesProperty(
            email="email",
            groups="groups",
            login="login",
            name="name",
            org="org",
            role="role"
        ),
        login_validity_duration=123,
        role_values=grafana.CfnWorkspace.RoleValuesProperty(
            admin=["admin"],
            editor=["editor"]
        )
    ),
    stack_set_name="stackSetName",
    tags=[grafana.CfnWorkspace.TagsItemsProperty(
        key="key",
        value="value"
    )],
    vpc_configuration=grafana.CfnWorkspace.VpcConfigurationProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
)
```

Java:

```java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.grafana.*;

CfnWorkspace cfnWorkspace = CfnWorkspace.Builder.create(this, "MyCfnWorkspace")
        .accountAccessType("accountAccessType")
        .authenticationProviders(List.of("authenticationProviders"))
        .permissionType("permissionType")

        // the properties below are optional
        .clientToken("clientToken")
        .dataSources(List.of("dataSources"))
        .description("description")
        .grafanaVersion("grafanaVersion")
        .name("name")
        .networkAccessControl(NetworkAccessControlProperty.builder()
                .prefixListIds(List.of("prefixListIds"))
                .vpceIds(List.of("vpceIds"))
                .build())
        .notificationDestinations(List.of("notificationDestinations"))
        .organizationalUnits(List.of("organizationalUnits"))
        .organizationRoleName("organizationRoleName")
        .pluginAdminEnabled(false)
        .roleArn("roleArn")
        .samlConfiguration(SamlConfigurationProperty.builder()
                .idpMetadata(IdpMetadataProperty.builder()
                        .url("url")
                        .xml("xml")
                        .build())

                // the properties below are optional
                .allowedOrganizations(List.of("allowedOrganizations"))
                .assertionAttributes(AssertionAttributesProperty.builder()
                        .email("email")
                        .groups("groups")
                        .login("login")
                        .name("name")
                        .org("org")
                        .role("role")
                        .build())
                .loginValidityDuration(123)
                .roleValues(RoleValuesProperty.builder()
                        .admin(List.of("admin"))
                        .editor(List.of("editor"))
                        .build())
                .build())
        .stackSetName("stackSetName")
        .tags(List.of(TagsItemsProperty.builder()
                .key("key")
                .value("value")
                .build()))
        .vpcConfiguration(VpcConfigurationProperty.builder()
                .securityGroupIds(List.of("securityGroupIds"))
                .subnetIds(List.of("subnetIds"))
                .build())
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Grafana;

var cfnWorkspace = new CfnWorkspace(this, "MyCfnWorkspace", new CfnWorkspaceProps {
    AccountAccessType = "accountAccessType",
    AuthenticationProviders = new [] { "authenticationProviders" },
    PermissionType = "permissionType",

    // the properties below are optional
    ClientToken = "clientToken",
    DataSources = new [] { "dataSources" },
    Description = "description",
    GrafanaVersion = "grafanaVersion",
    Name = "name",
    NetworkAccessControl = new NetworkAccessControlProperty {
        PrefixListIds = new [] { "prefixListIds" },
        VpceIds = new [] { "vpceIds" }
    },
    NotificationDestinations = new [] { "notificationDestinations" },
    OrganizationalUnits = new [] { "organizationalUnits" },
    OrganizationRoleName = "organizationRoleName",
    PluginAdminEnabled = false,
    RoleArn = "roleArn",
    SamlConfiguration = new SamlConfigurationProperty {
        IdpMetadata = new IdpMetadataProperty {
            Url = "url",
            Xml = "xml"
        },

        // the properties below are optional
        AllowedOrganizations = new [] { "allowedOrganizations" },
        AssertionAttributes = new AssertionAttributesProperty {
            Email = "email",
            Groups = "groups",
            Login = "login",
            Name = "name",
            Org = "org",
            Role = "role"
        },
        LoginValidityDuration = 123,
        RoleValues = new RoleValuesProperty {
            Admin = new [] { "admin" },
            Editor = new [] { "editor" }
        }
    },
    StackSetName = "stackSetName",
    Tags = new [] { new TagsItemsProperty {
        Key = "key",
        Value = "value"
    } },
    VpcConfiguration = new VpcConfigurationProperty {
        SecurityGroupIds = new [] { "securityGroupIds" },
        SubnetIds = new [] { "subnetIds" }
    }
});
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnWorkspace := awscdk.Aws_grafana.NewCfnWorkspace(this, jsii.String("MyCfnWorkspace"), &CfnWorkspaceProps{
	AccountAccessType: jsii.String("accountAccessType"),
	AuthenticationProviders: []*string{
		jsii.String("authenticationProviders"),
	},
	PermissionType: jsii.String("permissionType"),

	// the properties below are optional
	ClientToken: jsii.String("clientToken"),
	DataSources: []*string{
		jsii.String("dataSources"),
	},
	Description: jsii.String("description"),
	GrafanaVersion: jsii.String("grafanaVersion"),
	Name: jsii.String("name"),
	NetworkAccessControl: &NetworkAccessControlProperty{
		PrefixListIds: []*string{
			jsii.String("prefixListIds"),
		},
		VpceIds: []*string{
			jsii.String("vpceIds"),
		},
	},
	NotificationDestinations: []*string{
		jsii.String("notificationDestinations"),
	},
	OrganizationalUnits: []*string{
		jsii.String("organizationalUnits"),
	},
	OrganizationRoleName: jsii.String("organizationRoleName"),
	PluginAdminEnabled: jsii.Boolean(false),
	RoleArn: jsii.String("roleArn"),
	SamlConfiguration: &SamlConfigurationProperty{
		IdpMetadata: &IdpMetadataProperty{
			Url: jsii.String("url"),
			Xml: jsii.String("xml"),
		},

		// the properties below are optional
		AllowedOrganizations: []*string{
			jsii.String("allowedOrganizations"),
		},
		AssertionAttributes: &AssertionAttributesProperty{
			Email: jsii.String("email"),
			Groups: jsii.String("groups"),
			Login: jsii.String("login"),
			Name: jsii.String("name"),
			Org: jsii.String("org"),
			Role: jsii.String("role"),
		},
		LoginValidityDuration: jsii.Number(123),
		RoleValues: &RoleValuesProperty{
			Admin: []*string{
				jsii.String("admin"),
			},
			Editor: []*string{
				jsii.String("editor"),
			},
		},
	},
	StackSetName: jsii.String("stackSetName"),
	Tags: []TagsItemsProperty{
		&TagsItemsProperty{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	VpcConfiguration: &VpcConfigurationProperty{
		SecurityGroupIds: []*string{
			jsii.String("securityGroupIds"),
		},
		SubnetIds: []*string{
			jsii.String("subnetIds"),
		},
	},
})
```

## Initializer

TypeScript:

```ts
new CfnWorkspace(scope: Construct, id: string, props: CfnWorkspaceProps)
```

Python:

```python
CfnWorkspace(scope: Construct, id: str, props: CfnWorkspaceProps)
```

Java:

```java
new CfnWorkspace(Construct scope, String id, CfnWorkspaceProps props)
```

C# / .NET:

```csharp
new CfnWorkspace(Construct scope, string id, CfnWorkspaceProps props)
```

Golang:

```go
NewCfnWorkspace(Scope Construct, Id *string, Props CfnWorkspaceProps)
```

## Construct Props

- `accountAccessType`: string (required) — 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`: string[] (required) — Specifies whether this workspace uses SAML 2.0, SSOlong , 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`

- `clientToken`: string — A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

- `dataSources`: string[] — 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` .

- `description`: string — The user-defined description of the workspace.

- `grafanaVersion`: string — 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.

- `name`: string — The name of the workspace.

- `networkAccessControl`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnWorkspace.NetworkAccessControlProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_grafana.CfnWorkspace.NetworkAccessControlProperty.html) — The configuration settings for network access to your workspace.

- `notificationDestinations`: string[] — 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`

- `organizationalUnits`: string[] — 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.

- `organizationRoleName`: string — The name of the IAM role that is used to access resources through Organizations.

- `permissionType`: string (required) — 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)

- `pluginAdminEnabled`: boolean | [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — 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.

- `roleArn`: string | [IRoleRef](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_iam.IRoleRef.html) — The IAM role that grants permissions to the AWS resources that the workspace will view data from.

  This role must already exist.

- `samlConfiguration`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnWorkspace.SamlConfigurationProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_grafana.CfnWorkspace.SamlConfigurationProperty.html) — 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 that is used to generate IAM roles to be used for this workspace.

- `tags`: [CfnWorkspace.TagsItemsProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_grafana.CfnWorkspace.TagsItemsProperty.html)[] — The list of tags associated with the workspace.

- `vpcConfiguration`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnWorkspace.VpcConfigurationProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_grafana.CfnWorkspace.VpcConfigurationProperty.html) — 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).

## Properties

- `accountAccessType`: string — 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.

- `attrCreationTimestamp`: string — The date that the workspace was created.

  Type: Timestamp

- `attrEndpoint`: string — The URL that users can use to access the Grafana console in the workspace.

  Type: String

- `attrGrafanaVersion`: string — Specifies the version of Grafana supported by this workspace.

  Type: String

- `attrId`: string — The unique ID of this workspace.

  Type: String

- `attrModificationTimestamp`: string — The most recent date that the workspace was modified.

  Type: Timestamp

- `attrSamlConfigurationStatus`: string — Specifies whether the workspace's SAML configuration is complete.

  Valid values: `CONFIGURED | NOT_CONFIGURED`

  Type: String

- `attrSsoClientId`: string — The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana .

  Type: String

- `attrStatus`: string — 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

- `authenticationProviders`: string[] — Specifies whether this workspace uses SAML 2.0, SSOlong , 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) .

- `cdkTagManager`: [TagManager](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.TagManager.html) — Tag Manager which manages the tags for this resource.

- `CFN_RESOURCE_TYPE_NAME`: string (static) — The CloudFormation resource type name for this resource class.

- `cfnOptions`: [ICfnResourceOptions](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.ICfnResourceOptions.html) — Options for this resource, such as condition, update policy etc.

- `cfnResourceType`: string — AWS resource type.

- `clientToken`: string — A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

- `creationStack`: string[]

- `dataSources`: string[] — 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.

- `description`: string — The user-defined description of the workspace.

- `env`: [ResourceEnvironment](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html)

- `grafanaVersion`: string — Specifies the version of Grafana to support in the workspace.

- `logicalId`: string — The logical ID for this CloudFormation stack element.

  The logical ID of the element
  is calculated from the path of the resource node in the construct tree.

  To override this value, use `overrideLogicalId(newLogicalId)`.

- `name`: string — The name of the workspace.

- `networkAccessControl`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnWorkspace.NetworkAccessControlProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_grafana.CfnWorkspace.NetworkAccessControlProperty.html) — The configuration settings for network access to your workspace.

- `node`: [Node](https://docs.aws.amazon.com/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `notificationDestinations`: string[] — 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.

- `organizationalUnits`: string[] — 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.

- `organizationRoleName`: string — The name of the IAM role that is used to access resources through Organizations.

- `permissionType`: string — 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.

- `pluginAdminEnabled`: boolean | [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Whether plugin administration is enabled in the workspace.

- `ref`: string — Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

  If, by any chance, the intrinsic reference of a resource is not a string, you could
  coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.

- `roleArn`: string — The IAM role that grants permissions to the AWS resources that the workspace will view data from.

- `samlConfiguration`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnWorkspace.SamlConfigurationProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_grafana.CfnWorkspace.SamlConfigurationProperty.html) — 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`: [Stack](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this element is defined.

  CfnElements must be defined within a stack scope (directly or indirectly).

- `stackSetName`: string — The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.

- `tags`: [CfnWorkspace.TagsItemsProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_grafana.CfnWorkspace.TagsItemsProperty.html)[] — The list of tags associated with the workspace.

- `vpcConfiguration`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnWorkspace.VpcConfigurationProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_grafana.CfnWorkspace.VpcConfigurationProperty.html) — The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

- `workspaceRef`: [WorkspaceReference](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_grafana.WorkspaceReference.html) — A reference to a Workspace resource.

## Methods

- `addDeletionOverride(path: string): void` — Syntactic sugar for `addOverride(path, undefined)`.

  **Parameters**

  - `path` — The path of the value to delete.

- `addDependency(target: CfnResource): void` — Use `addResourceDependency` instead.

  This method has been renamed to `addResourceDependency` to more clearly
  set it apart from `construct.node.addDependency`. See the documentation
  of that function for more details.

- `addDependsOn(target: CfnResource): void` — Use `addResourceDependency` instead.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method has been renamed to `addResourceDependency`, which makes it
  more clear that this method operates at a different level from the
  construct-level `construct.node.addDependency()` mechanism.

- `addMetadata(key: string, value: any): void` — Add a value to the CloudFormation Resource Metadata.

- `addOverride(path: string, value: any): void` — Adds an override to the synthesized CloudFormation resource.

  To add a
  property override, either use `addPropertyOverride` or prefix `path` with
  "Properties." (i.e. `Properties.TopicName`).

  If the override is nested, separate each nested level using a dot (.) in the path parameter.
  If there is an array as part of the nesting, specify the index in the path.

  To include a literal `.` in the property name, prefix with a `\`. In most
  programming languages you will need to write this as `"\\."` because the
  `\` itself will need to be escaped.

  For example,
  ```typescript
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
  ```
  would add the overrides
  ```json
  "Properties": {
    "GlobalSecondaryIndexes": [
      {
        "Projection": {
          "NonKeyAttributes": [ "myattribute" ]
          ...
        }
        ...
      },
      {
        "ProjectionType": "INCLUDE"
        ...
      },
    ]
    ...
  }
  ```

  The `value` argument to `addOverride` will not be processed or translated
  in any way. Pass raw JSON values in here with the correct capitalization
  for CloudFormation. If you pass CDK classes or structs, they will be
  rendered with lowercased key names, and CloudFormation will reject the
  template.

  **Parameters**

  - `path` — - The path of the property, you can use dot notation to override values in complex types.
  - `value` — - The value.

- `addPropertyDeletionOverride(propertyPath: string): void` — Adds an override that deletes the value of a property from the resource definition.

  **Parameters**

  - `propertyPath` — The path to the property.

- `addPropertyOverride(propertyPath: string, value: any): void` — Adds an override to a resource property.

  Syntactic sugar for `addOverride("Properties.<...>", value)`.

  **Parameters**

  - `propertyPath` — The path of the property.
  - `value` — The value.

- `addResourceDependency(target: CfnResource, reason?: string): void` — Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method only adds dependencies between L1 resources. If you are
  looking for a generic construct-to-construct dependency mechanism that works
  for all constructs including L2s, use `construct.node.addDependency` instead.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Sets the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  strength instead of the global default from the consuming stack's context.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void` — Sets the deletion policy of the resource based on the removal policy specified.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
  cases, a snapshot can be taken of the resource prior to deletion
  (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
  can be found in the following link:

- `cfnPropertyName(cdkPropertyName: string): string`

- `getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference` — Returns a token for an runtime attribute of this resource.

  Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
  in case there is no generated attribute.

  **Parameters**

  - `attributeName` — The name of the attribute.

- `getMetadata(key: string): any` — Retrieve a value value from the CloudFormation Resource Metadata.

- `inspect(inspector: TreeInspector): void` — Examines the CloudFormation resource and discloses attributes.

  **Parameters**

  - `inspector` — tree inspector to collect and process attributes.

- `isCfnElement(x: any): boolean` (static) — Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

  Uses duck-typing instead of `instanceof` to allow stack elements from different
  versions of this library to be included in the same stack.

  **Returns:** The construct as a stack element or undefined if it is not a stack element.

- `isCfnResource(x: any): boolean` (static) — Check whether the given object is a CfnResource.

- `isCfnWorkspace(x: any): boolean` (static) — Checks whether the given object is a CfnWorkspace.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `obtainDependencies(): Stack | CfnResource[]` — Retrieves an array of resources and stacks this resource depends on.

  For resources depended on directly, returns the `CfnResource` object. For
  dependencies on other stacks, returns the `Stack` object. The order of the
  array is not guaranteed.

- `overrideLogicalId(newLogicalId: string): void` — Overrides the auto-generated logical ID with a specific ID.

  **Parameters**

  - `newLogicalId` — The new logical ID to use for this stack element.

- `removeDependency(target: CfnResource): void` — Use `removeResourceDependency` instead

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `removeResourceDependency(target: CfnResource): void` — Indicates that this resource no longer depends on another resource.

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `replaceDependency(target: CfnResource, newTarget: CfnResource): void` — Replaces one dependency with another.

  **Parameters**

  - `target` — The dependency to replace.
  - `newTarget` — The new dependency to add.

- `toString(): string` — Returns a string representation of this construct.

  **Returns:** a string representation of this resource

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.
