CfnSecurityConfigMixinProps
- class aws_cdk.mixins_preview.aws_opensearchserverless.mixins.CfnSecurityConfigMixinProps(*, description=None, iam_federation_options=None, iam_identity_center_options=None, name=None, saml_options=None, type=None)
Bases:
objectProperties for CfnSecurityConfigPropsMixin.
- Parameters:
description (
Optional[str]) – The description of the security configuration.iam_federation_options (
Union[IResolvable,IamFederationConfigOptionsProperty,Dict[str,Any],None]) – 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.iam_identity_center_options (
Union[IResolvable,IamIdentityCenterConfigOptionsProperty,Dict[str,Any],None]) – Describes IAM Identity Center options in the form of a key-value map.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 issaml.
- See:
- 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.mixins_preview.aws_opensearchserverless import mixins as opensearchserverless_mixins cfn_security_config_mixin_props = opensearchserverless_mixins.CfnSecurityConfigMixinProps( description="description", iam_federation_options=opensearchserverless_mixins.CfnSecurityConfigPropsMixin.IamFederationConfigOptionsProperty( group_attribute="groupAttribute", user_attribute="userAttribute" ), iam_identity_center_options=opensearchserverless_mixins.CfnSecurityConfigPropsMixin.IamIdentityCenterConfigOptionsProperty( application_arn="applicationArn", application_description="applicationDescription", application_name="applicationName", group_attribute="groupAttribute", instance_arn="instanceArn", user_attribute="userAttribute" ), name="name", saml_options=opensearchserverless_mixins.CfnSecurityConfigPropsMixin.SamlConfigOptionsProperty( group_attribute="groupAttribute", metadata="metadata", open_search_serverless_entity_id="openSearchServerlessEntityId", session_timeout=123, user_attribute="userAttribute" ), type="type" )
Attributes
- description
The description of the security configuration.
- iam_federation_options
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.
- iam_identity_center_options
Describes IAM Identity Center options in the form of a key-value map.
- name
The name of the security configuration.
- saml_options
SAML options for the security configuration in the form of a key-value map.
- type
The type of security configuration.
Currently the only option is
saml.