Class CfnEnvironment
The AWS::FinSpace::Environment
resource represents an Amazon FinSpace environment.
Inherited Members
Namespace: Amazon.CDK.AWS.FinSpace
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEnvironment : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnEnvironment
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-finspace-environment.html
CloudformationResource: AWS::FinSpace::Environment
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.FinSpace;
var cfnEnvironment = new CfnEnvironment(this, "MyCfnEnvironment", new CfnEnvironmentProps {
Name = "name",
// the properties below are optional
DataBundles = new [] { "dataBundles" },
Description = "description",
FederationMode = "federationMode",
FederationParameters = new FederationParametersProperty {
ApplicationCallBackUrl = "applicationCallBackUrl",
AttributeMap = new [] { new AttributeMapItemsProperty {
Key = "key",
Value = "value"
} },
FederationProviderName = "federationProviderName",
FederationUrn = "federationUrn",
SamlMetadataDocument = "samlMetadataDocument",
SamlMetadataUrl = "samlMetadataUrl"
},
KmsKeyId = "kmsKeyId",
SuperuserParameters = new SuperuserParametersProperty {
EmailAddress = "emailAddress",
FirstName = "firstName",
LastName = "lastName"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnEnvironment(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEnvironment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnEnvironment(Construct, String, ICfnEnvironmentProps) |
Properties
AttrAwsAccountId | The ID of the AWS account in which the FinSpace environment is created. |
AttrDedicatedServiceAccountId | The AWS account ID of the dedicated service account associated with your FinSpace environment. |
AttrEnvironmentArn | The Amazon Resource Name (ARN) of your FinSpace environment. |
AttrEnvironmentId | The identifier of the FinSpace environment. |
AttrEnvironmentUrl | The sign-in url for the web application of your FinSpace environment. |
AttrSageMakerStudioDomainUrl | The url of the integrated FinSpace notebook environment in your web application. |
AttrStatus | The current status of creation of the FinSpace environment. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DataBundles | (deprecated) ARNs of FinSpace Data Bundles to install. |
Description | The description of the FinSpace environment. |
FederationMode | The authentication mode for the environment. |
FederationParameters | Configuration information when authentication mode is FEDERATED. |
KmsKeyId | The KMS key id used to encrypt in the FinSpace environment. |
Name | The name of the FinSpace environment. |
SuperuserParameters | Configuration information for the superuser. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEnvironment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEnvironment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEnvironment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEnvironment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnEnvironment(Construct, String, ICfnEnvironmentProps)
public CfnEnvironment(Construct scope, string id, ICfnEnvironmentProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnEnvironmentProps
Resource properties.
Properties
AttrAwsAccountId
The ID of the AWS account in which the FinSpace environment is created.
public virtual string AttrAwsAccountId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: AwsAccountId
AttrDedicatedServiceAccountId
The AWS account ID of the dedicated service account associated with your FinSpace environment.
public virtual string AttrDedicatedServiceAccountId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DedicatedServiceAccountId
AttrEnvironmentArn
The Amazon Resource Name (ARN) of your FinSpace environment.
public virtual string AttrEnvironmentArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EnvironmentArn
AttrEnvironmentId
The identifier of the FinSpace environment.
public virtual string AttrEnvironmentId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EnvironmentId
AttrEnvironmentUrl
The sign-in url for the web application of your FinSpace environment.
public virtual string AttrEnvironmentUrl { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EnvironmentUrl
AttrSageMakerStudioDomainUrl
The url of the integrated FinSpace notebook environment in your web application.
public virtual string AttrSageMakerStudioDomainUrl { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SageMakerStudioDomainUrl
AttrStatus
The current status of creation of the FinSpace environment.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Status
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DataBundles
(deprecated) ARNs of FinSpace Data Bundles to install.
public virtual string[] DataBundles { get; set; }
Property Value
System.String[]
Remarks
Stability: Deprecated
Description
The description of the FinSpace environment.
public virtual string Description { get; set; }
Property Value
System.String
FederationMode
The authentication mode for the environment.
public virtual string FederationMode { get; set; }
Property Value
System.String
FederationParameters
Configuration information when authentication mode is FEDERATED.
public virtual object FederationParameters { get; set; }
Property Value
System.Object
KmsKeyId
The KMS key id used to encrypt in the FinSpace environment.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
Name
The name of the FinSpace environment.
public virtual string Name { get; set; }
Property Value
System.String
SuperuserParameters
Configuration information for the superuser.
public virtual object SuperuserParameters { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>