Package software.amazon.awscdk.services.opensearchserverless

Class CfnSecurityConfig.Builder

java.lang.Object

software.amazon.awscdk.services.opensearchserverless.CfnSecurityConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSecurityConfig>

Enclosing class:

CfnSecurityConfig

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

A fluent builder for CfnSecurityConfig.

Method Summary

Modifier and Type	Method	Description
CfnSecurityConfig	build()
static CfnSecurityConfig.Builder	create(software.constructs.Construct scope, String id)
CfnSecurityConfig.Builder	description(String description)	The description of the security configuration.
CfnSecurityConfig.Builder	iamFederationOptions(IResolvable iamFederationOptions)	Describes IAM federation options in the form of a key-value map.
CfnSecurityConfig.Builder	iamFederationOptions(CfnSecurityConfig.IamFederationConfigOptionsProperty iamFederationOptions)	Describes IAM federation options in the form of a key-value map.
CfnSecurityConfig.Builder	iamIdentityCenterOptions(IResolvable iamIdentityCenterOptions)	Describes IAM Identity Center options in the form of a key-value map.
CfnSecurityConfig.Builder	iamIdentityCenterOptions(CfnSecurityConfig.IamIdentityCenterConfigOptionsProperty iamIdentityCenterOptions)	Describes IAM Identity Center options in the form of a key-value map.
CfnSecurityConfig.Builder	name(String name)	The name of the security configuration.
CfnSecurityConfig.Builder	samlOptions(IResolvable samlOptions)	SAML options for the security configuration in the form of a key-value map.
CfnSecurityConfig.Builder	samlOptions(CfnSecurityConfig.SamlConfigOptionsProperty samlOptions)	SAML options for the security configuration in the form of a key-value map.
CfnSecurityConfig.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 CfnSecurityConfig.Builder create(software.constructs.Construct scope,
 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.

Returns:

a new instance of CfnSecurityConfig.Builder.

description

@Stability(Stable)
public CfnSecurityConfig.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 CfnSecurityConfig.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 CfnSecurityConfig.Builder iamFederationOptions(CfnSecurityConfig.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 CfnSecurityConfig.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 CfnSecurityConfig.Builder iamIdentityCenterOptions(CfnSecurityConfig.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 CfnSecurityConfig.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 CfnSecurityConfig.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 CfnSecurityConfig.Builder samlOptions(CfnSecurityConfig.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 CfnSecurityConfig.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 CfnSecurityConfig build()

Specified by:

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

Returns:

a newly built instance of CfnSecurityConfig.