---
title: DataStoreInstance
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-datastoreinstance
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-datastoreinstance.html
section_ids:
  sec-amster-entity-datastoreinstance-global-ops: Global Operations
  sec-amster-entity-datastoreinstance-global-ops-create: create
  sec-amster-entity-datastoreinstance-global-ops-delete: delete
  sec-amster-entity-datastoreinstance-global-ops-getalltypes: getAllTypes
  sec-amster-entity-datastoreinstance-global-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-datastoreinstance-global-ops-nextdescendents: nextdescendents
  sec-amster-entity-datastoreinstance-global-ops-query: query
  sec-amster-entity-datastoreinstance-global-ops-read: read
  sec-amster-entity-datastoreinstance-global-ops-update: update
---

# DataStoreInstance

## Global Operations

Resource path:

```
/global-config/services/DataStoreService/config
```

Resource version: `1.0`

### create

**Usage**

```
am> create DataStoreInstance --global --id id --body body
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "bindDN" : {
        "title" : "Bind DN",
        "description" : "This property is ignored if <code>mTLS Enabled</code> is set.",
        "propertyOrder" : 400,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "bindPassword" : {
        "title" : "Bind Password",
        "description" : "This property is ignored if <code>mTLS Enabled</code> is set.",
        "propertyOrder" : 500,
        "required" : true,
        "type" : "string",
        "format" : "password",
        "exampleValue" : ""
      },
      "affinityEnabled" : {
        "title" : "Affinity Enabled",
        "description" : "",
        "propertyOrder" : 1000,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "useSsl" : {
        "title" : "Use SSL",
        "description" : "",
        "propertyOrder" : 800,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "useStartTLS" : {
        "title" : "Start TLS",
        "description" : "",
        "propertyOrder" : 900,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "dataStoreEnabled" : {
        "title" : "Enabled",
        "description" : "Only enabled data stores can be selected at the realm level.",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "mtlsEnabled" : {
        "title" : "mTLS Enabled",
        "description" : "Enables mTLS (mutual TLS) between AM and this store. When mTLS is enabled:<ul><li>Set <code>Use SSL</code> to true. <li>Set a secure port in <code>Host Urls</code>.</li> <li>The values for <code>Bind DN</code> and <code>Bind Password</code> are ignored.</li> <li>Provide an <code>mTLS Secret Label Identifier</code> below.</li></ul>Instructions for setting up certificates and keystore mappings are in the product documentation.",
        "propertyOrder" : 850,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "serverUrls" : {
        "title" : "Host Urls",
        "description" : "An ordered list of connection strings for LDAP directories.Each connection string is composed as follows: HOST:PORT. serverHostname = Host Name",
        "propertyOrder" : 200,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "minItems" : 1,
        "type" : "array",
        "exampleValue" : ""
      },
      "mtlsSecretLabel" : {
        "title" : "mTLS Secret Label Identifier",
        "description" : "Identifier used to create a secret label for mapping to the mTLS certificate in the secret store. AM uses this identifier to create a specific secret label for this data store. The secret label takes the form <code>am.external.datastore.{{identifier}}.mtls.cert</code> where {{identifier}} is the value of mTLS Secret Label Identifier. The label can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}.",
        "propertyOrder" : 860,
        "required" : false,
        "type" : "string",
        "exampleValue" : ""
      },
      "minimumConnectionPool" : {
        "title" : "Minimum Connection Pool Size",
        "description" : "",
        "propertyOrder" : 600,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      },
      "maximumConnectionPool" : {
        "title" : "Maximum Connection Pool Size",
        "description" : "",
        "propertyOrder" : 700,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      }
    }
  }
  ```

### delete

**Usage**

```
am> delete DataStoreInstance --global --id id
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

### getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

**Usage**

```
am> action DataStoreInstance --global --actionName getAllTypes
```

### getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

**Usage**

```
am> action DataStoreInstance --global --actionName getCreatableTypes
```

### nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

**Usage**

```
am> action DataStoreInstance --global --actionName nextdescendents
```

### query

Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.

**Usage**

```
am> query DataStoreInstance --global --filter filter
```

**Parameters**

* *\--filter*

  A CREST formatted query filter, where "true" will query all.

### read

**Usage**

```
am> read DataStoreInstance --global --id id
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update DataStoreInstance --global --id id --body body
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "bindDN" : {
        "title" : "Bind DN",
        "description" : "This property is ignored if <code>mTLS Enabled</code> is set.",
        "propertyOrder" : 400,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "bindPassword" : {
        "title" : "Bind Password",
        "description" : "This property is ignored if <code>mTLS Enabled</code> is set.",
        "propertyOrder" : 500,
        "required" : true,
        "type" : "string",
        "format" : "password",
        "exampleValue" : ""
      },
      "affinityEnabled" : {
        "title" : "Affinity Enabled",
        "description" : "",
        "propertyOrder" : 1000,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "useSsl" : {
        "title" : "Use SSL",
        "description" : "",
        "propertyOrder" : 800,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "useStartTLS" : {
        "title" : "Start TLS",
        "description" : "",
        "propertyOrder" : 900,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "dataStoreEnabled" : {
        "title" : "Enabled",
        "description" : "Only enabled data stores can be selected at the realm level.",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "mtlsEnabled" : {
        "title" : "mTLS Enabled",
        "description" : "Enables mTLS (mutual TLS) between AM and this store. When mTLS is enabled:<ul><li>Set <code>Use SSL</code> to true. <li>Set a secure port in <code>Host Urls</code>.</li> <li>The values for <code>Bind DN</code> and <code>Bind Password</code> are ignored.</li> <li>Provide an <code>mTLS Secret Label Identifier</code> below.</li></ul>Instructions for setting up certificates and keystore mappings are in the product documentation.",
        "propertyOrder" : 850,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "serverUrls" : {
        "title" : "Host Urls",
        "description" : "An ordered list of connection strings for LDAP directories.Each connection string is composed as follows: HOST:PORT. serverHostname = Host Name",
        "propertyOrder" : 200,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "minItems" : 1,
        "type" : "array",
        "exampleValue" : ""
      },
      "mtlsSecretLabel" : {
        "title" : "mTLS Secret Label Identifier",
        "description" : "Identifier used to create a secret label for mapping to the mTLS certificate in the secret store. AM uses this identifier to create a specific secret label for this data store. The secret label takes the form <code>am.external.datastore.{{identifier}}.mtls.cert</code> where {{identifier}} is the value of mTLS Secret Label Identifier. The label can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}.",
        "propertyOrder" : 860,
        "required" : false,
        "type" : "string",
        "exampleValue" : ""
      },
      "minimumConnectionPool" : {
        "title" : "Minimum Connection Pool Size",
        "description" : "",
        "propertyOrder" : 600,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      },
      "maximumConnectionPool" : {
        "title" : "Maximum Connection Pool Size",
        "description" : "",
        "propertyOrder" : 700,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      }
    }
  }
  ```