awsiotthingsgraph

Documentation

Index

• func CfnFlowTemplate_CFN_RESOURCE_TYPE_NAME() *string
• func CfnFlowTemplate_IsCfnElement(x interface{}) *bool
• func CfnFlowTemplate_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnFlowTemplate_IsConstruct(x interface{}) *bool
• func NewCfnFlowTemplate_Override(c CfnFlowTemplate, scope constructs.Construct, id *string, ...)
• type CfnFlowTemplate
  • func NewCfnFlowTemplate(scope constructs.Construct, id *string, props *CfnFlowTemplateProps) CfnFlowTemplate
• type CfnFlowTemplateProps
• type CfnFlowTemplate_DefinitionDocumentProperty

Functions

func CfnFlowTemplate_CFN_RESOURCE_TYPE_NAME

func CfnFlowTemplate_CFN_RESOURCE_TYPE_NAME() *string

func CfnFlowTemplate_IsCfnElement

func CfnFlowTemplate_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 CfnFlowTemplate_IsCfnResource

func CfnFlowTemplate_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnFlowTemplate_IsConstruct

func CfnFlowTemplate_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

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

func NewCfnFlowTemplate_Override

func NewCfnFlowTemplate_Override(c CfnFlowTemplate, scope constructs.Construct, id *string, props *CfnFlowTemplateProps)

Create a new `AWS::IoTThingsGraph::FlowTemplate`.

Types

type CfnFlowTemplate

type CfnFlowTemplate interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CompatibleNamespaceVersion() *float64
	SetCompatibleNamespaceVersion(val *float64)
	CreationStack() *[]*string
	Definition() interface{}
	SetDefinition(val interface{})
	LogicalId() *string
	Node() constructs.Node
	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)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoTThingsGraph::FlowTemplate`.

Represents a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.

TODO: EXAMPLE

func NewCfnFlowTemplate

func NewCfnFlowTemplate(scope constructs.Construct, id *string, props *CfnFlowTemplateProps) CfnFlowTemplate

Create a new `AWS::IoTThingsGraph::FlowTemplate`.

type CfnFlowTemplateProps

type CfnFlowTemplateProps struct {
	// A workflow's definition document.
	Definition interface{} `json:"definition" yaml:"definition"`
	// The version of the user's namespace against which the workflow was validated.
	//
	// Use this value in your system instance.
	CompatibleNamespaceVersion *float64 `json:"compatibleNamespaceVersion" yaml:"compatibleNamespaceVersion"`
}

Properties for defining a `CfnFlowTemplate`.

TODO: EXAMPLE

type CfnFlowTemplate_DefinitionDocumentProperty

type CfnFlowTemplate_DefinitionDocumentProperty struct {
	// The language used to define the entity.
	//
	// `GRAPHQL` is the only valid value.
	Language *string `json:"language" yaml:"language"`
	// The GraphQL text that defines the entity.
	Text *string `json:"text" yaml:"text"`
}

A document that defines an entity.

TODO: EXAMPLE