Package software.amazon.awscdk.cfnpropertymixins.services.finspace

Interface CfnEnvironmentMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEnvironmentMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:59.426Z")
@Stability(Stable)
public interface CfnEnvironmentMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnEnvironmentPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.finspace.*;
 CfnEnvironmentMixinProps cfnEnvironmentMixinProps = CfnEnvironmentMixinProps.builder()
         .dataBundles(List.of("dataBundles"))
         .description("description")
         .federationMode("federationMode")
         .federationParameters(FederationParametersProperty.builder()
                 .applicationCallBackUrl("applicationCallBackUrl")
                 .attributeMap(List.of(AttributeMapItemsProperty.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .federationProviderName("federationProviderName")
                 .federationUrn("federationUrn")
                 .samlMetadataDocument("samlMetadataDocument")
                 .samlMetadataUrl("samlMetadataUrl")
                 .build())
         .kmsKeyId("kmsKeyId")
         .name("name")
         .superuserParameters(SuperuserParametersProperty.builder()
                 .emailAddress("emailAddress")
                 .firstName("firstName")
                 .lastName("lastName")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnEnvironmentMixinProps.Builder	builder()
default List<String>	getDataBundles()	Deprecated. this property has been deprecated
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.
default String	getName()	The name of the FinSpace environment.
default Object	getSuperuserParameters()	Configuration information for the superuser.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataBundles

@Stability(Deprecated)
@Deprecated
@Nullable
default List<String> getDataBundles()

Deprecated.

this property has been deprecated

(deprecated) ARNs of FinSpace Data Bundles to install.

See Also:

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

getDescription

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

The description of the FinSpace environment.

See Also:

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

getFederationMode

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

The authentication mode for the environment.

See Also:

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

getFederationParameters

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

Configuration information when authentication mode is FEDERATED.

Returns union: either IResolvable or CfnEnvironmentPropsMixin.FederationParametersProperty

See Also:

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

getKmsKeyId

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

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

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the FinSpace environment.

See Also:

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

getSuperuserParameters

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

Configuration information for the superuser.

Returns union: either IResolvable or CfnEnvironmentPropsMixin.SuperuserParametersProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnEnvironmentMixinProps.Builder builder()

Returns:

a CfnEnvironmentMixinProps.Builder of CfnEnvironmentMixinProps