1. Packages
  2. Zitadel
  3. API Docs
  4. Action
zitadel v0.1.7 published on Tuesday, Mar 26, 2024 by pulumiverse

zitadel.Action

Explore with Pulumi AI

zitadel logo
zitadel v0.1.7 published on Tuesday, Mar 26, 2024 by pulumiverse

    Resource representing an action belonging to an organization.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Zitadel = Pulumiverse.Zitadel;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = new Zitadel.Action("default", new()
        {
            OrgId = data.Zitadel_org.Default.Id,
            Script = "testscript",
            Timeout = "10s",
            AllowedToFail = true,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-zitadel/sdk/go/zitadel"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := zitadel.NewAction(ctx, "default", &zitadel.ActionArgs{
    			OrgId:         pulumi.Any(data.Zitadel_org.Default.Id),
    			Script:        pulumi.String("testscript"),
    			Timeout:       pulumi.String("10s"),
    			AllowedToFail: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.zitadel.Action;
    import com.pulumi.zitadel.ActionArgs;
    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 default_ = new Action("default", ActionArgs.builder()        
                .orgId(data.zitadel_org().default().id())
                .script("testscript")
                .timeout("10s")
                .allowedToFail(true)
                .build());
    
        }
    }
    
    import pulumi
    import pulumiverse_zitadel as zitadel
    
    default = zitadel.Action("default",
        org_id=data["zitadel_org"]["default"]["id"],
        script="testscript",
        timeout="10s",
        allowed_to_fail=True)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as zitadel from "@pulumiverse/zitadel";
    
    const _default = new zitadel.Action("default", {
        orgId: data.zitadel_org["default"].id,
        script: "testscript",
        timeout: "10s",
        allowedToFail: true,
    });
    
    resources:
      default:
        type: zitadel:Action
        properties:
          orgId: ${data.zitadel_org.default.id}
          script: testscript
          timeout: 10s
          allowedToFail: true
    

    Create Action Resource

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

    Constructor syntax

    new Action(name: string, args: ActionArgs, opts?: CustomResourceOptions);
    @overload
    def Action(resource_name: str,
               args: ActionArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Action(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               allowed_to_fail: Optional[bool] = None,
               script: Optional[str] = None,
               timeout: Optional[str] = None,
               name: Optional[str] = None,
               org_id: Optional[str] = None)
    func NewAction(ctx *Context, name string, args ActionArgs, opts ...ResourceOption) (*Action, error)
    public Action(string name, ActionArgs args, CustomResourceOptions? opts = null)
    public Action(String name, ActionArgs args)
    public Action(String name, ActionArgs args, CustomResourceOptions options)
    
    type: zitadel:Action
    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 ActionArgs
    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 ActionArgs
    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 ActionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ActionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ActionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var actionResource = new Zitadel.Action("actionResource", new()
    {
        AllowedToFail = false,
        Script = "string",
        Timeout = "string",
        Name = "string",
        OrgId = "string",
    });
    
    example, err := zitadel.NewAction(ctx, "actionResource", &zitadel.ActionArgs{
    	AllowedToFail: pulumi.Bool(false),
    	Script:        pulumi.String("string"),
    	Timeout:       pulumi.String("string"),
    	Name:          pulumi.String("string"),
    	OrgId:         pulumi.String("string"),
    })
    
    var actionResource = new Action("actionResource", ActionArgs.builder()        
        .allowedToFail(false)
        .script("string")
        .timeout("string")
        .name("string")
        .orgId("string")
        .build());
    
    action_resource = zitadel.Action("actionResource",
        allowed_to_fail=False,
        script="string",
        timeout="string",
        name="string",
        org_id="string")
    
    const actionResource = new zitadel.Action("actionResource", {
        allowedToFail: false,
        script: "string",
        timeout: "string",
        name: "string",
        orgId: "string",
    });
    
    type: zitadel:Action
    properties:
        allowedToFail: false
        name: string
        orgId: string
        script: string
        timeout: string
    

    Action Resource Properties

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

    Inputs

    The Action resource accepts the following input properties:

    AllowedToFail bool
    when true, the next action will be called even if this action fails
    Script string
    Timeout string
    after which time the action will be terminated if not finished
    Name string
    OrgId string
    ID of the organization
    AllowedToFail bool
    when true, the next action will be called even if this action fails
    Script string
    Timeout string
    after which time the action will be terminated if not finished
    Name string
    OrgId string
    ID of the organization
    allowedToFail Boolean
    when true, the next action will be called even if this action fails
    script String
    timeout String
    after which time the action will be terminated if not finished
    name String
    orgId String
    ID of the organization
    allowedToFail boolean
    when true, the next action will be called even if this action fails
    script string
    timeout string
    after which time the action will be terminated if not finished
    name string
    orgId string
    ID of the organization
    allowed_to_fail bool
    when true, the next action will be called even if this action fails
    script str
    timeout str
    after which time the action will be terminated if not finished
    name str
    org_id str
    ID of the organization
    allowedToFail Boolean
    when true, the next action will be called even if this action fails
    script String
    timeout String
    after which time the action will be terminated if not finished
    name String
    orgId String
    ID of the organization

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    State int
    the state of the action
    Id string
    The provider-assigned unique ID for this managed resource.
    State int
    the state of the action
    id String
    The provider-assigned unique ID for this managed resource.
    state Integer
    the state of the action
    id string
    The provider-assigned unique ID for this managed resource.
    state number
    the state of the action
    id str
    The provider-assigned unique ID for this managed resource.
    state int
    the state of the action
    id String
    The provider-assigned unique ID for this managed resource.
    state Number
    the state of the action

    Look up Existing Action Resource

    Get an existing Action 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?: ActionState, opts?: CustomResourceOptions): Action
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allowed_to_fail: Optional[bool] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            script: Optional[str] = None,
            state: Optional[int] = None,
            timeout: Optional[str] = None) -> Action
    func GetAction(ctx *Context, name string, id IDInput, state *ActionState, opts ...ResourceOption) (*Action, error)
    public static Action Get(string name, Input<string> id, ActionState? state, CustomResourceOptions? opts = null)
    public static Action get(String name, Output<String> id, ActionState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AllowedToFail bool
    when true, the next action will be called even if this action fails
    Name string
    OrgId string
    ID of the organization
    Script string
    State int
    the state of the action
    Timeout string
    after which time the action will be terminated if not finished
    AllowedToFail bool
    when true, the next action will be called even if this action fails
    Name string
    OrgId string
    ID of the organization
    Script string
    State int
    the state of the action
    Timeout string
    after which time the action will be terminated if not finished
    allowedToFail Boolean
    when true, the next action will be called even if this action fails
    name String
    orgId String
    ID of the organization
    script String
    state Integer
    the state of the action
    timeout String
    after which time the action will be terminated if not finished
    allowedToFail boolean
    when true, the next action will be called even if this action fails
    name string
    orgId string
    ID of the organization
    script string
    state number
    the state of the action
    timeout string
    after which time the action will be terminated if not finished
    allowed_to_fail bool
    when true, the next action will be called even if this action fails
    name str
    org_id str
    ID of the organization
    script str
    state int
    the state of the action
    timeout str
    after which time the action will be terminated if not finished
    allowedToFail Boolean
    when true, the next action will be called even if this action fails
    name String
    orgId String
    ID of the organization
    script String
    state Number
    the state of the action
    timeout String
    after which time the action will be terminated if not finished

    Import

    terraform The resource can be imported using the ID format <id[:org_id]>, e.g.

     $ pulumi import zitadel:index/action:Action imported '123456789012345678:123456789012345678'
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    zitadel pulumiverse/pulumi-zitadel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the zitadel Terraform Provider.
    zitadel logo
    zitadel v0.1.7 published on Tuesday, Mar 26, 2024 by pulumiverse