Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Commercetools Provider
  3. API Docs
  4. StateTransitions
commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
labd/terraform-provider-commercetools

commercetools.StateTransitions

Explore with Pulumi AI

commercetools logo
commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
labd/terraform-provider-commercetools

    Transitions are a way to describe possible transformations of the current state to other states of the same type (for example: Initial > Shipped). When performing a transitionState update action and transitions is set, the currently referenced state must have a transition to the new state. If transitions is an empty list, it means the current state is a final state and no further transitions are allowed. If transitions is not set, the validation is turned off. When performing a transitionState update action, any other state of the same type can be transitioned to.

    Note: Only one resource can be created for each state

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as commercetools from "@pulumi/commercetools";

const productForSale = new commercetools.State("productForSale", {
    key: "product-for-sale",
    type: "ProductState",
    name: {
        en: "For Sale",
    },
    description: {
        en: "Regularly stocked product.",
    },
    initial: true,
});
const productClearance = new commercetools.State("productClearance", {
    key: "product-clearance",
    type: "ProductState",
    name: {
        en: "On Clearance",
    },
    description: {
        en: "The product line will not be ordered again.",
    },
});
// Only allow transition from sale to clearance
const transition1 = new commercetools.StateTransitions("transition1", {
    from: productForSale.id,
    tos: [productClearance.id],
});
// Disable transitions from product clearance to other
const transition2 = new commercetools.StateTransitions("transition2", {
    from: productClearance.id,
    tos: [],
});

    import pulumi
import pulumi_commercetools as commercetools

product_for_sale = commercetools.State("productForSale",
    key="product-for-sale",
    type="ProductState",
    name={
        "en": "For Sale",
    },
    description={
        "en": "Regularly stocked product.",
    },
    initial=True)
product_clearance = commercetools.State("productClearance",
    key="product-clearance",
    type="ProductState",
    name={
        "en": "On Clearance",
    },
    description={
        "en": "The product line will not be ordered again.",
    })
# Only allow transition from sale to clearance
transition1 = commercetools.StateTransitions("transition1",
    from_=product_for_sale.id,
    tos=[product_clearance.id])
# Disable transitions from product clearance to other
transition2 = commercetools.StateTransitions("transition2",
    from_=product_clearance.id,
    tos=[])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/commercetools/commercetools"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		productForSale, err := commercetools.NewState(ctx, "productForSale", &commercetools.StateArgs{
			Key:  pulumi.String("product-for-sale"),
			Type: pulumi.String("ProductState"),
			Name: pulumi.StringMap{
				"en": pulumi.String("For Sale"),
			},
			Description: pulumi.StringMap{
				"en": pulumi.String("Regularly stocked product."),
			},
			Initial: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		productClearance, err := commercetools.NewState(ctx, "productClearance", &commercetools.StateArgs{
			Key:  pulumi.String("product-clearance"),
			Type: pulumi.String("ProductState"),
			Name: pulumi.StringMap{
				"en": pulumi.String("On Clearance"),
			},
			Description: pulumi.StringMap{
				"en": pulumi.String("The product line will not be ordered again."),
			},
		})
		if err != nil {
			return err
		}
		// Only allow transition from sale to clearance
		_, err = commercetools.NewStateTransitions(ctx, "transition1", &commercetools.StateTransitionsArgs{
			From: productForSale.ID(),
			Tos: pulumi.StringArray{
				productClearance.ID(),
			},
		})
		if err != nil {
			return err
		}
		// Disable transitions from product clearance to other
		_, err = commercetools.NewStateTransitions(ctx, "transition2", &commercetools.StateTransitionsArgs{
			From: productClearance.ID(),
			Tos:  pulumi.StringArray{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Commercetools = Pulumi.Commercetools;

return await Deployment.RunAsync(() => 
{
    var productForSale = new Commercetools.State("productForSale", new()
    {
        Key = "product-for-sale",
        Type = "ProductState",
        Name = 
        {
            { "en", "For Sale" },
        },
        Description = 
        {
            { "en", "Regularly stocked product." },
        },
        Initial = true,
    });

    var productClearance = new Commercetools.State("productClearance", new()
    {
        Key = "product-clearance",
        Type = "ProductState",
        Name = 
        {
            { "en", "On Clearance" },
        },
        Description = 
        {
            { "en", "The product line will not be ordered again." },
        },
    });

    // Only allow transition from sale to clearance
    var transition1 = new Commercetools.StateTransitions("transition1", new()
    {
        From = productForSale.Id,
        Tos = new[]
        {
            productClearance.Id,
        },
    });

    // Disable transitions from product clearance to other
    var transition2 = new Commercetools.StateTransitions("transition2", new()
    {
        From = productClearance.Id,
        Tos = new[] {},
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.commercetools.State;
import com.pulumi.commercetools.StateArgs;
import com.pulumi.commercetools.StateTransitions;
import com.pulumi.commercetools.StateTransitionsArgs;
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 productForSale = new State("productForSale", StateArgs.builder()
            .key("product-for-sale")
            .type("ProductState")
            .name(Map.of("en", "For Sale"))
            .description(Map.of("en", "Regularly stocked product."))
            .initial(true)
            .build());

        var productClearance = new State("productClearance", StateArgs.builder()
            .key("product-clearance")
            .type("ProductState")
            .name(Map.of("en", "On Clearance"))
            .description(Map.of("en", "The product line will not be ordered again."))
            .build());

        // Only allow transition from sale to clearance
        var transition1 = new StateTransitions("transition1", StateTransitionsArgs.builder()
            .from(productForSale.id())
            .tos(productClearance.id())
            .build());

        // Disable transitions from product clearance to other
        var transition2 = new StateTransitions("transition2", StateTransitionsArgs.builder()
            .from(productClearance.id())
            .tos()
            .build());

    }
}

    resources:
  productForSale:
    type: commercetools:State
    properties:
      key: product-for-sale
      type: ProductState
      name:
        en: For Sale
      description:
        en: Regularly stocked product.
      initial: true
  productClearance:
    type: commercetools:State
    properties:
      key: product-clearance
      type: ProductState
      name:
        en: On Clearance
      description:
        en: The product line will not be ordered again.
  # Only allow transition from sale to clearance
  transition1:
    type: commercetools:StateTransitions
    properties:
      from: ${productForSale.id}
      tos:
        - ${productClearance.id}
  # Disable transitions from product clearance to other
  transition2:
    type: commercetools:StateTransitions
    properties:
      from: ${productClearance.id}
      tos: []

    Create StateTransitions Resource

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

    Constructor syntax

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

@overload
def StateTransitions(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     from_: Optional[str] = None,
                     tos: Optional[Sequence[str]] = None)
    func NewStateTransitions(ctx *Context, name string, args StateTransitionsArgs, opts ...ResourceOption) (*StateTransitions, error)
    public StateTransitions(string name, StateTransitionsArgs args, CustomResourceOptions? opts = null)
    public StateTransitions(String name, StateTransitionsArgs args)
public StateTransitions(String name, StateTransitionsArgs args, CustomResourceOptions options)

    type: commercetools:StateTransitions
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 StateTransitionsArgs
    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 StateTransitionsArgs
    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 StateTransitionsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StateTransitionsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StateTransitionsArgs
    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 stateTransitionsResource = new Commercetools.StateTransitions("stateTransitionsResource", new()
{
    From = "string",
    Tos = new[]
    {
        "string",
    },
});

    example, err := commercetools.NewStateTransitions(ctx, "stateTransitionsResource", &commercetools.StateTransitionsArgs{
From: pulumi.String("string"),
Tos: pulumi.StringArray{
pulumi.String("string"),
},
})

    var stateTransitionsResource = new StateTransitions("stateTransitionsResource", StateTransitionsArgs.builder()
    .from("string")
    .tos("string")
    .build());

    state_transitions_resource = commercetools.StateTransitions("stateTransitionsResource",
    from_="string",
    tos=["string"])

    const stateTransitionsResource = new commercetools.StateTransitions("stateTransitionsResource", {
    from: "string",
    tos: ["string"],
});

    type: commercetools:StateTransitions
properties:
    from: string
    tos:
        - string

    StateTransitions 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 StateTransitions resource accepts the following input properties:

    From string
    ID of the state to transition from
    Tos List<string>
    Transitions are a way to describe possible transformations of the current state to other states of the same type (for example: Initial > Shipped). When performing a transitionState update action and transitions is set, the currently referenced state must have a transition to the new state. If transitions is an empty list, it means the current state is a final state and no further transitions are allowed. If transitions is not set, the validation is turned off. When performing a transitionState update action, any other state of the same type can be transitioned to
    From string
    ID of the state to transition from
    Tos []string
    Transitions are a way to describe possible transformations of the current state to other states of the same type (for example: Initial > Shipped). When performing a transitionState update action and transitions is set, the currently referenced state must have a transition to the new state. If transitions is an empty list, it means the current state is a final state and no further transitions are allowed. If transitions is not set, the validation is turned off. When performing a transitionState update action, any other state of the same type can be transitioned to
    from String
    ID of the state to transition from
    tos List<String>
    Transitions are a way to describe possible transformations of the current state to other states of the same type (for example: Initial > Shipped). When performing a transitionState update action and transitions is set, the currently referenced state must have a transition to the new state. If transitions is an empty list, it means the current state is a final state and no further transitions are allowed. If transitions is not set, the validation is turned off. When performing a transitionState update action, any other state of the same type can be transitioned to
    from string
    ID of the state to transition from
    tos string[]
    Transitions are a way to describe possible transformations of the current state to other states of the same type (for example: Initial > Shipped). When performing a transitionState update action and transitions is set, the currently referenced state must have a transition to the new state. If transitions is an empty list, it means the current state is a final state and no further transitions are allowed. If transitions is not set, the validation is turned off. When performing a transitionState update action, any other state of the same type can be transitioned to
    from_ str
    ID of the state to transition from
    tos Sequence[str]
    Transitions are a way to describe possible transformations of the current state to other states of the same type (for example: Initial > Shipped). When performing a transitionState update action and transitions is set, the currently referenced state must have a transition to the new state. If transitions is an empty list, it means the current state is a final state and no further transitions are allowed. If transitions is not set, the validation is turned off. When performing a transitionState update action, any other state of the same type can be transitioned to
    from String
    ID of the state to transition from
    tos List<String>
    Transitions are a way to describe possible transformations of the current state to other states of the same type (for example: Initial > Shipped). When performing a transitionState update action and transitions is set, the currently referenced state must have a transition to the new state. If transitions is an empty list, it means the current state is a final state and no further transitions are allowed. If transitions is not set, the validation is turned off. When performing a transitionState update action, any other state of the same type can be transitioned to

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StateTransitions 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 StateTransitions Resource

    Get an existing StateTransitions 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?: StateTransitionsState, opts?: CustomResourceOptions): StateTransitions
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        from_: Optional[str] = None,
        tos: Optional[Sequence[str]] = None) -> StateTransitions
    func GetStateTransitions(ctx *Context, name string, id IDInput, state *StateTransitionsState, opts ...ResourceOption) (*StateTransitions, error)
    public static StateTransitions Get(string name, Input<string> id, StateTransitionsState? state, CustomResourceOptions? opts = null)
    public static StateTransitions get(String name, Output<String> id, StateTransitionsState state, CustomResourceOptions options)
    resources:  _:    type: commercetools:StateTransitions    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:
    From string
    ID of the state to transition from
    Tos List<string>
    Transitions are a way to describe possible transformations of the current state to other states of the same type (for example: Initial > Shipped). When performing a transitionState update action and transitions is set, the currently referenced state must have a transition to the new state. If transitions is an empty list, it means the current state is a final state and no further transitions are allowed. If transitions is not set, the validation is turned off. When performing a transitionState update action, any other state of the same type can be transitioned to
    From string
    ID of the state to transition from
    Tos []string
    Transitions are a way to describe possible transformations of the current state to other states of the same type (for example: Initial > Shipped). When performing a transitionState update action and transitions is set, the currently referenced state must have a transition to the new state. If transitions is an empty list, it means the current state is a final state and no further transitions are allowed. If transitions is not set, the validation is turned off. When performing a transitionState update action, any other state of the same type can be transitioned to
    from String
    ID of the state to transition from
    tos List<String>
    Transitions are a way to describe possible transformations of the current state to other states of the same type (for example: Initial > Shipped). When performing a transitionState update action and transitions is set, the currently referenced state must have a transition to the new state. If transitions is an empty list, it means the current state is a final state and no further transitions are allowed. If transitions is not set, the validation is turned off. When performing a transitionState update action, any other state of the same type can be transitioned to
    from string
    ID of the state to transition from
    tos string[]
    Transitions are a way to describe possible transformations of the current state to other states of the same type (for example: Initial > Shipped). When performing a transitionState update action and transitions is set, the currently referenced state must have a transition to the new state. If transitions is an empty list, it means the current state is a final state and no further transitions are allowed. If transitions is not set, the validation is turned off. When performing a transitionState update action, any other state of the same type can be transitioned to
    from_ str
    ID of the state to transition from
    tos Sequence[str]
    Transitions are a way to describe possible transformations of the current state to other states of the same type (for example: Initial > Shipped). When performing a transitionState update action and transitions is set, the currently referenced state must have a transition to the new state. If transitions is an empty list, it means the current state is a final state and no further transitions are allowed. If transitions is not set, the validation is turned off. When performing a transitionState update action, any other state of the same type can be transitioned to
    from String
    ID of the state to transition from
    tos List<String>
    Transitions are a way to describe possible transformations of the current state to other states of the same type (for example: Initial > Shipped). When performing a transitionState update action and transitions is set, the currently referenced state must have a transition to the new state. If transitions is an empty list, it means the current state is a final state and no further transitions are allowed. If transitions is not set, the validation is turned off. When performing a transitionState update action, any other state of the same type can be transitioned to

    Package Details

    Repository
    commercetools labd/terraform-provider-commercetools
    License
    Notes
    This Pulumi package is based on the commercetools Terraform Provider.
    commercetools logo
    commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
    labd/terraform-provider-commercetools