interface CfnEnvironmentProps

Language	Type name
.NET	`Amazon.CDK.AWS.FinSpace.CfnEnvironmentProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsfinspace#CfnEnvironmentProps`
Java	`software.amazon.awscdk.services.finspace.CfnEnvironmentProps`
Python	`aws_cdk.aws_finspace.CfnEnvironmentProps`
TypeScript	`aws-cdk-lib` » `aws_finspace` » `CfnEnvironmentProps`

Properties for defining a CfnEnvironment.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_finspace as finspace } from 'aws-cdk-lib';
const cfnEnvironmentProps: finspace.CfnEnvironmentProps = {
  name: 'name',

  // the properties below are optional
  dataBundles: ['dataBundles'],
  description: 'description',
  federationMode: 'federationMode',
  federationParameters: {
    applicationCallBackUrl: 'applicationCallBackUrl',
    attributeMap: [{
      key: 'key',
      value: 'value',
    }],
    federationProviderName: 'federationProviderName',
    federationUrn: 'federationUrn',
    samlMetadataDocument: 'samlMetadataDocument',
    samlMetadataUrl: 'samlMetadataUrl',
  },
  kmsKeyId: 'kmsKeyId',
  superuserParameters: {
    emailAddress: 'emailAddress',
    firstName: 'firstName',
    lastName: 'lastName',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
name	`string`	The name of the FinSpace environment.
dataBundles?⚠️	`string[]`	ARNs of FinSpace Data Bundles to install.
description?	`string`	The description of the FinSpace environment.
federationMode?	`string`	The authentication mode for the environment.
federationParameters?	`IResolvable` `\|` `FederationParametersProperty`	Configuration information when authentication mode is FEDERATED.
kmsKeyId?	`string`	The KMS key id used to encrypt in the FinSpace environment.
superuserParameters?	`IResolvable` `\|` `SuperuserParametersProperty`	Configuration information for the superuser.
tags?	`CfnTag[]`	An array of key-value pairs to apply to this resource.