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.46.0 (build cd08c55)",
           date="2021-11-25T20:11:06.585Z")
 @Stability(value=Stable)
public class CfnEnvironment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::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 Example:
static interface	CfnEnvironment.SuperuserParametersProperty Example:

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()
String	getAttrDedicatedServiceAccountId()
String	getAttrEnvironmentArn()
String	getAttrEnvironmentId()
String	getAttrEnvironmentUrl()
String	getAttrSageMakerStudioDomainUrl()
String	getAttrStatus()
protected Map<String,Object>	getCfnProperties()
List<String>	getDataBundles() `AWS::FinSpace::Environment.DataBundles`.
String	getDescription() `AWS::FinSpace::Environment.Description`.
String	getFederationMode() `AWS::FinSpace::Environment.FederationMode`.
Object	getFederationParameters() `AWS::FinSpace::Environment.FederationParameters`.
String	getKmsKeyId() `AWS::FinSpace::Environment.KmsKeyId`.
String	getName() `AWS::FinSpace::Environment.Name`.
Object	getSuperuserParameters() `AWS::FinSpace::Environment.SuperuserParameters`.
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) `AWS::FinSpace::Environment.DataBundles`.
void	setDescription(String value) `AWS::FinSpace::Environment.Description`.
void	setFederationMode(String value) `AWS::FinSpace::Environment.FederationMode`.
void	setFederationParameters(CfnEnvironment.FederationParametersProperty value) `AWS::FinSpace::Environment.FederationParameters`.
void	setFederationParameters(IResolvable value) `AWS::FinSpace::Environment.FederationParameters`.
void	setKmsKeyId(String value) `AWS::FinSpace::Environment.KmsKeyId`.
void	setName(String value) `AWS::FinSpace::Environment.Name`.
void	setSuperuserParameters(CfnEnvironment.SuperuserParametersProperty value) `AWS::FinSpace::Environment.SuperuserParameters`.
void	setSuperuserParameters(IResolvable value) `AWS::FinSpace::Environment.SuperuserParameters`.

Methods inherited from class software.amazon.awscdk.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.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()

getAttrDedicatedServiceAccountId

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

getAttrEnvironmentArn

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

getAttrEnvironmentId

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

getAttrEnvironmentUrl

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

getAttrSageMakerStudioDomainUrl

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

getAttrStatus

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getDataBundles

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

`AWS::FinSpace::Environment.DataBundles`.

setDataBundles

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

`AWS::FinSpace::Environment.DataBundles`.

getDescription

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

`AWS::FinSpace::Environment.Description`.

setDescription

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

`AWS::FinSpace::Environment.Description`.

getFederationMode

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

`AWS::FinSpace::Environment.FederationMode`.

setFederationMode

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

`AWS::FinSpace::Environment.FederationMode`.

getFederationParameters

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

`AWS::FinSpace::Environment.FederationParameters`.

setFederationParameters

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

`AWS::FinSpace::Environment.FederationParameters`.

setFederationParameters

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

`AWS::FinSpace::Environment.FederationParameters`.

getKmsKeyId

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

`AWS::FinSpace::Environment.KmsKeyId`.

setKmsKeyId

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

`AWS::FinSpace::Environment.KmsKeyId`.

getName

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

`AWS::FinSpace::Environment.Name`.

setName

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

`AWS::FinSpace::Environment.Name`.

getSuperuserParameters

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

`AWS::FinSpace::Environment.SuperuserParameters`.

setSuperuserParameters

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

`AWS::FinSpace::Environment.SuperuserParameters`.

setSuperuserParameters

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

`AWS::FinSpace::Environment.SuperuserParameters`.