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(value=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 and Description
CfnEnvironment	build()
static CfnEnvironment.Builder	create(software.constructs.Construct scope, String id)
CfnEnvironment.Builder	dataBundles(List<String> dataBundles) The list of Amazon Resource Names (ARN) of the data bundles to install.
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(CfnEnvironment.FederationParametersProperty federationParameters) Configuration information when authentication mode is FEDERATED.
CfnEnvironment.Builder	federationParameters(IResolvable 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(CfnEnvironment.SuperuserParametersProperty superuserParameters) Configuration information for the superuser.
CfnEnvironment.Builder	superuserParameters(IResolvable superuserParameters) Configuration information for the superuser.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=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 - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnEnvironment.FederationParametersProperty.Builder.

name

@Stability(value=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

dataBundles

@Stability(value=Stable)
public CfnEnvironment.Builder dataBundles(List<String> dataBundles)

The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:.

• arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.
• arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.

Parameters:

dataBundles - The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:. This parameter is required.

Returns:

this

description

@Stability(value=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

federationMode

@Stability(value=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

federationParameters

@Stability(value=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

federationParameters

@Stability(value=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

kmsKeyId

@Stability(value=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

superuserParameters

@Stability(value=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

superuserParameters

@Stability(value=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

build

@Stability(value=Stable)
public CfnEnvironment build()

Specified by:

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