interface CfnEnvironmentProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.FinSpace.CfnEnvironmentProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsfinspace#CfnEnvironmentProps |
![]() | software.amazon.awscdk.services.finspace.CfnEnvironmentProps |
![]() | aws_cdk.aws_finspace.CfnEnvironmentProps |
![]() | 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. |
data | string[] | ARNs of FinSpace Data Bundles to install. |
description? | string | The description of the FinSpace environment. |
federation | string | The authentication mode for the environment. |
federation | IResolvable | Federation | Configuration information when authentication mode is FEDERATED. |
kms | string | The KMS key id used to encrypt in the FinSpace environment. |
superuser | IResolvable | Superuser | Configuration information for the superuser. |
tags? | Cfn [] | An array of key-value pairs to apply to this resource. |
name
Type:
string
The name of the FinSpace environment.
dataBundles?
⚠️ Deprecated: this property has been deprecated
Type:
string[]
(optional)
ARNs of FinSpace Data Bundles to install.
description?
Type:
string
(optional)
The description of the FinSpace environment.
federationMode?
Type:
string
(optional)
The authentication mode for the environment.
federationParameters?
Type:
IResolvable
|
Federation
(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
|
Superuser
(optional)
Configuration information for the superuser.
tags?
Type:
Cfn
[]
(optional)
An array of key-value pairs to apply to this resource.