Class CfnEnvironment

The AWS::FinSpace::Environment resource represents an Amazon FinSpace environment.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnEnvironment

Implements

IInspectable

IEnvironmentRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.AddResourceDependency(CfnResource, string)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.RemoveResourceDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.FinSpace

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnEnvironment : CfnResource, IInspectable, IEnvironmentRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnEnvironment Inherits CfnResource Implements IInspectable, IEnvironmentRef, IConstruct, IDependable, IEnvironmentAware, 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(Construct, string, ICfnEnvironmentProps)

Create a new AWS::FinSpace::Environment.

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	The `AWS::FinSpace::Environment` resource represents an Amazon FinSpace environment.
CfnPropertyNames	The `AWS::FinSpace::Environment` resource represents an Amazon FinSpace environment.
DataBundles	(deprecated) ARNs of FinSpace Data Bundles to install.
Description	The description of the FinSpace environment.
EnvironmentRef	A reference to a Environment resource.
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

ArnForEnvironment(IEnvironmentRef)	The `AWS::FinSpace::Environment` resource represents an Amazon FinSpace environment.
FromEnvironmentArn(Construct, string, string)	Creates a new IEnvironmentRef from an ARN.
FromEnvironmentId(Construct, string, string)	Creates a new IEnvironmentRef from a environmentId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnEnvironment(object)	Checks whether the given object is a CfnEnvironment.
RenderProperties(IDictionary<string, object>)	The `AWS::FinSpace::Environment` resource represents an Amazon FinSpace environment.

Constructors

CfnEnvironment(Construct, string, ICfnEnvironmentProps)

Create a new AWS::FinSpace::Environment.

public CfnEnvironment(Construct scope, string id, ICfnEnvironmentProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnEnvironmentProps: Resource properties.

Remarks

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

CloudformationResource: AWS::FinSpace::Environment

ExampleMetadata: fixture=_generated

Properties

AttrAwsAccountId

The ID of the AWS account in which the FinSpace environment is created.

public virtual string AttrAwsAccountId { get; }

Property Value

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

string

Remarks

CloudformationAttribute: DedicatedServiceAccountId

AttrEnvironmentArn

The Amazon Resource Name (ARN) of your FinSpace environment.

public virtual string AttrEnvironmentArn { get; }

Property Value

string

Remarks

CloudformationAttribute: EnvironmentArn

AttrEnvironmentId

The identifier of the FinSpace environment.

public virtual string AttrEnvironmentId { get; }

Property Value

string

Remarks

CloudformationAttribute: EnvironmentId

AttrEnvironmentUrl

The sign-in url for the web application of your FinSpace environment.

public virtual string AttrEnvironmentUrl { get; }

Property Value

string

Remarks

CloudformationAttribute: EnvironmentUrl

AttrSageMakerStudioDomainUrl

The url of the integrated FinSpace notebook environment in your web application.

public virtual string AttrSageMakerStudioDomainUrl { get; }

Property Value

string

Remarks

CloudformationAttribute: SageMakerStudioDomainUrl

AttrStatus

The current status of creation of the FinSpace environment.

public virtual string AttrStatus { get; }

Property Value

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

string

Remarks

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

CloudformationResource: AWS::FinSpace::Environment

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::FinSpace::Environment resource represents an Amazon FinSpace environment.

protected override IDictionary<string, object> CfnProperties { get; }

CloudformationResource: AWS::FinSpace::Environment

ExampleMetadata: fixture=_generated

CfnPropertyNames

The AWS::FinSpace::Environment resource represents an Amazon FinSpace environment.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

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

CloudformationResource: AWS::FinSpace::Environment

ExampleMetadata: fixture=_generated

DataBundles

(deprecated) ARNs of FinSpace Data Bundles to install.

[Obsolete("this property has been deprecated")]
public virtual string[]? DataBundles { get; set; }

Property Value

string[]

Remarks

Stability: Deprecated

Description

The description of the FinSpace environment.

public virtual string? Description { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::FinSpace::Environment

ExampleMetadata: fixture=_generated

EnvironmentRef

A reference to a Environment resource.

public virtual IEnvironmentReference EnvironmentRef { get; }

Property Value

IEnvironmentReference

Remarks

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

CloudformationResource: AWS::FinSpace::Environment

ExampleMetadata: fixture=_generated

FederationMode

The authentication mode for the environment.

public virtual string? FederationMode { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::FinSpace::Environment

ExampleMetadata: fixture=_generated

FederationParameters

Configuration information when authentication mode is FEDERATED.

public virtual object? FederationParameters { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnEnvironment.IFederationParametersProperty

KmsKeyId

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

public virtual string? KmsKeyId { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::FinSpace::Environment

ExampleMetadata: fixture=_generated

Name

The name of the FinSpace environment.

public virtual string Name { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::FinSpace::Environment

ExampleMetadata: fixture=_generated

SuperuserParameters

Configuration information for the superuser.

public virtual object? SuperuserParameters { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnEnvironment.ISuperuserParametersProperty

TagsRaw

An array of key-value pairs to apply to this resource.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

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

CloudformationResource: AWS::FinSpace::Environment

ExampleMetadata: fixture=_generated

Methods

ArnForEnvironment(IEnvironmentRef)

The AWS::FinSpace::Environment resource represents an Amazon FinSpace environment.

public static string ArnForEnvironment(IEnvironmentRef resource)

Parameters

resource IEnvironmentRef

Returns

string

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"
                 } }
             });

FromEnvironmentArn(Construct, string, string)

Creates a new IEnvironmentRef from an ARN.

public static IEnvironmentRef FromEnvironmentArn(Construct scope, string id, string arn)

Parameters

scope Construct
id string
arn string

Returns

IEnvironmentRef

Remarks

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

CloudformationResource: AWS::FinSpace::Environment

ExampleMetadata: fixture=_generated

FromEnvironmentId(Construct, string, string)

Creates a new IEnvironmentRef from a environmentId.

public static IEnvironmentRef FromEnvironmentId(Construct scope, string id, string environmentId)

Parameters

scope Construct
id string
environmentId string

Returns

IEnvironmentRef

Remarks

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

CloudformationResource: AWS::FinSpace::Environment

ExampleMetadata: fixture=_generated

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.

Remarks

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

CloudformationResource: AWS::FinSpace::Environment

ExampleMetadata: fixture=_generated

IsCfnEnvironment(object)

Checks whether the given object is a CfnEnvironment.

public static bool IsCfnEnvironment(object x)

Parameters

x object

Returns

bool

Remarks

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

CloudformationResource: AWS::FinSpace::Environment

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::FinSpace::Environment resource represents an Amazon FinSpace environment.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

CloudformationResource: AWS::FinSpace::Environment

ExampleMetadata: fixture=_generated

Implements

IInspectable

IEnvironmentRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable