Package software.amazon.awscdk.services.finspace

Class CfnEnvironment.Builder

java.lang.Object

software.amazon.awscdk.services.finspace.CfnEnvironment.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEnvironment>

Enclosing class:

CfnEnvironment

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

A fluent builder for CfnEnvironment.

Method Summary

Modifier and Type	Method	Description
CfnEnvironment	build()
static CfnEnvironment.Builder	create(software.constructs.Construct scope, String id)
CfnEnvironment.Builder	dataBundles(List<String> dataBundles)	Deprecated. this property has been deprecated
CfnEnvironment.Builder	description(String description)	The description of the FinSpace environment.
CfnEnvironment.Builder	federationMode(String federationMode)	The authentication mode for the environment.
CfnEnvironment.Builder	federationParameters(IResolvable federationParameters)	Configuration information when authentication mode is FEDERATED.
CfnEnvironment.Builder	federationParameters(CfnEnvironment.FederationParametersProperty federationParameters)	Configuration information when authentication mode is FEDERATED.
CfnEnvironment.Builder	kmsKeyId(String kmsKeyId)	The KMS key id used to encrypt in the FinSpace environment.
CfnEnvironment.Builder	name(String name)	The name of the FinSpace environment.
CfnEnvironment.Builder	superuserParameters(IResolvable superuserParameters)	Configuration information for the superuser.
CfnEnvironment.Builder	superuserParameters(CfnEnvironment.SuperuserParametersProperty superuserParameters)	Configuration information for the superuser.
CfnEnvironment.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.

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 CfnEnvironment.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 CfnEnvironment.Builder.

name

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

The name of the FinSpace environment.

Parameters:

name - The name of the FinSpace environment. This parameter is required.

Returns:

this

See Also:

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

dataBundles

@Stability(Deprecated)
@Deprecated
public CfnEnvironment.Builder dataBundles(List<String> dataBundles)

Deprecated.

this property has been deprecated

(deprecated) ARNs of FinSpace Data Bundles to install.

Parameters:

dataBundles - ARNs of FinSpace Data Bundles to install. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#cfn-finspace-environment-databundles

description

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

The description of the FinSpace environment.

Parameters:

description - The description of the FinSpace environment. This parameter is required.

Returns:

this

See Also:

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

federationMode

@Stability(Stable)
public CfnEnvironment.Builder federationMode(String federationMode)

The authentication mode for the environment.

Parameters:

federationMode - The authentication mode for the environment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#cfn-finspace-environment-federationmode

federationParameters

@Stability(Stable)
public CfnEnvironment.Builder federationParameters(IResolvable federationParameters)

Configuration information when authentication mode is FEDERATED.

Parameters:

federationParameters - Configuration information when authentication mode is FEDERATED. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#cfn-finspace-environment-federationparameters

federationParameters

@Stability(Stable)
public CfnEnvironment.Builder federationParameters(CfnEnvironment.FederationParametersProperty federationParameters)

Configuration information when authentication mode is FEDERATED.

Parameters:

federationParameters - Configuration information when authentication mode is FEDERATED. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#cfn-finspace-environment-federationparameters

kmsKeyId

@Stability(Stable)
public CfnEnvironment.Builder kmsKeyId(String kmsKeyId)

The KMS key id used to encrypt in the FinSpace environment.

Parameters:

kmsKeyId - The KMS key id used to encrypt in the FinSpace environment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#cfn-finspace-environment-kmskeyid

superuserParameters

@Stability(Stable)
public CfnEnvironment.Builder superuserParameters(IResolvable superuserParameters)

Configuration information for the superuser.

Parameters:

superuserParameters - Configuration information for the superuser. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#cfn-finspace-environment-superuserparameters

superuserParameters

@Stability(Stable)
public CfnEnvironment.Builder superuserParameters(CfnEnvironment.SuperuserParametersProperty superuserParameters)

Configuration information for the superuser.

Parameters:

superuserParameters - Configuration information for the superuser. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html#cfn-finspace-environment-superuserparameters

tags

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

An array of key-value pairs to apply to this resource.

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnEnvironment build()

Specified by:

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

Returns:

a newly built instance of CfnEnvironment.