Package software.amazon.awscdk.cfnpropertymixins.services.opensearchserverless

Interface CfnSecurityConfigPropsMixin.IamFederationConfigOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSecurityConfigPropsMixin.IamFederationConfigOptionsProperty.Jsii$Proxy

Enclosing class:

CfnSecurityConfigPropsMixin

@Stability(Stable)
public static interface CfnSecurityConfigPropsMixin.IamFederationConfigOptionsProperty
extends software.amazon.jsii.JsiiSerializable

Describes IAM federation options for an OpenSearch Serverless security configuration in the form of a key-value map.

These options define how OpenSearch Serverless integrates with external identity providers using federation.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.opensearchserverless.*;
 IamFederationConfigOptionsProperty iamFederationConfigOptionsProperty = IamFederationConfigOptionsProperty.builder()
         .groupAttribute("groupAttribute")
         .userAttribute("userAttribute")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnSecurityConfigPropsMixin.IamFederationConfigOptionsProperty.Builder	builder()
default String	getGroupAttribute()	The group attribute for this IAM federation integration.
default String	getUserAttribute()	The user attribute for this IAM federation integration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGroupAttribute

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

The group attribute for this IAM federation integration.

This attribute is used to map identity provider groups to OpenSearch Serverless permissions.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamfederationconfigoptions.html#cfn-opensearchserverless-securityconfig-iamfederationconfigoptions-groupattribute

getUserAttribute

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

The user attribute for this IAM federation integration.

This attribute is used to identify users in the federated authentication process.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamfederationconfigoptions.html#cfn-opensearchserverless-securityconfig-iamfederationconfigoptions-userattribute

builder

@Stability(Stable)
static CfnSecurityConfigPropsMixin.IamFederationConfigOptionsProperty.Builder builder()

Returns:

a CfnSecurityConfigPropsMixin.IamFederationConfigOptionsProperty.Builder of CfnSecurityConfigPropsMixin.IamFederationConfigOptionsProperty