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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.363Z")
 @Stability(value=Stable)
public class CfnEnvironment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::FinSpace::Environment`.

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.*;
 Object attributeMap;
 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(attributeMap)
                 .federationProviderName("federationProviderName")
                 .federationUrn("federationUrn")
                 .samlMetadataDocument("samlMetadataDocument")
                 .samlMetadataUrl("samlMetadataUrl")
                 .build())
         .kmsKeyId("kmsKeyId")
         .superuserParameters(SuperuserParametersProperty.builder()
                 .emailAddress("emailAddress")
                 .firstName("firstName")
                 .lastName("lastName")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnEnvironment.Builder A fluent builder for CfnEnvironment.
static interface	CfnEnvironment.FederationParametersProperty Configuration information when authentication mode is FEDERATED.
static interface	CfnEnvironment.SuperuserParametersProperty Configuration information for the superuser.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEnvironment(software.constructs.Construct scope, String id, CfnEnvironmentProps props) Create a new `AWS::FinSpace::Environment`.
protected	CfnEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEnvironment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrAwsAccountId() The ID of the AWS account in which the FinSpace environment is created.
String	getAttrDedicatedServiceAccountId() The AWS account ID of the dedicated service account associated with your FinSpace environment.
String	getAttrEnvironmentArn() The Amazon Resource Name (ARN) of your FinSpace environment.
String	getAttrEnvironmentId() The identifier of the FinSpace environment.
String	getAttrEnvironmentUrl() The sign-in url for the web application of your FinSpace environment.
String	getAttrSageMakerStudioDomainUrl() The url of the integrated FinSpace notebook environment in your web application.
String	getAttrStatus() The current status of creation of the FinSpace environment.
protected Map<String,Object>	getCfnProperties()
List<String>	getDataBundles() The list of Amazon Resource Names (ARN) of the data bundles to install.
String	getDescription() The description of the FinSpace environment.
String	getFederationMode() The authentication mode for the environment.
Object	getFederationParameters() Configuration information when authentication mode is FEDERATED.
String	getKmsKeyId() The KMS key id used to encrypt in the FinSpace environment.
String	getName() The name of the FinSpace environment.
Object	getSuperuserParameters() Configuration information for the superuser.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDataBundles(List<String> value) The list of Amazon Resource Names (ARN) of the data bundles to install.
void	setDescription(String value) The description of the FinSpace environment.
void	setFederationMode(String value) The authentication mode for the environment.
void	setFederationParameters(CfnEnvironment.FederationParametersProperty value) Configuration information when authentication mode is FEDERATED.
void	setFederationParameters(IResolvable value) Configuration information when authentication mode is FEDERATED.
void	setKmsKeyId(String value) The KMS key id used to encrypt in the FinSpace environment.
void	setName(String value) The name of the FinSpace environment.
void	setSuperuserParameters(CfnEnvironment.SuperuserParametersProperty value) Configuration information for the superuser.
void	setSuperuserParameters(IResolvable value) Configuration information for the superuser.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEnvironment

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

CfnEnvironment

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

CfnEnvironment

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrAwsAccountId()

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

getAttrDedicatedServiceAccountId

@Stability(value=Stable)
 @NotNull
public String getAttrDedicatedServiceAccountId()

The AWS account ID of the dedicated service account associated with your FinSpace environment.

getAttrEnvironmentArn

@Stability(value=Stable)
 @NotNull
public String getAttrEnvironmentArn()

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

getAttrEnvironmentId

@Stability(value=Stable)
 @NotNull
public String getAttrEnvironmentId()

The identifier of the FinSpace environment.

getAttrEnvironmentUrl

@Stability(value=Stable)
 @NotNull
public String getAttrEnvironmentUrl()

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

getAttrSageMakerStudioDomainUrl

@Stability(value=Stable)
 @NotNull
public String getAttrSageMakerStudioDomainUrl()

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

getAttrStatus

@Stability(value=Stable)
 @NotNull
public String getAttrStatus()

The current status of creation of the FinSpace environment.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the FinSpace environment.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the FinSpace environment.

getDataBundles

@Stability(value=Stable)
 @Nullable
public List<String> getDataBundles()

The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:.

• arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.
• arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.

setDataBundles

@Stability(value=Stable)
public void setDataBundles(@Nullable
                                                    List<String> value)

The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:.

• arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.
• arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of the FinSpace environment.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the FinSpace environment.

getFederationMode

@Stability(value=Stable)
 @Nullable
public String getFederationMode()

The authentication mode for the environment.

setFederationMode

@Stability(value=Stable)
public void setFederationMode(@Nullable
                                                       String value)

The authentication mode for the environment.

getFederationParameters

@Stability(value=Stable)
 @Nullable
public Object getFederationParameters()

Configuration information when authentication mode is FEDERATED.

setFederationParameters

@Stability(value=Stable)
public void setFederationParameters(@Nullable
                                                             CfnEnvironment.FederationParametersProperty value)

Configuration information when authentication mode is FEDERATED.

setFederationParameters

@Stability(value=Stable)
public void setFederationParameters(@Nullable
                                                             IResolvable value)

Configuration information when authentication mode is FEDERATED.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
public String getKmsKeyId()

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

setKmsKeyId

@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)

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

getSuperuserParameters

@Stability(value=Stable)
 @Nullable
public Object getSuperuserParameters()

Configuration information for the superuser.

setSuperuserParameters

@Stability(value=Stable)
public void setSuperuserParameters(@Nullable
                                                            CfnEnvironment.SuperuserParametersProperty value)

Configuration information for the superuser.

setSuperuserParameters

@Stability(value=Stable)
public void setSuperuserParameters(@Nullable
                                                            IResolvable value)

Configuration information for the superuser.