software.amazon.awscdk.services.finspace

Interface CfnEnvironmentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEnvironmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.365Z")
 @Stability(value=Stable)
public interface CfnEnvironmentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnEnvironment`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.finspace.*;
 Object attributeMap;
 CfnEnvironmentProps cfnEnvironmentProps = CfnEnvironmentProps.builder()
         .name("name")
         // the properties below are optional
         .dataBundles(List.of("dataBundles"))
         .description("description")
         .federationMode("federationMode")
         .federationParameters(FederationParametersProperty.builder()
                 .applicationCallBackUrl("applicationCallBackUrl")
                 .attributeMap(attributeMap)
                 .federationProviderName("federationProviderName")
                 .federationUrn("federationUrn")
                 .samlMetadataDocument("samlMetadataDocument")
                 .samlMetadataUrl("samlMetadataUrl")
                 .build())
         .kmsKeyId("kmsKeyId")
         .superuserParameters(SuperuserParametersProperty.builder()
                 .emailAddress("emailAddress")
                 .firstName("firstName")
                 .lastName("lastName")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnEnvironmentProps.Builder A builder for CfnEnvironmentProps
static class	CfnEnvironmentProps.Jsii$Proxy An implementation for CfnEnvironmentProps

Method Summary

Modifier and Type	Method and Description
static CfnEnvironmentProps.Builder	builder()
default List<String>	getDataBundles() The list of Amazon Resource Names (ARN) of the data bundles to install.
default String	getDescription() The description of the FinSpace environment.
default String	getFederationMode() The authentication mode for the environment.
default Object	getFederationParameters() Configuration information when authentication mode is FEDERATED.
default String	getKmsKeyId() The KMS key id used to encrypt in the FinSpace environment.
String	getName() The name of the FinSpace environment.
default Object	getSuperuserParameters() Configuration information for the superuser.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name of the FinSpace environment.

getDataBundles

@Stability(value=Stable)
 @Nullable
default List<String> getDataBundles()

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.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

The description of the FinSpace environment.

getFederationMode

@Stability(value=Stable)
 @Nullable
default String getFederationMode()

The authentication mode for the environment.

getFederationParameters

@Stability(value=Stable)
 @Nullable
default Object getFederationParameters()

Configuration information when authentication mode is FEDERATED.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
default String getKmsKeyId()

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

getSuperuserParameters

@Stability(value=Stable)
 @Nullable
default Object getSuperuserParameters()

Configuration information for the superuser.

builder

@Stability(value=Stable)
static CfnEnvironmentProps.Builder builder()

Returns:

a CfnEnvironmentProps.Builder of CfnEnvironmentProps