1. Packages
  2. Sumologic Provider
  3. API Docs
  4. CsoarPlaybook
sumologic 3.1.7 published on Friday, Oct 31, 2025 by sumologic
sumologic/terraform-provider-sumologic

sumologic.CsoarPlaybook

Start a Neo task
Explain and create a sumologic.CsoarPlaybook resource
sumologic logo
sumologic 3.1.7 published on Friday, Oct 31, 2025 by sumologic
sumologic/terraform-provider-sumologic

    Import

    CSOAR playbooks must be imported before they can be managed by Terraform. Import using the playbook name:

    bash

    $ pulumi import sumologic:index/csoarPlaybook:CsoarPlaybook example "My Playbook Name"

    Create CsoarPlaybook Resource

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

    Constructor syntax

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

@overload
def CsoarPlaybook(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  csoar_playbook_id: Optional[str] = None,
                  description: Optional[str] = None,
                  draft: Optional[bool] = None,
                  is_deleted: Optional[bool] = None,
                  is_enabled: Optional[bool] = None,
                  is_published: Optional[bool] = None,
                  links: Optional[str] = None,
                  name: Optional[str] = None,
                  nested: Optional[bool] = None,
                  nodes: Optional[str] = None,
                  tags: Optional[str] = None,
                  type: Optional[str] = None,
                  updated_name: Optional[str] = None)
    func NewCsoarPlaybook(ctx *Context, name string, args *CsoarPlaybookArgs, opts ...ResourceOption) (*CsoarPlaybook, error)
    public CsoarPlaybook(string name, CsoarPlaybookArgs? args = null, CustomResourceOptions? opts = null)
    public CsoarPlaybook(String name, CsoarPlaybookArgs args)
public CsoarPlaybook(String name, CsoarPlaybookArgs args, CustomResourceOptions options)

    type: sumologic:CsoarPlaybook
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 CsoarPlaybookArgs
    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 CsoarPlaybookArgs
    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 CsoarPlaybookArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CsoarPlaybookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CsoarPlaybookArgs
    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 csoarPlaybookResource = new Sumologic.CsoarPlaybook("csoarPlaybookResource", new()
{
    CsoarPlaybookId = "string",
    Description = "string",
    Draft = false,
    IsDeleted = false,
    IsEnabled = false,
    IsPublished = false,
    Links = "string",
    Name = "string",
    Nested = false,
    Nodes = "string",
    Tags = "string",
    Type = "string",
    UpdatedName = "string",
});

    example, err := sumologic.NewCsoarPlaybook(ctx, "csoarPlaybookResource", &sumologic.CsoarPlaybookArgs{
	CsoarPlaybookId: pulumi.String("string"),
	Description:     pulumi.String("string"),
	Draft:           pulumi.Bool(false),
	IsDeleted:       pulumi.Bool(false),
	IsEnabled:       pulumi.Bool(false),
	IsPublished:     pulumi.Bool(false),
	Links:           pulumi.String("string"),
	Name:            pulumi.String("string"),
	Nested:          pulumi.Bool(false),
	Nodes:           pulumi.String("string"),
	Tags:            pulumi.String("string"),
	Type:            pulumi.String("string"),
	UpdatedName:     pulumi.String("string"),
})

    var csoarPlaybookResource = new CsoarPlaybook("csoarPlaybookResource", CsoarPlaybookArgs.builder()
    .csoarPlaybookId("string")
    .description("string")
    .draft(false)
    .isDeleted(false)
    .isEnabled(false)
    .isPublished(false)
    .links("string")
    .name("string")
    .nested(false)
    .nodes("string")
    .tags("string")
    .type("string")
    .updatedName("string")
    .build());

    csoar_playbook_resource = sumologic.CsoarPlaybook("csoarPlaybookResource",
    csoar_playbook_id="string",
    description="string",
    draft=False,
    is_deleted=False,
    is_enabled=False,
    is_published=False,
    links="string",
    name="string",
    nested=False,
    nodes="string",
    tags="string",
    type="string",
    updated_name="string")

    const csoarPlaybookResource = new sumologic.CsoarPlaybook("csoarPlaybookResource", {
    csoarPlaybookId: "string",
    description: "string",
    draft: false,
    isDeleted: false,
    isEnabled: false,
    isPublished: false,
    links: "string",
    name: "string",
    nested: false,
    nodes: "string",
    tags: "string",
    type: "string",
    updatedName: "string",
});

    type: sumologic:CsoarPlaybook
properties:
    csoarPlaybookId: string
    description: string
    draft: false
    isDeleted: false
    isEnabled: false
    isPublished: false
    links: string
    name: string
    nested: false
    nodes: string
    tags: string
    type: string
    updatedName: string

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

    CsoarPlaybookId string
    The ID for this playbook (same as name).
    Description string
    The description of the playbook. Supports HTML markup.
    Draft bool
    Whether the playbook is in draft state.
    IsDeleted bool
    Whether the playbook is deleted.
    IsEnabled bool
    Whether the playbook is enabled.
    IsPublished bool
    Whether the playbook is published.
    Links string

    JSON string representation of playbook links that connect the nodes together to form the workflow.

    Additional data provided in state:

    Name string
    The current name of the playbook. This is used to identify the playbook for import and updates.
    Nested bool
    Whether the playbook is nested.
    Nodes string
    JSON string representation of playbook nodes.
    Tags string
    Comma-separated tags for the playbook.
    Type string
    The type of playbook.
    UpdatedName string
    When specified, this will rename the playbook to the new name.
    CsoarPlaybookId string
    The ID for this playbook (same as name).
    Description string
    The description of the playbook. Supports HTML markup.
    Draft bool
    Whether the playbook is in draft state.
    IsDeleted bool
    Whether the playbook is deleted.
    IsEnabled bool
    Whether the playbook is enabled.
    IsPublished bool
    Whether the playbook is published.
    Links string

    JSON string representation of playbook links that connect the nodes together to form the workflow.

    Additional data provided in state:

    Name string
    The current name of the playbook. This is used to identify the playbook for import and updates.
    Nested bool
    Whether the playbook is nested.
    Nodes string
    JSON string representation of playbook nodes.
    Tags string
    Comma-separated tags for the playbook.
    Type string
    The type of playbook.
    UpdatedName string
    When specified, this will rename the playbook to the new name.
    csoarPlaybookId String
    The ID for this playbook (same as name).
    description String
    The description of the playbook. Supports HTML markup.
    draft Boolean
    Whether the playbook is in draft state.
    isDeleted Boolean
    Whether the playbook is deleted.
    isEnabled Boolean
    Whether the playbook is enabled.
    isPublished Boolean
    Whether the playbook is published.
    links String

    JSON string representation of playbook links that connect the nodes together to form the workflow.

    Additional data provided in state:

    name String
    The current name of the playbook. This is used to identify the playbook for import and updates.
    nested Boolean
    Whether the playbook is nested.
    nodes String
    JSON string representation of playbook nodes.
    tags String
    Comma-separated tags for the playbook.
    type String
    The type of playbook.
    updatedName String
    When specified, this will rename the playbook to the new name.
    csoarPlaybookId string
    The ID for this playbook (same as name).
    description string
    The description of the playbook. Supports HTML markup.
    draft boolean
    Whether the playbook is in draft state.
    isDeleted boolean
    Whether the playbook is deleted.
    isEnabled boolean
    Whether the playbook is enabled.
    isPublished boolean
    Whether the playbook is published.
    links string

    JSON string representation of playbook links that connect the nodes together to form the workflow.

    Additional data provided in state:

    name string
    The current name of the playbook. This is used to identify the playbook for import and updates.
    nested boolean
    Whether the playbook is nested.
    nodes string
    JSON string representation of playbook nodes.
    tags string
    Comma-separated tags for the playbook.
    type string
    The type of playbook.
    updatedName string
    When specified, this will rename the playbook to the new name.
    csoar_playbook_id str
    The ID for this playbook (same as name).
    description str
    The description of the playbook. Supports HTML markup.
    draft bool
    Whether the playbook is in draft state.
    is_deleted bool
    Whether the playbook is deleted.
    is_enabled bool
    Whether the playbook is enabled.
    is_published bool
    Whether the playbook is published.
    links str

    JSON string representation of playbook links that connect the nodes together to form the workflow.

    Additional data provided in state:

    name str
    The current name of the playbook. This is used to identify the playbook for import and updates.
    nested bool
    Whether the playbook is nested.
    nodes str
    JSON string representation of playbook nodes.
    tags str
    Comma-separated tags for the playbook.
    type str
    The type of playbook.
    updated_name str
    When specified, this will rename the playbook to the new name.
    csoarPlaybookId String
    The ID for this playbook (same as name).
    description String
    The description of the playbook. Supports HTML markup.
    draft Boolean
    Whether the playbook is in draft state.
    isDeleted Boolean
    Whether the playbook is deleted.
    isEnabled Boolean
    Whether the playbook is enabled.
    isPublished Boolean
    Whether the playbook is published.
    links String

    JSON string representation of playbook links that connect the nodes together to form the workflow.

    Additional data provided in state:

    name String
    The current name of the playbook. This is used to identify the playbook for import and updates.
    nested Boolean
    Whether the playbook is nested.
    nodes String
    JSON string representation of playbook nodes.
    tags String
    Comma-separated tags for the playbook.
    type String
    The type of playbook.
    updatedName String
    When specified, this will rename the playbook to the new name.

    Outputs

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

    CreatedBy double
    ID of the user who created the playbook.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdated double
    Timestamp of when the playbook was last updated.
    UpdatedBy double
    ID of the user who last updated the playbook.
    CreatedBy float64
    ID of the user who created the playbook.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdated float64
    Timestamp of when the playbook was last updated.
    UpdatedBy float64
    ID of the user who last updated the playbook.
    createdBy Double
    ID of the user who created the playbook.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdated Double
    Timestamp of when the playbook was last updated.
    updatedBy Double
    ID of the user who last updated the playbook.
    createdBy number
    ID of the user who created the playbook.
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdated number
    Timestamp of when the playbook was last updated.
    updatedBy number
    ID of the user who last updated the playbook.
    created_by float
    ID of the user who created the playbook.
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated float
    Timestamp of when the playbook was last updated.
    updated_by float
    ID of the user who last updated the playbook.
    createdBy Number
    ID of the user who created the playbook.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdated Number
    Timestamp of when the playbook was last updated.
    updatedBy Number
    ID of the user who last updated the playbook.

    Look up Existing CsoarPlaybook Resource

    Get an existing CsoarPlaybook 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?: CsoarPlaybookState, opts?: CustomResourceOptions): CsoarPlaybook
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_by: Optional[float] = None,
        csoar_playbook_id: Optional[str] = None,
        description: Optional[str] = None,
        draft: Optional[bool] = None,
        is_deleted: Optional[bool] = None,
        is_enabled: Optional[bool] = None,
        is_published: Optional[bool] = None,
        last_updated: Optional[float] = None,
        links: Optional[str] = None,
        name: Optional[str] = None,
        nested: Optional[bool] = None,
        nodes: Optional[str] = None,
        tags: Optional[str] = None,
        type: Optional[str] = None,
        updated_by: Optional[float] = None,
        updated_name: Optional[str] = None) -> CsoarPlaybook
    func GetCsoarPlaybook(ctx *Context, name string, id IDInput, state *CsoarPlaybookState, opts ...ResourceOption) (*CsoarPlaybook, error)
    public static CsoarPlaybook Get(string name, Input<string> id, CsoarPlaybookState? state, CustomResourceOptions? opts = null)
    public static CsoarPlaybook get(String name, Output<String> id, CsoarPlaybookState state, CustomResourceOptions options)
    resources:  _:    type: sumologic:CsoarPlaybook    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:
    CreatedBy double
    ID of the user who created the playbook.
    CsoarPlaybookId string
    The ID for this playbook (same as name).
    Description string
    The description of the playbook. Supports HTML markup.
    Draft bool
    Whether the playbook is in draft state.
    IsDeleted bool
    Whether the playbook is deleted.
    IsEnabled bool
    Whether the playbook is enabled.
    IsPublished bool
    Whether the playbook is published.
    LastUpdated double
    Timestamp of when the playbook was last updated.
    Links string

    JSON string representation of playbook links that connect the nodes together to form the workflow.

    Additional data provided in state:

    Name string
    The current name of the playbook. This is used to identify the playbook for import and updates.
    Nested bool
    Whether the playbook is nested.
    Nodes string
    JSON string representation of playbook nodes.
    Tags string
    Comma-separated tags for the playbook.
    Type string
    The type of playbook.
    UpdatedBy double
    ID of the user who last updated the playbook.
    UpdatedName string
    When specified, this will rename the playbook to the new name.
    CreatedBy float64
    ID of the user who created the playbook.
    CsoarPlaybookId string
    The ID for this playbook (same as name).
    Description string
    The description of the playbook. Supports HTML markup.
    Draft bool
    Whether the playbook is in draft state.
    IsDeleted bool
    Whether the playbook is deleted.
    IsEnabled bool
    Whether the playbook is enabled.
    IsPublished bool
    Whether the playbook is published.
    LastUpdated float64
    Timestamp of when the playbook was last updated.
    Links string

    JSON string representation of playbook links that connect the nodes together to form the workflow.

    Additional data provided in state:

    Name string
    The current name of the playbook. This is used to identify the playbook for import and updates.
    Nested bool
    Whether the playbook is nested.
    Nodes string
    JSON string representation of playbook nodes.
    Tags string
    Comma-separated tags for the playbook.
    Type string
    The type of playbook.
    UpdatedBy float64
    ID of the user who last updated the playbook.
    UpdatedName string
    When specified, this will rename the playbook to the new name.
    createdBy Double
    ID of the user who created the playbook.
    csoarPlaybookId String
    The ID for this playbook (same as name).
    description String
    The description of the playbook. Supports HTML markup.
    draft Boolean
    Whether the playbook is in draft state.
    isDeleted Boolean
    Whether the playbook is deleted.
    isEnabled Boolean
    Whether the playbook is enabled.
    isPublished Boolean
    Whether the playbook is published.
    lastUpdated Double
    Timestamp of when the playbook was last updated.
    links String

    JSON string representation of playbook links that connect the nodes together to form the workflow.

    Additional data provided in state:

    name String
    The current name of the playbook. This is used to identify the playbook for import and updates.
    nested Boolean
    Whether the playbook is nested.
    nodes String
    JSON string representation of playbook nodes.
    tags String
    Comma-separated tags for the playbook.
    type String
    The type of playbook.
    updatedBy Double
    ID of the user who last updated the playbook.
    updatedName String
    When specified, this will rename the playbook to the new name.
    createdBy number
    ID of the user who created the playbook.
    csoarPlaybookId string
    The ID for this playbook (same as name).
    description string
    The description of the playbook. Supports HTML markup.
    draft boolean
    Whether the playbook is in draft state.
    isDeleted boolean
    Whether the playbook is deleted.
    isEnabled boolean
    Whether the playbook is enabled.
    isPublished boolean
    Whether the playbook is published.
    lastUpdated number
    Timestamp of when the playbook was last updated.
    links string

    JSON string representation of playbook links that connect the nodes together to form the workflow.

    Additional data provided in state:

    name string
    The current name of the playbook. This is used to identify the playbook for import and updates.
    nested boolean
    Whether the playbook is nested.
    nodes string
    JSON string representation of playbook nodes.
    tags string
    Comma-separated tags for the playbook.
    type string
    The type of playbook.
    updatedBy number
    ID of the user who last updated the playbook.
    updatedName string
    When specified, this will rename the playbook to the new name.
    created_by float
    ID of the user who created the playbook.
    csoar_playbook_id str
    The ID for this playbook (same as name).
    description str
    The description of the playbook. Supports HTML markup.
    draft bool
    Whether the playbook is in draft state.
    is_deleted bool
    Whether the playbook is deleted.
    is_enabled bool
    Whether the playbook is enabled.
    is_published bool
    Whether the playbook is published.
    last_updated float
    Timestamp of when the playbook was last updated.
    links str

    JSON string representation of playbook links that connect the nodes together to form the workflow.

    Additional data provided in state:

    name str
    The current name of the playbook. This is used to identify the playbook for import and updates.
    nested bool
    Whether the playbook is nested.
    nodes str
    JSON string representation of playbook nodes.
    tags str
    Comma-separated tags for the playbook.
    type str
    The type of playbook.
    updated_by float
    ID of the user who last updated the playbook.
    updated_name str
    When specified, this will rename the playbook to the new name.
    createdBy Number
    ID of the user who created the playbook.
    csoarPlaybookId String
    The ID for this playbook (same as name).
    description String
    The description of the playbook. Supports HTML markup.
    draft Boolean
    Whether the playbook is in draft state.
    isDeleted Boolean
    Whether the playbook is deleted.
    isEnabled Boolean
    Whether the playbook is enabled.
    isPublished Boolean
    Whether the playbook is published.
    lastUpdated Number
    Timestamp of when the playbook was last updated.
    links String

    JSON string representation of playbook links that connect the nodes together to form the workflow.

    Additional data provided in state:

    name String
    The current name of the playbook. This is used to identify the playbook for import and updates.
    nested Boolean
    Whether the playbook is nested.
    nodes String
    JSON string representation of playbook nodes.
    tags String
    Comma-separated tags for the playbook.
    type String
    The type of playbook.
    updatedBy Number
    ID of the user who last updated the playbook.
    updatedName String
    When specified, this will rename the playbook to the new name.

    Package Details

    Repository
    Sumo Logic sumologic/terraform-provider-sumologic
    License
    Notes
    This Pulumi package is based on the sumologic Terraform Provider.
    sumologic logo
    sumologic 3.1.7 published on Friday, Oct 31, 2025 by sumologic
    sumologic/terraform-provider-sumologic
      Meet Neo: Your AI Platform Teammate