# CfnSecurityConfigProps

Properties for defining a `CfnSecurityConfig`.

Extends: CfnSecurityConfigProps
Used as props by: CfnSecurityConfig

- Source: Generated code
- Type last changed: v2.217.0 · 25 Sep 2025

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_opensearchserverless as opensearchserverless } from 'aws-cdk-lib';
const cfnSecurityConfigProps: opensearchserverless.CfnSecurityConfigProps = {
  description: 'description',
  iamFederationOptions: {
    groupAttribute: 'groupAttribute',
    userAttribute: 'userAttribute',
  },
  iamIdentityCenterOptions: {
    instanceArn: 'instanceArn',

    // the properties below are optional
    applicationArn: 'applicationArn',
    applicationDescription: 'applicationDescription',
    applicationName: 'applicationName',
    groupAttribute: 'groupAttribute',
    userAttribute: 'userAttribute',
  },
  name: 'name',
  samlOptions: {
    metadata: 'metadata',

    // the properties below are optional
    groupAttribute: 'groupAttribute',
    openSearchServerlessEntityId: 'openSearchServerlessEntityId',
    sessionTimeout: 123,
    userAttribute: 'userAttribute',
  },
  type: 'type',
};
```

## Properties

- `description`: string — The description of the security configuration.

- `iamFederationOptions`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnSecurityConfig.IamFederationConfigOptionsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_opensearchserverless.CfnSecurityConfig.IamFederationConfigOptionsProperty.html) — Describes IAM federation options in the form of a key-value map.

  Contains configuration details about how OpenSearch Serverless integrates with external identity providers through federation.

- `iamIdentityCenterOptions`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnSecurityConfig.IamIdentityCenterConfigOptionsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_opensearchserverless.CfnSecurityConfig.IamIdentityCenterConfigOptionsProperty.html) — Describes IAM Identity Center options in the form of a key-value map.

- `name`: string — The name of the security configuration.

- `samlOptions`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnSecurityConfig.SamlConfigOptionsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_opensearchserverless.CfnSecurityConfig.SamlConfigOptionsProperty.html) — SAML options for the security configuration in the form of a key-value map.

- `type`: string — The type of security configuration.

  Currently the only option is `saml` .