# CfnLocationObjectStorage

The `AWS::DataSync::LocationObjectStorage` resource specifies an endpoint for a self-managed object storage bucket.

For more information about self-managed object storage locations, see [Creating a Location for Object Storage](https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html) .

Extends: Construct › CfnElement › CfnRefElement › CfnResource › CfnLocationObjectStorage
Implements: IInspectable, ITaggable, IEnvironmentAware, ILocationObjectStorageRef, IConstruct, IDependable

- CloudFormation: [`AWS::DataSync::LocationObjectStorage`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-datasync-locationobjectstorage.html)
- Source: Generated code
- Type last changed: v2.272.0 · 30 Sep 2026

## Example

```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 cfnLocationObjectStorage = new datasync.CfnLocationObjectStorage(this, 'MyCfnLocationObjectStorage', /* all optional props */ {
  accessKey: 'accessKey',
  agentArns: ['agentArns'],
  bucketName: 'bucketName',
  cmkSecretConfig: {
    kmsKeyArn: 'kmsKeyArn',
    secretArn: 'secretArn',
  },
  customSecretConfig: {
    secretAccessRoleArn: 'secretAccessRoleArn',
    secretArn: 'secretArn',
  },
  federatedIdentity: {
    awsIamRole: 'awsIamRole',
    externalIdentity: {
      googleOidc: {
        identityPoolName: 'identityPoolName',
        identityProviderName: 'identityProviderName',
        projectName: 'projectName',
        projectNumber: 'projectNumber',
      },
    },
  },
  secretKey: 'secretKey',
  serverCertificate: 'serverCertificate',
  serverHostname: 'serverHostname',
  serverPort: 123,
  serverProtocol: 'serverProtocol',
  subdirectory: 'subdirectory',
  tags: [{
    key: 'key',
    value: 'value',
  }],
});
```

## Initializer

```ts
new CfnLocationObjectStorage(scope: Construct, id: string, props?: CfnLocationObjectStorageProps)
```

## Construct Props

- `accessKey`: string — Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

- `agentArns`: string[] — (Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.

  If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.

  > Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you create it.

- `bucketName`: string — Specifies the name of the object storage bucket involved in the transfer.

- `cmkSecretConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLocationObjectStorage.CmkSecretConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_datasync.CfnLocationObjectStorage.CmkSecretConfigProperty.html) — Specifies configuration information for a DataSync-managed secret, which includes the `SecretKey` that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .

  When you include this parameter as part of a `CreateLocationObjectStorage` request, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the `SecretKey` parameter to create a DataSync-managed secret to store the location access credentials.

  Make sure that DataSync has permission to access the KMS key that you specify.

  > You can use either `CmkSecretConfig` (with `SecretKey` ) or `CustomSecretConfig` (without `SecretKey` ) to provide credentials for a `CreateLocationObjectStorage` request. Do not provide both parameters for the same request.

- `customSecretConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLocationObjectStorage.CustomSecretConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_datasync.CfnLocationObjectStorage.CustomSecretConfigProperty.html) — Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text, in Secrets Manager.

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

  > You can use either `CmkSecretConfig` (with `SecretKey` ) or `CustomSecretConfig` (without `SecretKey` ) to provide credentials for a `CreateLocationObjectStorage` request. Do not provide both parameters for the same request.

- `federatedIdentity`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLocationObjectStorage.ObjectStorageFederatedIdentityConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_datasync.CfnLocationObjectStorage.ObjectStorageFederatedIdentityConfigProperty.html) — Specifies the identity federation configuration that DataSync uses to access your object storage location using an OpenID Connect (OIDC) token.

- `secretKey`: string — Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

  > If you provide a secret using `SecretKey` , but do not provide secret configuration details using `CmkSecretConfig` or `CustomSecretConfig` , then DataSync stores the token using your AWS account's Secrets Manager secret.

- `serverCertificate`: string — Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).

  You must specify a single `.pem` file with a full certificate chain (for example, `file:///home/user/.ssh/object_storage_certificates.pem` ).

  The certificate chain might include:

  - The object storage system's certificate
  - All intermediate certificates (if there are any)
  - The root certificate of the signing CA

  You can concatenate your certificates into a `.pem` file (which can be up to 32768 bytes before base64 encoding). The following example `cat` command creates an `object_storage_certificates.pem` file that includes three certificates:

  `cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem`

  To use this parameter, configure `ServerProtocol` to `HTTPS` .

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

- `serverPort`: number — Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

- `serverProtocol`: string — Specifies the protocol that your object storage server uses to communicate.

  If not specified, the default value is `HTTPS` .

- `subdirectory`: string — Specifies the object prefix for your object storage server.

  If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — Specifies the key-value pair that represents a tag that you want to add to the resource.

  Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.

## Properties

- `accessKey`: string — Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

- `agentArns`: string[] — (Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.

- `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 object storage location.

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

- `attrManagedSecretConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Specifies configuration information for a DataSync-managed secret, such as an authentication token 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.

- `bucketName`: string — Specifies the name of the object storage bucket involved in the transfer.

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

- `cmkSecretConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLocationObjectStorage.CmkSecretConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_datasync.CfnLocationObjectStorage.CmkSecretConfigProperty.html) — Specifies configuration information for a DataSync-managed secret, which includes the `SecretKey` that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .

- `creationStack`: string[]

- `customSecretConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLocationObjectStorage.CustomSecretConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_datasync.CfnLocationObjectStorage.CustomSecretConfigProperty.html) — Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text, in Secrets Manager.

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

- `federatedIdentity`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLocationObjectStorage.ObjectStorageFederatedIdentityConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_datasync.CfnLocationObjectStorage.ObjectStorageFederatedIdentityConfigProperty.html) — Specifies the identity federation configuration that DataSync uses to access your object storage location using an OpenID Connect (OIDC) token.

- `locationObjectStorageRef`: [LocationObjectStorageReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_datasync.LocationObjectStorageReference.html) — A reference to a LocationObjectStorage 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)`.

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

- `secretKey`: string — Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

- `serverCertificate`: string — Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).

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

- `serverPort`: number — Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

- `serverProtocol`: string — Specifies the protocol that your object storage server uses to communicate.

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

- `subdirectory`: string — Specifies the object prefix for your object storage server.

- `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)[] — Specifies the key-value pair that represents a tag that you want to add to the 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.

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

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