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

Class CfnSecurityConfigPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.opensearchserverless.CfnSecurityConfigPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSecurityConfigPropsMixin>

Enclosing class:

CfnSecurityConfigPropsMixin

@Stability(Stable)
public static final class CfnSecurityConfigPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSecurityConfigPropsMixin>

A fluent builder for CfnSecurityConfigPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnSecurityConfigPropsMixin	build()
static CfnSecurityConfigPropsMixin.Builder	create()
static CfnSecurityConfigPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnSecurityConfigPropsMixin.Builder	description(String description)	The description of the security configuration.
CfnSecurityConfigPropsMixin.Builder	iamFederationOptions(CfnSecurityConfigPropsMixin.IamFederationConfigOptionsProperty iamFederationOptions)	Describes IAM federation options in the form of a key-value map.
CfnSecurityConfigPropsMixin.Builder	iamFederationOptions(IResolvable iamFederationOptions)	Describes IAM federation options in the form of a key-value map.
CfnSecurityConfigPropsMixin.Builder	iamIdentityCenterOptions(CfnSecurityConfigPropsMixin.IamIdentityCenterConfigOptionsProperty iamIdentityCenterOptions)	Describes IAM Identity Center options in the form of a key-value map.
CfnSecurityConfigPropsMixin.Builder	iamIdentityCenterOptions(IResolvable iamIdentityCenterOptions)	Describes IAM Identity Center options in the form of a key-value map.
CfnSecurityConfigPropsMixin.Builder	name(String name)	The name of the security configuration.
CfnSecurityConfigPropsMixin.Builder	samlOptions(CfnSecurityConfigPropsMixin.SamlConfigOptionsProperty samlOptions)	SAML options for the security configuration in the form of a key-value map.
CfnSecurityConfigPropsMixin.Builder	samlOptions(IResolvable samlOptions)	SAML options for the security configuration in the form of a key-value map.
CfnSecurityConfigPropsMixin.Builder	type(String type)	The type of security configuration.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnSecurityConfigPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnSecurityConfigPropsMixin.Builder.

create

@Stability(Stable)
public static CfnSecurityConfigPropsMixin.Builder create()

Returns:

a new instance of CfnSecurityConfigPropsMixin.Builder.

description

@Stability(Stable)
public CfnSecurityConfigPropsMixin.Builder description(String description)

The description of the security configuration.

Parameters:

description - The description of the security configuration. This parameter is required.

Returns:

this

See Also:

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

iamFederationOptions

@Stability(Stable)
public CfnSecurityConfigPropsMixin.Builder iamFederationOptions(IResolvable iamFederationOptions)

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.

Parameters:

iamFederationOptions - Describes IAM federation options in the form of a key-value map. This parameter is required.

Returns:

this

See Also:

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

iamFederationOptions

@Stability(Stable)
public CfnSecurityConfigPropsMixin.Builder iamFederationOptions(CfnSecurityConfigPropsMixin.IamFederationConfigOptionsProperty iamFederationOptions)

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.

Parameters:

iamFederationOptions - Describes IAM federation options in the form of a key-value map. This parameter is required.

Returns:

this

See Also:

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

iamIdentityCenterOptions

@Stability(Stable)
public CfnSecurityConfigPropsMixin.Builder iamIdentityCenterOptions(IResolvable iamIdentityCenterOptions)

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

Parameters:

iamIdentityCenterOptions - Describes IAM Identity Center options in the form of a key-value map. This parameter is required.

Returns:

this

See Also:

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

iamIdentityCenterOptions

@Stability(Stable)
public CfnSecurityConfigPropsMixin.Builder iamIdentityCenterOptions(CfnSecurityConfigPropsMixin.IamIdentityCenterConfigOptionsProperty iamIdentityCenterOptions)

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

Parameters:

iamIdentityCenterOptions - Describes IAM Identity Center options in the form of a key-value map. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnSecurityConfigPropsMixin.Builder name(String name)

The name of the security configuration.

Parameters:

name - The name of the security configuration. This parameter is required.

Returns:

this

See Also:

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

samlOptions

@Stability(Stable)
public CfnSecurityConfigPropsMixin.Builder samlOptions(IResolvable samlOptions)

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

Parameters:

samlOptions - SAML options for the security configuration in the form of a key-value map. This parameter is required.

Returns:

this

See Also:

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

samlOptions

@Stability(Stable)
public CfnSecurityConfigPropsMixin.Builder samlOptions(CfnSecurityConfigPropsMixin.SamlConfigOptionsProperty samlOptions)

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

Parameters:

samlOptions - SAML options for the security configuration in the form of a key-value map. This parameter is required.

Returns:

this

See Also:

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

type

@Stability(Stable)
public CfnSecurityConfigPropsMixin.Builder type(String type)

The type of security configuration.

Currently the only option is saml .

Parameters:

type - The type of security configuration. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnSecurityConfigPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnSecurityConfigPropsMixin>

Returns:

a newly built instance of CfnSecurityConfigPropsMixin.