# CfnLocationSMB

The `AWS::DataSync::LocationSMB` resource specifies a Server Message Block (SMB) location that AWS DataSync can use as a transfer source or destination.

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) › CfnLocationSMB
Implements: [IInspectable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IInspectable.html), [ITaggable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.ITaggable.html), [IEnvironmentAware](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.interfaces.IEnvironmentAware.html), [ILocationSMBRef](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_datasync.ILocationSMBRef.html), IConstruct, IDependable

- CloudFormation: [`AWS::DataSync::LocationSMB`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-datasync-locationsmb.html)
- Source: Generated at build time
- Type last changed: v2.252.0 · 30 Apr 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_datasync as datasync } from 'aws-cdk-lib';
const cfnLocationSMB = new datasync.CfnLocationSMB(this, 'MyCfnLocationSMB', {
  agentArns: ['agentArns'],

  // the properties below are optional
  authenticationType: 'authenticationType',
  cmkSecretConfig: {
    kmsKeyArn: 'kmsKeyArn',
    secretArn: 'secretArn',
  },
  customSecretConfig: {
    secretAccessRoleArn: 'secretAccessRoleArn',
    secretArn: 'secretArn',
  },
  dnsIpAddresses: ['dnsIpAddresses'],
  domain: 'domain',
  kerberosKeytab: 'kerberosKeytab',
  kerberosKrb5Conf: 'kerberosKrb5Conf',
  kerberosPrincipal: 'kerberosPrincipal',
  mountOptions: {
    version: 'version',
  },
  password: 'password',
  serverHostname: 'serverHostname',
  subdirectory: 'subdirectory',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  user: 'user',
});
```

Python:

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

cfn_location_smb = datasync.CfnLocationSMB(self, "MyCfnLocationSMB",
    agent_arns=["agentArns"],

    # the properties below are optional
    authentication_type="authenticationType",
    cmk_secret_config=datasync.CfnLocationSMB.CmkSecretConfigProperty(
        kms_key_arn="kmsKeyArn",
        secret_arn="secretArn"
    ),
    custom_secret_config=datasync.CfnLocationSMB.CustomSecretConfigProperty(
        secret_access_role_arn="secretAccessRoleArn",
        secret_arn="secretArn"
    ),
    dns_ip_addresses=["dnsIpAddresses"],
    domain="domain",
    kerberos_keytab="kerberosKeytab",
    kerberos_krb5_conf="kerberosKrb5Conf",
    kerberos_principal="kerberosPrincipal",
    mount_options=datasync.CfnLocationSMB.MountOptionsProperty(
        version="version"
    ),
    password="password",
    server_hostname="serverHostname",
    subdirectory="subdirectory",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    user="user"
)
```

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.datasync.*;

CfnLocationSMB cfnLocationSMB = CfnLocationSMB.Builder.create(this, "MyCfnLocationSMB")
        .agentArns(List.of("agentArns"))

        // the properties below are optional
        .authenticationType("authenticationType")
        .cmkSecretConfig(CmkSecretConfigProperty.builder()
                .kmsKeyArn("kmsKeyArn")
                .secretArn("secretArn")
                .build())
        .customSecretConfig(CustomSecretConfigProperty.builder()
                .secretAccessRoleArn("secretAccessRoleArn")
                .secretArn("secretArn")
                .build())
        .dnsIpAddresses(List.of("dnsIpAddresses"))
        .domain("domain")
        .kerberosKeytab("kerberosKeytab")
        .kerberosKrb5Conf("kerberosKrb5Conf")
        .kerberosPrincipal("kerberosPrincipal")
        .mountOptions(MountOptionsProperty.builder()
                .version("version")
                .build())
        .password("password")
        .serverHostname("serverHostname")
        .subdirectory("subdirectory")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .user("user")
        .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.DataSync;

var cfnLocationSMB = new CfnLocationSMB(this, "MyCfnLocationSMB", new CfnLocationSMBProps {
    AgentArns = new [] { "agentArns" },

    // the properties below are optional
    AuthenticationType = "authenticationType",
    CmkSecretConfig = new CmkSecretConfigProperty {
        KmsKeyArn = "kmsKeyArn",
        SecretArn = "secretArn"
    },
    CustomSecretConfig = new CustomSecretConfigProperty {
        SecretAccessRoleArn = "secretAccessRoleArn",
        SecretArn = "secretArn"
    },
    DnsIpAddresses = new [] { "dnsIpAddresses" },
    Domain = "domain",
    KerberosKeytab = "kerberosKeytab",
    KerberosKrb5Conf = "kerberosKrb5Conf",
    KerberosPrincipal = "kerberosPrincipal",
    MountOptions = new MountOptionsProperty {
        Version = "version"
    },
    Password = "password",
    ServerHostname = "serverHostname",
    Subdirectory = "subdirectory",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    User = "user"
});
```

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"

cfnLocationSMB := awscdk.Aws_datasync.NewCfnLocationSMB(this, jsii.String("MyCfnLocationSMB"), &CfnLocationSMBProps{
	AgentArns: []*string{
		jsii.String("agentArns"),
	},

	// the properties below are optional
	AuthenticationType: jsii.String("authenticationType"),
	CmkSecretConfig: &CmkSecretConfigProperty{
		KmsKeyArn: jsii.String("kmsKeyArn"),
		SecretArn: jsii.String("secretArn"),
	},
	CustomSecretConfig: &CustomSecretConfigProperty{
		SecretAccessRoleArn: jsii.String("secretAccessRoleArn"),
		SecretArn: jsii.String("secretArn"),
	},
	DnsIpAddresses: []*string{
		jsii.String("dnsIpAddresses"),
	},
	Domain: jsii.String("domain"),
	KerberosKeytab: jsii.String("kerberosKeytab"),
	KerberosKrb5Conf: jsii.String("kerberosKrb5Conf"),
	KerberosPrincipal: jsii.String("kerberosPrincipal"),
	MountOptions: &MountOptionsProperty{
		Version: jsii.String("version"),
	},
	Password: jsii.String("password"),
	ServerHostname: jsii.String("serverHostname"),
	Subdirectory: jsii.String("subdirectory"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	User: jsii.String("user"),
})
```

## Initializer

TypeScript:

```ts
new CfnLocationSMB(scope: Construct, id: string, props: CfnLocationSMBProps)
```

Python:

```python
CfnLocationSMB(scope: Construct, id: str, props: CfnLocationSMBProps)
```

Java:

```java
new CfnLocationSMB(Construct scope, String id, CfnLocationSMBProps props)
```

C# / .NET:

```csharp
new CfnLocationSMB(Construct scope, string id, CfnLocationSMBProps props)
```

Golang:

```go
NewCfnLocationSMB(Scope Construct, Id *string, Props CfnLocationSMBProps)
```

## Construct Props

- `agentArns`: string[] (required) — Specifies the DataSync agent (or agents) that can connect to your SMB file server.

  You specify an agent by using its Amazon Resource Name (ARN).

- `authenticationType`: string — The authentication mode used to determine identity of user.

- `cmkSecretConfig`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLocationSMB.CmkSecretConfigProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_datasync.CfnLocationSMB.CmkSecretConfigProperty.html) — Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .

  > You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request.

- `customSecretConfig`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLocationSMB.CustomSecretConfigProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_datasync.CfnLocationSMB.CustomSecretConfigProperty.html) — Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab).

  This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

  > You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request.

- `dnsIpAddresses`: string[] — Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to.

  This parameter applies only if AuthenticationType is set to KERBEROS. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.

- `domain`: string — Specifies the Windows domain name that your SMB file server belongs to.

  This parameter applies only if `AuthenticationType` is set to `NTLM` .

  If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

- `kerberosKeytab`: string — The Base64 string representation of the Keytab file.

  Specifies your Kerberos key table (keytab) file, which includes mappings between your service principal name (SPN) and encryption keys. To avoid task execution errors, make sure that the SPN in the keytab file matches exactly what you specify for KerberosPrincipal and in your krb5.conf file.

- `kerberosKrb5Conf`: string — The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.

- `kerberosPrincipal`: string — Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.

  SPNs are case sensitive and must include a prepended cifs/. For example, an SPN might look like cifs/kerberosuser@EXAMPLE.COM. Your task execution will fail if the SPN that you provide for this parameter doesn't match exactly what's in your keytab or krb5.conf files.

- `mountOptions`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLocationSMB.MountOptionsProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_datasync.CfnLocationSMB.MountOptionsProperty.html) — Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

- `password`: string — Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.

  This parameter applies only if `AuthenticationType` is set to `NTLM` .

- `serverHostname`: string — Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to.

  > If you're using Kerberos authentication, you must specify a domain name.

- `subdirectory`: string — Specifies the name of the share exported by your SMB file server where DataSync will read or write data.

  You can include a subdirectory in the share path (for example, `/path/to/subdirectory` ). Make sure that other SMB clients in your network can also mount this path.

  To copy all data in the subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see [Providing DataSync access to SMB file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) .

- `tags`: [CfnTag](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — Specifies labels that help you categorize, filter, and search for your AWS resources.

  We recommend creating at least a name tag for your location.

- `user`: string — Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

  This parameter applies only if `AuthenticationType` is set to `NTLM` .

  For information about choosing a user with the right level of access for your transfer, see [Providing DataSync access to SMB file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) .

## Properties

- `agentArns`: string[] — Specifies the DataSync agent (or agents) that can connect to your SMB file server.

- `attrCmkSecretConfigSecretArn`: string — Specifies the ARN for the DataSync-managed AWS Secrets Manager secret that that is used to access a specific storage location.

  This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for `KmsKeyArn` .

- `attrLocationArn`: string — The Amazon Resource Name (ARN) of the specified SMB location.

- `attrLocationUri`: string — The URI of the specified SMB location.

- `attrManagedSecretConfig`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Specifies configuration information for a DataSync-managed secret, such as a password or set of credentials that DataSync uses to access a specific transfer location.

  DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.

- `authenticationType`: string — The authentication mode used to determine identity of user.

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

- `cmkSecretConfig`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLocationSMB.CmkSecretConfigProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_datasync.CfnLocationSMB.CmkSecretConfigProperty.html) — Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .

- `creationStack`: string[]

- `customSecretConfig`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLocationSMB.CustomSecretConfigProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_datasync.CfnLocationSMB.CustomSecretConfigProperty.html) — Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab).

- `dnsIpAddresses`: string[] — Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to.

- `domain`: string — Specifies the Windows domain name that your SMB file server belongs to.

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

- `kerberosKeytab`: string — The Base64 string representation of the Keytab file.

- `kerberosKrb5Conf`: string — The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.

- `kerberosPrincipal`: string — Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.

- `locationSmbRef`: [LocationSMBReference](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_datasync.LocationSMBReference.html) — A reference to a LocationSMB resource.

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

- `mountOptions`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLocationSMB.MountOptionsProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_datasync.CfnLocationSMB.MountOptionsProperty.html) — Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

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

- `password`: string — Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.

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

- `serverHostname`: string — Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to.

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

- `subdirectory`: string — Specifies the name of the share exported by your SMB file server where DataSync will read or write data.

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

- `tagsRaw`: [CfnTag](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — Specifies labels that help you categorize, filter, and search for your AWS resources.

- `user`: string — Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

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

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

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