alicloudroscdkfnf

README

Aliyun ROS FNF Construct Library

This module is part of the AliCloud ROS Cloud Development Kit (ROS CDK) project.

import * as FNF from '@alicloud/ros-cdk-fnf';

Documentation

Overview

Aliyun SDK Copyright (C) Alibaba Cloud Computing All rights reserved. http://www.aliyun.com

Index

• func Flow_IsConstruct(x interface{}) *bool
• func NewFlow_Override(f Flow, scope alicloudroscdkcore.Construct, id *string, props *FlowProps, ...)
• func NewRosFlow_Override(r RosFlow, scope alicloudroscdkcore.Construct, id *string, props *RosFlowProps, ...)
• func NewRosSchedule_Override(r RosSchedule, scope alicloudroscdkcore.Construct, id *string, ...)
• func NewSchedule_Override(s Schedule, scope alicloudroscdkcore.Construct, id *string, ...)
• func RosFlow_IsConstruct(x interface{}) *bool
• func RosFlow_IsRosElement(x interface{}) *bool
• func RosFlow_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
• func RosFlow_ROS_RESOURCE_TYPE_NAME() *string
• func RosSchedule_IsConstruct(x interface{}) *bool
• func RosSchedule_IsRosElement(x interface{}) *bool
• func RosSchedule_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
• func RosSchedule_ROS_RESOURCE_TYPE_NAME() *string
• func Schedule_IsConstruct(x interface{}) *bool
• type Flow
  • func NewFlow(scope alicloudroscdkcore.Construct, id *string, props *FlowProps, ...) Flow
• type FlowProps
• type IFlow
• type ISchedule
• type RosFlow
  • func NewRosFlow(scope alicloudroscdkcore.Construct, id *string, props *RosFlowProps, ...) RosFlow
• type RosFlowProps
• type RosSchedule
  • func NewRosSchedule(scope alicloudroscdkcore.Construct, id *string, props *RosScheduleProps, ...) RosSchedule
• type RosScheduleProps
• type Schedule
  • func NewSchedule(scope alicloudroscdkcore.Construct, id *string, props *ScheduleProps, ...) Schedule
• type ScheduleProps

Functions

func Flow_IsConstruct

func Flow_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func NewFlow_Override

func NewFlow_Override(f Flow, scope alicloudroscdkcore.Construct, id *string, props *FlowProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewRosFlow_Override

func NewRosFlow_Override(r RosFlow, scope alicloudroscdkcore.Construct, id *string, props *RosFlowProps, enableResourcePropertyConstraint *bool)

func NewRosSchedule_Override

func NewRosSchedule_Override(r RosSchedule, scope alicloudroscdkcore.Construct, id *string, props *RosScheduleProps, enableResourcePropertyConstraint *bool)

func NewSchedule_Override

func NewSchedule_Override(s Schedule, scope alicloudroscdkcore.Construct, id *string, props *ScheduleProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func RosFlow_IsConstruct

func RosFlow_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosFlow_IsRosElement

func RosFlow_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized 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 RosFlow_IsRosResource

func RosFlow_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosFlow_ROS_RESOURCE_TYPE_NAME

func RosFlow_ROS_RESOURCE_TYPE_NAME() *string

func RosSchedule_IsConstruct

func RosSchedule_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosSchedule_IsRosElement

func RosSchedule_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized 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 RosSchedule_IsRosResource

func RosSchedule_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosSchedule_ROS_RESOURCE_TYPE_NAME

func RosSchedule_ROS_RESOURCE_TYPE_NAME() *string

func Schedule_IsConstruct

func Schedule_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

Types

type Flow

type Flow interface {
	alicloudroscdkcore.Resource
	IFlow
	// Attribute CreatedTime: Flow creation time.
	AttrCreatedTime() interface{}
	// Attribute Id: The unique ID of the flow.
	AttrId() interface{}
	// Attribute LastModifiedTime: The most recently modified time of the flow.
	AttrLastModifiedTime() interface{}
	// Attribute Name: The name of the flow created.
	AttrName() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *FlowProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::FNF::Flow`, which is used to create a flow.

func NewFlow

func NewFlow(scope alicloudroscdkcore.Construct, id *string, props *FlowProps, enableResourcePropertyConstraint *bool) Flow

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type FlowProps

type FlowProps struct {
	// Property definition: The definition of the created flow following the FDL syntax standard.
	Definition interface{} `field:"required" json:"definition" yaml:"definition"`
	// Property name: The name of the flow created.
	//
	// This name is unique under the account.
	Name interface{} `field:"required" json:"name" yaml:"name"`
	// Property description: Create a description of the flow.
	Description interface{} `field:"optional" json:"description" yaml:"description"`
	// Property executionMode: The execution mode of the flow.
	ExecutionMode interface{} `field:"optional" json:"executionMode" yaml:"executionMode"`
	// Property externalStorageLocation: The external storage location for the flow.
	ExternalStorageLocation interface{} `field:"optional" json:"externalStorageLocation" yaml:"externalStorageLocation"`
	// Property requestId: The specified Request ID for this request.
	//
	// If not specified, our system will help you generate a random one.
	RequestId interface{} `field:"optional" json:"requestId" yaml:"requestId"`
	// Property roleArn: Optional parameter, the resource descriptor information required for the execution of the flow, used to perform the assume role during FnF execution.
	RoleArn interface{} `field:"optional" json:"roleArn" yaml:"roleArn"`
}

Properties for defining a `Flow`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-fnf-flow

type IFlow

type IFlow interface {
	alicloudroscdkcore.IResource
	// Attribute CreatedTime: Flow creation time.
	AttrCreatedTime() interface{}
	// Attribute Id: The unique ID of the flow.
	AttrId() interface{}
	// Attribute LastModifiedTime: The most recently modified time of the flow.
	AttrLastModifiedTime() interface{}
	// Attribute Name: The name of the flow created.
	AttrName() interface{}
	Props() *FlowProps
}

Represents a `Flow`.

type ISchedule

type ISchedule interface {
	alicloudroscdkcore.IResource
	// Attribute FlowName: Flow name.
	AttrFlowName() interface{}
	// Attribute ScheduleId: Schedule Id.
	AttrScheduleId() interface{}
	// Attribute ScheduleName: Schedule name.
	AttrScheduleName() interface{}
	Props() *ScheduleProps
}

Represents a `Schedule`.

type RosFlow

type RosFlow interface {
	alicloudroscdkcore.RosResource
	AttrCreatedTime() alicloudroscdkcore.IResolvable
	AttrId() alicloudroscdkcore.IResolvable
	AttrLastModifiedTime() alicloudroscdkcore.IResolvable
	AttrName() alicloudroscdkcore.IResolvable
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	Definition() interface{}
	SetDefinition(val interface{})
	Description() interface{}
	SetDescription(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	ExecutionMode() interface{}
	SetExecutionMode(val interface{})
	ExternalStorageLocation() interface{}
	SetExternalStorageLocation(val interface{})
	// The logical ID for this 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
	Name() interface{}
	SetName(val interface{})
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Return a string that will be resolved to a RosTemplate `{ 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
	RequestId() interface{}
	SetRequestId(val interface{})
	RoleArn() interface{}
	SetRoleArn(val interface{})
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// 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{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count 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 alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS 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.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	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{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// 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) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::FNF::Flow`, which is used to create a flow.

func NewRosFlow

func NewRosFlow(scope alicloudroscdkcore.Construct, id *string, props *RosFlowProps, enableResourcePropertyConstraint *bool) RosFlow

type RosFlowProps

type RosFlowProps struct {
	Definition              interface{} `field:"required" json:"definition" yaml:"definition"`
	Name                    interface{} `field:"required" json:"name" yaml:"name"`
	Description             interface{} `field:"optional" json:"description" yaml:"description"`
	ExecutionMode           interface{} `field:"optional" json:"executionMode" yaml:"executionMode"`
	ExternalStorageLocation interface{} `field:"optional" json:"externalStorageLocation" yaml:"externalStorageLocation"`
	RequestId               interface{} `field:"optional" json:"requestId" yaml:"requestId"`
	RoleArn                 interface{} `field:"optional" json:"roleArn" yaml:"roleArn"`
}

Properties for defining a `RosFlow`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-fnf-flow

type RosSchedule

type RosSchedule interface {
	alicloudroscdkcore.RosResource
	AttrFlowName() alicloudroscdkcore.IResolvable
	AttrScheduleId() alicloudroscdkcore.IResolvable
	AttrScheduleName() alicloudroscdkcore.IResolvable
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	CronExpression() interface{}
	SetCronExpression(val interface{})
	Description() interface{}
	SetDescription(val interface{})
	Enable() interface{}
	SetEnable(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	FlowName() interface{}
	SetFlowName(val interface{})
	// The logical ID for this 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 construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	Payload() interface{}
	SetPayload(val interface{})
	// Return a string that will be resolved to a RosTemplate `{ 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
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	ScheduleName() interface{}
	SetScheduleName(val interface{})
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// 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{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count 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 alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS 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.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	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{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// 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) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::FNF::Schedule`, which is used to create a time-based schedule.

func NewRosSchedule

func NewRosSchedule(scope alicloudroscdkcore.Construct, id *string, props *RosScheduleProps, enableResourcePropertyConstraint *bool) RosSchedule

type RosScheduleProps

type RosScheduleProps struct {
	CronExpression interface{} `field:"required" json:"cronExpression" yaml:"cronExpression"`
	FlowName       interface{} `field:"required" json:"flowName" yaml:"flowName"`
	ScheduleName   interface{} `field:"required" json:"scheduleName" yaml:"scheduleName"`
	Description    interface{} `field:"optional" json:"description" yaml:"description"`
	Enable         interface{} `field:"optional" json:"enable" yaml:"enable"`
	Payload        interface{} `field:"optional" json:"payload" yaml:"payload"`
}

Properties for defining a `RosSchedule`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-fnf-schedule

type Schedule

type Schedule interface {
	alicloudroscdkcore.Resource
	ISchedule
	// Attribute FlowName: Flow name.
	AttrFlowName() interface{}
	// Attribute ScheduleId: Schedule Id.
	AttrScheduleId() interface{}
	// Attribute ScheduleName: Schedule name.
	AttrScheduleName() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *ScheduleProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::FNF::Schedule`, which is used to create a time-based schedule.

func NewSchedule

func NewSchedule(scope alicloudroscdkcore.Construct, id *string, props *ScheduleProps, enableResourcePropertyConstraint *bool) Schedule

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type ScheduleProps

type ScheduleProps struct {
	// Property cronExpression: Cron expression.
	CronExpression interface{} `field:"required" json:"cronExpression" yaml:"cronExpression"`
	// Property flowName: Flow name.
	FlowName interface{} `field:"required" json:"flowName" yaml:"flowName"`
	// Property scheduleName: Schedule name.
	ScheduleName interface{} `field:"required" json:"scheduleName" yaml:"scheduleName"`
	// Property description: Description of the schedule.
	Description interface{} `field:"optional" json:"description" yaml:"description"`
	// Property enable: Whether enable schedule.
	Enable interface{} `field:"optional" json:"enable" yaml:"enable"`
	// Property payload: Payload.
	Payload interface{} `field:"optional" json:"payload" yaml:"payload"`
}

Properties for defining a `Schedule`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-fnf-schedule