Package software.amazon.awscdk.services.opensearchserverless

Interface CfnSecurityConfigProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSecurityConfigProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:40.983Z")
@Stability(Stable)
public interface CfnSecurityConfigProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSecurityConfig.

Example:

 // 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSecurityConfigProps.Builder	A builder for CfnSecurityConfigProps
static final class	CfnSecurityConfigProps.Jsii$Proxy	An implementation for CfnSecurityConfigProps

Method Summary

Modifier and Type	Method	Description
static CfnSecurityConfigProps.Builder	builder()
default String	getDescription()	The description of the security configuration.
default Object	getIamFederationOptions()	Describes IAM federation options in the form of a key-value map.
default Object	getIamIdentityCenterOptions()	Describes IAM Identity Center options in the form of a key-value map.
default String	getName()	The name of the security configuration.
default Object	getSamlOptions()	SAML options for the security configuration in the form of a key-value map.
default String	getType()	The type of security configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the security configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#cfn-opensearchserverless-securityconfig-description

getIamFederationOptions

@Stability(Stable)
@Nullable
default Object getIamFederationOptions()

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.

Returns union: either IResolvable or CfnSecurityConfig.IamFederationConfigOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#cfn-opensearchserverless-securityconfig-iamfederationoptions

getIamIdentityCenterOptions

@Stability(Stable)
@Nullable
default Object getIamIdentityCenterOptions()

Describes IAM Identity Center options in the form of a key-value map.

Returns union: either IResolvable or CfnSecurityConfig.IamIdentityCenterConfigOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#cfn-opensearchserverless-securityconfig-iamidentitycenteroptions

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the security configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#cfn-opensearchserverless-securityconfig-name

getSamlOptions

@Stability(Stable)
@Nullable
default Object getSamlOptions()

SAML options for the security configuration in the form of a key-value map.

Returns union: either IResolvable or CfnSecurityConfig.SamlConfigOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#cfn-opensearchserverless-securityconfig-samloptions

getType

@Stability(Stable)
@Nullable
default String getType()

The type of security configuration.

Currently the only option is saml .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#cfn-opensearchserverless-securityconfig-type

builder

@Stability(Stable)
static CfnSecurityConfigProps.Builder builder()

Returns:

a CfnSecurityConfigProps.Builder of CfnSecurityConfigProps