interface CfnEnvironmentProps

Language	Type name
.NET	Amazon.CDK.AWS.FinSpace.CfnEnvironmentProps
Java	software.amazon.awscdk.services.finspace.CfnEnvironmentProps
Python	aws_cdk.aws_finspace.CfnEnvironmentProps
TypeScript	@aws-cdk/aws-finspace » CfnEnvironmentProps

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 * as finspace from '@aws-cdk/aws-finspace';
const cfnEnvironmentProps: finspace.CfnEnvironmentProps = {
  name: 'name',

  // the properties below are optional
  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.
description?	string	The description of the FinSpace environment.
federationMode?	string	The authentication mode for the environment.
federationParameters?	FederationParametersProperty | IResolvable	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[]	AWS::FinSpace::Environment.Tags.

---

name

Type: string

The name of the FinSpace environment.

---

description?

Type: string (optional)

The description of the FinSpace environment.

---

federationMode?

Type: string (optional)

The authentication mode for the environment.

---

federationParameters?

Type: FederationParametersProperty | IResolvable (optional)

Configuration information when authentication mode is FEDERATED.

---

kmsKeyId?

Type: string (optional)

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

---

superuserParameters?

Type: IResolvable | SuperuserParametersProperty (optional)

Configuration information for the superuser.

---

tags?

Type: CfnTag[] (optional)

AWS::FinSpace::Environment.Tags.