awsfinspace

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

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
	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
	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`.

func NewCfnEnvironment

func NewCfnEnvironment(scope awscdk.Construct, id *string, props *CfnEnvironmentProps) CfnEnvironment

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

type CfnEnvironmentProps

type CfnEnvironmentProps struct {
	// `AWS::FinSpace::Environment.Name`.
	Name *string `json:"name"`
	// `AWS::FinSpace::Environment.Description`.
	Description *string `json:"description"`
	// `AWS::FinSpace::Environment.FederationMode`.
	FederationMode *string `json:"federationMode"`
	// `AWS::FinSpace::Environment.FederationParameters`.
	FederationParameters interface{} `json:"federationParameters"`
	// `AWS::FinSpace::Environment.KmsKeyId`.
	KmsKeyId *string `json:"kmsKeyId"`
}

Properties for defining a `AWS::FinSpace::Environment`.

type CfnEnvironment_FederationParametersProperty

type CfnEnvironment_FederationParametersProperty struct {
	// `CfnEnvironment.FederationParametersProperty.ApplicationCallBackURL`.
	ApplicationCallBackUrl *string `json:"applicationCallBackUrl"`
	// `CfnEnvironment.FederationParametersProperty.AttributeMap`.
	AttributeMap interface{} `json:"attributeMap"`
	// `CfnEnvironment.FederationParametersProperty.FederationProviderName`.
	FederationProviderName *string `json:"federationProviderName"`
	// `CfnEnvironment.FederationParametersProperty.FederationURN`.
	FederationUrn *string `json:"federationUrn"`
	// `CfnEnvironment.FederationParametersProperty.SamlMetadataDocument`.
	SamlMetadataDocument *string `json:"samlMetadataDocument"`
	// `CfnEnvironment.FederationParametersProperty.SamlMetadataURL`.
	SamlMetadataUrl *string `json:"samlMetadataUrl"`
}