Package software.amazon.awscdk.services.finspace

Class CfnEnvironment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.finspace.CfnEnvironment
All Implemented Interfaces:
IInspectable, IEnvironmentRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:10.791Z") @Stability(Stable) public class CfnEnvironment extends CfnResource implements IInspectable, IEnvironmentRef, ITaggable
The AWS::FinSpace::Environment resource represents an Amazon FinSpace environment.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.finspace.*;
 CfnEnvironment cfnEnvironment = CfnEnvironment.Builder.create(this, "MyCfnEnvironment")
         .name("name")
         // the properties below are optional
         .dataBundles(List.of("dataBundles"))
         .description("description")
         .federationMode("federationMode")
         .federationParameters(FederationParametersProperty.builder()
                 .applicationCallBackUrl("applicationCallBackUrl")
                 .attributeMap(List.of(AttributeMapItemsProperty.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .federationProviderName("federationProviderName")
                 .federationUrn("federationUrn")
                 .samlMetadataDocument("samlMetadataDocument")
                 .samlMetadataUrl("samlMetadataUrl")
                 .build())
         .kmsKeyId("kmsKeyId")
         .superuserParameters(SuperuserParametersProperty.builder()
                 .emailAddress("emailAddress")
                 .firstName("firstName")
                 .lastName("lastName")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEnvironment

      protected CfnEnvironment(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnEnvironment

      protected CfnEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnEnvironment

      @Stability(Stable) public CfnEnvironment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnEnvironmentProps props)
      Create a new AWS::FinSpace::Environment.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForEnvironment

      @Stability(Stable) @NotNull public static String arnForEnvironment(@NotNull IEnvironmentRef resource)
      Parameters:
      resource - This parameter is required.

    • fromEnvironmentArn

      @Stability(Stable) @NotNull public static IEnvironmentRef fromEnvironmentArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IEnvironmentRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromEnvironmentId

      @Stability(Stable) @NotNull public static IEnvironmentRef fromEnvironmentId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String environmentId)
      Creates a new IEnvironmentRef from a environmentId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      environmentId - This parameter is required.

    • isCfnEnvironment

      @Stability(Stable) @NotNull public static Boolean isCfnEnvironment(@NotNull Object x)
      Checks whether the given object is a CfnEnvironment.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAwsAccountId

      @Stability(Stable) @NotNull public String getAttrAwsAccountId()
      The ID of the AWS account in which the FinSpace environment is created.

    • getAttrDedicatedServiceAccountId

      @Stability(Stable) @NotNull public String getAttrDedicatedServiceAccountId()
      The AWS account ID of the dedicated service account associated with your FinSpace environment.

    • getAttrEnvironmentArn

      @Stability(Stable) @NotNull public String getAttrEnvironmentArn()
      The Amazon Resource Name (ARN) of your FinSpace environment.

    • getAttrEnvironmentId

      @Stability(Stable) @NotNull public String getAttrEnvironmentId()
      The identifier of the FinSpace environment.

    • getAttrEnvironmentUrl

      @Stability(Stable) @NotNull public String getAttrEnvironmentUrl()
      The sign-in url for the web application of your FinSpace environment.

    • getAttrSageMakerStudioDomainUrl

      @Stability(Stable) @NotNull public String getAttrSageMakerStudioDomainUrl()
      The url of the integrated FinSpace notebook environment in your web application.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The current status of creation of the FinSpace environment.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getEnvironmentRef

      @Stability(Stable) @NotNull public EnvironmentReference getEnvironmentRef()
      A reference to a Environment resource.
      Specified by:
      getEnvironmentRef in interface IEnvironmentRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the FinSpace environment.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the FinSpace environment.

    • getDataBundles

      @Stability(Deprecated) @Deprecated @Nullable public List<String> getDataBundles()
      Deprecated.
      this property has been deprecated
      (deprecated) ARNs of FinSpace Data Bundles to install.

    • setDataBundles

      @Stability(Deprecated) @Deprecated public void setDataBundles(@Nullable List<String> value)
      Deprecated.
      this property has been deprecated
      (deprecated) ARNs of FinSpace Data Bundles to install.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the FinSpace environment.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the FinSpace environment.

    • getFederationMode

      @Stability(Stable) @Nullable public String getFederationMode()
      The authentication mode for the environment.

    • setFederationMode

      @Stability(Stable) public void setFederationMode(@Nullable String value)
      The authentication mode for the environment.

    • getFederationParameters

      @Stability(Stable) @Nullable public Object getFederationParameters()
      Configuration information when authentication mode is FEDERATED.

      Returns union: either IResolvable or CfnEnvironment.FederationParametersProperty

    • setFederationParameters

      @Stability(Stable) public void setFederationParameters(@Nullable IResolvable value)
      Configuration information when authentication mode is FEDERATED.

    • setFederationParameters

      @Stability(Stable) public void setFederationParameters(@Nullable CfnEnvironment.FederationParametersProperty value)
      Configuration information when authentication mode is FEDERATED.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The KMS key id used to encrypt in the FinSpace environment.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The KMS key id used to encrypt in the FinSpace environment.

    • getSuperuserParameters

      @Stability(Stable) @Nullable public Object getSuperuserParameters()
      Configuration information for the superuser.

      Returns union: either IResolvable or CfnEnvironment.SuperuserParametersProperty

    • setSuperuserParameters

      @Stability(Stable) public void setSuperuserParameters(@Nullable IResolvable value)
      Configuration information for the superuser.

    • setSuperuserParameters

      @Stability(Stable) public void setSuperuserParameters(@Nullable CfnEnvironment.SuperuserParametersProperty value)
      Configuration information for the superuser.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.