CfnEnvironment

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.finspace.CfnEnvironment

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:14.878Z")
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 interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnEnvironment(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrAwsAccountId()` The ID of the AWS account in which the FinSpace environment is created.
`java.lang.String`	`getAttrDedicatedServiceAccountId()` The AWS account ID of the dedicated service account associated with your FinSpace environment.
`java.lang.String`	`getAttrEnvironmentArn()` The Amazon Resource Name (ARN) of your FinSpace environment.
`java.lang.String`	`getAttrEnvironmentId()` The identifier of the FinSpace environment.
`java.lang.String`	`getAttrEnvironmentUrl()` The sign-in url for the web application of your FinSpace environment.
`java.lang.String`	`getAttrSageMakerStudioDomainUrl()` The url of the integrated FinSpace notebook environment in your web application.
`java.lang.String`	`getAttrStatus()` The current status of creation of the FinSpace environment.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.util.List<java.lang.String>`	`getDataBundles()` The list of Amazon Resource Names (ARN) of the data bundles to install.
`java.lang.String`	`getDescription()` The description of the FinSpace environment.
`java.lang.String`	`getFederationMode()` The authentication mode for the environment.
`java.lang.Object`	`getFederationParameters()` Configuration information when authentication mode is FEDERATED.
`java.lang.String`	`getKmsKeyId()` The KMS key id used to encrypt in the FinSpace environment.
`java.lang.String`	`getName()` The name of the FinSpace environment.
`java.lang.Object`	`getSuperuserParameters()` Configuration information for the superuser.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setDataBundles(java.util.List<java.lang.String> value)` The list of Amazon Resource Names (ARN) of the data bundles to install.
`void`	`setDescription(java.lang.String value)` The description of the FinSpace environment.
`void`	`setFederationMode(java.lang.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(java.lang.String value)` The KMS key id used to encrypt in the FinSpace environment.
`void`	`setName(java.lang.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.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnEnvironment(Construct scope,
                      java.lang.String id,
                      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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrAwsAccountId
```
public java.lang.String getAttrAwsAccountId()
```
    The ID of the AWS account in which the FinSpace environment is created.
  - getAttrDedicatedServiceAccountId
```
public java.lang.String getAttrDedicatedServiceAccountId()
```
    The AWS account ID of the dedicated service account associated with your FinSpace environment.
  - getAttrEnvironmentArn
```
public java.lang.String getAttrEnvironmentArn()
```
    The Amazon Resource Name (ARN) of your FinSpace environment.
  - getAttrEnvironmentId
```
public java.lang.String getAttrEnvironmentId()
```
    The identifier of the FinSpace environment.
  - getAttrEnvironmentUrl
```
public java.lang.String getAttrEnvironmentUrl()
```
    The sign-in url for the web application of your FinSpace environment.
  - getAttrSageMakerStudioDomainUrl
```
public java.lang.String getAttrSageMakerStudioDomainUrl()
```
    The url of the integrated FinSpace notebook environment in your web application.
  - getAttrStatus
```
public java.lang.String getAttrStatus()
```
    The current status of creation of the FinSpace environment.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getName
```
public java.lang.String getName()
```
    The name of the FinSpace environment.
  - setName
```
public void setName(java.lang.String value)
```
    The name of the FinSpace environment.
  - getDataBundles
```
public java.util.List<java.lang.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
```
public void setDataBundles(java.util.List<java.lang.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
```
public java.lang.String getDescription()
```
    The description of the FinSpace environment.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    The description of the FinSpace environment.
  - getFederationMode
```
public java.lang.String getFederationMode()
```
    The authentication mode for the environment.
  - setFederationMode
```
public void setFederationMode(java.lang.String value)
```
    The authentication mode for the environment.
  - getFederationParameters
```
public java.lang.Object getFederationParameters()
```
    Configuration information when authentication mode is FEDERATED.
  - setFederationParameters
```
public void setFederationParameters(CfnEnvironment.FederationParametersProperty value)
```
    Configuration information when authentication mode is FEDERATED.
  - setFederationParameters
```
public void setFederationParameters(IResolvable value)
```
    Configuration information when authentication mode is FEDERATED.
  - getKmsKeyId
```
public java.lang.String getKmsKeyId()
```
    The KMS key id used to encrypt in the FinSpace environment.
  - setKmsKeyId
```
public void setKmsKeyId(java.lang.String value)
```
    The KMS key id used to encrypt in the FinSpace environment.
  - getSuperuserParameters
```
public java.lang.Object getSuperuserParameters()
```
    Configuration information for the superuser.
  - setSuperuserParameters
```
public void setSuperuserParameters(IResolvable value)
```
    Configuration information for the superuser.
  - setSuperuserParameters
```
public void setSuperuserParameters(CfnEnvironment.SuperuserParametersProperty value)
```
    Configuration information for the superuser.

Class CfnEnvironment

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnEnvironment

CfnEnvironment

CfnEnvironment

Method Detail

inspect

renderProperties

getAttrAwsAccountId

getAttrDedicatedServiceAccountId

getAttrEnvironmentArn

getAttrEnvironmentId

getAttrEnvironmentUrl

getAttrSageMakerStudioDomainUrl

getAttrStatus

getCfnProperties

getName

setName

getDataBundles

setDataBundles

getDescription

setDescription

getFederationMode

setFederationMode

getFederationParameters

setFederationParameters

setFederationParameters

getKmsKeyId

setKmsKeyId

getSuperuserParameters

setSuperuserParameters

setSuperuserParameters