CfnSecurityConfigProps

class aws_cdk.aws_opensearchserverless.CfnSecurityConfigProps(*, description=None, name=None, saml_options=None, type=None)

Bases: object

Properties for defining a CfnSecurityConfig.

Parameters:

• description (Optional[str]) – The description of the security configuration.

• name (Optional[str]) – The name of the security configuration.

• saml_options (Union[IResolvable, SamlConfigOptionsProperty, Dict[str, Any], None]) – SAML options for the security configuration in the form of a key-value map.

• type (Optional[str]) – The type of security configuration. Currently the only option is saml .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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",
    name="name",
    saml_options=opensearchserverless.CfnSecurityConfig.SamlConfigOptionsProperty(
        metadata="metadata",

        # the properties below are optional
        group_attribute="groupAttribute",
        session_timeout=123,
        user_attribute="userAttribute"
    ),
    type="type"
)

Attributes

description

The description of the security configuration.

See:

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

name

The name of the security configuration.

See:

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

saml_options

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

See:

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

type

The type of security configuration.

Currently the only option is saml .

See:

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