Skip to main content

PipelineSchedule

Resource PipelineSchedule in pulumi-buildkite.
2 min read

Resource PipelineSchedule in pulumi-buildkite.

Pulumi type: buildkite:index/pipelineSchedule:PipelineSchedule.

name is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

Example#

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

Arguments#

PropertyTypeRequiredDescription
branchstringyesThe branch that the schedule should run on.
commitstringnoThe commit that the schedule should run on.
cronlinestringyesThe cronline that describes when the schedule should run. Seehere for supported syntax.
enabledbooleannoWhether the schedule is enabled or not.
env{ [key: string]: string }noThe environment variables that scheduled builds should use. An empty map ({}) is equivalent to omitting this attribute at the API level.
labelstringyesA label to describe the schedule.
messagestringnoThe message the builds show for builds created by this schedule.
pipelineIdstringyesThe GraphQL ID of the pipeline that this schedule belongs to.

Outputs#

Computed outputs are produced by the provider. They are not constructor arguments.

PropertyTypeComputedDescription
branchstringnoThe branch that the schedule should run on.
commitstringnoThe commit that the schedule should run on.
cronlinestringnoThe cronline that describes when the schedule should run. Seehere for supported syntax.
enabledbooleannoWhether the schedule is enabled or not.
env{ [key: string]: string }noThe environment variables that scheduled builds should use. An empty map ({}) is equivalent to omitting this attribute at the API level.
labelstringnoA label to describe the schedule.
messagestringnoThe message the builds show for builds created by this schedule.
pipelineIdstringnoThe GraphQL ID of the pipeline that this schedule belongs to.
uuidstringyesThe UUID of the schedule.