com.pulumi.azure.datafactory.kotlin.TriggerSchedule.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-kotlin Show documentation
Show all versions of pulumi-azure-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.datafactory.kotlin
import com.pulumi.azure.datafactory.kotlin.outputs.TriggerSchedulePipeline
import com.pulumi.azure.datafactory.kotlin.outputs.TriggerScheduleSchedule
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import com.pulumi.azure.datafactory.kotlin.outputs.TriggerSchedulePipeline.Companion.toKotlin as triggerSchedulePipelineToKotlin
import com.pulumi.azure.datafactory.kotlin.outputs.TriggerScheduleSchedule.Companion.toKotlin as triggerScheduleScheduleToKotlin
/**
* Builder for [TriggerSchedule].
*/
@PulumiTagMarker
public class TriggerScheduleResourceBuilder internal constructor() {
public var name: String? = null
public var args: TriggerScheduleArgs = TriggerScheduleArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend TriggerScheduleArgsBuilder.() -> Unit) {
val builder = TriggerScheduleArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): TriggerSchedule {
val builtJavaResource = com.pulumi.azure.datafactory.TriggerSchedule(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return TriggerSchedule(builtJavaResource)
}
}
/**
* Manages a Trigger Schedule inside a Azure Data Factory.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const example = new azure.core.ResourceGroup("example", {
* name: "example-resources",
* location: "West Europe",
* });
* const exampleFactory = new azure.datafactory.Factory("example", {
* name: "example",
* location: example.location,
* resourceGroupName: example.name,
* });
* const examplePipeline = new azure.datafactory.Pipeline("example", {
* name: "example",
* dataFactoryId: exampleFactory.id,
* });
* const exampleTriggerSchedule = new azure.datafactory.TriggerSchedule("example", {
* name: "example",
* dataFactoryId: exampleFactory.id,
* pipelineName: examplePipeline.name,
* interval: 5,
* frequency: "Day",
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="example-resources",
* location="West Europe")
* example_factory = azure.datafactory.Factory("example",
* name="example",
* location=example.location,
* resource_group_name=example.name)
* example_pipeline = azure.datafactory.Pipeline("example",
* name="example",
* data_factory_id=example_factory.id)
* example_trigger_schedule = azure.datafactory.TriggerSchedule("example",
* name="example",
* data_factory_id=example_factory.id,
* pipeline_name=example_pipeline.name,
* interval=5,
* frequency="Day")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Azure = Pulumi.Azure;
* return await Deployment.RunAsync(() =>
* {
* var example = new Azure.Core.ResourceGroup("example", new()
* {
* Name = "example-resources",
* Location = "West Europe",
* });
* var exampleFactory = new Azure.DataFactory.Factory("example", new()
* {
* Name = "example",
* Location = example.Location,
* ResourceGroupName = example.Name,
* });
* var examplePipeline = new Azure.DataFactory.Pipeline("example", new()
* {
* Name = "example",
* DataFactoryId = exampleFactory.Id,
* });
* var exampleTriggerSchedule = new Azure.DataFactory.TriggerSchedule("example", new()
* {
* Name = "example",
* DataFactoryId = exampleFactory.Id,
* PipelineName = examplePipeline.Name,
* Interval = 5,
* Frequency = "Day",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/datafactory"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
* Name: pulumi.String("example-resources"),
* Location: pulumi.String("West Europe"),
* })
* if err != nil {
* return err
* }
* exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
* Name: pulumi.String("example"),
* Location: example.Location,
* ResourceGroupName: example.Name,
* })
* if err != nil {
* return err
* }
* examplePipeline, err := datafactory.NewPipeline(ctx, "example", &datafactory.PipelineArgs{
* Name: pulumi.String("example"),
* DataFactoryId: exampleFactory.ID(),
* })
* if err != nil {
* return err
* }
* _, err = datafactory.NewTriggerSchedule(ctx, "example", &datafactory.TriggerScheduleArgs{
* Name: pulumi.String("example"),
* DataFactoryId: exampleFactory.ID(),
* PipelineName: examplePipeline.Name,
* Interval: pulumi.Int(5),
* Frequency: pulumi.String("Day"),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azure.core.ResourceGroup;
* import com.pulumi.azure.core.ResourceGroupArgs;
* import com.pulumi.azure.datafactory.Factory;
* import com.pulumi.azure.datafactory.FactoryArgs;
* import com.pulumi.azure.datafactory.Pipeline;
* import com.pulumi.azure.datafactory.PipelineArgs;
* import com.pulumi.azure.datafactory.TriggerSchedule;
* import com.pulumi.azure.datafactory.TriggerScheduleArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* var example = new ResourceGroup("example", ResourceGroupArgs.builder()
* .name("example-resources")
* .location("West Europe")
* .build());
* var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
* .name("example")
* .location(example.location())
* .resourceGroupName(example.name())
* .build());
* var examplePipeline = new Pipeline("examplePipeline", PipelineArgs.builder()
* .name("example")
* .dataFactoryId(exampleFactory.id())
* .build());
* var exampleTriggerSchedule = new TriggerSchedule("exampleTriggerSchedule", TriggerScheduleArgs.builder()
* .name("example")
* .dataFactoryId(exampleFactory.id())
* .pipelineName(examplePipeline.name())
* .interval(5)
* .frequency("Day")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: example-resources
* location: West Europe
* exampleFactory:
* type: azure:datafactory:Factory
* name: example
* properties:
* name: example
* location: ${example.location}
* resourceGroupName: ${example.name}
* examplePipeline:
* type: azure:datafactory:Pipeline
* name: example
* properties:
* name: example
* dataFactoryId: ${exampleFactory.id}
* exampleTriggerSchedule:
* type: azure:datafactory:TriggerSchedule
* name: example
* properties:
* name: example
* dataFactoryId: ${exampleFactory.id}
* pipelineName: ${examplePipeline.name}
* interval: 5
* frequency: Day
* ```
*
* ## Import
* Data Factory Schedule Trigger can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:datafactory/triggerSchedule:TriggerSchedule example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/triggers/example
* ```
*/
public class TriggerSchedule internal constructor(
override val javaResource: com.pulumi.azure.datafactory.TriggerSchedule,
) : KotlinCustomResource(javaResource, TriggerScheduleMapper) {
/**
* Specifies if the Data Factory Schedule Trigger is activated. Defaults to `true`.
*/
public val activated: Output?
get() = javaResource.activated().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* List of tags that can be used for describing the Data Factory Schedule Trigger.
*/
public val annotations: Output>?
get() = javaResource.annotations().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
/**
* The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*/
public val dataFactoryId: Output
get() = javaResource.dataFactoryId().applyValue({ args0 -> args0 })
/**
* The Schedule Trigger's description.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The time the Schedule Trigger should end. The time will be represented in UTC.
*/
public val endTime: Output?
get() = javaResource.endTime().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The trigger frequency. Valid values include `Minute`, `Hour`, `Day`, `Week`, `Month`. Defaults to `Minute`.
*/
public val frequency: Output?
get() = javaResource.frequency().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The interval for how often the trigger occurs. This defaults to `1`.
*/
public val interval: Output?
get() = javaResource.interval().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Specifies the name of the Data Factory Schedule Trigger. Changing this forces a new resource to be created. Must be globally unique. See the [Microsoft documentation](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The Data Factory Pipeline name that the trigger will act on.
*/
public val pipelineName: Output
get() = javaResource.pipelineName().applyValue({ args0 -> args0 })
/**
* The pipeline parameters that the trigger will act upon.
*/
public val pipelineParameters: Output>
get() = javaResource.pipelineParameters().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* A `pipeline` block as defined below.
*/
public val pipelines: Output>
get() = javaResource.pipelines().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
triggerSchedulePipelineToKotlin(args0)
})
})
})
/**
* A `schedule` block as defined below, which further specifies the recurrence schedule for the trigger. A schedule is capable of limiting or increasing the number of trigger executions specified by the `frequency` and `interval` properties.
*/
public val schedule: Output?
get() = javaResource.schedule().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
triggerScheduleScheduleToKotlin(args0)
})
}).orElse(null)
})
/**
* The time the Schedule Trigger will start. This defaults to the current time. The time will be represented in UTC.
*/
public val startTime: Output
get() = javaResource.startTime().applyValue({ args0 -> args0 })
/**
* The timezone of the start/end time.
*/
public val timeZone: Output?
get() = javaResource.timeZone().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
}
public object TriggerScheduleMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.datafactory.TriggerSchedule::class == javaResource::class
override fun map(javaResource: Resource): TriggerSchedule = TriggerSchedule(
javaResource as
com.pulumi.azure.datafactory.TriggerSchedule,
)
}
/**
* @see [TriggerSchedule].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [TriggerSchedule].
*/
public suspend fun triggerSchedule(
name: String,
block: suspend TriggerScheduleResourceBuilder.() -> Unit,
): TriggerSchedule {
val builder = TriggerScheduleResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [TriggerSchedule].
* @param name The _unique_ name of the resulting resource.
*/
public fun triggerSchedule(name: String): TriggerSchedule {
val builder = TriggerScheduleResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy