Package software.amazon.awscdk.services.opensearchserverless

Class CfnSecurityConfig

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.opensearchserverless.CfnSecurityConfig

All Implemented Interfaces:

IInspectable, IEnvironmentAware, ISecurityConfigRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:09.936Z")
@Stability(Stable)
public class CfnSecurityConfig
extends CfnResource
implements IInspectable, ISecurityConfigRef

Specifies a security configuration for OpenSearch Serverless.

For more information, see SAML authentication for Amazon OpenSearch Serverless .

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.*;
 CfnSecurityConfig cfnSecurityConfig = CfnSecurityConfig.Builder.create(this, "MyCfnSecurityConfig")
         .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	Class	Description
static final class	CfnSecurityConfig.Builder	A fluent builder for CfnSecurityConfig.
static interface	CfnSecurityConfig.IamFederationConfigOptionsProperty	Describes IAM federation options for an OpenSearch Serverless security configuration in the form of a key-value map.
static interface	CfnSecurityConfig.IamIdentityCenterConfigOptionsProperty	Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map.
static interface	CfnSecurityConfig.SamlConfigOptionsProperty	Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value map.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.opensearchserverless.ISecurityConfigRef

ISecurityConfigRef.Jsii$Default, ISecurityConfigRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnSecurityConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSecurityConfig(software.amazon.jsii.JsiiObjectRef objRef)
	CfnSecurityConfig(software.constructs.Construct scope, String id)	Create a new AWS::OpenSearchServerless::SecurityConfig.
	CfnSecurityConfig(software.constructs.Construct scope, String id, CfnSecurityConfigProps props)	Create a new AWS::OpenSearchServerless::SecurityConfig.

Method Summary

Modifier and Type	Method	Description
String	getAttrIamIdentityCenterOptionsApplicationArn()	The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.
String	getAttrIamIdentityCenterOptionsApplicationDescription()	The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.
String	getAttrIamIdentityCenterOptionsApplicationName()	The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.
String	getAttrId()	The unique identifier of the security configuration.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	The description of the security configuration.
Object	getIamFederationOptions()	Describes IAM federation options in the form of a key-value map.
Object	getIamIdentityCenterOptions()	Describes IAM Identity Center options in the form of a key-value map.
String	getName()	The name of the security configuration.
Object	getSamlOptions()	SAML options for the security configuration in the form of a key-value map.
SecurityConfigReference	getSecurityConfigRef()	A reference to a SecurityConfig resource.
String	getType()	The type of security configuration.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	The description of the security configuration.
void	setIamFederationOptions(IResolvable value)	Describes IAM federation options in the form of a key-value map.
void	setIamFederationOptions(CfnSecurityConfig.IamFederationConfigOptionsProperty value)	Describes IAM federation options in the form of a key-value map.
void	setIamIdentityCenterOptions(IResolvable value)	Describes IAM Identity Center options in the form of a key-value map.
void	setIamIdentityCenterOptions(CfnSecurityConfig.IamIdentityCenterConfigOptionsProperty value)	Describes IAM Identity Center options in the form of a key-value map.
void	setName(String value)	The name of the security configuration.
void	setSamlOptions(IResolvable value)	SAML options for the security configuration in the form of a key-value map.
void	setSamlOptions(CfnSecurityConfig.SamlConfigOptionsProperty value)	SAML options for the security configuration in the form of a key-value map.
void	setType(String value)	The type of security configuration.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnSecurityConfig

protected CfnSecurityConfig(software.amazon.jsii.JsiiObjectRef objRef)

CfnSecurityConfig

protected CfnSecurityConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSecurityConfig

@Stability(Stable)
public CfnSecurityConfig(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnSecurityConfigProps props)

Create a new AWS::OpenSearchServerless::SecurityConfig.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnSecurityConfig

@Stability(Stable)
public CfnSecurityConfig(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Create a new AWS::OpenSearchServerless::SecurityConfig.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrIamIdentityCenterOptionsApplicationArn

@Stability(Stable)
@NotNull
public String getAttrIamIdentityCenterOptionsApplicationArn()

The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.

getAttrIamIdentityCenterOptionsApplicationDescription

@Stability(Stable)
@NotNull
public String getAttrIamIdentityCenterOptionsApplicationDescription()

The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.

getAttrIamIdentityCenterOptionsApplicationName

@Stability(Stable)
@NotNull
public String getAttrIamIdentityCenterOptionsApplicationName()

The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

The unique identifier of the security configuration.

For example, saml/123456789012/myprovider .

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getSecurityConfigRef

@Stability(Stable)
@NotNull
public SecurityConfigReference getSecurityConfigRef()

A reference to a SecurityConfig resource.

Specified by:

getSecurityConfigRef in interface ISecurityConfigRef

getDescription

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

The description of the security configuration.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description of the security configuration.

getIamFederationOptions

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

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

Returns union: either IResolvable or CfnSecurityConfig.IamFederationConfigOptionsProperty

setIamFederationOptions

@Stability(Stable)
public void setIamFederationOptions(@Nullable
 IResolvable value)

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

setIamFederationOptions

@Stability(Stable)
public void setIamFederationOptions(@Nullable
 CfnSecurityConfig.IamFederationConfigOptionsProperty value)

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

getIamIdentityCenterOptions

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

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

Returns union: either IResolvable or CfnSecurityConfig.IamIdentityCenterConfigOptionsProperty

setIamIdentityCenterOptions

@Stability(Stable)
public void setIamIdentityCenterOptions(@Nullable
 IResolvable value)

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

setIamIdentityCenterOptions

@Stability(Stable)
public void setIamIdentityCenterOptions(@Nullable
 CfnSecurityConfig.IamIdentityCenterConfigOptionsProperty value)

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

getName

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

The name of the security configuration.

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

The name of the security configuration.

getSamlOptions

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

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

Returns union: either IResolvable or CfnSecurityConfig.SamlConfigOptionsProperty

setSamlOptions

@Stability(Stable)
public void setSamlOptions(@Nullable
 IResolvable value)

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

setSamlOptions

@Stability(Stable)
public void setSamlOptions(@Nullable
 CfnSecurityConfig.SamlConfigOptionsProperty value)

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

getType

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

The type of security configuration.

setType

@Stability(Stable)
public void setType(@Nullable
 String value)

The type of security configuration.