Package 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.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:56.747Z")
@Stability(Stable)
public interface CfnEnvironmentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnEnvironment.

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.*;
 CfnEnvironmentProps cfnEnvironmentProps = CfnEnvironmentProps.builder()
         .name("name")
         // the properties below are optional
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEnvironmentProps.Builder	A builder for CfnEnvironmentProps
static final class	CfnEnvironmentProps.Jsii$Proxy	An implementation for CfnEnvironmentProps

Method Summary

Modifier and Type	Method	Description
static CfnEnvironmentProps.Builder	builder()
default String	getDescription()	The description of the FinSpace environment.
default String	getFederationMode()	The authentication mode for the environment.
default Object	getFederationParameters()	Configuration information when authentication mode is FEDERATED.
default String	getKmsKeyId()	The KMS key id used to encrypt in the FinSpace environment.
String	getName()	The name of the FinSpace environment.
default Object	getSuperuserParameters()	Configuration information for the superuser.
default List<CfnTag>	getTags()	AWS::FinSpace::Environment.Tags.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the FinSpace environment.

getDescription

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

The description of the FinSpace environment.

getFederationMode

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

The authentication mode for the environment.

getFederationParameters

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

Configuration information when authentication mode is FEDERATED.

getKmsKeyId

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

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

getSuperuserParameters

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

Configuration information for the superuser.

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

AWS::FinSpace::Environment.Tags.

builder

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

Returns:

a CfnEnvironmentProps.Builder of CfnEnvironmentProps