awsfinspace

README

AWS::FinSpace Construct Library

This module is part of the AWS Cloud Development Kit project.

import finspace "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

• Search Construct Hub for FinSpace construct libraries
• Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::FinSpace resources directly.

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::FinSpace.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

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 constructs.Construct, id *string, ...)
• type CfnEnvironment
  • func NewCfnEnvironment(scope constructs.Construct, id *string, props *CfnEnvironmentProps) CfnEnvironment
• type CfnEnvironmentProps
• type CfnEnvironment_FederationParametersProperty
• type CfnEnvironment_SuperuserParametersProperty

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.

func CfnEnvironment_IsCfnResource

func CfnEnvironment_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnEnvironment_IsConstruct

func CfnEnvironment_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func NewCfnEnvironment_Override

func NewCfnEnvironment_Override(c CfnEnvironment, scope constructs.Construct, id *string, props *CfnEnvironmentProps)

Create a new `AWS::FinSpace::Environment`.

Types

type CfnEnvironment

type CfnEnvironment interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The ID of the AWS account in which the FinSpace environment is created.
	AttrAwsAccountId() *string
	// The AWS account ID of the dedicated service account associated with your FinSpace environment.
	AttrDedicatedServiceAccountId() *string
	// The Amazon Resource Name (ARN) of your FinSpace environment.
	AttrEnvironmentArn() *string
	// The identifier of the FinSpace environment.
	AttrEnvironmentId() *string
	// The sign-in url for the web application of your FinSpace environment.
	AttrEnvironmentUrl() *string
	// The url of the integrated FinSpace notebook environment in your web application.
	AttrSageMakerStudioDomainUrl() *string
	// The current status of creation of the FinSpace environment.
	AttrStatus() *string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// 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
	SetDataBundles(val *[]*string)
	// The description of the FinSpace environment.
	Description() *string
	SetDescription(val *string)
	// The authentication mode for the environment.
	FederationMode() *string
	SetFederationMode(val *string)
	// Configuration information when authentication mode is FEDERATED.
	FederationParameters() interface{}
	SetFederationParameters(val interface{})
	// The KMS key id used to encrypt in the FinSpace environment.
	KmsKeyId() *string
	SetKmsKeyId(val *string)
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The name of the FinSpace environment.
	Name() *string
	SetName(val *string)
	// The tree node.
	Node() constructs.Node
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// Configuration information for the superuser.
	SuperuserParameters() interface{}
	SetSuperuserParameters(val interface{})
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// Return properties modified after initiation
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::FinSpace::Environment`.

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 "github.com/aws/aws-cdk-go/awscdk"

var attributeMap interface{}

cfnEnvironment := awscdk.Aws_finspace.NewCfnEnvironment(this, jsii.String("MyCfnEnvironment"), &cfnEnvironmentProps{
	name: jsii.String("name"),

	// the properties below are optional
	dataBundles: []*string{
		jsii.String("dataBundles"),
	},
	description: jsii.String("description"),
	federationMode: jsii.String("federationMode"),
	federationParameters: &federationParametersProperty{
		applicationCallBackUrl: jsii.String("applicationCallBackUrl"),
		attributeMap: attributeMap,
		federationProviderName: jsii.String("federationProviderName"),
		federationUrn: jsii.String("federationUrn"),
		samlMetadataDocument: jsii.String("samlMetadataDocument"),
		samlMetadataUrl: jsii.String("samlMetadataUrl"),
	},
	kmsKeyId: jsii.String("kmsKeyId"),
	superuserParameters: &superuserParametersProperty{
		emailAddress: jsii.String("emailAddress"),
		firstName: jsii.String("firstName"),
		lastName: jsii.String("lastName"),
	},
})

func NewCfnEnvironment

func NewCfnEnvironment(scope constructs.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 `field:"required" 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 `field:"optional" json:"dataBundles" yaml:"dataBundles"`
	// The description of the FinSpace environment.
	Description *string `field:"optional" json:"description" yaml:"description"`
	// The authentication mode for the environment.
	FederationMode *string `field:"optional" json:"federationMode" yaml:"federationMode"`
	// Configuration information when authentication mode is FEDERATED.
	FederationParameters interface{} `field:"optional" json:"federationParameters" yaml:"federationParameters"`
	// The KMS key id used to encrypt in the FinSpace environment.
	KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"`
	// Configuration information for the superuser.
	SuperuserParameters interface{} `field:"optional" json:"superuserParameters" yaml:"superuserParameters"`
}

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 "github.com/aws/aws-cdk-go/awscdk"

var attributeMap interface{}

cfnEnvironmentProps := &cfnEnvironmentProps{
	name: jsii.String("name"),

	// the properties below are optional
	dataBundles: []*string{
		jsii.String("dataBundles"),
	},
	description: jsii.String("description"),
	federationMode: jsii.String("federationMode"),
	federationParameters: &federationParametersProperty{
		applicationCallBackUrl: jsii.String("applicationCallBackUrl"),
		attributeMap: attributeMap,
		federationProviderName: jsii.String("federationProviderName"),
		federationUrn: jsii.String("federationUrn"),
		samlMetadataDocument: jsii.String("samlMetadataDocument"),
		samlMetadataUrl: jsii.String("samlMetadataUrl"),
	},
	kmsKeyId: jsii.String("kmsKeyId"),
	superuserParameters: &superuserParametersProperty{
		emailAddress: jsii.String("emailAddress"),
		firstName: jsii.String("firstName"),
		lastName: jsii.String("lastName"),
	},
}

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 `field:"optional" 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{} `field:"optional" json:"attributeMap" yaml:"attributeMap"`
	// Name of the identity provider (IdP).
	FederationProviderName *string `field:"optional" 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 `field:"optional" json:"federationUrn" yaml:"federationUrn"`
	// SAML 2.0 Metadata document from identity provider (IdP).
	SamlMetadataDocument *string `field:"optional" json:"samlMetadataDocument" yaml:"samlMetadataDocument"`
	// Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
	SamlMetadataUrl *string `field:"optional" json:"samlMetadataUrl" yaml:"samlMetadataUrl"`
}

Configuration information when authentication mode is FEDERATED.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var attributeMap interface{}

federationParametersProperty := &federationParametersProperty{
	applicationCallBackUrl: jsii.String("applicationCallBackUrl"),
	attributeMap: attributeMap,
	federationProviderName: jsii.String("federationProviderName"),
	federationUrn: jsii.String("federationUrn"),
	samlMetadataDocument: jsii.String("samlMetadataDocument"),
	samlMetadataUrl: jsii.String("samlMetadataUrl"),
}

type CfnEnvironment_SuperuserParametersProperty

type CfnEnvironment_SuperuserParametersProperty struct {
	// The email address of the superuser.
	EmailAddress *string `field:"optional" json:"emailAddress" yaml:"emailAddress"`
	// The first name of the superuser.
	FirstName *string `field:"optional" json:"firstName" yaml:"firstName"`
	// The last name of the superuser.
	LastName *string `field:"optional" json:"lastName" yaml:"lastName"`
}

Configuration information for the superuser.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

superuserParametersProperty := &superuserParametersProperty{
	emailAddress: jsii.String("emailAddress"),
	firstName: jsii.String("firstName"),
	lastName: jsii.String("lastName"),
}