AWS CDK Reference

Appearance

v2.276.0

CfnSecurityConfigProps Struct ​

Properties for defining a 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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_opensearchserverless as opensearchserverless

cfn_security_config_props = opensearchserverless.CfnSecurityConfigProps(
    description="description",
    iam_federation_options=opensearchserverless.CfnSecurityConfig.IamFederationConfigOptionsProperty(
        group_attribute="groupAttribute",
        user_attribute="userAttribute"
    ),
    iam_identity_center_options=opensearchserverless.CfnSecurityConfig.IamIdentityCenterConfigOptionsProperty(
        instance_arn="instanceArn",

        # the properties below are optional
        application_arn="applicationArn",
        application_description="applicationDescription",
        application_name="applicationName",
        group_attribute="groupAttribute",
        user_attribute="userAttribute"
    ),
    name="name",
    saml_options=opensearchserverless.CfnSecurityConfig.SamlConfigOptionsProperty(
        metadata="metadata",

        # the properties below are optional
        group_attribute="groupAttribute",
        open_search_serverless_entity_id="openSearchServerlessEntityId",
        session_timeout=123,
        user_attribute="userAttribute"
    ),
    type="type"
)
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.opensearchserverless.*;

CfnSecurityConfigProps cfnSecurityConfigProps = CfnSecurityConfigProps.builder()
        .description("description")
        .iamFederationOptions(IamFederationConfigOptionsProperty.builder()
                .groupAttribute("groupAttribute")
                .userAttribute("userAttribute")
                .build())
        .iamIdentityCenterOptions(IamIdentityCenterConfigOptionsProperty.builder()
                .instanceArn("instanceArn")

                // the properties below are optional
                .applicationArn("applicationArn")
                .applicationDescription("applicationDescription")
                .applicationName("applicationName")
                .groupAttribute("groupAttribute")
                .userAttribute("userAttribute")
                .build())
        .name("name")
        .samlOptions(SamlConfigOptionsProperty.builder()
                .metadata("metadata")

                // the properties below are optional
                .groupAttribute("groupAttribute")
                .openSearchServerlessEntityId("openSearchServerlessEntityId")
                .sessionTimeout(123)
                .userAttribute("userAttribute")
                .build())
        .type("type")
        .build();
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.OpenSearchServerless;

var cfnSecurityConfigProps = new CfnSecurityConfigProps {
    Description = "description",
    IamFederationOptions = new IamFederationConfigOptionsProperty {
        GroupAttribute = "groupAttribute",
        UserAttribute = "userAttribute"
    },
    IamIdentityCenterOptions = new IamIdentityCenterConfigOptionsProperty {
        InstanceArn = "instanceArn",

        // the properties below are optional
        ApplicationArn = "applicationArn",
        ApplicationDescription = "applicationDescription",
        ApplicationName = "applicationName",
        GroupAttribute = "groupAttribute",
        UserAttribute = "userAttribute"
    },
    Name = "name",
    SamlOptions = new SamlConfigOptionsProperty {
        Metadata = "metadata",

        // the properties below are optional
        GroupAttribute = "groupAttribute",
        OpenSearchServerlessEntityId = "openSearchServerlessEntityId",
        SessionTimeout = 123,
        UserAttribute = "userAttribute"
    },
    Type = "type"
};
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"

cfnSecurityConfigProps := &CfnSecurityConfigProps{
	Description: jsii.String("description"),
	IamFederationOptions: &IamFederationConfigOptionsProperty{
		GroupAttribute: jsii.String("groupAttribute"),
		UserAttribute: jsii.String("userAttribute"),
	},
	IamIdentityCenterOptions: &IamIdentityCenterConfigOptionsProperty{
		InstanceArn: jsii.String("instanceArn"),

		// the properties below are optional
		ApplicationArn: jsii.String("applicationArn"),
		ApplicationDescription: jsii.String("applicationDescription"),
		ApplicationName: jsii.String("applicationName"),
		GroupAttribute: jsii.String("groupAttribute"),
		UserAttribute: jsii.String("userAttribute"),
	},
	Name: jsii.String("name"),
	SamlOptions: &SamlConfigOptionsProperty{
		Metadata: jsii.String("metadata"),

		// the properties below are optional
		GroupAttribute: jsii.String("groupAttribute"),
		OpenSearchServerlessEntityId: jsii.String("openSearchServerlessEntityId"),
		SessionTimeout: jsii.Number(123),
		UserAttribute: jsii.String("userAttribute"),
	},
	Type: jsii.String("type"),
}

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the security configuration.
iamFederationOptionsoptionalIResolvable | CfnSecurityConfig.IamFederationConfigOptionsPropertyiam_federation_optionsoptionaltyping.Union[IResolvable, IamFederationConfigOptionsProperty]iamFederationOptionsoptionalIResolvableIamFederationOptionsoptionalIResolvableIamFederationOptionsoptionalinterface{}#
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.

iamIdentityCenterOptionsoptionalIResolvable | CfnSecurityConfig.IamIdentityCenterConfigOptionsPropertyiam_identity_center_optionsoptionaltyping.Union[IResolvable, IamIdentityCenterConfigOptionsProperty]iamIdentityCenterOptionsoptionalIResolvableIamIdentityCenterOptionsoptionalIResolvableIamIdentityCenterOptionsoptionalinterface{}#
Describes IAM Identity Center options in the form of a key-value map.
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
The name of the security configuration.
samlOptionsoptionalIResolvable | CfnSecurityConfig.SamlConfigOptionsPropertysaml_optionsoptionaltyping.Union[IResolvable, SamlConfigOptionsProperty]samlOptionsoptionalIResolvableSamlOptionsoptionalIResolvableSamlOptionsoptionalinterface{}#
SAML options for the security configuration in the form of a key-value map.
typeoptionalstringtypeoptionalstrtypeoptionalStringTypeoptionalstringTypeoptional*string#
The type of security configuration.

Currently the only option is saml .