aws-cdk-lib.aws_finspace.CfnEnvironmentProps

interface CfnEnvironmentProps

LanguageType name
.NETAmazon.CDK.AWS.FinSpace.CfnEnvironmentProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsfinspace#CfnEnvironmentProps
Javasoftware.amazon.awscdk.services.finspace.CfnEnvironmentProps
Pythonaws_cdk.aws_finspace.CfnEnvironmentProps
TypeScript aws-cdk-lib » 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 { aws_finspace as finspace } from 'aws-cdk-lib';
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

NameTypeDescription
namestringThe name of the FinSpace environment.
description?stringThe description of the FinSpace environment.
federationMode?stringThe authentication mode for the environment.
federationParameters?IResolvable | FederationParametersPropertyConfiguration information when authentication mode is FEDERATED.
kmsKeyId?stringThe KMS key id used to encrypt in the FinSpace environment.
superuserParameters?IResolvable | SuperuserParametersPropertyConfiguration 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: IResolvable | FederationParametersProperty (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.