Package software.amazon.awscdk.cfnpropertymixins.services.opensearchservice

Class CfnApplicationPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.opensearchservice.CfnApplicationPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnApplicationPropsMixin>

Enclosing class:

CfnApplicationPropsMixin

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

A fluent builder for CfnApplicationPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnApplicationPropsMixin.Builder	appConfigs(List<? extends Object> appConfigs)	List of application configurations.
CfnApplicationPropsMixin.Builder	appConfigs(IResolvable appConfigs)	List of application configurations.
CfnApplicationPropsMixin	build()
static CfnApplicationPropsMixin.Builder	create()
static CfnApplicationPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnApplicationPropsMixin.Builder	dataSources(List<? extends Object> dataSources)	List of data sources.
CfnApplicationPropsMixin.Builder	dataSources(IResolvable dataSources)	List of data sources.
CfnApplicationPropsMixin.Builder	endpoint(String endpoint)	The endpoint URL of an OpenSearch application.
CfnApplicationPropsMixin.Builder	iamIdentityCenterOptions(CfnApplicationPropsMixin.IamIdentityCenterOptionsProperty iamIdentityCenterOptions)	Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources.
CfnApplicationPropsMixin.Builder	iamIdentityCenterOptions(IResolvable iamIdentityCenterOptions)	Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources.
CfnApplicationPropsMixin.Builder	kmsKeyArn(String kmsKeyArn)	The ARN of the KMS key used to encrypt the application.
CfnApplicationPropsMixin.Builder	name(String name)	The name of an OpenSearch application.
CfnApplicationPropsMixin.Builder	tags(List<? extends CfnTag> tags)	An arbitrary set of tags (key-value pairs) for this application.

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 CfnApplicationPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnApplicationPropsMixin.Builder.

create

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

Returns:

a new instance of CfnApplicationPropsMixin.Builder.

appConfigs

@Stability(Stable)
public CfnApplicationPropsMixin.Builder appConfigs(IResolvable appConfigs)

List of application configurations.

Parameters:

appConfigs - List of application configurations. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#cfn-opensearchservice-application-appconfigs

appConfigs

@Stability(Stable)
public CfnApplicationPropsMixin.Builder appConfigs(List<? extends Object> appConfigs)

List of application configurations.

Parameters:

appConfigs - List of application configurations. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#cfn-opensearchservice-application-appconfigs

dataSources

@Stability(Stable)
public CfnApplicationPropsMixin.Builder dataSources(IResolvable dataSources)

List of data sources.

Parameters:

dataSources - List of data sources. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#cfn-opensearchservice-application-datasources

dataSources

@Stability(Stable)
public CfnApplicationPropsMixin.Builder dataSources(List<? extends Object> dataSources)

List of data sources.

Parameters:

dataSources - List of data sources. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#cfn-opensearchservice-application-datasources

endpoint

@Stability(Stable)
public CfnApplicationPropsMixin.Builder endpoint(String endpoint)

The endpoint URL of an OpenSearch application.

Parameters:

endpoint - The endpoint URL of an OpenSearch application. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#cfn-opensearchservice-application-endpoint

iamIdentityCenterOptions

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

Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources.

This setup supports single sign-on (SSO) through IAM Identity Center, allowing centralized user management.

Parameters:

iamIdentityCenterOptions - Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources. This parameter is required.

Returns:

this

See Also:

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

iamIdentityCenterOptions

@Stability(Stable)
public CfnApplicationPropsMixin.Builder iamIdentityCenterOptions(CfnApplicationPropsMixin.IamIdentityCenterOptionsProperty iamIdentityCenterOptions)

Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources.

This setup supports single sign-on (SSO) through IAM Identity Center, allowing centralized user management.

Parameters:

iamIdentityCenterOptions - Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources. This parameter is required.

Returns:

this

See Also:

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

kmsKeyArn

@Stability(Stable)
public CfnApplicationPropsMixin.Builder kmsKeyArn(String kmsKeyArn)

The ARN of the KMS key used to encrypt the application.

Parameters:

kmsKeyArn - The ARN of the KMS key used to encrypt the application. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#cfn-opensearchservice-application-kmskeyarn

name

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

The name of an OpenSearch application.

Parameters:

name - The name of an OpenSearch application. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnApplicationPropsMixin.Builder tags(List<? extends CfnTag> tags)

An arbitrary set of tags (key-value pairs) for this application.

Parameters:

tags - An arbitrary set of tags (key-value pairs) for this application. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html#cfn-opensearchservice-application-tags

build

@Stability(Stable)
public CfnApplicationPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnApplicationPropsMixin.