# CfnDomain Creates a `Domain` . A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other. *EFS storage* When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files. SageMaker AI uses the AWS Key Management Service ( AWS KMS) to encrypt the EFS volume attached to the domain with an AWS managed key by default. For more control, you can specify a customer managed key. For more information, see [Protect Data at Rest Using Encryption](https://docs.aws.amazon.com/sagemaker/latest/dg/encryption-at-rest.html) . *VPC configuration* All traffic between the domain and the Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can specify the `AppNetworkAccessType` parameter. `AppNetworkAccessType` corresponds to the network access type that you choose when you onboard to the domain. The following options are available: - `PublicInternetOnly` - Non-EFS traffic goes through a VPC managed by Amazon SageMaker AI, which allows internet access. This is the default value. - `VpcOnly` - All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway. When internet access is disabled, you won't be able to run a Amazon SageMaker AI Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker AI API and runtime or a NAT gateway and your security groups allow outbound connections. > NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker AI Studio app successfully. For more information, see [Connect Amazon SageMaker AI Studio Notebooks to Resources in a VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-notebooks-and-internet-access.html) . Extends: Construct › CfnElement › CfnRefElement › CfnResource › CfnDomain Implements: IInspectable, ITaggable, IEnvironmentAware, IDomainRef, IConstruct, IDependable - CloudFormation: [`AWS::SageMaker::Domain`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-sagemaker-domain.html) - Source: Generated code - Type last changed: v2.258.0 · 4 Jun 2026 ## Example ```ts // The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import { aws_sagemaker as sagemaker } from 'aws-cdk-lib'; const cfnDomain = new sagemaker.CfnDomain(this, 'MyCfnDomain', { authMode: 'authMode', defaultUserSettings: { executionRole: 'executionRole', // the properties below are optional autoMountHomeEfs: 'autoMountHomeEfs', codeEditorAppSettings: { appLifecycleManagement: { idleSettings: { idleTimeoutInMinutes: 123, lifecycleManagement: 'lifecycleManagement', maxIdleTimeoutInMinutes: 123, minIdleTimeoutInMinutes: 123, }, }, builtInLifecycleConfigArn: 'builtInLifecycleConfigArn', customImages: [{ appImageConfigName: 'appImageConfigName', imageName: 'imageName', // the properties below are optional imageVersionNumber: 123, }], defaultResourceSpec: { instanceType: 'instanceType', lifecycleConfigArn: 'lifecycleConfigArn', sageMakerImageArn: 'sageMakerImageArn', sageMakerImageVersionArn: 'sageMakerImageVersionArn', trainingPlanArn: 'trainingPlanArn', }, lifecycleConfigArns: ['lifecycleConfigArns'], }, customFileSystemConfigs: [{ efsFileSystemConfig: { fileSystemId: 'fileSystemId', // the properties below are optional fileSystemPath: 'fileSystemPath', }, fSxLustreFileSystemConfig: { fileSystemId: 'fileSystemId', // the properties below are optional fileSystemPath: 'fileSystemPath', }, s3FileSystemConfig: { mountPath: 'mountPath', s3Uri: 's3Uri', }, }], customPosixUserConfig: { gid: 123, uid: 123, }, defaultLandingUri: 'defaultLandingUri', jupyterLabAppSettings: { appLifecycleManagement: { idleSettings: { idleTimeoutInMinutes: 123, lifecycleManagement: 'lifecycleManagement', maxIdleTimeoutInMinutes: 123, minIdleTimeoutInMinutes: 123, }, }, builtInLifecycleConfigArn: 'builtInLifecycleConfigArn', codeRepositories: [{ repositoryUrl: 'repositoryUrl', }], customImages: [{ appImageConfigName: 'appImageConfigName', imageName: 'imageName', // the properties below are optional imageVersionNumber: 123, }], defaultResourceSpec: { instanceType: 'instanceType', lifecycleConfigArn: 'lifecycleConfigArn', sageMakerImageArn: 'sageMakerImageArn', sageMakerImageVersionArn: 'sageMakerImageVersionArn', trainingPlanArn: 'trainingPlanArn', }, lifecycleConfigArns: ['lifecycleConfigArns'], }, jupyterServerAppSettings: { defaultResourceSpec: { instanceType: 'instanceType', lifecycleConfigArn: 'lifecycleConfigArn', sageMakerImageArn: 'sageMakerImageArn', sageMakerImageVersionArn: 'sageMakerImageVersionArn', trainingPlanArn: 'trainingPlanArn', }, lifecycleConfigArns: ['lifecycleConfigArns'], }, kernelGatewayAppSettings: { customImages: [{ appImageConfigName: 'appImageConfigName', imageName: 'imageName', // the properties below are optional imageVersionNumber: 123, }], defaultResourceSpec: { instanceType: 'instanceType', lifecycleConfigArn: 'lifecycleConfigArn', sageMakerImageArn: 'sageMakerImageArn', sageMakerImageVersionArn: 'sageMakerImageVersionArn', trainingPlanArn: 'trainingPlanArn', }, lifecycleConfigArns: ['lifecycleConfigArns'], }, rSessionAppSettings: { customImages: [{ appImageConfigName: 'appImageConfigName', imageName: 'imageName', // the properties below are optional imageVersionNumber: 123, }], defaultResourceSpec: { instanceType: 'instanceType', lifecycleConfigArn: 'lifecycleConfigArn', sageMakerImageArn: 'sageMakerImageArn', sageMakerImageVersionArn: 'sageMakerImageVersionArn', trainingPlanArn: 'trainingPlanArn', }, }, rStudioServerProAppSettings: { accessStatus: 'accessStatus', userGroup: 'userGroup', }, securityGroups: ['securityGroups'], sharingSettings: { notebookOutputOption: 'notebookOutputOption', s3KmsKeyId: 's3KmsKeyId', s3OutputPath: 's3OutputPath', }, spaceStorageSettings: { defaultEbsStorageSettings: { defaultEbsVolumeSizeInGb: 123, maximumEbsVolumeSizeInGb: 123, }, }, studioWebPortal: 'studioWebPortal', studioWebPortalSettings: { hiddenAppTypes: ['hiddenAppTypes'], hiddenInstanceTypes: ['hiddenInstanceTypes'], hiddenMlTools: ['hiddenMlTools'], hiddenSageMakerImageVersionAliases: [{ sageMakerImageName: 'sageMakerImageName', versionAliases: ['versionAliases'], }], }, }, domainName: 'domainName', // the properties below are optional appNetworkAccessType: 'appNetworkAccessType', appSecurityGroupManagement: 'appSecurityGroupManagement', defaultSpaceSettings: { executionRole: 'executionRole', // the properties below are optional customFileSystemConfigs: [{ efsFileSystemConfig: { fileSystemId: 'fileSystemId', // the properties below are optional fileSystemPath: 'fileSystemPath', }, fSxLustreFileSystemConfig: { fileSystemId: 'fileSystemId', // the properties below are optional fileSystemPath: 'fileSystemPath', }, s3FileSystemConfig: { mountPath: 'mountPath', s3Uri: 's3Uri', }, }], customPosixUserConfig: { gid: 123, uid: 123, }, jupyterLabAppSettings: { appLifecycleManagement: { idleSettings: { idleTimeoutInMinutes: 123, lifecycleManagement: 'lifecycleManagement', maxIdleTimeoutInMinutes: 123, minIdleTimeoutInMinutes: 123, }, }, builtInLifecycleConfigArn: 'builtInLifecycleConfigArn', codeRepositories: [{ repositoryUrl: 'repositoryUrl', }], customImages: [{ appImageConfigName: 'appImageConfigName', imageName: 'imageName', // the properties below are optional imageVersionNumber: 123, }], defaultResourceSpec: { instanceType: 'instanceType', lifecycleConfigArn: 'lifecycleConfigArn', sageMakerImageArn: 'sageMakerImageArn', sageMakerImageVersionArn: 'sageMakerImageVersionArn', trainingPlanArn: 'trainingPlanArn', }, lifecycleConfigArns: ['lifecycleConfigArns'], }, jupyterServerAppSettings: { defaultResourceSpec: { instanceType: 'instanceType', lifecycleConfigArn: 'lifecycleConfigArn', sageMakerImageArn: 'sageMakerImageArn', sageMakerImageVersionArn: 'sageMakerImageVersionArn', trainingPlanArn: 'trainingPlanArn', }, lifecycleConfigArns: ['lifecycleConfigArns'], }, kernelGatewayAppSettings: { customImages: [{ appImageConfigName: 'appImageConfigName', imageName: 'imageName', // the properties below are optional imageVersionNumber: 123, }], defaultResourceSpec: { instanceType: 'instanceType', lifecycleConfigArn: 'lifecycleConfigArn', sageMakerImageArn: 'sageMakerImageArn', sageMakerImageVersionArn: 'sageMakerImageVersionArn', trainingPlanArn: 'trainingPlanArn', }, lifecycleConfigArns: ['lifecycleConfigArns'], }, securityGroups: ['securityGroups'], spaceStorageSettings: { defaultEbsStorageSettings: { defaultEbsVolumeSizeInGb: 123, maximumEbsVolumeSizeInGb: 123, }, }, }, domainSettings: { dockerSettings: { enableDockerAccess: 'enableDockerAccess', vpcOnlyTrustedAccounts: ['vpcOnlyTrustedAccounts'], }, executionRoleIdentityConfig: 'executionRoleIdentityConfig', ipAddressType: 'ipAddressType', rStudioServerProDomainSettings: { domainExecutionRoleArn: 'domainExecutionRoleArn', // the properties below are optional defaultResourceSpec: { instanceType: 'instanceType', lifecycleConfigArn: 'lifecycleConfigArn', sageMakerImageArn: 'sageMakerImageArn', sageMakerImageVersionArn: 'sageMakerImageVersionArn', trainingPlanArn: 'trainingPlanArn', }, rStudioConnectUrl: 'rStudioConnectUrl', rStudioPackageManagerUrl: 'rStudioPackageManagerUrl', }, securityGroupIds: ['securityGroupIds'], unifiedStudioSettings: { domainAccountId: 'domainAccountId', domainId: 'domainId', domainRegion: 'domainRegion', environmentId: 'environmentId', projectId: 'projectId', projectS3Path: 'projectS3Path', studioWebPortalAccess: 'studioWebPortalAccess', }, }, homeEfsFileSystemCreation: 'homeEfsFileSystemCreation', kmsKeyId: 'kmsKeyId', subnetIds: ['subnetIds'], tagPropagation: 'tagPropagation', tags: [{ key: 'key', value: 'value', }], vpcId: 'vpcId', }); ``` ## Initializer ```ts new CfnDomain(scope: Construct, id: string, props: CfnDomainProps) ``` ## Construct Props - `appNetworkAccessType`: string — Specifies the VPC used for non-EFS traffic. The default value is `PublicInternetOnly` . - `PublicInternetOnly` - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI , which allows direct internet access - `VpcOnly` - All Studio traffic is through the specified VPC and subnets *Valid Values* : `PublicInternetOnly | VpcOnly` - `appSecurityGroupManagement`: string — The entity that creates and manages the required security groups for inter-app communication in `VpcOnly` mode. Required when `CreateDomain.AppNetworkAccessType` is `VpcOnly` and `DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn` is provided. If setting up the domain for use with RStudio, this value must be set to `Service` . *Allowed Values* : `Service` | `Customer` - `authMode`: string (required) — The mode of authentication that members use to access the Domain. *Valid Values* : `SSO | IAM` - `defaultSpaceSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDomain.DefaultSpaceSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnDomain.DefaultSpaceSettingsProperty.html) — The default settings for shared spaces that users create in the domain. SageMaker applies these settings only to shared spaces. It doesn't apply them to private spaces. - `defaultUserSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDomain.UserSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnDomain.UserSettingsProperty.html) (required) — The default user settings. - `domainName`: string (required) — The domain name. - `domainSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDomain.DomainSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnDomain.DomainSettingsProperty.html) — A collection of settings that apply to the `SageMaker Domain` . These settings are specified through the `CreateDomain` API call. - `homeEfsFileSystemCreation`: string — Indicates whether a home EFS file system is created for the domain. Set to Disabled to skip EFS creation and reduce domain creation time. - `kmsKeyId`: string — SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key (CMK) by default. For more control, specify a customer managed CMK. *Length Constraints* : Maximum length of 2048. *Pattern* : `.*` - `subnetIds`: string | [ISubnetRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_ec2.ISubnetRef.html)[] — The VPC subnets that Studio uses for communication. *Length Constraints* : Maximum length of 32. *Array members* : Minimum number of 1 item. Maximum number of 16 items. *Pattern* : `[-0-9a-zA-Z]+` - `tagPropagation`: string — Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources. - `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API. Tags that you specify for the Domain are also added to all apps that are launched in the Domain. *Array members* : Minimum number of 0 items. Maximum number of 50 items. - `vpcId`: string | [IVPCRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_ec2.IVPCRef.html) — The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication. *Length Constraints* : Maximum length of 32. *Pattern* : `[-0-9a-zA-Z]+` ## Properties - `appNetworkAccessType`: string — Specifies the VPC used for non-EFS traffic. The default value is `PublicInternetOnly` . - `appSecurityGroupManagement`: string — The entity that creates and manages the required security groups for inter-app communication in `VpcOnly` mode. - `attrDomainArn`: string — The Amazon Resource Name (ARN) of the Domain, such as `arn:aws:sagemaker:us-west-2:account-id:domain/my-domain-name` . - `attrDomainId`: string — The Domain ID. - `attrHomeEfsFileSystemId`: string — The ID of the Amazon Elastic File System (EFS) managed by this Domain. - `attrSecurityGroupIdForDomainBoundary`: string — The ID of the security group that authorizes traffic between the `RSessionGateway` apps and the `RStudioServerPro` app. - `attrSingleSignOnApplicationArn`: string — The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023. - `attrSingleSignOnManagedApplicationInstanceId`: string — The SSO managed application instance ID. - `attrUrl`: string — The URL for the Domain. - `authMode`: string — The mode of authentication that members use to access the Domain. - `CFN_RESOURCE_TYPE_NAME`: string (static) — The CloudFormation resource type name for this resource class. - `cfnOptions`: [ICfnResourceOptions](/cdk/api/v2/docs/aws-cdk-lib.ICfnResourceOptions.html) — Options for this resource, such as condition, update policy etc. - `cfnResourceType`: string — AWS resource type. - `creationStack`: string[] - `defaultSpaceSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDomain.DefaultSpaceSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnDomain.DefaultSpaceSettingsProperty.html) — The default settings for shared spaces that users create in the domain. - `defaultUserSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDomain.UserSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnDomain.UserSettingsProperty.html) — The default user settings. - `domainName`: string — The domain name. - `domainRef`: [DomainReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_sagemaker.DomainReference.html) — A reference to a Domain resource. - `domainSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDomain.DomainSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnDomain.DomainSettingsProperty.html) — A collection of settings that apply to the `SageMaker Domain` . - `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) - `homeEfsFileSystemCreation`: string — Indicates whether a home EFS file system is created for the domain. - `kmsKeyId`: string — SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key (CMK) by default. - `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)`. - `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node. - `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 })`. - `stack`: [Stack](/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). - `subnetIds`: string[] — The VPC subnets that Studio uses for communication. - `tagPropagation`: string — Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources. - `tags`: [TagManager](/cdk/api/v2/docs/aws-cdk-lib.TagManager.html) — Tag Manager which manages the tags for this resource. - `tagsRaw`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — Tags to associated with the Domain. - `vpcId`: string — The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication. ## 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: - `arnForDomain(resource: IDomainRef): string` (static) - `cfnPropertyName(cdkPropertyName: string): string` - `fromDomainArn(scope: Construct, id: string, arn: string): IDomainRef` (static) — Creates a new IDomainRef from an ARN. - `fromDomainId(scope: Construct, id: string, domainId: string): IDomainRef` (static) — Creates a new IDomainRef from a domainId. - `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. - `isCfnDomain(x: any): boolean` (static) — Checks whether the given object is a CfnDomain. - `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. - `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.