@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:27:50.368Z") public class CfnEnvironment extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnEnvironment(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnEnvironment(Construct scope, java.lang.String id, CfnEnvironmentProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrAwsAccountId()
public java.lang.String getAttrDedicatedServiceAccountId()
public java.lang.String getAttrEnvironmentArn()
public java.lang.String getAttrEnvironmentId()
public java.lang.String getAttrEnvironmentUrl()
public java.lang.String getAttrSageMakerStudioDomainUrl()
public java.lang.String getAttrStatus()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getName()
public void setName(java.lang.String value)
public java.util.List<java.lang.String> getDataBundles()
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.public void setDataBundles(java.util.List<java.lang.String> value)
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.public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.String getFederationMode()
public void setFederationMode(java.lang.String value)
public java.lang.Object getFederationParameters()
public void setFederationParameters(CfnEnvironment.FederationParametersProperty value)
public void setFederationParameters(IResolvable value)
public java.lang.String getKmsKeyId()
public void setKmsKeyId(java.lang.String value)
public java.lang.Object getSuperuserParameters()
public void setSuperuserParameters(IResolvable value)
public void setSuperuserParameters(CfnEnvironment.SuperuserParametersProperty value)