Documentation ¶
Overview ¶
schedule
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewSchedule_Override ¶
func NewSchedule_Override(s Schedule, scope constructs.Construct, id *string, config *ScheduleConfig)
func Schedule_IsConstruct ¶
func Schedule_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 Schedule_IsTerraformElement ¶
func Schedule_IsTerraformElement(x interface{}) *bool
Experimental.
Types ¶
type Schedule ¶
type Schedule 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 // The tree node. Node() constructs.Node // Experimental. Providers() *[]interface{} // Experimental. RawOverrides() interface{} ScheduleExpression() *string SetScheduleExpression(val *string) ScheduleName() *string SetScheduleName(val *string) ScheduleTimezone() *string SetScheduleTimezone(val *string) // Experimental. SkipAssetCreationFromLocalModules() *bool // Experimental. Source() *string StackId() *string SetStackId(val *string) TargetLambdaArn() *string SetTargetLambdaArn(val *string) // Experimental. Version() *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 Schedule based on a Terraform module.
Source at ./.nitric/modules/schedule
func NewSchedule ¶
func NewSchedule(scope constructs.Construct, id *string, config *ScheduleConfig) Schedule
type ScheduleConfig ¶
type ScheduleConfig 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 schedule expression. ScheduleExpression *string `field:"required" json:"scheduleExpression" yaml:"scheduleExpression"` // The name of the schedule. ScheduleName *string `field:"required" json:"scheduleName" yaml:"scheduleName"` // The timezone for the schedule. ScheduleTimezone *string `field:"required" json:"scheduleTimezone" yaml:"scheduleTimezone"` // The ID of the Nitric stack. StackId *string `field:"required" json:"stackId" yaml:"stackId"` // The ARN of the target lambda function. TargetLambdaArn *string `field:"required" json:"targetLambdaArn" yaml:"targetLambdaArn"` }