1. Packages
  2. Packages
  3. Newrelic Provider
  4. API Docs
  5. WorkflowAutomation
Viewing docs for New Relic v5.65.1
published on Friday, May 1, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-newrelic

newrelic.WorkflowAutomation

newrelic logo
Viewing docs for New Relic v5.65.1
published on Friday, May 1, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-newrelic

    Use this resource to create and manage New Relic Workflow Automation.

    Workflow Automation allows you to define automated workflows using YAML definitions. These workflows can be scoped to either an account or an organization and support various automation steps and configurations.

    Create WorkflowAutomation Resource

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

    Constructor syntax

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

@overload
def WorkflowAutomation(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       definition: Optional[str] = None,
                       scope_id: Optional[str] = None,
                       scope_type: Optional[str] = None,
                       name: Optional[str] = None)
    func NewWorkflowAutomation(ctx *Context, name string, args WorkflowAutomationArgs, opts ...ResourceOption) (*WorkflowAutomation, error)
    public WorkflowAutomation(string name, WorkflowAutomationArgs args, CustomResourceOptions? opts = null)
    public WorkflowAutomation(String name, WorkflowAutomationArgs args)
public WorkflowAutomation(String name, WorkflowAutomationArgs args, CustomResourceOptions options)

    type: newrelic:WorkflowAutomation
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 WorkflowAutomationArgs
    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 WorkflowAutomationArgs
    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 WorkflowAutomationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowAutomationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowAutomationArgs
    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 workflowAutomationResource = new NewRelic.WorkflowAutomation("workflowAutomationResource", new()
{
    Definition = "string",
    ScopeId = "string",
    ScopeType = "string",
    Name = "string",
});

    example, err := newrelic.NewWorkflowAutomation(ctx, "workflowAutomationResource", &newrelic.WorkflowAutomationArgs{
	Definition: pulumi.String("string"),
	ScopeId:    pulumi.String("string"),
	ScopeType:  pulumi.String("string"),
	Name:       pulumi.String("string"),
})

    var workflowAutomationResource = new WorkflowAutomation("workflowAutomationResource", WorkflowAutomationArgs.builder()
    .definition("string")
    .scopeId("string")
    .scopeType("string")
    .name("string")
    .build());

    workflow_automation_resource = newrelic.WorkflowAutomation("workflowAutomationResource",
    definition="string",
    scope_id="string",
    scope_type="string",
    name="string")

    const workflowAutomationResource = new newrelic.WorkflowAutomation("workflowAutomationResource", {
    definition: "string",
    scopeId: "string",
    scopeType: "string",
    name: "string",
});

    type: newrelic:WorkflowAutomation
properties:
    definition: string
    name: string
    scopeId: string
    scopeType: string

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

    Definition string
    The YAML definition of the workflow automation. This should be a valid YAML string that includes a name field matching the resource name argument, and defines the workflow steps and configuration.
    ScopeId string
    The scope ID for the workflow automation. For ACCOUNT scope, this should be your New Relic account ID (numeric). For ORGANIZATION scope, this should be your organization ID (string). Important: Changes to this field will force a new resource to be created.
    ScopeType string
    The scope type for the workflow automation. Must be either ACCOUNT or ORGANIZATION. Important: Changes to this field will force a new resource to be created.
    Name string
    The name of the workflow automation. This must match the name field in the YAML definition provided in the definition argument. Important: Changes to this field will force a new resource to be created.
    Definition string
    The YAML definition of the workflow automation. This should be a valid YAML string that includes a name field matching the resource name argument, and defines the workflow steps and configuration.
    ScopeId string
    The scope ID for the workflow automation. For ACCOUNT scope, this should be your New Relic account ID (numeric). For ORGANIZATION scope, this should be your organization ID (string). Important: Changes to this field will force a new resource to be created.
    ScopeType string
    The scope type for the workflow automation. Must be either ACCOUNT or ORGANIZATION. Important: Changes to this field will force a new resource to be created.
    Name string
    The name of the workflow automation. This must match the name field in the YAML definition provided in the definition argument. Important: Changes to this field will force a new resource to be created.
    definition String
    The YAML definition of the workflow automation. This should be a valid YAML string that includes a name field matching the resource name argument, and defines the workflow steps and configuration.
    scopeId String
    The scope ID for the workflow automation. For ACCOUNT scope, this should be your New Relic account ID (numeric). For ORGANIZATION scope, this should be your organization ID (string). Important: Changes to this field will force a new resource to be created.
    scopeType String
    The scope type for the workflow automation. Must be either ACCOUNT or ORGANIZATION. Important: Changes to this field will force a new resource to be created.
    name String
    The name of the workflow automation. This must match the name field in the YAML definition provided in the definition argument. Important: Changes to this field will force a new resource to be created.
    definition string
    The YAML definition of the workflow automation. This should be a valid YAML string that includes a name field matching the resource name argument, and defines the workflow steps and configuration.
    scopeId string
    The scope ID for the workflow automation. For ACCOUNT scope, this should be your New Relic account ID (numeric). For ORGANIZATION scope, this should be your organization ID (string). Important: Changes to this field will force a new resource to be created.
    scopeType string
    The scope type for the workflow automation. Must be either ACCOUNT or ORGANIZATION. Important: Changes to this field will force a new resource to be created.
    name string
    The name of the workflow automation. This must match the name field in the YAML definition provided in the definition argument. Important: Changes to this field will force a new resource to be created.
    definition str
    The YAML definition of the workflow automation. This should be a valid YAML string that includes a name field matching the resource name argument, and defines the workflow steps and configuration.
    scope_id str
    The scope ID for the workflow automation. For ACCOUNT scope, this should be your New Relic account ID (numeric). For ORGANIZATION scope, this should be your organization ID (string). Important: Changes to this field will force a new resource to be created.
    scope_type str
    The scope type for the workflow automation. Must be either ACCOUNT or ORGANIZATION. Important: Changes to this field will force a new resource to be created.
    name str
    The name of the workflow automation. This must match the name field in the YAML definition provided in the definition argument. Important: Changes to this field will force a new resource to be created.
    definition String
    The YAML definition of the workflow automation. This should be a valid YAML string that includes a name field matching the resource name argument, and defines the workflow steps and configuration.
    scopeId String
    The scope ID for the workflow automation. For ACCOUNT scope, this should be your New Relic account ID (numeric). For ORGANIZATION scope, this should be your organization ID (string). Important: Changes to this field will force a new resource to be created.
    scopeType String
    The scope type for the workflow automation. Must be either ACCOUNT or ORGANIZATION. Important: Changes to this field will force a new resource to be created.
    name String
    The name of the workflow automation. This must match the name field in the YAML definition provided in the definition argument. Important: Changes to this field will force a new resource to be created.

    Outputs

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

    DefinitionId string
    The ID of the workflow automation.
    Description string
    The description of the workflow automation, as defined in the YAML definition.
    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The current version number of the workflow automation.
    Yaml string
    The yaml of the workflow automation.
    DefinitionId string
    The ID of the workflow automation.
    Description string
    The description of the workflow automation, as defined in the YAML definition.
    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The current version number of the workflow automation.
    Yaml string
    The yaml of the workflow automation.
    definitionId String
    The ID of the workflow automation.
    description String
    The description of the workflow automation, as defined in the YAML definition.
    id String
    The provider-assigned unique ID for this managed resource.
    version Integer
    The current version number of the workflow automation.
    yaml String
    The yaml of the workflow automation.
    definitionId string
    The ID of the workflow automation.
    description string
    The description of the workflow automation, as defined in the YAML definition.
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    The current version number of the workflow automation.
    yaml string
    The yaml of the workflow automation.
    definition_id str
    The ID of the workflow automation.
    description str
    The description of the workflow automation, as defined in the YAML definition.
    id str
    The provider-assigned unique ID for this managed resource.
    version int
    The current version number of the workflow automation.
    yaml str
    The yaml of the workflow automation.
    definitionId String
    The ID of the workflow automation.
    description String
    The description of the workflow automation, as defined in the YAML definition.
    id String
    The provider-assigned unique ID for this managed resource.
    version Number
    The current version number of the workflow automation.
    yaml String
    The yaml of the workflow automation.

    Look up Existing WorkflowAutomation Resource

    Get an existing WorkflowAutomation 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?: WorkflowAutomationState, opts?: CustomResourceOptions): WorkflowAutomation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        definition: Optional[str] = None,
        definition_id: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        scope_id: Optional[str] = None,
        scope_type: Optional[str] = None,
        version: Optional[int] = None,
        yaml: Optional[str] = None) -> WorkflowAutomation
    func GetWorkflowAutomation(ctx *Context, name string, id IDInput, state *WorkflowAutomationState, opts ...ResourceOption) (*WorkflowAutomation, error)
    public static WorkflowAutomation Get(string name, Input<string> id, WorkflowAutomationState? state, CustomResourceOptions? opts = null)
    public static WorkflowAutomation get(String name, Output<String> id, WorkflowAutomationState state, CustomResourceOptions options)
    resources:  _:    type: newrelic:WorkflowAutomation    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:
    Definition string
    The YAML definition of the workflow automation. This should be a valid YAML string that includes a name field matching the resource name argument, and defines the workflow steps and configuration.
    DefinitionId string
    The ID of the workflow automation.
    Description string
    The description of the workflow automation, as defined in the YAML definition.
    Name string
    The name of the workflow automation. This must match the name field in the YAML definition provided in the definition argument. Important: Changes to this field will force a new resource to be created.
    ScopeId string
    The scope ID for the workflow automation. For ACCOUNT scope, this should be your New Relic account ID (numeric). For ORGANIZATION scope, this should be your organization ID (string). Important: Changes to this field will force a new resource to be created.
    ScopeType string
    The scope type for the workflow automation. Must be either ACCOUNT or ORGANIZATION. Important: Changes to this field will force a new resource to be created.
    Version int
    The current version number of the workflow automation.
    Yaml string
    The yaml of the workflow automation.
    Definition string
    The YAML definition of the workflow automation. This should be a valid YAML string that includes a name field matching the resource name argument, and defines the workflow steps and configuration.
    DefinitionId string
    The ID of the workflow automation.
    Description string
    The description of the workflow automation, as defined in the YAML definition.
    Name string
    The name of the workflow automation. This must match the name field in the YAML definition provided in the definition argument. Important: Changes to this field will force a new resource to be created.
    ScopeId string
    The scope ID for the workflow automation. For ACCOUNT scope, this should be your New Relic account ID (numeric). For ORGANIZATION scope, this should be your organization ID (string). Important: Changes to this field will force a new resource to be created.
    ScopeType string
    The scope type for the workflow automation. Must be either ACCOUNT or ORGANIZATION. Important: Changes to this field will force a new resource to be created.
    Version int
    The current version number of the workflow automation.
    Yaml string
    The yaml of the workflow automation.
    definition String
    The YAML definition of the workflow automation. This should be a valid YAML string that includes a name field matching the resource name argument, and defines the workflow steps and configuration.
    definitionId String
    The ID of the workflow automation.
    description String
    The description of the workflow automation, as defined in the YAML definition.
    name String
    The name of the workflow automation. This must match the name field in the YAML definition provided in the definition argument. Important: Changes to this field will force a new resource to be created.
    scopeId String
    The scope ID for the workflow automation. For ACCOUNT scope, this should be your New Relic account ID (numeric). For ORGANIZATION scope, this should be your organization ID (string). Important: Changes to this field will force a new resource to be created.
    scopeType String
    The scope type for the workflow automation. Must be either ACCOUNT or ORGANIZATION. Important: Changes to this field will force a new resource to be created.
    version Integer
    The current version number of the workflow automation.
    yaml String
    The yaml of the workflow automation.
    definition string
    The YAML definition of the workflow automation. This should be a valid YAML string that includes a name field matching the resource name argument, and defines the workflow steps and configuration.
    definitionId string
    The ID of the workflow automation.
    description string
    The description of the workflow automation, as defined in the YAML definition.
    name string
    The name of the workflow automation. This must match the name field in the YAML definition provided in the definition argument. Important: Changes to this field will force a new resource to be created.
    scopeId string
    The scope ID for the workflow automation. For ACCOUNT scope, this should be your New Relic account ID (numeric). For ORGANIZATION scope, this should be your organization ID (string). Important: Changes to this field will force a new resource to be created.
    scopeType string
    The scope type for the workflow automation. Must be either ACCOUNT or ORGANIZATION. Important: Changes to this field will force a new resource to be created.
    version number
    The current version number of the workflow automation.
    yaml string
    The yaml of the workflow automation.
    definition str
    The YAML definition of the workflow automation. This should be a valid YAML string that includes a name field matching the resource name argument, and defines the workflow steps and configuration.
    definition_id str
    The ID of the workflow automation.
    description str
    The description of the workflow automation, as defined in the YAML definition.
    name str
    The name of the workflow automation. This must match the name field in the YAML definition provided in the definition argument. Important: Changes to this field will force a new resource to be created.
    scope_id str
    The scope ID for the workflow automation. For ACCOUNT scope, this should be your New Relic account ID (numeric). For ORGANIZATION scope, this should be your organization ID (string). Important: Changes to this field will force a new resource to be created.
    scope_type str
    The scope type for the workflow automation. Must be either ACCOUNT or ORGANIZATION. Important: Changes to this field will force a new resource to be created.
    version int
    The current version number of the workflow automation.
    yaml str
    The yaml of the workflow automation.
    definition String
    The YAML definition of the workflow automation. This should be a valid YAML string that includes a name field matching the resource name argument, and defines the workflow steps and configuration.
    definitionId String
    The ID of the workflow automation.
    description String
    The description of the workflow automation, as defined in the YAML definition.
    name String
    The name of the workflow automation. This must match the name field in the YAML definition provided in the definition argument. Important: Changes to this field will force a new resource to be created.
    scopeId String
    The scope ID for the workflow automation. For ACCOUNT scope, this should be your New Relic account ID (numeric). For ORGANIZATION scope, this should be your organization ID (string). Important: Changes to this field will force a new resource to be created.
    scopeType String
    The scope type for the workflow automation. Must be either ACCOUNT or ORGANIZATION. Important: Changes to this field will force a new resource to be created.
    version Number
    The current version number of the workflow automation.
    yaml String
    The yaml of the workflow automation.

    Package Details

    Repository
    New Relic pulumi/pulumi-newrelic
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the newrelic Terraform Provider.
    newrelic logo
    Viewing docs for New Relic v5.65.1
    published on Friday, May 1, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-newrelic
      Try Pulumi Cloud free. Your team will thank you.