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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.109.0 (build c221850)", date="2025-03-19T18:01:38.780Z") @Stability(Stable) public class CfnSecurityConfig extends CfnResource implements IInspectable
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")
         .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:

  • 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)
      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)
      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

    • 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.

    • getIamIdentityCenterOptions

      @Stability(Stable) @Nullable public Object getIamIdentityCenterOptions()
      Describes IAM Identity Center options in the form of a key-value map.

    • 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.

    • 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.