Documentation
¶
Index ¶
- func CfnEnvironment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEnvironment_IsCfnElement(x interface{}) *bool
- func CfnEnvironment_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnEnvironment_IsConstruct(x interface{}) *bool
- func NewCfnEnvironment_Override(c CfnEnvironment, scope awscdk.Construct, id *string, ...)
- type CfnEnvironment
- type CfnEnvironmentProps
- type CfnEnvironment_FederationParametersProperty
- type CfnEnvironment_SuperuserParametersProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnEnvironment_CFN_RESOURCE_TYPE_NAME ¶
func CfnEnvironment_CFN_RESOURCE_TYPE_NAME() *string
func CfnEnvironment_IsCfnElement ¶
func CfnEnvironment_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.
func CfnEnvironment_IsCfnResource ¶
func CfnEnvironment_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnEnvironment_IsConstruct ¶
func CfnEnvironment_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewCfnEnvironment_Override ¶
func NewCfnEnvironment_Override(c CfnEnvironment, scope awscdk.Construct, id *string, props *CfnEnvironmentProps)
Create a new `AWS::FinSpace::Environment`.
Types ¶
type CfnEnvironment ¶
type CfnEnvironment interface {
awscdk.CfnResource
awscdk.IInspectable
AttrAwsAccountId() *string
AttrDedicatedServiceAccountId() *string
AttrEnvironmentArn() *string
AttrEnvironmentId() *string
AttrEnvironmentUrl() *string
AttrSageMakerStudioDomainUrl() *string
AttrStatus() *string
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
DataBundles() *[]*string
SetDataBundles(val *[]*string)
Description() *string
SetDescription(val *string)
FederationMode() *string
SetFederationMode(val *string)
FederationParameters() interface{}
SetFederationParameters(val interface{})
KmsKeyId() *string
SetKmsKeyId(val *string)
LogicalId() *string
Name() *string
SetName(val *string)
Node() awscdk.ConstructNode
Ref() *string
Stack() awscdk.Stack
SuperuserParameters() interface{}
SetSuperuserParameters(val interface{})
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OnPrepare()
OnSynthesize(session constructs.ISynthesisSession)
OnValidate() *[]*string
OverrideLogicalId(newLogicalId *string)
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
Synthesize(session awscdk.ISynthesisSession)
ToString() *string
Validate() *[]*string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::FinSpace::Environment`.
The `AWS::FinSpace::Environment` resource represents an Amazon FinSpace environment.
TODO: EXAMPLE
func NewCfnEnvironment ¶
func NewCfnEnvironment(scope awscdk.Construct, id *string, props *CfnEnvironmentProps) CfnEnvironment
Create a new `AWS::FinSpace::Environment`.
type CfnEnvironmentProps ¶
type CfnEnvironmentProps struct {
// The name of the FinSpace environment.
Name *string `json:"name" yaml:"name"`
// 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.
DataBundles *[]*string `json:"dataBundles" yaml:"dataBundles"`
// The description of the FinSpace environment.
Description *string `json:"description" yaml:"description"`
// The authentication mode for the environment.
FederationMode *string `json:"federationMode" yaml:"federationMode"`
// Configuration information when authentication mode is FEDERATED.
FederationParameters interface{} `json:"federationParameters" yaml:"federationParameters"`
// The KMS key id used to encrypt in the FinSpace environment.
KmsKeyId *string `json:"kmsKeyId" yaml:"kmsKeyId"`
// Configuration information for the superuser.
SuperuserParameters interface{} `json:"superuserParameters" yaml:"superuserParameters"`
}
Properties for defining a `CfnEnvironment`.
TODO: EXAMPLE
type CfnEnvironment_FederationParametersProperty ¶
type CfnEnvironment_FederationParametersProperty struct {
// The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
ApplicationCallBackUrl *string `json:"applicationCallBackUrl" yaml:"applicationCallBackUrl"`
// SAML attribute name and value.
//
// The name must always be `Email` and the value should be set to the attribute definition in which user email is set. For example, name would be `Email` and value `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` . Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
AttributeMap interface{} `json:"attributeMap" yaml:"attributeMap"`
// Name of the identity provider (IdP).
FederationProviderName *string `json:"federationProviderName" yaml:"federationProviderName"`
// The Uniform Resource Name (URN).
//
// Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
FederationUrn *string `json:"federationUrn" yaml:"federationUrn"`
// SAML 2.0 Metadata document from identity provider (IdP).
SamlMetadataDocument *string `json:"samlMetadataDocument" yaml:"samlMetadataDocument"`
// Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
SamlMetadataUrl *string `json:"samlMetadataUrl" yaml:"samlMetadataUrl"`
}
Configuration information when authentication mode is FEDERATED.
TODO: EXAMPLE
type CfnEnvironment_SuperuserParametersProperty ¶
type CfnEnvironment_SuperuserParametersProperty struct {
// The email address of the superuser.
EmailAddress *string `json:"emailAddress" yaml:"emailAddress"`
// The first name of the superuser.
FirstName *string `json:"firstName" yaml:"firstName"`
// The last name of the superuser.
LastName *string `json:"lastName" yaml:"lastName"`
}
Configuration information for the superuser.
TODO: EXAMPLE