software.amazon.awscdk.services.finspace

Interface CfnEnvironmentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEnvironmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:06.586Z")
 @Stability(value=Stable)
public interface CfnEnvironmentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `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;
 CfnEnvironmentProps cfnEnvironmentProps = CfnEnvironmentProps.builder()
         .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	Interface and Description
static class	CfnEnvironmentProps.Builder A builder for CfnEnvironmentProps
static class	CfnEnvironmentProps.Jsii$Proxy An implementation for CfnEnvironmentProps

Method Summary

Modifier and Type	Method and Description
static CfnEnvironmentProps.Builder	builder()
default List<String>	getDataBundles() `AWS::FinSpace::Environment.DataBundles`.
default String	getDescription() `AWS::FinSpace::Environment.Description`.
default String	getFederationMode() `AWS::FinSpace::Environment.FederationMode`.
default Object	getFederationParameters() `AWS::FinSpace::Environment.FederationParameters`.
default String	getKmsKeyId() `AWS::FinSpace::Environment.KmsKeyId`.
String	getName() `AWS::FinSpace::Environment.Name`.
default Object	getSuperuserParameters() `AWS::FinSpace::Environment.SuperuserParameters`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDataBundles

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

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

getDescription

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

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

getFederationMode

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

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

getFederationParameters

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

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

getKmsKeyId

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

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

getName

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

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

getSuperuserParameters

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

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

builder

@Stability(value=Stable)
static CfnEnvironmentProps.Builder builder()

Returns:

a CfnEnvironmentProps.Builder of CfnEnvironmentProps