Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. BuiltInTrigger
octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.BuiltInTrigger

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

    This resource manages automatic release trigger based on new version of referenced package.

    Create BuiltInTrigger Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new BuiltInTrigger(name: string, args: BuiltInTriggerArgs, opts?: CustomResourceOptions);
    @overload
def BuiltInTrigger(resource_name: str,
                   args: BuiltInTriggerArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def BuiltInTrigger(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   channel_id: Optional[str] = None,
                   project_id: Optional[str] = None,
                   release_creation_package: Optional[BuiltInTriggerReleaseCreationPackageArgs] = None,
                   release_creation_package_step_id: Optional[str] = None,
                   space_id: Optional[str] = None)
    func NewBuiltInTrigger(ctx *Context, name string, args BuiltInTriggerArgs, opts ...ResourceOption) (*BuiltInTrigger, error)
    public BuiltInTrigger(string name, BuiltInTriggerArgs args, CustomResourceOptions? opts = null)
    public BuiltInTrigger(String name, BuiltInTriggerArgs args)
public BuiltInTrigger(String name, BuiltInTriggerArgs args, CustomResourceOptions options)

    type: octopusdeploy:BuiltInTrigger
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args BuiltInTriggerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BuiltInTriggerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BuiltInTriggerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BuiltInTriggerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BuiltInTriggerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var builtInTriggerResource = new Octopusdeploy.BuiltInTrigger("builtInTriggerResource", new()
{
    ChannelId = "string",
    ProjectId = "string",
    ReleaseCreationPackage = new Octopusdeploy.Inputs.BuiltInTriggerReleaseCreationPackageArgs
    {
        DeploymentAction = "string",
        PackageReference = "string",
    },
    ReleaseCreationPackageStepId = "string",
    SpaceId = "string",
});

    example, err := octopusdeploy.NewBuiltInTrigger(ctx, "builtInTriggerResource", &octopusdeploy.BuiltInTriggerArgs{
ChannelId: pulumi.String("string"),
ProjectId: pulumi.String("string"),
ReleaseCreationPackage: &.BuiltInTriggerReleaseCreationPackageArgs{
DeploymentAction: pulumi.String("string"),
PackageReference: pulumi.String("string"),
},
ReleaseCreationPackageStepId: pulumi.String("string"),
SpaceId: pulumi.String("string"),
})

    var builtInTriggerResource = new BuiltInTrigger("builtInTriggerResource", BuiltInTriggerArgs.builder()
    .channelId("string")
    .projectId("string")
    .releaseCreationPackage(BuiltInTriggerReleaseCreationPackageArgs.builder()
        .deploymentAction("string")
        .packageReference("string")
        .build())
    .releaseCreationPackageStepId("string")
    .spaceId("string")
    .build());

    built_in_trigger_resource = octopusdeploy.BuiltInTrigger("builtInTriggerResource",
    channel_id="string",
    project_id="string",
    release_creation_package={
        "deployment_action": "string",
        "package_reference": "string",
    },
    release_creation_package_step_id="string",
    space_id="string")

    const builtInTriggerResource = new octopusdeploy.BuiltInTrigger("builtInTriggerResource", {
    channelId: "string",
    projectId: "string",
    releaseCreationPackage: {
        deploymentAction: "string",
        packageReference: "string",
    },
    releaseCreationPackageStepId: "string",
    spaceId: "string",
});

    type: octopusdeploy:BuiltInTrigger
properties:
    channelId: string
    projectId: string
    releaseCreationPackage:
        deploymentAction: string
        packageReference: string
    releaseCreationPackageStepId: string
    spaceId: string

    BuiltInTrigger Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The BuiltInTrigger resource accepts the following input properties:

    ChannelId string
    The ID of the channel in which triggered release will be created.
    ProjectId string
    The ID of the project the trigger will be attached to.
    ReleaseCreationPackage BuiltInTriggerReleaseCreationPackage
    Combination of deployment action and package references.
    ReleaseCreationPackageStepId string
    The package step ID trigger will be listening.
    SpaceId string
    Space ID of the associated project.
    ChannelId string
    The ID of the channel in which triggered release will be created.
    ProjectId string
    The ID of the project the trigger will be attached to.
    ReleaseCreationPackage BuiltInTriggerReleaseCreationPackageArgs
    Combination of deployment action and package references.
    ReleaseCreationPackageStepId string
    The package step ID trigger will be listening.
    SpaceId string
    Space ID of the associated project.
    channelId String
    The ID of the channel in which triggered release will be created.
    projectId String
    The ID of the project the trigger will be attached to.
    releaseCreationPackage BuiltInTriggerReleaseCreationPackage
    Combination of deployment action and package references.
    releaseCreationPackageStepId String
    The package step ID trigger will be listening.
    spaceId String
    Space ID of the associated project.
    channelId string
    The ID of the channel in which triggered release will be created.
    projectId string
    The ID of the project the trigger will be attached to.
    releaseCreationPackage BuiltInTriggerReleaseCreationPackage
    Combination of deployment action and package references.
    releaseCreationPackageStepId string
    The package step ID trigger will be listening.
    spaceId string
    Space ID of the associated project.
    channel_id str
    The ID of the channel in which triggered release will be created.
    project_id str
    The ID of the project the trigger will be attached to.
    release_creation_package BuiltInTriggerReleaseCreationPackageArgs
    Combination of deployment action and package references.
    release_creation_package_step_id str
    The package step ID trigger will be listening.
    space_id str
    Space ID of the associated project.
    channelId String
    The ID of the channel in which triggered release will be created.
    projectId String
    The ID of the project the trigger will be attached to.
    releaseCreationPackage Property Map
    Combination of deployment action and package references.
    releaseCreationPackageStepId String
    The package step ID trigger will be listening.
    spaceId String
    Space ID of the associated project.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BuiltInTrigger resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing BuiltInTrigger Resource

    Get an existing BuiltInTrigger resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BuiltInTriggerState, opts?: CustomResourceOptions): BuiltInTrigger
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        channel_id: Optional[str] = None,
        project_id: Optional[str] = None,
        release_creation_package: Optional[BuiltInTriggerReleaseCreationPackageArgs] = None,
        release_creation_package_step_id: Optional[str] = None,
        space_id: Optional[str] = None) -> BuiltInTrigger
    func GetBuiltInTrigger(ctx *Context, name string, id IDInput, state *BuiltInTriggerState, opts ...ResourceOption) (*BuiltInTrigger, error)
    public static BuiltInTrigger Get(string name, Input<string> id, BuiltInTriggerState? state, CustomResourceOptions? opts = null)
    public static BuiltInTrigger get(String name, Output<String> id, BuiltInTriggerState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:BuiltInTrigger    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ChannelId string
    The ID of the channel in which triggered release will be created.
    ProjectId string
    The ID of the project the trigger will be attached to.
    ReleaseCreationPackage BuiltInTriggerReleaseCreationPackage
    Combination of deployment action and package references.
    ReleaseCreationPackageStepId string
    The package step ID trigger will be listening.
    SpaceId string
    Space ID of the associated project.
    ChannelId string
    The ID of the channel in which triggered release will be created.
    ProjectId string
    The ID of the project the trigger will be attached to.
    ReleaseCreationPackage BuiltInTriggerReleaseCreationPackageArgs
    Combination of deployment action and package references.
    ReleaseCreationPackageStepId string
    The package step ID trigger will be listening.
    SpaceId string
    Space ID of the associated project.
    channelId String
    The ID of the channel in which triggered release will be created.
    projectId String
    The ID of the project the trigger will be attached to.
    releaseCreationPackage BuiltInTriggerReleaseCreationPackage
    Combination of deployment action and package references.
    releaseCreationPackageStepId String
    The package step ID trigger will be listening.
    spaceId String
    Space ID of the associated project.
    channelId string
    The ID of the channel in which triggered release will be created.
    projectId string
    The ID of the project the trigger will be attached to.
    releaseCreationPackage BuiltInTriggerReleaseCreationPackage
    Combination of deployment action and package references.
    releaseCreationPackageStepId string
    The package step ID trigger will be listening.
    spaceId string
    Space ID of the associated project.
    channel_id str
    The ID of the channel in which triggered release will be created.
    project_id str
    The ID of the project the trigger will be attached to.
    release_creation_package BuiltInTriggerReleaseCreationPackageArgs
    Combination of deployment action and package references.
    release_creation_package_step_id str
    The package step ID trigger will be listening.
    space_id str
    Space ID of the associated project.
    channelId String
    The ID of the channel in which triggered release will be created.
    projectId String
    The ID of the project the trigger will be attached to.
    releaseCreationPackage Property Map
    Combination of deployment action and package references.
    releaseCreationPackageStepId String
    The package step ID trigger will be listening.
    spaceId String
    Space ID of the associated project.

    Supporting Types

    BuiltInTriggerReleaseCreationPackage, BuiltInTriggerReleaseCreationPackageArgs

    DeploymentAction string
    Deployment action.
    PackageReference string
    Package reference.
    DeploymentAction string
    Deployment action.
    PackageReference string
    Package reference.
    deploymentAction String
    Deployment action.
    packageReference String
    Package reference.
    deploymentAction string
    Deployment action.
    packageReference string
    Package reference.
    deployment_action str
    Deployment action.
    package_reference str
    Package reference.
    deploymentAction String
    Deployment action.
    packageReference String
    Package reference.

    Package Details

    Repository
    octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
    License
    Notes
    This Pulumi package is based on the octopusdeploy Terraform Provider.
    octopusdeploy logo
    octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs
    octopusdeploylabs/terraform-provider-octopusdeploy