websocket

Documentation

Overview

websocket

Index

• func NewWebsocket_Override(w Websocket, scope constructs.Construct, id *string, config *WebsocketConfig)
• func Websocket_IsConstruct(x interface{}) *bool
• func Websocket_IsTerraformElement(x interface{}) *bool
• type Websocket
  • func NewWebsocket(scope constructs.Construct, id *string, config *WebsocketConfig) Websocket
• type WebsocketConfig

Functions

func NewWebsocket_Override

func NewWebsocket_Override(w Websocket, scope constructs.Construct, id *string, config *WebsocketConfig)

func Websocket_IsConstruct

func Websocket_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 Websocket_IsTerraformElement

func Websocket_IsTerraformElement(x interface{}) *bool

Experimental.

Types

type Websocket

type Websocket interface {
	cdktf.TerraformModule
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	LambdaConnectTarget() *string
	SetLambdaConnectTarget(val *string)
	LambdaDisconnectTarget() *string
	SetLambdaDisconnectTarget(val *string)
	LambdaMessageTarget() *string
	SetLambdaMessageTarget(val *string)
	// The tree node.
	Node() constructs.Node
	// Experimental.
	Providers() *[]interface{}
	// Experimental.
	RawOverrides() interface{}
	// Experimental.
	SkipAssetCreationFromLocalModules() *bool
	// Experimental.
	Source() *string
	StackId() *string
	SetStackId(val *string)
	// Experimental.
	Version() *string
	WebsocketArnOutput() *string
	WebsocketExecArnOutput() *string
	WebsocketName() *string
	SetWebsocketName(val *string)
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	AddProvider(provider interface{})
	// Experimental.
	GetString(output *string) *string
	// Experimental.
	InterpolationForOutput(moduleOutput *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Experimental.
	ToHclTerraform() interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Experimental.
	ToTerraform() interface{}
}

Defines an Websocket based on a Terraform module.

Source at ./.nitric/modules/websocket

func NewWebsocket

func NewWebsocket(scope constructs.Construct, id *string, config *WebsocketConfig) Websocket

type WebsocketConfig

type WebsocketConfig struct {
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Providers *[]interface{} `field:"optional" json:"providers" yaml:"providers"`
	// Experimental.
	SkipAssetCreationFromLocalModules *bool `field:"optional" json:"skipAssetCreationFromLocalModules" yaml:"skipAssetCreationFromLocalModules"`
	// The ARN of the lambda to send websocket connection events to.
	LambdaConnectTarget *string `field:"required" json:"lambdaConnectTarget" yaml:"lambdaConnectTarget"`
	// The ARN of the lambda to send websocket disconnection events to.
	LambdaDisconnectTarget *string `field:"required" json:"lambdaDisconnectTarget" yaml:"lambdaDisconnectTarget"`
	// The ARN of the lambda to send websocket disconnection events to.
	LambdaMessageTarget *string `field:"required" json:"lambdaMessageTarget" yaml:"lambdaMessageTarget"`
	// The ID of the Nitric stack.
	StackId *string `field:"required" json:"stackId" yaml:"stackId"`
	// The name of the websocket.
	WebsocketName *string `field:"required" json:"websocketName" yaml:"websocketName"`
}