Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. SchematicsAction
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.SchematicsAction

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Create, update, and delete ibm.SchematicsAction. For more information, about Schematics action, refer to setting up actions.

Example Usage

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

const schematicsAction = new ibm.SchematicsAction("schematicsAction", {
    description: "<action_description>",
    location: "us-east",
    resourceGroup: "default",
});
Copy
import pulumi
import pulumi_ibm as ibm

schematics_action = ibm.SchematicsAction("schematicsAction",
    description="<action_description>",
    location="us-east",
    resource_group="default")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewSchematicsAction(ctx, "schematicsAction", &ibm.SchematicsActionArgs{
			Description:   pulumi.String("<action_description>"),
			Location:      pulumi.String("us-east"),
			ResourceGroup: pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var schematicsAction = new Ibm.SchematicsAction("schematicsAction", new()
    {
        Description = "<action_description>",
        Location = "us-east",
        ResourceGroup = "default",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SchematicsAction;
import com.pulumi.ibm.SchematicsActionArgs;
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 schematicsAction = new SchematicsAction("schematicsAction", SchematicsActionArgs.builder()
            .description("<action_description>")
            .location("us-east")
            .resourceGroup("default")
            .build());

    }
}
Copy
resources:
  schematicsAction:
    type: ibm:SchematicsAction
    properties:
      description: <action_description>
      location: us-east
      resourceGroup: default
Copy

Create SchematicsAction Resource

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

Constructor syntax

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

@overload
def SchematicsAction(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     action_inputs: Optional[Sequence[SchematicsActionActionInputArgs]] = None,
                     action_outputs: Optional[Sequence[SchematicsActionActionOutputArgs]] = None,
                     bastion: Optional[SchematicsActionBastionArgs] = None,
                     bastion_credential: Optional[SchematicsActionBastionCredentialArgs] = None,
                     command_parameter: Optional[str] = None,
                     credentials: Optional[SchematicsActionCredentialsArgs] = None,
                     description: Optional[str] = None,
                     inventory: Optional[str] = None,
                     location: Optional[str] = None,
                     name: Optional[str] = None,
                     resource_group: Optional[str] = None,
                     schematics_action_id: Optional[str] = None,
                     settings: Optional[Sequence[SchematicsActionSettingArgs]] = None,
                     source_readme_url: Optional[str] = None,
                     source_type: Optional[str] = None,
                     sources: Optional[Sequence[SchematicsActionSourceArgs]] = None,
                     tags: Optional[Sequence[str]] = None,
                     targets_ini: Optional[str] = None,
                     user_states: Optional[Sequence[SchematicsActionUserStateArgs]] = None,
                     x_github_token: Optional[str] = None)
func NewSchematicsAction(ctx *Context, name string, args *SchematicsActionArgs, opts ...ResourceOption) (*SchematicsAction, error)
public SchematicsAction(string name, SchematicsActionArgs? args = null, CustomResourceOptions? opts = null)
public SchematicsAction(String name, SchematicsActionArgs args)
public SchematicsAction(String name, SchematicsActionArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args SchematicsActionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args SchematicsActionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args SchematicsActionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args SchematicsActionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SchematicsActionArgs
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 schematicsActionResource = new Ibm.SchematicsAction("schematicsActionResource", new()
{
    ActionInputs = new[]
    {
        new Ibm.Inputs.SchematicsActionActionInputArgs
        {
            Link = "string",
            Metadatas = new[]
            {
                new Ibm.Inputs.SchematicsActionActionInputMetadataArgs
                {
                    Aliases = new[]
                    {
                        "string",
                    },
                    DefaultValue = "string",
                    Description = "string",
                    GroupBy = "string",
                    Hidden = false,
                    Immutable = false,
                    Matches = "string",
                    MaxLength = 0,
                    MaxValue = 0,
                    MinLength = 0,
                    MinValue = 0,
                    Options = new[]
                    {
                        "string",
                    },
                    Position = 0,
                    Secure = false,
                    Source = "string",
                    Type = "string",
                },
            },
            Name = "string",
            Value = "string",
        },
    },
    ActionOutputs = new[]
    {
        new Ibm.Inputs.SchematicsActionActionOutputArgs
        {
            Link = "string",
            Metadatas = new[]
            {
                new Ibm.Inputs.SchematicsActionActionOutputMetadataArgs
                {
                    Aliases = new[]
                    {
                        "string",
                    },
                    DefaultValue = "string",
                    Description = "string",
                    GroupBy = "string",
                    Hidden = false,
                    Immutable = false,
                    Matches = "string",
                    MaxLength = 0,
                    MaxValue = 0,
                    MinLength = 0,
                    MinValue = 0,
                    Options = new[]
                    {
                        "string",
                    },
                    Position = 0,
                    Secure = false,
                    Source = "string",
                    Type = "string",
                },
            },
            Name = "string",
            Value = "string",
        },
    },
    Bastion = new Ibm.Inputs.SchematicsActionBastionArgs
    {
        Host = "string",
        Name = "string",
    },
    BastionCredential = new Ibm.Inputs.SchematicsActionBastionCredentialArgs
    {
        Link = "string",
        Metadatas = new[]
        {
            new Ibm.Inputs.SchematicsActionBastionCredentialMetadataArgs
            {
                Aliases = new[]
                {
                    "string",
                },
                DefaultValue = "string",
                Description = "string",
                GroupBy = "string",
                Hidden = false,
                Immutable = false,
                Matches = "string",
                MaxLength = 0,
                MaxValue = 0,
                MinLength = 0,
                MinValue = 0,
                Options = new[]
                {
                    "string",
                },
                Position = 0,
                Secure = false,
                Source = "string",
                Type = "string",
            },
        },
        Name = "string",
        Value = "string",
    },
    CommandParameter = "string",
    Credentials = new Ibm.Inputs.SchematicsActionCredentialsArgs
    {
        Link = "string",
        Metadatas = new[]
        {
            new Ibm.Inputs.SchematicsActionCredentialsMetadataArgs
            {
                Aliases = new[]
                {
                    "string",
                },
                DefaultValue = "string",
                Description = "string",
                GroupBy = "string",
                Hidden = false,
                Immutable = false,
                Matches = "string",
                MaxLength = 0,
                MaxValue = 0,
                MinLength = 0,
                MinValue = 0,
                Options = new[]
                {
                    "string",
                },
                Position = 0,
                Secure = false,
                Source = "string",
                Type = "string",
            },
        },
        Name = "string",
        Value = "string",
    },
    Description = "string",
    Inventory = "string",
    Location = "string",
    Name = "string",
    ResourceGroup = "string",
    SchematicsActionId = "string",
    Settings = new[]
    {
        new Ibm.Inputs.SchematicsActionSettingArgs
        {
            Link = "string",
            Metadatas = new[]
            {
                new Ibm.Inputs.SchematicsActionSettingMetadataArgs
                {
                    Aliases = new[]
                    {
                        "string",
                    },
                    DefaultValue = "string",
                    Description = "string",
                    GroupBy = "string",
                    Hidden = false,
                    Immutable = false,
                    Matches = "string",
                    MaxLength = 0,
                    MaxValue = 0,
                    MinLength = 0,
                    MinValue = 0,
                    Options = new[]
                    {
                        "string",
                    },
                    Position = 0,
                    Secure = false,
                    Source = "string",
                    Type = "string",
                },
            },
            Name = "string",
            Value = "string",
        },
    },
    SourceReadmeUrl = "string",
    SourceType = "string",
    Sources = new[]
    {
        new Ibm.Inputs.SchematicsActionSourceArgs
        {
            SourceType = "string",
            Catalog = new Ibm.Inputs.SchematicsActionSourceCatalogArgs
            {
                CatalogName = "string",
                OfferingId = "string",
                OfferingKind = "string",
                OfferingName = "string",
                OfferingRepoUrl = "string",
                OfferingVersion = "string",
                OfferingVersionId = "string",
            },
            Gits = new[]
            {
                new Ibm.Inputs.SchematicsActionSourceGitArgs
                {
                    ComputedGitRepoUrl = "string",
                    GitBranch = "string",
                    GitRelease = "string",
                    GitRepoFolder = "string",
                    GitRepoUrl = "string",
                    GitToken = "string",
                },
            },
        },
    },
    Tags = new[]
    {
        "string",
    },
    TargetsIni = "string",
    UserStates = new[]
    {
        new Ibm.Inputs.SchematicsActionUserStateArgs
        {
            SetAt = "string",
            SetBy = "string",
            State = "string",
        },
    },
    XGithubToken = "string",
});
Copy
example, err := ibm.NewSchematicsAction(ctx, "schematicsActionResource", &ibm.SchematicsActionArgs{
ActionInputs: .SchematicsActionActionInputArray{
&.SchematicsActionActionInputArgs{
Link: pulumi.String("string"),
Metadatas: .SchematicsActionActionInputMetadataArray{
&.SchematicsActionActionInputMetadataArgs{
Aliases: pulumi.StringArray{
pulumi.String("string"),
},
DefaultValue: pulumi.String("string"),
Description: pulumi.String("string"),
GroupBy: pulumi.String("string"),
Hidden: pulumi.Bool(false),
Immutable: pulumi.Bool(false),
Matches: pulumi.String("string"),
MaxLength: pulumi.Float64(0),
MaxValue: pulumi.Float64(0),
MinLength: pulumi.Float64(0),
MinValue: pulumi.Float64(0),
Options: pulumi.StringArray{
pulumi.String("string"),
},
Position: pulumi.Float64(0),
Secure: pulumi.Bool(false),
Source: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
ActionOutputs: .SchematicsActionActionOutputArray{
.SchematicsActionActionOutputArgs{
Link: pulumi.String("string"),
Metadatas: .SchematicsActionActionOutputMetadataArray{
&.SchematicsActionActionOutputMetadataArgs{
Aliases: pulumi.StringArray{
pulumi.String("string"),
},
DefaultValue: pulumi.String("string"),
Description: pulumi.String("string"),
GroupBy: pulumi.String("string"),
Hidden: pulumi.Bool(false),
Immutable: pulumi.Bool(false),
Matches: pulumi.String("string"),
MaxLength: pulumi.Float64(0),
MaxValue: pulumi.Float64(0),
MinLength: pulumi.Float64(0),
MinValue: pulumi.Float64(0),
Options: pulumi.StringArray{
pulumi.String("string"),
},
Position: pulumi.Float64(0),
Secure: pulumi.Bool(false),
Source: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Bastion: &.SchematicsActionBastionArgs{
Host: pulumi.String("string"),
Name: pulumi.String("string"),
},
BastionCredential: &.SchematicsActionBastionCredentialArgs{
Link: pulumi.String("string"),
Metadatas: .SchematicsActionBastionCredentialMetadataArray{
&.SchematicsActionBastionCredentialMetadataArgs{
Aliases: pulumi.StringArray{
pulumi.String("string"),
},
DefaultValue: pulumi.String("string"),
Description: pulumi.String("string"),
GroupBy: pulumi.String("string"),
Hidden: pulumi.Bool(false),
Immutable: pulumi.Bool(false),
Matches: pulumi.String("string"),
MaxLength: pulumi.Float64(0),
MaxValue: pulumi.Float64(0),
MinLength: pulumi.Float64(0),
MinValue: pulumi.Float64(0),
Options: pulumi.StringArray{
pulumi.String("string"),
},
Position: pulumi.Float64(0),
Secure: pulumi.Bool(false),
Source: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
CommandParameter: pulumi.String("string"),
Credentials: &.SchematicsActionCredentialsArgs{
Link: pulumi.String("string"),
Metadatas: .SchematicsActionCredentialsMetadataArray{
&.SchematicsActionCredentialsMetadataArgs{
Aliases: pulumi.StringArray{
pulumi.String("string"),
},
DefaultValue: pulumi.String("string"),
Description: pulumi.String("string"),
GroupBy: pulumi.String("string"),
Hidden: pulumi.Bool(false),
Immutable: pulumi.Bool(false),
Matches: pulumi.String("string"),
MaxLength: pulumi.Float64(0),
MaxValue: pulumi.Float64(0),
MinLength: pulumi.Float64(0),
MinValue: pulumi.Float64(0),
Options: pulumi.StringArray{
pulumi.String("string"),
},
Position: pulumi.Float64(0),
Secure: pulumi.Bool(false),
Source: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
Description: pulumi.String("string"),
Inventory: pulumi.String("string"),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
ResourceGroup: pulumi.String("string"),
SchematicsActionId: pulumi.String("string"),
Settings: .SchematicsActionSettingArray{
&.SchematicsActionSettingArgs{
Link: pulumi.String("string"),
Metadatas: .SchematicsActionSettingMetadataArray{
&.SchematicsActionSettingMetadataArgs{
Aliases: pulumi.StringArray{
pulumi.String("string"),
},
DefaultValue: pulumi.String("string"),
Description: pulumi.String("string"),
GroupBy: pulumi.String("string"),
Hidden: pulumi.Bool(false),
Immutable: pulumi.Bool(false),
Matches: pulumi.String("string"),
MaxLength: pulumi.Float64(0),
MaxValue: pulumi.Float64(0),
MinLength: pulumi.Float64(0),
MinValue: pulumi.Float64(0),
Options: pulumi.StringArray{
pulumi.String("string"),
},
Position: pulumi.Float64(0),
Secure: pulumi.Bool(false),
Source: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
SourceReadmeUrl: pulumi.String("string"),
SourceType: pulumi.String("string"),
Sources: .SchematicsActionSourceArray{
&.SchematicsActionSourceArgs{
SourceType: pulumi.String("string"),
Catalog: &.SchematicsActionSourceCatalogArgs{
CatalogName: pulumi.String("string"),
OfferingId: pulumi.String("string"),
OfferingKind: pulumi.String("string"),
OfferingName: pulumi.String("string"),
OfferingRepoUrl: pulumi.String("string"),
OfferingVersion: pulumi.String("string"),
OfferingVersionId: pulumi.String("string"),
},
Gits: .SchematicsActionSourceGitArray{
&.SchematicsActionSourceGitArgs{
ComputedGitRepoUrl: pulumi.String("string"),
GitBranch: pulumi.String("string"),
GitRelease: pulumi.String("string"),
GitRepoFolder: pulumi.String("string"),
GitRepoUrl: pulumi.String("string"),
GitToken: pulumi.String("string"),
},
},
},
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
TargetsIni: pulumi.String("string"),
UserStates: .SchematicsActionUserStateArray{
&.SchematicsActionUserStateArgs{
SetAt: pulumi.String("string"),
SetBy: pulumi.String("string"),
State: pulumi.String("string"),
},
},
XGithubToken: pulumi.String("string"),
})
Copy
var schematicsActionResource = new SchematicsAction("schematicsActionResource", SchematicsActionArgs.builder()
    .actionInputs(SchematicsActionActionInputArgs.builder()
        .link("string")
        .metadatas(SchematicsActionActionInputMetadataArgs.builder()
            .aliases("string")
            .defaultValue("string")
            .description("string")
            .groupBy("string")
            .hidden(false)
            .immutable(false)
            .matches("string")
            .maxLength(0)
            .maxValue(0)
            .minLength(0)
            .minValue(0)
            .options("string")
            .position(0)
            .secure(false)
            .source("string")
            .type("string")
            .build())
        .name("string")
        .value("string")
        .build())
    .actionOutputs(SchematicsActionActionOutputArgs.builder()
        .link("string")
        .metadatas(SchematicsActionActionOutputMetadataArgs.builder()
            .aliases("string")
            .defaultValue("string")
            .description("string")
            .groupBy("string")
            .hidden(false)
            .immutable(false)
            .matches("string")
            .maxLength(0)
            .maxValue(0)
            .minLength(0)
            .minValue(0)
            .options("string")
            .position(0)
            .secure(false)
            .source("string")
            .type("string")
            .build())
        .name("string")
        .value("string")
        .build())
    .bastion(SchematicsActionBastionArgs.builder()
        .host("string")
        .name("string")
        .build())
    .bastionCredential(SchematicsActionBastionCredentialArgs.builder()
        .link("string")
        .metadatas(SchematicsActionBastionCredentialMetadataArgs.builder()
            .aliases("string")
            .defaultValue("string")
            .description("string")
            .groupBy("string")
            .hidden(false)
            .immutable(false)
            .matches("string")
            .maxLength(0)
            .maxValue(0)
            .minLength(0)
            .minValue(0)
            .options("string")
            .position(0)
            .secure(false)
            .source("string")
            .type("string")
            .build())
        .name("string")
        .value("string")
        .build())
    .commandParameter("string")
    .credentials(SchematicsActionCredentialsArgs.builder()
        .link("string")
        .metadatas(SchematicsActionCredentialsMetadataArgs.builder()
            .aliases("string")
            .defaultValue("string")
            .description("string")
            .groupBy("string")
            .hidden(false)
            .immutable(false)
            .matches("string")
            .maxLength(0)
            .maxValue(0)
            .minLength(0)
            .minValue(0)
            .options("string")
            .position(0)
            .secure(false)
            .source("string")
            .type("string")
            .build())
        .name("string")
        .value("string")
        .build())
    .description("string")
    .inventory("string")
    .location("string")
    .name("string")
    .resourceGroup("string")
    .schematicsActionId("string")
    .settings(SchematicsActionSettingArgs.builder()
        .link("string")
        .metadatas(SchematicsActionSettingMetadataArgs.builder()
            .aliases("string")
            .defaultValue("string")
            .description("string")
            .groupBy("string")
            .hidden(false)
            .immutable(false)
            .matches("string")
            .maxLength(0)
            .maxValue(0)
            .minLength(0)
            .minValue(0)
            .options("string")
            .position(0)
            .secure(false)
            .source("string")
            .type("string")
            .build())
        .name("string")
        .value("string")
        .build())
    .sourceReadmeUrl("string")
    .sourceType("string")
    .sources(SchematicsActionSourceArgs.builder()
        .sourceType("string")
        .catalog(SchematicsActionSourceCatalogArgs.builder()
            .catalogName("string")
            .offeringId("string")
            .offeringKind("string")
            .offeringName("string")
            .offeringRepoUrl("string")
            .offeringVersion("string")
            .offeringVersionId("string")
            .build())
        .gits(SchematicsActionSourceGitArgs.builder()
            .computedGitRepoUrl("string")
            .gitBranch("string")
            .gitRelease("string")
            .gitRepoFolder("string")
            .gitRepoUrl("string")
            .gitToken("string")
            .build())
        .build())
    .tags("string")
    .targetsIni("string")
    .userStates(SchematicsActionUserStateArgs.builder()
        .setAt("string")
        .setBy("string")
        .state("string")
        .build())
    .xGithubToken("string")
    .build());
Copy
schematics_action_resource = ibm.SchematicsAction("schematicsActionResource",
    action_inputs=[{
        "link": "string",
        "metadatas": [{
            "aliases": ["string"],
            "default_value": "string",
            "description": "string",
            "group_by": "string",
            "hidden": False,
            "immutable": False,
            "matches": "string",
            "max_length": 0,
            "max_value": 0,
            "min_length": 0,
            "min_value": 0,
            "options": ["string"],
            "position": 0,
            "secure": False,
            "source": "string",
            "type": "string",
        }],
        "name": "string",
        "value": "string",
    }],
    action_outputs=[{
        "link": "string",
        "metadatas": [{
            "aliases": ["string"],
            "default_value": "string",
            "description": "string",
            "group_by": "string",
            "hidden": False,
            "immutable": False,
            "matches": "string",
            "max_length": 0,
            "max_value": 0,
            "min_length": 0,
            "min_value": 0,
            "options": ["string"],
            "position": 0,
            "secure": False,
            "source": "string",
            "type": "string",
        }],
        "name": "string",
        "value": "string",
    }],
    bastion={
        "host": "string",
        "name": "string",
    },
    bastion_credential={
        "link": "string",
        "metadatas": [{
            "aliases": ["string"],
            "default_value": "string",
            "description": "string",
            "group_by": "string",
            "hidden": False,
            "immutable": False,
            "matches": "string",
            "max_length": 0,
            "max_value": 0,
            "min_length": 0,
            "min_value": 0,
            "options": ["string"],
            "position": 0,
            "secure": False,
            "source": "string",
            "type": "string",
        }],
        "name": "string",
        "value": "string",
    },
    command_parameter="string",
    credentials={
        "link": "string",
        "metadatas": [{
            "aliases": ["string"],
            "default_value": "string",
            "description": "string",
            "group_by": "string",
            "hidden": False,
            "immutable": False,
            "matches": "string",
            "max_length": 0,
            "max_value": 0,
            "min_length": 0,
            "min_value": 0,
            "options": ["string"],
            "position": 0,
            "secure": False,
            "source": "string",
            "type": "string",
        }],
        "name": "string",
        "value": "string",
    },
    description="string",
    inventory="string",
    location="string",
    name="string",
    resource_group="string",
    schematics_action_id="string",
    settings=[{
        "link": "string",
        "metadatas": [{
            "aliases": ["string"],
            "default_value": "string",
            "description": "string",
            "group_by": "string",
            "hidden": False,
            "immutable": False,
            "matches": "string",
            "max_length": 0,
            "max_value": 0,
            "min_length": 0,
            "min_value": 0,
            "options": ["string"],
            "position": 0,
            "secure": False,
            "source": "string",
            "type": "string",
        }],
        "name": "string",
        "value": "string",
    }],
    source_readme_url="string",
    source_type="string",
    sources=[{
        "source_type": "string",
        "catalog": {
            "catalog_name": "string",
            "offering_id": "string",
            "offering_kind": "string",
            "offering_name": "string",
            "offering_repo_url": "string",
            "offering_version": "string",
            "offering_version_id": "string",
        },
        "gits": [{
            "computed_git_repo_url": "string",
            "git_branch": "string",
            "git_release": "string",
            "git_repo_folder": "string",
            "git_repo_url": "string",
            "git_token": "string",
        }],
    }],
    tags=["string"],
    targets_ini="string",
    user_states=[{
        "set_at": "string",
        "set_by": "string",
        "state": "string",
    }],
    x_github_token="string")
Copy
const schematicsActionResource = new ibm.SchematicsAction("schematicsActionResource", {
    actionInputs: [{
        link: "string",
        metadatas: [{
            aliases: ["string"],
            defaultValue: "string",
            description: "string",
            groupBy: "string",
            hidden: false,
            immutable: false,
            matches: "string",
            maxLength: 0,
            maxValue: 0,
            minLength: 0,
            minValue: 0,
            options: ["string"],
            position: 0,
            secure: false,
            source: "string",
            type: "string",
        }],
        name: "string",
        value: "string",
    }],
    actionOutputs: [{
        link: "string",
        metadatas: [{
            aliases: ["string"],
            defaultValue: "string",
            description: "string",
            groupBy: "string",
            hidden: false,
            immutable: false,
            matches: "string",
            maxLength: 0,
            maxValue: 0,
            minLength: 0,
            minValue: 0,
            options: ["string"],
            position: 0,
            secure: false,
            source: "string",
            type: "string",
        }],
        name: "string",
        value: "string",
    }],
    bastion: {
        host: "string",
        name: "string",
    },
    bastionCredential: {
        link: "string",
        metadatas: [{
            aliases: ["string"],
            defaultValue: "string",
            description: "string",
            groupBy: "string",
            hidden: false,
            immutable: false,
            matches: "string",
            maxLength: 0,
            maxValue: 0,
            minLength: 0,
            minValue: 0,
            options: ["string"],
            position: 0,
            secure: false,
            source: "string",
            type: "string",
        }],
        name: "string",
        value: "string",
    },
    commandParameter: "string",
    credentials: {
        link: "string",
        metadatas: [{
            aliases: ["string"],
            defaultValue: "string",
            description: "string",
            groupBy: "string",
            hidden: false,
            immutable: false,
            matches: "string",
            maxLength: 0,
            maxValue: 0,
            minLength: 0,
            minValue: 0,
            options: ["string"],
            position: 0,
            secure: false,
            source: "string",
            type: "string",
        }],
        name: "string",
        value: "string",
    },
    description: "string",
    inventory: "string",
    location: "string",
    name: "string",
    resourceGroup: "string",
    schematicsActionId: "string",
    settings: [{
        link: "string",
        metadatas: [{
            aliases: ["string"],
            defaultValue: "string",
            description: "string",
            groupBy: "string",
            hidden: false,
            immutable: false,
            matches: "string",
            maxLength: 0,
            maxValue: 0,
            minLength: 0,
            minValue: 0,
            options: ["string"],
            position: 0,
            secure: false,
            source: "string",
            type: "string",
        }],
        name: "string",
        value: "string",
    }],
    sourceReadmeUrl: "string",
    sourceType: "string",
    sources: [{
        sourceType: "string",
        catalog: {
            catalogName: "string",
            offeringId: "string",
            offeringKind: "string",
            offeringName: "string",
            offeringRepoUrl: "string",
            offeringVersion: "string",
            offeringVersionId: "string",
        },
        gits: [{
            computedGitRepoUrl: "string",
            gitBranch: "string",
            gitRelease: "string",
            gitRepoFolder: "string",
            gitRepoUrl: "string",
            gitToken: "string",
        }],
    }],
    tags: ["string"],
    targetsIni: "string",
    userStates: [{
        setAt: "string",
        setBy: "string",
        state: "string",
    }],
    xGithubToken: "string",
});
Copy
type: ibm:SchematicsAction
properties:
    actionInputs:
        - link: string
          metadatas:
            - aliases:
                - string
              defaultValue: string
              description: string
              groupBy: string
              hidden: false
              immutable: false
              matches: string
              maxLength: 0
              maxValue: 0
              minLength: 0
              minValue: 0
              options:
                - string
              position: 0
              secure: false
              source: string
              type: string
          name: string
          value: string
    actionOutputs:
        - link: string
          metadatas:
            - aliases:
                - string
              defaultValue: string
              description: string
              groupBy: string
              hidden: false
              immutable: false
              matches: string
              maxLength: 0
              maxValue: 0
              minLength: 0
              minValue: 0
              options:
                - string
              position: 0
              secure: false
              source: string
              type: string
          name: string
          value: string
    bastion:
        host: string
        name: string
    bastionCredential:
        link: string
        metadatas:
            - aliases:
                - string
              defaultValue: string
              description: string
              groupBy: string
              hidden: false
              immutable: false
              matches: string
              maxLength: 0
              maxValue: 0
              minLength: 0
              minValue: 0
              options:
                - string
              position: 0
              secure: false
              source: string
              type: string
        name: string
        value: string
    commandParameter: string
    credentials:
        link: string
        metadatas:
            - aliases:
                - string
              defaultValue: string
              description: string
              groupBy: string
              hidden: false
              immutable: false
              matches: string
              maxLength: 0
              maxValue: 0
              minLength: 0
              minValue: 0
              options:
                - string
              position: 0
              secure: false
              source: string
              type: string
        name: string
        value: string
    description: string
    inventory: string
    location: string
    name: string
    resourceGroup: string
    schematicsActionId: string
    settings:
        - link: string
          metadatas:
            - aliases:
                - string
              defaultValue: string
              description: string
              groupBy: string
              hidden: false
              immutable: false
              matches: string
              maxLength: 0
              maxValue: 0
              minLength: 0
              minValue: 0
              options:
                - string
              position: 0
              secure: false
              source: string
              type: string
          name: string
          value: string
    sourceReadmeUrl: string
    sourceType: string
    sources:
        - catalog:
            catalogName: string
            offeringId: string
            offeringKind: string
            offeringName: string
            offeringRepoUrl: string
            offeringVersion: string
            offeringVersionId: string
          gits:
            - computedGitRepoUrl: string
              gitBranch: string
              gitRelease: string
              gitRepoFolder: string
              gitRepoUrl: string
              gitToken: string
          sourceType: string
    tags:
        - string
    targetsIni: string
    userStates:
        - setAt: string
          setBy: string
          state: string
    xGithubToken: string
Copy

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

ActionInputs List<SchematicsActionActionInput>
Input variables for the Action. Nested scheme for action_inputs:
ActionOutputs List<SchematicsActionActionOutput>
Output variables for the Action. Nested scheme for action_outputs:
Bastion SchematicsActionBastion
Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
BastionCredential SchematicsActionBastionCredential
User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
CommandParameter string
Schematics job command parameter (playbook-name).
Credentials SchematicsActionCredentials
credentials of the Action. MaxItems: 1. Nested scheme for credentials:
Description string
Action description.
Inventory string
Target inventory record ID, used by the action or ansible playbook.
Location string
Location supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
Name string
The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. Example you can use the name to stop action.
ResourceGroup string
Resource-group name for an action. By default, action is created in default resource group.
SchematicsActionId string
The unique identifier of the schematics_action.
Settings List<SchematicsActionSetting>
Environment variables for the Action. Nested scheme for settings:
SourceReadmeUrl string
URL of the README file, for the source URL.
SourceType string
Type of source for the Template.

  • Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket
Sources List<SchematicsActionSource>
Source of templates, playbooks, or controls. Nested scheme for source:
Tags List<string>
Action tags.
TargetsIni string
Inventory of host and host group for the playbook in INI file format. For example, "targets_ini": "[webserverhost] 172.22.192.6 [dbhost] 172.22.192.5". For more information, about an inventory host group syntax, see Inventory host groups.
UserStates List<SchematicsActionUserState>
User defined status of the Schematics object. Nested scheme for user_state:
XGithubToken string
ActionInputs []SchematicsActionActionInputArgs
Input variables for the Action. Nested scheme for action_inputs:
ActionOutputs []SchematicsActionActionOutputArgs
Output variables for the Action. Nested scheme for action_outputs:
Bastion SchematicsActionBastionArgs
Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
BastionCredential SchematicsActionBastionCredentialArgs
User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
CommandParameter string
Schematics job command parameter (playbook-name).
Credentials SchematicsActionCredentialsArgs
credentials of the Action. MaxItems: 1. Nested scheme for credentials:
Description string
Action description.
Inventory string
Target inventory record ID, used by the action or ansible playbook.
Location string
Location supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
Name string
The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. Example you can use the name to stop action.
ResourceGroup string
Resource-group name for an action. By default, action is created in default resource group.
SchematicsActionId string
The unique identifier of the schematics_action.
Settings []SchematicsActionSettingArgs
Environment variables for the Action. Nested scheme for settings:
SourceReadmeUrl string
URL of the README file, for the source URL.
SourceType string
Type of source for the Template.

  • Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket
Sources []SchematicsActionSourceArgs
Source of templates, playbooks, or controls. Nested scheme for source:
Tags []string
Action tags.
TargetsIni string
Inventory of host and host group for the playbook in INI file format. For example, "targets_ini": "[webserverhost] 172.22.192.6 [dbhost] 172.22.192.5". For more information, about an inventory host group syntax, see Inventory host groups.
UserStates []SchematicsActionUserStateArgs
User defined status of the Schematics object. Nested scheme for user_state:
XGithubToken string
actionInputs List<SchematicsActionActionInput>
Input variables for the Action. Nested scheme for action_inputs:
actionOutputs List<SchematicsActionActionOutput>
Output variables for the Action. Nested scheme for action_outputs:
bastion SchematicsActionBastion
Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
bastionCredential SchematicsActionBastionCredential
User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
commandParameter String
Schematics job command parameter (playbook-name).
credentials SchematicsActionCredentials
credentials of the Action. MaxItems: 1. Nested scheme for credentials:
description String
Action description.
inventory String
Target inventory record ID, used by the action or ansible playbook.
location String
Location supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
name String
The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. Example you can use the name to stop action.
resourceGroup String
Resource-group name for an action. By default, action is created in default resource group.
schematicsActionId String
The unique identifier of the schematics_action.
settings List<SchematicsActionSetting>
Environment variables for the Action. Nested scheme for settings:
sourceReadmeUrl String
URL of the README file, for the source URL.
sourceType String
Type of source for the Template.

  • Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket
sources List<SchematicsActionSource>
Source of templates, playbooks, or controls. Nested scheme for source:
tags List<String>
Action tags.
targetsIni String
Inventory of host and host group for the playbook in INI file format. For example, "targets_ini": "[webserverhost] 172.22.192.6 [dbhost] 172.22.192.5". For more information, about an inventory host group syntax, see Inventory host groups.
userStates List<SchematicsActionUserState>
User defined status of the Schematics object. Nested scheme for user_state:
xGithubToken String
actionInputs SchematicsActionActionInput[]
Input variables for the Action. Nested scheme for action_inputs:
actionOutputs SchematicsActionActionOutput[]
Output variables for the Action. Nested scheme for action_outputs:
bastion SchematicsActionBastion
Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
bastionCredential SchematicsActionBastionCredential
User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
commandParameter string
Schematics job command parameter (playbook-name).
credentials SchematicsActionCredentials
credentials of the Action. MaxItems: 1. Nested scheme for credentials:
description string
Action description.
inventory string
Target inventory record ID, used by the action or ansible playbook.
location string
Location supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
name string
The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. Example you can use the name to stop action.
resourceGroup string
Resource-group name for an action. By default, action is created in default resource group.
schematicsActionId string
The unique identifier of the schematics_action.
settings SchematicsActionSetting[]
Environment variables for the Action. Nested scheme for settings:
sourceReadmeUrl string
URL of the README file, for the source URL.
sourceType string
Type of source for the Template.

  • Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket
sources SchematicsActionSource[]
Source of templates, playbooks, or controls. Nested scheme for source:
tags string[]
Action tags.
targetsIni string
Inventory of host and host group for the playbook in INI file format. For example, "targets_ini": "[webserverhost] 172.22.192.6 [dbhost] 172.22.192.5". For more information, about an inventory host group syntax, see Inventory host groups.
userStates SchematicsActionUserState[]
User defined status of the Schematics object. Nested scheme for user_state:
xGithubToken string
action_inputs Sequence[SchematicsActionActionInputArgs]
Input variables for the Action. Nested scheme for action_inputs:
action_outputs Sequence[SchematicsActionActionOutputArgs]
Output variables for the Action. Nested scheme for action_outputs:
bastion SchematicsActionBastionArgs
Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
bastion_credential SchematicsActionBastionCredentialArgs
User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
command_parameter str
Schematics job command parameter (playbook-name).
credentials SchematicsActionCredentialsArgs
credentials of the Action. MaxItems: 1. Nested scheme for credentials:
description str
Action description.
inventory str
Target inventory record ID, used by the action or ansible playbook.
location str
Location supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
name str
The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. Example you can use the name to stop action.
resource_group str
Resource-group name for an action. By default, action is created in default resource group.
schematics_action_id str
The unique identifier of the schematics_action.
settings Sequence[SchematicsActionSettingArgs]
Environment variables for the Action. Nested scheme for settings:
source_readme_url str
URL of the README file, for the source URL.
source_type str
Type of source for the Template.

  • Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket
sources Sequence[SchematicsActionSourceArgs]
Source of templates, playbooks, or controls. Nested scheme for source:
tags Sequence[str]
Action tags.
targets_ini str
Inventory of host and host group for the playbook in INI file format. For example, "targets_ini": "[webserverhost] 172.22.192.6 [dbhost] 172.22.192.5". For more information, about an inventory host group syntax, see Inventory host groups.
user_states Sequence[SchematicsActionUserStateArgs]
User defined status of the Schematics object. Nested scheme for user_state:
x_github_token str
actionInputs List<Property Map>
Input variables for the Action. Nested scheme for action_inputs:
actionOutputs List<Property Map>
Output variables for the Action. Nested scheme for action_outputs:
bastion Property Map
Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
bastionCredential Property Map
User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
commandParameter String
Schematics job command parameter (playbook-name).
credentials Property Map
credentials of the Action. MaxItems: 1. Nested scheme for credentials:
description String
Action description.
inventory String
Target inventory record ID, used by the action or ansible playbook.
location String
Location supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
name String
The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. Example you can use the name to stop action.
resourceGroup String
Resource-group name for an action. By default, action is created in default resource group.
schematicsActionId String
The unique identifier of the schematics_action.
settings List<Property Map>
Environment variables for the Action. Nested scheme for settings:
sourceReadmeUrl String
URL of the README file, for the source URL.
sourceType String
Type of source for the Template.

  • Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket
sources List<Property Map>
Source of templates, playbooks, or controls. Nested scheme for source:
tags List<String>
Action tags.
targetsIni String
Inventory of host and host group for the playbook in INI file format. For example, "targets_ini": "[webserverhost] 172.22.192.6 [dbhost] 172.22.192.5". For more information, about an inventory host group syntax, see Inventory host groups.
userStates List<Property Map>
User defined status of the Schematics object. Nested scheme for user_state:
xGithubToken String

Outputs

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

Account string
(Optional, String) Action account ID.
CreatedAt string
(String) Action creation time.
CreatedBy string
(String) E-mail address of the user who created an action.
Crn string
(Optional, String) Action Cloud Resource Name.
Id string
The provider-assigned unique ID for this managed resource.
PlaybookNames List<string>
(Optional, List) Playbook names retrieved from the respository.
SourceCreatedAt string
(String) Action Playbook Source creation time.
SourceCreatedBy string
(String) E-mail address of user who created the Action Playbook Source.
SourceUpdatedAt string
(String) The action playbook updation time.
SourceUpdatedBy string
(String) E-mail address of user who updated the action playbook source.
States List<SchematicsActionState>
(List) Computed state of the Action. Nested scheme for state:
SysLocks List<SchematicsActionSysLock>
(List) System lock status. Nested scheme for sys_lock:
UpdatedAt string
(String) Action updation time.
UpdatedBy string
(String) E-mail address of the user who updated an action.
Account string
(Optional, String) Action account ID.
CreatedAt string
(String) Action creation time.
CreatedBy string
(String) E-mail address of the user who created an action.
Crn string
(Optional, String) Action Cloud Resource Name.
Id string
The provider-assigned unique ID for this managed resource.
PlaybookNames []string
(Optional, List) Playbook names retrieved from the respository.
SourceCreatedAt string
(String) Action Playbook Source creation time.
SourceCreatedBy string
(String) E-mail address of user who created the Action Playbook Source.
SourceUpdatedAt string
(String) The action playbook updation time.
SourceUpdatedBy string
(String) E-mail address of user who updated the action playbook source.
States []SchematicsActionStateType
(List) Computed state of the Action. Nested scheme for state:
SysLocks []SchematicsActionSysLock
(List) System lock status. Nested scheme for sys_lock:
UpdatedAt string
(String) Action updation time.
UpdatedBy string
(String) E-mail address of the user who updated an action.
account String
(Optional, String) Action account ID.
createdAt String
(String) Action creation time.
createdBy String
(String) E-mail address of the user who created an action.
crn String
(Optional, String) Action Cloud Resource Name.
id String
The provider-assigned unique ID for this managed resource.
playbookNames List<String>
(Optional, List) Playbook names retrieved from the respository.
sourceCreatedAt String
(String) Action Playbook Source creation time.
sourceCreatedBy String
(String) E-mail address of user who created the Action Playbook Source.
sourceUpdatedAt String
(String) The action playbook updation time.
sourceUpdatedBy String
(String) E-mail address of user who updated the action playbook source.
states List<SchematicsActionState>
(List) Computed state of the Action. Nested scheme for state:
sysLocks List<SchematicsActionSysLock>
(List) System lock status. Nested scheme for sys_lock:
updatedAt String
(String) Action updation time.
updatedBy String
(String) E-mail address of the user who updated an action.
account string
(Optional, String) Action account ID.
createdAt string
(String) Action creation time.
createdBy string
(String) E-mail address of the user who created an action.
crn string
(Optional, String) Action Cloud Resource Name.
id string
The provider-assigned unique ID for this managed resource.
playbookNames string[]
(Optional, List) Playbook names retrieved from the respository.
sourceCreatedAt string
(String) Action Playbook Source creation time.
sourceCreatedBy string
(String) E-mail address of user who created the Action Playbook Source.
sourceUpdatedAt string
(String) The action playbook updation time.
sourceUpdatedBy string
(String) E-mail address of user who updated the action playbook source.
states SchematicsActionState[]
(List) Computed state of the Action. Nested scheme for state:
sysLocks SchematicsActionSysLock[]
(List) System lock status. Nested scheme for sys_lock:
updatedAt string
(String) Action updation time.
updatedBy string
(String) E-mail address of the user who updated an action.
account str
(Optional, String) Action account ID.
created_at str
(String) Action creation time.
created_by str
(String) E-mail address of the user who created an action.
crn str
(Optional, String) Action Cloud Resource Name.
id str
The provider-assigned unique ID for this managed resource.
playbook_names Sequence[str]
(Optional, List) Playbook names retrieved from the respository.
source_created_at str
(String) Action Playbook Source creation time.
source_created_by str
(String) E-mail address of user who created the Action Playbook Source.
source_updated_at str
(String) The action playbook updation time.
source_updated_by str
(String) E-mail address of user who updated the action playbook source.
states Sequence[SchematicsActionState]
(List) Computed state of the Action. Nested scheme for state:
sys_locks Sequence[SchematicsActionSysLock]
(List) System lock status. Nested scheme for sys_lock:
updated_at str
(String) Action updation time.
updated_by str
(String) E-mail address of the user who updated an action.
account String
(Optional, String) Action account ID.
createdAt String
(String) Action creation time.
createdBy String
(String) E-mail address of the user who created an action.
crn String
(Optional, String) Action Cloud Resource Name.
id String
The provider-assigned unique ID for this managed resource.
playbookNames List<String>
(Optional, List) Playbook names retrieved from the respository.
sourceCreatedAt String
(String) Action Playbook Source creation time.
sourceCreatedBy String
(String) E-mail address of user who created the Action Playbook Source.
sourceUpdatedAt String
(String) The action playbook updation time.
sourceUpdatedBy String
(String) E-mail address of user who updated the action playbook source.
states List<Property Map>
(List) Computed state of the Action. Nested scheme for state:
sysLocks List<Property Map>
(List) System lock status. Nested scheme for sys_lock:
updatedAt String
(String) Action updation time.
updatedBy String
(String) E-mail address of the user who updated an action.

Look up Existing SchematicsAction Resource

Get an existing SchematicsAction 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?: SchematicsActionState, opts?: CustomResourceOptions): SchematicsAction
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account: Optional[str] = None,
        action_inputs: Optional[Sequence[SchematicsActionActionInputArgs]] = None,
        action_outputs: Optional[Sequence[SchematicsActionActionOutputArgs]] = None,
        bastion: Optional[SchematicsActionBastionArgs] = None,
        bastion_credential: Optional[SchematicsActionBastionCredentialArgs] = None,
        command_parameter: Optional[str] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        credentials: Optional[SchematicsActionCredentialsArgs] = None,
        crn: Optional[str] = None,
        description: Optional[str] = None,
        inventory: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        playbook_names: Optional[Sequence[str]] = None,
        resource_group: Optional[str] = None,
        schematics_action_id: Optional[str] = None,
        settings: Optional[Sequence[SchematicsActionSettingArgs]] = None,
        source_created_at: Optional[str] = None,
        source_created_by: Optional[str] = None,
        source_readme_url: Optional[str] = None,
        source_type: Optional[str] = None,
        source_updated_at: Optional[str] = None,
        source_updated_by: Optional[str] = None,
        sources: Optional[Sequence[SchematicsActionSourceArgs]] = None,
        states: Optional[Sequence[SchematicsActionStateArgs]] = None,
        sys_locks: Optional[Sequence[SchematicsActionSysLockArgs]] = None,
        tags: Optional[Sequence[str]] = None,
        targets_ini: Optional[str] = None,
        updated_at: Optional[str] = None,
        updated_by: Optional[str] = None,
        user_states: Optional[Sequence[SchematicsActionUserStateArgs]] = None,
        x_github_token: Optional[str] = None) -> SchematicsAction
func GetSchematicsAction(ctx *Context, name string, id IDInput, state *SchematicsActionState, opts ...ResourceOption) (*SchematicsAction, error)
public static SchematicsAction Get(string name, Input<string> id, SchematicsActionState? state, CustomResourceOptions? opts = null)
public static SchematicsAction get(String name, Output<String> id, SchematicsActionState state, CustomResourceOptions options)
resources:  _:    type: ibm:SchematicsAction    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Account string
(Optional, String) Action account ID.
ActionInputs List<SchematicsActionActionInput>
Input variables for the Action. Nested scheme for action_inputs:
ActionOutputs List<SchematicsActionActionOutput>
Output variables for the Action. Nested scheme for action_outputs:
Bastion SchematicsActionBastion
Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
BastionCredential SchematicsActionBastionCredential
User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
CommandParameter string
Schematics job command parameter (playbook-name).
CreatedAt string
(String) Action creation time.
CreatedBy string
(String) E-mail address of the user who created an action.
Credentials SchematicsActionCredentials
credentials of the Action. MaxItems: 1. Nested scheme for credentials:
Crn string
(Optional, String) Action Cloud Resource Name.
Description string
Action description.
Inventory string
Target inventory record ID, used by the action or ansible playbook.
Location string
Location supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
Name string
The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. Example you can use the name to stop action.
PlaybookNames List<string>
(Optional, List) Playbook names retrieved from the respository.
ResourceGroup string
Resource-group name for an action. By default, action is created in default resource group.
SchematicsActionId string
The unique identifier of the schematics_action.
Settings List<SchematicsActionSetting>
Environment variables for the Action. Nested scheme for settings:
SourceCreatedAt string
(String) Action Playbook Source creation time.
SourceCreatedBy string
(String) E-mail address of user who created the Action Playbook Source.
SourceReadmeUrl string
URL of the README file, for the source URL.
SourceType string
Type of source for the Template.

  • Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket
SourceUpdatedAt string
(String) The action playbook updation time.
SourceUpdatedBy string
(String) E-mail address of user who updated the action playbook source.
Sources List<SchematicsActionSource>
Source of templates, playbooks, or controls. Nested scheme for source:
States List<SchematicsActionState>
(List) Computed state of the Action. Nested scheme for state:
SysLocks List<SchematicsActionSysLock>
(List) System lock status. Nested scheme for sys_lock:
Tags List<string>
Action tags.
TargetsIni string
Inventory of host and host group for the playbook in INI file format. For example, "targets_ini": "[webserverhost] 172.22.192.6 [dbhost] 172.22.192.5". For more information, about an inventory host group syntax, see Inventory host groups.
UpdatedAt string
(String) Action updation time.
UpdatedBy string
(String) E-mail address of the user who updated an action.
UserStates List<SchematicsActionUserState>
User defined status of the Schematics object. Nested scheme for user_state:
XGithubToken string
Account string
(Optional, String) Action account ID.
ActionInputs []SchematicsActionActionInputArgs
Input variables for the Action. Nested scheme for action_inputs:
ActionOutputs []SchematicsActionActionOutputArgs
Output variables for the Action. Nested scheme for action_outputs:
Bastion SchematicsActionBastionArgs
Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
BastionCredential SchematicsActionBastionCredentialArgs
User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
CommandParameter string
Schematics job command parameter (playbook-name).
CreatedAt string
(String) Action creation time.
CreatedBy string
(String) E-mail address of the user who created an action.
Credentials SchematicsActionCredentialsArgs
credentials of the Action. MaxItems: 1. Nested scheme for credentials:
Crn string
(Optional, String) Action Cloud Resource Name.
Description string
Action description.
Inventory string
Target inventory record ID, used by the action or ansible playbook.
Location string
Location supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
Name string
The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. Example you can use the name to stop action.
PlaybookNames []string
(Optional, List) Playbook names retrieved from the respository.
ResourceGroup string
Resource-group name for an action. By default, action is created in default resource group.
SchematicsActionId string
The unique identifier of the schematics_action.
Settings []SchematicsActionSettingArgs
Environment variables for the Action. Nested scheme for settings:
SourceCreatedAt string
(String) Action Playbook Source creation time.
SourceCreatedBy string
(String) E-mail address of user who created the Action Playbook Source.
SourceReadmeUrl string
URL of the README file, for the source URL.
SourceType string
Type of source for the Template.

  • Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket
SourceUpdatedAt string
(String) The action playbook updation time.
SourceUpdatedBy string
(String) E-mail address of user who updated the action playbook source.
Sources []SchematicsActionSourceArgs
Source of templates, playbooks, or controls. Nested scheme for source:
States []SchematicsActionStateTypeArgs
(List) Computed state of the Action. Nested scheme for state:
SysLocks []SchematicsActionSysLockArgs
(List) System lock status. Nested scheme for sys_lock:
Tags []string
Action tags.
TargetsIni string
Inventory of host and host group for the playbook in INI file format. For example, "targets_ini": "[webserverhost] 172.22.192.6 [dbhost] 172.22.192.5". For more information, about an inventory host group syntax, see Inventory host groups.
UpdatedAt string
(String) Action updation time.
UpdatedBy string
(String) E-mail address of the user who updated an action.
UserStates []SchematicsActionUserStateArgs
User defined status of the Schematics object. Nested scheme for user_state:
XGithubToken string
account String
(Optional, String) Action account ID.
actionInputs List<SchematicsActionActionInput>
Input variables for the Action. Nested scheme for action_inputs:
actionOutputs List<SchematicsActionActionOutput>
Output variables for the Action. Nested scheme for action_outputs:
bastion SchematicsActionBastion
Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
bastionCredential SchematicsActionBastionCredential
User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
commandParameter String
Schematics job command parameter (playbook-name).
createdAt String
(String) Action creation time.
createdBy String
(String) E-mail address of the user who created an action.
credentials SchematicsActionCredentials
credentials of the Action. MaxItems: 1. Nested scheme for credentials:
crn String
(Optional, String) Action Cloud Resource Name.
description String
Action description.
inventory String
Target inventory record ID, used by the action or ansible playbook.
location String
Location supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
name String
The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. Example you can use the name to stop action.
playbookNames List<String>
(Optional, List) Playbook names retrieved from the respository.
resourceGroup String
Resource-group name for an action. By default, action is created in default resource group.
schematicsActionId String
The unique identifier of the schematics_action.
settings List<SchematicsActionSetting>
Environment variables for the Action. Nested scheme for settings:
sourceCreatedAt String
(String) Action Playbook Source creation time.
sourceCreatedBy String
(String) E-mail address of user who created the Action Playbook Source.
sourceReadmeUrl String
URL of the README file, for the source URL.
sourceType String
Type of source for the Template.

  • Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket
sourceUpdatedAt String
(String) The action playbook updation time.
sourceUpdatedBy String
(String) E-mail address of user who updated the action playbook source.
sources List<SchematicsActionSource>
Source of templates, playbooks, or controls. Nested scheme for source:
states List<SchematicsActionState>
(List) Computed state of the Action. Nested scheme for state:
sysLocks List<SchematicsActionSysLock>
(List) System lock status. Nested scheme for sys_lock:
tags List<String>
Action tags.
targetsIni String
Inventory of host and host group for the playbook in INI file format. For example, "targets_ini": "[webserverhost] 172.22.192.6 [dbhost] 172.22.192.5". For more information, about an inventory host group syntax, see Inventory host groups.
updatedAt String
(String) Action updation time.
updatedBy String
(String) E-mail address of the user who updated an action.
userStates List<SchematicsActionUserState>
User defined status of the Schematics object. Nested scheme for user_state:
xGithubToken String
account string
(Optional, String) Action account ID.
actionInputs SchematicsActionActionInput[]
Input variables for the Action. Nested scheme for action_inputs:
actionOutputs SchematicsActionActionOutput[]
Output variables for the Action. Nested scheme for action_outputs:
bastion SchematicsActionBastion
Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
bastionCredential SchematicsActionBastionCredential
User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
commandParameter string
Schematics job command parameter (playbook-name).
createdAt string
(String) Action creation time.
createdBy string
(String) E-mail address of the user who created an action.
credentials SchematicsActionCredentials
credentials of the Action. MaxItems: 1. Nested scheme for credentials:
crn string
(Optional, String) Action Cloud Resource Name.
description string
Action description.
inventory string
Target inventory record ID, used by the action or ansible playbook.
location string
Location supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
name string
The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. Example you can use the name to stop action.
playbookNames string[]
(Optional, List) Playbook names retrieved from the respository.
resourceGroup string
Resource-group name for an action. By default, action is created in default resource group.
schematicsActionId string
The unique identifier of the schematics_action.
settings SchematicsActionSetting[]
Environment variables for the Action. Nested scheme for settings:
sourceCreatedAt string
(String) Action Playbook Source creation time.
sourceCreatedBy string
(String) E-mail address of user who created the Action Playbook Source.
sourceReadmeUrl string
URL of the README file, for the source URL.
sourceType string
Type of source for the Template.

  • Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket
sourceUpdatedAt string
(String) The action playbook updation time.
sourceUpdatedBy string
(String) E-mail address of user who updated the action playbook source.
sources SchematicsActionSource[]
Source of templates, playbooks, or controls. Nested scheme for source:
states SchematicsActionState[]
(List) Computed state of the Action. Nested scheme for state:
sysLocks SchematicsActionSysLock[]
(List) System lock status. Nested scheme for sys_lock:
tags string[]
Action tags.
targetsIni string
Inventory of host and host group for the playbook in INI file format. For example, "targets_ini": "[webserverhost] 172.22.192.6 [dbhost] 172.22.192.5". For more information, about an inventory host group syntax, see Inventory host groups.
updatedAt string
(String) Action updation time.
updatedBy string
(String) E-mail address of the user who updated an action.
userStates SchematicsActionUserState[]
User defined status of the Schematics object. Nested scheme for user_state:
xGithubToken string
account str
(Optional, String) Action account ID.
action_inputs Sequence[SchematicsActionActionInputArgs]
Input variables for the Action. Nested scheme for action_inputs:
action_outputs Sequence[SchematicsActionActionOutputArgs]
Output variables for the Action. Nested scheme for action_outputs:
bastion SchematicsActionBastionArgs
Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
bastion_credential SchematicsActionBastionCredentialArgs
User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
command_parameter str
Schematics job command parameter (playbook-name).
created_at str
(String) Action creation time.
created_by str
(String) E-mail address of the user who created an action.
credentials SchematicsActionCredentialsArgs
credentials of the Action. MaxItems: 1. Nested scheme for credentials:
crn str
(Optional, String) Action Cloud Resource Name.
description str
Action description.
inventory str
Target inventory record ID, used by the action or ansible playbook.
location str
Location supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
name str
The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. Example you can use the name to stop action.
playbook_names Sequence[str]
(Optional, List) Playbook names retrieved from the respository.
resource_group str
Resource-group name for an action. By default, action is created in default resource group.
schematics_action_id str
The unique identifier of the schematics_action.
settings Sequence[SchematicsActionSettingArgs]
Environment variables for the Action. Nested scheme for settings:
source_created_at str
(String) Action Playbook Source creation time.
source_created_by str
(String) E-mail address of user who created the Action Playbook Source.
source_readme_url str
URL of the README file, for the source URL.
source_type str
Type of source for the Template.

  • Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket
source_updated_at str
(String) The action playbook updation time.
source_updated_by str
(String) E-mail address of user who updated the action playbook source.
sources Sequence[SchematicsActionSourceArgs]
Source of templates, playbooks, or controls. Nested scheme for source:
states Sequence[SchematicsActionStateArgs]
(List) Computed state of the Action. Nested scheme for state:
sys_locks Sequence[SchematicsActionSysLockArgs]
(List) System lock status. Nested scheme for sys_lock:
tags Sequence[str]
Action tags.
targets_ini str
Inventory of host and host group for the playbook in INI file format. For example, "targets_ini": "[webserverhost] 172.22.192.6 [dbhost] 172.22.192.5". For more information, about an inventory host group syntax, see Inventory host groups.
updated_at str
(String) Action updation time.
updated_by str
(String) E-mail address of the user who updated an action.
user_states Sequence[SchematicsActionUserStateArgs]
User defined status of the Schematics object. Nested scheme for user_state:
x_github_token str
account String
(Optional, String) Action account ID.
actionInputs List<Property Map>
Input variables for the Action. Nested scheme for action_inputs:
actionOutputs List<Property Map>
Output variables for the Action. Nested scheme for action_outputs:
bastion Property Map
Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
bastionCredential Property Map
User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
commandParameter String
Schematics job command parameter (playbook-name).
createdAt String
(String) Action creation time.
createdBy String
(String) E-mail address of the user who created an action.
credentials Property Map
credentials of the Action. MaxItems: 1. Nested scheme for credentials:
crn String
(Optional, String) Action Cloud Resource Name.
description String
Action description.
inventory String
Target inventory record ID, used by the action or ansible playbook.
location String
Location supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de
name String
The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. Example you can use the name to stop action.
playbookNames List<String>
(Optional, List) Playbook names retrieved from the respository.
resourceGroup String
Resource-group name for an action. By default, action is created in default resource group.
schematicsActionId String
The unique identifier of the schematics_action.
settings List<Property Map>
Environment variables for the Action. Nested scheme for settings:
sourceCreatedAt String
(String) Action Playbook Source creation time.
sourceCreatedBy String
(String) E-mail address of user who created the Action Playbook Source.
sourceReadmeUrl String
URL of the README file, for the source URL.
sourceType String
Type of source for the Template.

  • Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket
sourceUpdatedAt String
(String) The action playbook updation time.
sourceUpdatedBy String
(String) E-mail address of user who updated the action playbook source.
sources List<Property Map>
Source of templates, playbooks, or controls. Nested scheme for source:
states List<Property Map>
(List) Computed state of the Action. Nested scheme for state:
sysLocks List<Property Map>
(List) System lock status. Nested scheme for sys_lock:
tags List<String>
Action tags.
targetsIni String
Inventory of host and host group for the playbook in INI file format. For example, "targets_ini": "[webserverhost] 172.22.192.6 [dbhost] 172.22.192.5". For more information, about an inventory host group syntax, see Inventory host groups.
updatedAt String
(String) Action updation time.
updatedBy String
(String) E-mail address of the user who updated an action.
userStates List<Property Map>
User defined status of the Schematics object. Nested scheme for user_state:
xGithubToken String

Supporting Types

SchematicsActionActionInput
, SchematicsActionActionInputArgs

Link string
Reference link to the variable value By default the expression will point to self.value.
Metadatas List<SchematicsActionActionInputMetadata>
User editable metadata for the variables. Nested scheme for metadata:
Name string
Name of the variable.
Value string
Value for the variable or reference to the value.
Link string
Reference link to the variable value By default the expression will point to self.value.
Metadatas []SchematicsActionActionInputMetadata
User editable metadata for the variables. Nested scheme for metadata:
Name string
Name of the variable.
Value string
Value for the variable or reference to the value.
link String
Reference link to the variable value By default the expression will point to self.value.
metadatas List<SchematicsActionActionInputMetadata>
User editable metadata for the variables. Nested scheme for metadata:
name String
Name of the variable.
value String
Value for the variable or reference to the value.
link string
Reference link to the variable value By default the expression will point to self.value.
metadatas SchematicsActionActionInputMetadata[]
User editable metadata for the variables. Nested scheme for metadata:
name string
Name of the variable.
value string
Value for the variable or reference to the value.
link str
Reference link to the variable value By default the expression will point to self.value.
metadatas Sequence[SchematicsActionActionInputMetadata]
User editable metadata for the variables. Nested scheme for metadata:
name str
Name of the variable.
value str
Value for the variable or reference to the value.
link String
Reference link to the variable value By default the expression will point to self.value.
metadatas List<Property Map>
User editable metadata for the variables. Nested scheme for metadata:
name String
Name of the variable.
value String
Value for the variable or reference to the value.

SchematicsActionActionInputMetadata
, SchematicsActionActionInputMetadataArgs

Aliases List<string>
List of aliases for the variable name.
DefaultValue string
Default value for the variable, if the override value is not specified.
Description string
Description of the meta data.
GroupBy string
Display name of the group this variable belongs to.
Hidden bool
If true, the variable will not be displayed on UI or CLI.
Immutable bool
Is the variable readonly ?.
Matches string
Regex for the variable value.
MaxLength double
Maximum length of the variable value. Applicable for string type.
MaxValue double
Maximum value of the variable. Applicable for integer type.
MinLength double
Minimum length of the variable value. Applicable for string type.
MinValue double
Minimum value of the variable. Applicable for integer type.
Options List<string>
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
Position double
Relative position of this variable in a list.
Secure bool
Is the variable secure or sensitive ?.
Source string
Source of this meta-data.
Type string
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
Aliases []string
List of aliases for the variable name.
DefaultValue string
Default value for the variable, if the override value is not specified.
Description string
Description of the meta data.
GroupBy string
Display name of the group this variable belongs to.
Hidden bool
If true, the variable will not be displayed on UI or CLI.
Immutable bool
Is the variable readonly ?.
Matches string
Regex for the variable value.
MaxLength float64
Maximum length of the variable value. Applicable for string type.
MaxValue float64
Maximum value of the variable. Applicable for integer type.
MinLength float64
Minimum length of the variable value. Applicable for string type.
MinValue float64
Minimum value of the variable. Applicable for integer type.
Options []string
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
Position float64
Relative position of this variable in a list.
Secure bool
Is the variable secure or sensitive ?.
Source string
Source of this meta-data.
Type string
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases List<String>
List of aliases for the variable name.
defaultValue String
Default value for the variable, if the override value is not specified.
description String
Description of the meta data.
groupBy String
Display name of the group this variable belongs to.
hidden Boolean
If true, the variable will not be displayed on UI or CLI.
immutable Boolean
Is the variable readonly ?.
matches String
Regex for the variable value.
maxLength Double
Maximum length of the variable value. Applicable for string type.
maxValue Double
Maximum value of the variable. Applicable for integer type.
minLength Double
Minimum length of the variable value. Applicable for string type.
minValue Double
Minimum value of the variable. Applicable for integer type.
options List<String>
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position Double
Relative position of this variable in a list.
secure Boolean
Is the variable secure or sensitive ?.
source String
Source of this meta-data.
type String
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases string[]
List of aliases for the variable name.
defaultValue string
Default value for the variable, if the override value is not specified.
description string
Description of the meta data.
groupBy string
Display name of the group this variable belongs to.
hidden boolean
If true, the variable will not be displayed on UI or CLI.
immutable boolean
Is the variable readonly ?.
matches string
Regex for the variable value.
maxLength number
Maximum length of the variable value. Applicable for string type.
maxValue number
Maximum value of the variable. Applicable for integer type.
minLength number
Minimum length of the variable value. Applicable for string type.
minValue number
Minimum value of the variable. Applicable for integer type.
options string[]
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position number
Relative position of this variable in a list.
secure boolean
Is the variable secure or sensitive ?.
source string
Source of this meta-data.
type string
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases Sequence[str]
List of aliases for the variable name.
default_value str
Default value for the variable, if the override value is not specified.
description str
Description of the meta data.
group_by str
Display name of the group this variable belongs to.
hidden bool
If true, the variable will not be displayed on UI or CLI.
immutable bool
Is the variable readonly ?.
matches str
Regex for the variable value.
max_length float
Maximum length of the variable value. Applicable for string type.
max_value float
Maximum value of the variable. Applicable for integer type.
min_length float
Minimum length of the variable value. Applicable for string type.
min_value float
Minimum value of the variable. Applicable for integer type.
options Sequence[str]
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position float
Relative position of this variable in a list.
secure bool
Is the variable secure or sensitive ?.
source str
Source of this meta-data.
type str
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases List<String>
List of aliases for the variable name.
defaultValue String
Default value for the variable, if the override value is not specified.
description String
Description of the meta data.
groupBy String
Display name of the group this variable belongs to.
hidden Boolean
If true, the variable will not be displayed on UI or CLI.
immutable Boolean
Is the variable readonly ?.
matches String
Regex for the variable value.
maxLength Number
Maximum length of the variable value. Applicable for string type.
maxValue Number
Maximum value of the variable. Applicable for integer type.
minLength Number
Minimum length of the variable value. Applicable for string type.
minValue Number
Minimum value of the variable. Applicable for integer type.
options List<String>
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position Number
Relative position of this variable in a list.
secure Boolean
Is the variable secure or sensitive ?.
source String
Source of this meta-data.
type String
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

SchematicsActionActionOutput
, SchematicsActionActionOutputArgs

Link string
Reference link to the variable value By default the expression will point to self.value.
Metadatas List<SchematicsActionActionOutputMetadata>
User editable metadata for the variables. Nested scheme for metadata:
Name string
Name of the variable.
Value string
Value for the variable or reference to the value.
Link string
Reference link to the variable value By default the expression will point to self.value.
Metadatas []SchematicsActionActionOutputMetadata
User editable metadata for the variables. Nested scheme for metadata:
Name string
Name of the variable.
Value string
Value for the variable or reference to the value.
link String
Reference link to the variable value By default the expression will point to self.value.
metadatas List<SchematicsActionActionOutputMetadata>
User editable metadata for the variables. Nested scheme for metadata:
name String
Name of the variable.
value String
Value for the variable or reference to the value.
link string
Reference link to the variable value By default the expression will point to self.value.
metadatas SchematicsActionActionOutputMetadata[]
User editable metadata for the variables. Nested scheme for metadata:
name string
Name of the variable.
value string
Value for the variable or reference to the value.
link str
Reference link to the variable value By default the expression will point to self.value.
metadatas Sequence[SchematicsActionActionOutputMetadata]
User editable metadata for the variables. Nested scheme for metadata:
name str
Name of the variable.
value str
Value for the variable or reference to the value.
link String
Reference link to the variable value By default the expression will point to self.value.
metadatas List<Property Map>
User editable metadata for the variables. Nested scheme for metadata:
name String
Name of the variable.
value String
Value for the variable or reference to the value.

SchematicsActionActionOutputMetadata
, SchematicsActionActionOutputMetadataArgs

Aliases List<string>
List of aliases for the variable name.
DefaultValue string
Default value for the variable, if the override value is not specified.
Description string
Description of the meta data.
GroupBy string
Display name of the group this variable belongs to.
Hidden bool
If true, the variable will not be displayed on UI or CLI.
Immutable bool
Is the variable readonly ?.
Matches string
Regex for the variable value.
MaxLength double
Maximum length of the variable value. Applicable for string type.
MaxValue double
Maximum value of the variable. Applicable for integer type.
MinLength double
Minimum length of the variable value. Applicable for string type.
MinValue double
Minimum value of the variable. Applicable for integer type.
Options List<string>
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
Position double
Relative position of this variable in a list.
Secure bool
Is the variable secure or sensitive ?.
Source string
Source of this meta-data.
Type string
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
Aliases []string
List of aliases for the variable name.
DefaultValue string
Default value for the variable, if the override value is not specified.
Description string
Description of the meta data.
GroupBy string
Display name of the group this variable belongs to.
Hidden bool
If true, the variable will not be displayed on UI or CLI.
Immutable bool
Is the variable readonly ?.
Matches string
Regex for the variable value.
MaxLength float64
Maximum length of the variable value. Applicable for string type.
MaxValue float64
Maximum value of the variable. Applicable for integer type.
MinLength float64
Minimum length of the variable value. Applicable for string type.
MinValue float64
Minimum value of the variable. Applicable for integer type.
Options []string
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
Position float64
Relative position of this variable in a list.
Secure bool
Is the variable secure or sensitive ?.
Source string
Source of this meta-data.
Type string
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases List<String>
List of aliases for the variable name.
defaultValue String
Default value for the variable, if the override value is not specified.
description String
Description of the meta data.
groupBy String
Display name of the group this variable belongs to.
hidden Boolean
If true, the variable will not be displayed on UI or CLI.
immutable Boolean
Is the variable readonly ?.
matches String
Regex for the variable value.
maxLength Double
Maximum length of the variable value. Applicable for string type.
maxValue Double
Maximum value of the variable. Applicable for integer type.
minLength Double
Minimum length of the variable value. Applicable for string type.
minValue Double
Minimum value of the variable. Applicable for integer type.
options List<String>
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position Double
Relative position of this variable in a list.
secure Boolean
Is the variable secure or sensitive ?.
source String
Source of this meta-data.
type String
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases string[]
List of aliases for the variable name.
defaultValue string
Default value for the variable, if the override value is not specified.
description string
Description of the meta data.
groupBy string
Display name of the group this variable belongs to.
hidden boolean
If true, the variable will not be displayed on UI or CLI.
immutable boolean
Is the variable readonly ?.
matches string
Regex for the variable value.
maxLength number
Maximum length of the variable value. Applicable for string type.
maxValue number
Maximum value of the variable. Applicable for integer type.
minLength number
Minimum length of the variable value. Applicable for string type.
minValue number
Minimum value of the variable. Applicable for integer type.
options string[]
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position number
Relative position of this variable in a list.
secure boolean
Is the variable secure or sensitive ?.
source string
Source of this meta-data.
type string
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases Sequence[str]
List of aliases for the variable name.
default_value str
Default value for the variable, if the override value is not specified.
description str
Description of the meta data.
group_by str
Display name of the group this variable belongs to.
hidden bool
If true, the variable will not be displayed on UI or CLI.
immutable bool
Is the variable readonly ?.
matches str
Regex for the variable value.
max_length float
Maximum length of the variable value. Applicable for string type.
max_value float
Maximum value of the variable. Applicable for integer type.
min_length float
Minimum length of the variable value. Applicable for string type.
min_value float
Minimum value of the variable. Applicable for integer type.
options Sequence[str]
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position float
Relative position of this variable in a list.
secure bool
Is the variable secure or sensitive ?.
source str
Source of this meta-data.
type str
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases List<String>
List of aliases for the variable name.
defaultValue String
Default value for the variable, if the override value is not specified.
description String
Description of the meta data.
groupBy String
Display name of the group this variable belongs to.
hidden Boolean
If true, the variable will not be displayed on UI or CLI.
immutable Boolean
Is the variable readonly ?.
matches String
Regex for the variable value.
maxLength Number
Maximum length of the variable value. Applicable for string type.
maxValue Number
Maximum value of the variable. Applicable for integer type.
minLength Number
Minimum length of the variable value. Applicable for string type.
minValue Number
Minimum value of the variable. Applicable for integer type.
options List<String>
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position Number
Relative position of this variable in a list.
secure Boolean
Is the variable secure or sensitive ?.
source String
Source of this meta-data.
type String
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

SchematicsActionBastion
, SchematicsActionBastionArgs

Host string
Reference to the Inventory resource definition.
Name string
Bastion Name(Unique).
Host string
Reference to the Inventory resource definition.
Name string
Bastion Name(Unique).
host String
Reference to the Inventory resource definition.
name String
Bastion Name(Unique).
host string
Reference to the Inventory resource definition.
name string
Bastion Name(Unique).
host str
Reference to the Inventory resource definition.
name str
Bastion Name(Unique).
host String
Reference to the Inventory resource definition.
name String
Bastion Name(Unique).

SchematicsActionBastionCredential
, SchematicsActionBastionCredentialArgs

Link string
Reference link to the variable value By default the expression will point to self.value.
Metadatas List<SchematicsActionBastionCredentialMetadata>
User editable metadata for the variables. Nested scheme for metadata:
Name string
Name of the variable.
Value string
Value for the variable or reference to the value.
Link string
Reference link to the variable value By default the expression will point to self.value.
Metadatas []SchematicsActionBastionCredentialMetadata
User editable metadata for the variables. Nested scheme for metadata:
Name string
Name of the variable.
Value string
Value for the variable or reference to the value.
link String
Reference link to the variable value By default the expression will point to self.value.
metadatas List<SchematicsActionBastionCredentialMetadata>
User editable metadata for the variables. Nested scheme for metadata:
name String
Name of the variable.
value String
Value for the variable or reference to the value.
link string
Reference link to the variable value By default the expression will point to self.value.
metadatas SchematicsActionBastionCredentialMetadata[]
User editable metadata for the variables. Nested scheme for metadata:
name string
Name of the variable.
value string
Value for the variable or reference to the value.
link str
Reference link to the variable value By default the expression will point to self.value.
metadatas Sequence[SchematicsActionBastionCredentialMetadata]
User editable metadata for the variables. Nested scheme for metadata:
name str
Name of the variable.
value str
Value for the variable or reference to the value.
link String
Reference link to the variable value By default the expression will point to self.value.
metadatas List<Property Map>
User editable metadata for the variables. Nested scheme for metadata:
name String
Name of the variable.
value String
Value for the variable or reference to the value.

SchematicsActionBastionCredentialMetadata
, SchematicsActionBastionCredentialMetadataArgs

Aliases List<string>
List of aliases for the variable name.
DefaultValue string
Default value for the variable, if the override value is not specified.
Description string
Description of the meta data.
GroupBy string
Display name of the group this variable belongs to.
Hidden bool
If true, the variable will not be displayed on UI or CLI.
Immutable bool
Is the variable readonly ?.
Matches string
Regex for the variable value.
MaxLength double
Maximum length of the variable value. Applicable for string type.
MaxValue double
Maximum value of the variable. Applicable for integer type.
MinLength double
Minimum length of the variable value. Applicable for string type.
MinValue double
Minimum value of the variable. Applicable for integer type.
Options List<string>
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
Position double
Relative position of this variable in a list.
Secure bool
Is the variable secure or sensitive ?.
Source string
Source of this meta-data.
Type string
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
Aliases []string
List of aliases for the variable name.
DefaultValue string
Default value for the variable, if the override value is not specified.
Description string
Description of the meta data.
GroupBy string
Display name of the group this variable belongs to.
Hidden bool
If true, the variable will not be displayed on UI or CLI.
Immutable bool
Is the variable readonly ?.
Matches string
Regex for the variable value.
MaxLength float64
Maximum length of the variable value. Applicable for string type.
MaxValue float64
Maximum value of the variable. Applicable for integer type.
MinLength float64
Minimum length of the variable value. Applicable for string type.
MinValue float64
Minimum value of the variable. Applicable for integer type.
Options []string
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
Position float64
Relative position of this variable in a list.
Secure bool
Is the variable secure or sensitive ?.
Source string
Source of this meta-data.
Type string
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases List<String>
List of aliases for the variable name.
defaultValue String
Default value for the variable, if the override value is not specified.
description String
Description of the meta data.
groupBy String
Display name of the group this variable belongs to.
hidden Boolean
If true, the variable will not be displayed on UI or CLI.
immutable Boolean
Is the variable readonly ?.
matches String
Regex for the variable value.
maxLength Double
Maximum length of the variable value. Applicable for string type.
maxValue Double
Maximum value of the variable. Applicable for integer type.
minLength Double
Minimum length of the variable value. Applicable for string type.
minValue Double
Minimum value of the variable. Applicable for integer type.
options List<String>
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position Double
Relative position of this variable in a list.
secure Boolean
Is the variable secure or sensitive ?.
source String
Source of this meta-data.
type String
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases string[]
List of aliases for the variable name.
defaultValue string
Default value for the variable, if the override value is not specified.
description string
Description of the meta data.
groupBy string
Display name of the group this variable belongs to.
hidden boolean
If true, the variable will not be displayed on UI or CLI.
immutable boolean
Is the variable readonly ?.
matches string
Regex for the variable value.
maxLength number
Maximum length of the variable value. Applicable for string type.
maxValue number
Maximum value of the variable. Applicable for integer type.
minLength number
Minimum length of the variable value. Applicable for string type.
minValue number
Minimum value of the variable. Applicable for integer type.
options string[]
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position number
Relative position of this variable in a list.
secure boolean
Is the variable secure or sensitive ?.
source string
Source of this meta-data.
type string
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases Sequence[str]
List of aliases for the variable name.
default_value str
Default value for the variable, if the override value is not specified.
description str
Description of the meta data.
group_by str
Display name of the group this variable belongs to.
hidden bool
If true, the variable will not be displayed on UI or CLI.
immutable bool
Is the variable readonly ?.
matches str
Regex for the variable value.
max_length float
Maximum length of the variable value. Applicable for string type.
max_value float
Maximum value of the variable. Applicable for integer type.
min_length float
Minimum length of the variable value. Applicable for string type.
min_value float
Minimum value of the variable. Applicable for integer type.
options Sequence[str]
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position float
Relative position of this variable in a list.
secure bool
Is the variable secure or sensitive ?.
source str
Source of this meta-data.
type str
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases List<String>
List of aliases for the variable name.
defaultValue String
Default value for the variable, if the override value is not specified.
description String
Description of the meta data.
groupBy String
Display name of the group this variable belongs to.
hidden Boolean
If true, the variable will not be displayed on UI or CLI.
immutable Boolean
Is the variable readonly ?.
matches String
Regex for the variable value.
maxLength Number
Maximum length of the variable value. Applicable for string type.
maxValue Number
Maximum value of the variable. Applicable for integer type.
minLength Number
Minimum length of the variable value. Applicable for string type.
minValue Number
Minimum value of the variable. Applicable for integer type.
options List<String>
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position Number
Relative position of this variable in a list.
secure Boolean
Is the variable secure or sensitive ?.
source String
Source of this meta-data.
type String
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

SchematicsActionCredentials
, SchematicsActionCredentialsArgs

Link string
Reference link to the variable value By default the expression will point to self.value.
Metadatas List<SchematicsActionCredentialsMetadata>
User editable metadata for the variables. Nested scheme for metadata:
Name string
Name of the variable.
Value string
Value for the variable or reference to the value.
Link string
Reference link to the variable value By default the expression will point to self.value.
Metadatas []SchematicsActionCredentialsMetadata
User editable metadata for the variables. Nested scheme for metadata:
Name string
Name of the variable.
Value string
Value for the variable or reference to the value.
link String
Reference link to the variable value By default the expression will point to self.value.
metadatas List<SchematicsActionCredentialsMetadata>
User editable metadata for the variables. Nested scheme for metadata:
name String
Name of the variable.
value String
Value for the variable or reference to the value.
link string
Reference link to the variable value By default the expression will point to self.value.
metadatas SchematicsActionCredentialsMetadata[]
User editable metadata for the variables. Nested scheme for metadata:
name string
Name of the variable.
value string
Value for the variable or reference to the value.
link str
Reference link to the variable value By default the expression will point to self.value.
metadatas Sequence[SchematicsActionCredentialsMetadata]
User editable metadata for the variables. Nested scheme for metadata:
name str
Name of the variable.
value str
Value for the variable or reference to the value.
link String
Reference link to the variable value By default the expression will point to self.value.
metadatas List<Property Map>
User editable metadata for the variables. Nested scheme for metadata:
name String
Name of the variable.
value String
Value for the variable or reference to the value.

SchematicsActionCredentialsMetadata
, SchematicsActionCredentialsMetadataArgs

Aliases List<string>
List of aliases for the variable name.
DefaultValue string
Default value for the variable, if the override value is not specified.
Description string
Description of the meta data.
GroupBy string
Display name of the group this variable belongs to.
Hidden bool
If true, the variable will not be displayed on UI or CLI.
Immutable bool
Is the variable readonly ?.
Matches string
Regex for the variable value.
MaxLength double
Maximum length of the variable value. Applicable for string type.
MaxValue double
Maximum value of the variable. Applicable for integer type.
MinLength double
Minimum length of the variable value. Applicable for string type.
MinValue double
Minimum value of the variable. Applicable for integer type.
Options List<string>
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
Position double
Relative position of this variable in a list.
Secure bool
Is the variable secure or sensitive ?.
Source string
Source of this meta-data.
Type string
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
Aliases []string
List of aliases for the variable name.
DefaultValue string
Default value for the variable, if the override value is not specified.
Description string
Description of the meta data.
GroupBy string
Display name of the group this variable belongs to.
Hidden bool
If true, the variable will not be displayed on UI or CLI.
Immutable bool
Is the variable readonly ?.
Matches string
Regex for the variable value.
MaxLength float64
Maximum length of the variable value. Applicable for string type.
MaxValue float64
Maximum value of the variable. Applicable for integer type.
MinLength float64
Minimum length of the variable value. Applicable for string type.
MinValue float64
Minimum value of the variable. Applicable for integer type.
Options []string
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
Position float64
Relative position of this variable in a list.
Secure bool
Is the variable secure or sensitive ?.
Source string
Source of this meta-data.
Type string
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases List<String>
List of aliases for the variable name.
defaultValue String
Default value for the variable, if the override value is not specified.
description String
Description of the meta data.
groupBy String
Display name of the group this variable belongs to.
hidden Boolean
If true, the variable will not be displayed on UI or CLI.
immutable Boolean
Is the variable readonly ?.
matches String
Regex for the variable value.
maxLength Double
Maximum length of the variable value. Applicable for string type.
maxValue Double
Maximum value of the variable. Applicable for integer type.
minLength Double
Minimum length of the variable value. Applicable for string type.
minValue Double
Minimum value of the variable. Applicable for integer type.
options List<String>
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position Double
Relative position of this variable in a list.
secure Boolean
Is the variable secure or sensitive ?.
source String
Source of this meta-data.
type String
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases string[]
List of aliases for the variable name.
defaultValue string
Default value for the variable, if the override value is not specified.
description string
Description of the meta data.
groupBy string
Display name of the group this variable belongs to.
hidden boolean
If true, the variable will not be displayed on UI or CLI.
immutable boolean
Is the variable readonly ?.
matches string
Regex for the variable value.
maxLength number
Maximum length of the variable value. Applicable for string type.
maxValue number
Maximum value of the variable. Applicable for integer type.
minLength number
Minimum length of the variable value. Applicable for string type.
minValue number
Minimum value of the variable. Applicable for integer type.
options string[]
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position number
Relative position of this variable in a list.
secure boolean
Is the variable secure or sensitive ?.
source string
Source of this meta-data.
type string
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases Sequence[str]
List of aliases for the variable name.
default_value str
Default value for the variable, if the override value is not specified.
description str
Description of the meta data.
group_by str
Display name of the group this variable belongs to.
hidden bool
If true, the variable will not be displayed on UI or CLI.
immutable bool
Is the variable readonly ?.
matches str
Regex for the variable value.
max_length float
Maximum length of the variable value. Applicable for string type.
max_value float
Maximum value of the variable. Applicable for integer type.
min_length float
Minimum length of the variable value. Applicable for string type.
min_value float
Minimum value of the variable. Applicable for integer type.
options Sequence[str]
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position float
Relative position of this variable in a list.
secure bool
Is the variable secure or sensitive ?.
source str
Source of this meta-data.
type str
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases List<String>
List of aliases for the variable name.
defaultValue String
Default value for the variable, if the override value is not specified.
description String
Description of the meta data.
groupBy String
Display name of the group this variable belongs to.
hidden Boolean
If true, the variable will not be displayed on UI or CLI.
immutable Boolean
Is the variable readonly ?.
matches String
Regex for the variable value.
maxLength Number
Maximum length of the variable value. Applicable for string type.
maxValue Number
Maximum value of the variable. Applicable for integer type.
minLength Number
Minimum length of the variable value. Applicable for string type.
minValue Number
Minimum value of the variable. Applicable for integer type.
options List<String>
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position Number
Relative position of this variable in a list.
secure Boolean
Is the variable secure or sensitive ?.
source String
Source of this meta-data.
type String
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

SchematicsActionSetting
, SchematicsActionSettingArgs

Link string
Reference link to the variable value By default the expression will point to self.value.
Metadatas List<SchematicsActionSettingMetadata>
User editable metadata for the variables. Nested scheme for metadata:
Name string
Name of the variable.
Value string
Value for the variable or reference to the value.
Link string
Reference link to the variable value By default the expression will point to self.value.
Metadatas []SchematicsActionSettingMetadata
User editable metadata for the variables. Nested scheme for metadata:
Name string
Name of the variable.
Value string
Value for the variable or reference to the value.
link String
Reference link to the variable value By default the expression will point to self.value.
metadatas List<SchematicsActionSettingMetadata>
User editable metadata for the variables. Nested scheme for metadata:
name String
Name of the variable.
value String
Value for the variable or reference to the value.
link string
Reference link to the variable value By default the expression will point to self.value.
metadatas SchematicsActionSettingMetadata[]
User editable metadata for the variables. Nested scheme for metadata:
name string
Name of the variable.
value string
Value for the variable or reference to the value.
link str
Reference link to the variable value By default the expression will point to self.value.
metadatas Sequence[SchematicsActionSettingMetadata]
User editable metadata for the variables. Nested scheme for metadata:
name str
Name of the variable.
value str
Value for the variable or reference to the value.
link String
Reference link to the variable value By default the expression will point to self.value.
metadatas List<Property Map>
User editable metadata for the variables. Nested scheme for metadata:
name String
Name of the variable.
value String
Value for the variable or reference to the value.

SchematicsActionSettingMetadata
, SchematicsActionSettingMetadataArgs

Aliases List<string>
List of aliases for the variable name.
DefaultValue string
Default value for the variable, if the override value is not specified.
Description string
Description of the meta data.
GroupBy string
Display name of the group this variable belongs to.
Hidden bool
If true, the variable will not be displayed on UI or CLI.
Immutable bool
Is the variable readonly ?.
Matches string
Regex for the variable value.
MaxLength double
Maximum length of the variable value. Applicable for string type.
MaxValue double
Maximum value of the variable. Applicable for integer type.
MinLength double
Minimum length of the variable value. Applicable for string type.
MinValue double
Minimum value of the variable. Applicable for integer type.
Options List<string>
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
Position double
Relative position of this variable in a list.
Secure bool
Is the variable secure or sensitive ?.
Source string
Source of this meta-data.
Type string
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
Aliases []string
List of aliases for the variable name.
DefaultValue string
Default value for the variable, if the override value is not specified.
Description string
Description of the meta data.
GroupBy string
Display name of the group this variable belongs to.
Hidden bool
If true, the variable will not be displayed on UI or CLI.
Immutable bool
Is the variable readonly ?.
Matches string
Regex for the variable value.
MaxLength float64
Maximum length of the variable value. Applicable for string type.
MaxValue float64
Maximum value of the variable. Applicable for integer type.
MinLength float64
Minimum length of the variable value. Applicable for string type.
MinValue float64
Minimum value of the variable. Applicable for integer type.
Options []string
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
Position float64
Relative position of this variable in a list.
Secure bool
Is the variable secure or sensitive ?.
Source string
Source of this meta-data.
Type string
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases List<String>
List of aliases for the variable name.
defaultValue String
Default value for the variable, if the override value is not specified.
description String
Description of the meta data.
groupBy String
Display name of the group this variable belongs to.
hidden Boolean
If true, the variable will not be displayed on UI or CLI.
immutable Boolean
Is the variable readonly ?.
matches String
Regex for the variable value.
maxLength Double
Maximum length of the variable value. Applicable for string type.
maxValue Double
Maximum value of the variable. Applicable for integer type.
minLength Double
Minimum length of the variable value. Applicable for string type.
minValue Double
Minimum value of the variable. Applicable for integer type.
options List<String>
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position Double
Relative position of this variable in a list.
secure Boolean
Is the variable secure or sensitive ?.
source String
Source of this meta-data.
type String
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases string[]
List of aliases for the variable name.
defaultValue string
Default value for the variable, if the override value is not specified.
description string
Description of the meta data.
groupBy string
Display name of the group this variable belongs to.
hidden boolean
If true, the variable will not be displayed on UI or CLI.
immutable boolean
Is the variable readonly ?.
matches string
Regex for the variable value.
maxLength number
Maximum length of the variable value. Applicable for string type.
maxValue number
Maximum value of the variable. Applicable for integer type.
minLength number
Minimum length of the variable value. Applicable for string type.
minValue number
Minimum value of the variable. Applicable for integer type.
options string[]
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position number
Relative position of this variable in a list.
secure boolean
Is the variable secure or sensitive ?.
source string
Source of this meta-data.
type string
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases Sequence[str]
List of aliases for the variable name.
default_value str
Default value for the variable, if the override value is not specified.
description str
Description of the meta data.
group_by str
Display name of the group this variable belongs to.
hidden bool
If true, the variable will not be displayed on UI or CLI.
immutable bool
Is the variable readonly ?.
matches str
Regex for the variable value.
max_length float
Maximum length of the variable value. Applicable for string type.
max_value float
Maximum value of the variable. Applicable for integer type.
min_length float
Minimum length of the variable value. Applicable for string type.
min_value float
Minimum value of the variable. Applicable for integer type.
options Sequence[str]
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position float
Relative position of this variable in a list.
secure bool
Is the variable secure or sensitive ?.
source str
Source of this meta-data.
type str
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex
aliases List<String>
List of aliases for the variable name.
defaultValue String
Default value for the variable, if the override value is not specified.
description String
Description of the meta data.
groupBy String
Display name of the group this variable belongs to.
hidden Boolean
If true, the variable will not be displayed on UI or CLI.
immutable Boolean
Is the variable readonly ?.
matches String
Regex for the variable value.
maxLength Number
Maximum length of the variable value. Applicable for string type.
maxValue Number
Maximum value of the variable. Applicable for integer type.
minLength Number
Minimum length of the variable value. Applicable for string type.
minValue Number
Minimum value of the variable. Applicable for integer type.
options List<String>
List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.
position Number
Relative position of this variable in a list.
secure Boolean
Is the variable secure or sensitive ?.
source String
Source of this meta-data.
type String
Type of the variable.

  • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

SchematicsActionSource
, SchematicsActionSourceArgs

SourceType This property is required. string
Type of source for the Template.

  • Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket
Catalog SchematicsActionSourceCatalog
Connection details to IBM Cloud Catalog source. MaxItems:1. Nested scheme for catalog:
Gits List<SchematicsActionSourceGit>
Connection details to Git source. Nested scheme for git:
SourceType This property is required. string
Type of source for the Template.

  • Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket
Catalog SchematicsActionSourceCatalog
Connection details to IBM Cloud Catalog source. MaxItems:1. Nested scheme for catalog:
Gits []SchematicsActionSourceGit
Connection details to Git source. Nested scheme for git:
sourceType This property is required. String
Type of source for the Template.

  • Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket
catalog SchematicsActionSourceCatalog
Connection details to IBM Cloud Catalog source. MaxItems:1. Nested scheme for catalog:
gits List<SchematicsActionSourceGit>
Connection details to Git source. Nested scheme for git:
sourceType This property is required. string
Type of source for the Template.

  • Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket
catalog SchematicsActionSourceCatalog
Connection details to IBM Cloud Catalog source. MaxItems:1. Nested scheme for catalog:
gits SchematicsActionSourceGit[]
Connection details to Git source. Nested scheme for git:
source_type This property is required. str
Type of source for the Template.

  • Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket
catalog SchematicsActionSourceCatalog
Connection details to IBM Cloud Catalog source. MaxItems:1. Nested scheme for catalog:
gits Sequence[SchematicsActionSourceGit]
Connection details to Git source. Nested scheme for git:
sourceType This property is required. String
Type of source for the Template.

  • Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket
catalog Property Map
Connection details to IBM Cloud Catalog source. MaxItems:1. Nested scheme for catalog:
gits List<Property Map>
Connection details to Git source. Nested scheme for git:

SchematicsActionSourceCatalog
, SchematicsActionSourceCatalogArgs

CatalogName string
name of the private catalog.
OfferingId string
Id of the offering the IBM Catalog.
OfferingKind string
Type of the offering, in the IBM Catalog.
OfferingName string
Name of the offering in the IBM Catalog.
OfferingRepoUrl string
Repo Url of the offering, in the IBM Catalog.
OfferingVersion string
Version string of the offering in the IBM Catalog.
OfferingVersionId string
Id of the offering version the IBM Catalog.
CatalogName string
name of the private catalog.
OfferingId string
Id of the offering the IBM Catalog.
OfferingKind string
Type of the offering, in the IBM Catalog.
OfferingName string
Name of the offering in the IBM Catalog.
OfferingRepoUrl string
Repo Url of the offering, in the IBM Catalog.
OfferingVersion string
Version string of the offering in the IBM Catalog.
OfferingVersionId string
Id of the offering version the IBM Catalog.
catalogName String
name of the private catalog.
offeringId String
Id of the offering the IBM Catalog.
offeringKind String
Type of the offering, in the IBM Catalog.
offeringName String
Name of the offering in the IBM Catalog.
offeringRepoUrl String
Repo Url of the offering, in the IBM Catalog.
offeringVersion String
Version string of the offering in the IBM Catalog.
offeringVersionId String
Id of the offering version the IBM Catalog.
catalogName string
name of the private catalog.
offeringId string
Id of the offering the IBM Catalog.
offeringKind string
Type of the offering, in the IBM Catalog.
offeringName string
Name of the offering in the IBM Catalog.
offeringRepoUrl string
Repo Url of the offering, in the IBM Catalog.
offeringVersion string
Version string of the offering in the IBM Catalog.
offeringVersionId string
Id of the offering version the IBM Catalog.
catalog_name str
name of the private catalog.
offering_id str
Id of the offering the IBM Catalog.
offering_kind str
Type of the offering, in the IBM Catalog.
offering_name str
Name of the offering in the IBM Catalog.
offering_repo_url str
Repo Url of the offering, in the IBM Catalog.
offering_version str
Version string of the offering in the IBM Catalog.
offering_version_id str
Id of the offering version the IBM Catalog.
catalogName String
name of the private catalog.
offeringId String
Id of the offering the IBM Catalog.
offeringKind String
Type of the offering, in the IBM Catalog.
offeringName String
Name of the offering in the IBM Catalog.
offeringRepoUrl String
Repo Url of the offering, in the IBM Catalog.
offeringVersion String
Version string of the offering in the IBM Catalog.
offeringVersionId String
Id of the offering version the IBM Catalog.

SchematicsActionSourceGit
, SchematicsActionSourceGitArgs

ComputedGitRepoUrl string
The Complete URL which is computed by git_repo_url, git_repo_folder and branch.
GitBranch string
Name of the branch, used to fetch the Git Repo.
GitRelease string
Name of the release tag, used to fetch the Git Repo.
GitRepoFolder string
Name of the folder in the Git Repo, that contains the template.
GitRepoUrl string
URL to the GIT Repo that can be used to clone the template.
GitToken string
Personal Access Token to connect to Git URLs.
ComputedGitRepoUrl string
The Complete URL which is computed by git_repo_url, git_repo_folder and branch.
GitBranch string
Name of the branch, used to fetch the Git Repo.
GitRelease string
Name of the release tag, used to fetch the Git Repo.
GitRepoFolder string
Name of the folder in the Git Repo, that contains the template.
GitRepoUrl string
URL to the GIT Repo that can be used to clone the template.
GitToken string
Personal Access Token to connect to Git URLs.
computedGitRepoUrl String
The Complete URL which is computed by git_repo_url, git_repo_folder and branch.
gitBranch String
Name of the branch, used to fetch the Git Repo.
gitRelease String
Name of the release tag, used to fetch the Git Repo.
gitRepoFolder String
Name of the folder in the Git Repo, that contains the template.
gitRepoUrl String
URL to the GIT Repo that can be used to clone the template.
gitToken String
Personal Access Token to connect to Git URLs.
computedGitRepoUrl string
The Complete URL which is computed by git_repo_url, git_repo_folder and branch.
gitBranch string
Name of the branch, used to fetch the Git Repo.
gitRelease string
Name of the release tag, used to fetch the Git Repo.
gitRepoFolder string
Name of the folder in the Git Repo, that contains the template.
gitRepoUrl string
URL to the GIT Repo that can be used to clone the template.
gitToken string
Personal Access Token to connect to Git URLs.
computed_git_repo_url str
The Complete URL which is computed by git_repo_url, git_repo_folder and branch.
git_branch str
Name of the branch, used to fetch the Git Repo.
git_release str
Name of the release tag, used to fetch the Git Repo.
git_repo_folder str
Name of the folder in the Git Repo, that contains the template.
git_repo_url str
URL to the GIT Repo that can be used to clone the template.
git_token str
Personal Access Token to connect to Git URLs.
computedGitRepoUrl String
The Complete URL which is computed by git_repo_url, git_repo_folder and branch.
gitBranch String
Name of the branch, used to fetch the Git Repo.
gitRelease String
Name of the release tag, used to fetch the Git Repo.
gitRepoFolder String
Name of the folder in the Git Repo, that contains the template.
gitRepoUrl String
URL to the GIT Repo that can be used to clone the template.
gitToken String
Personal Access Token to connect to Git URLs.

SchematicsActionState
, SchematicsActionStateArgs

StatusCode This property is required. string
(String) Status of automation (workspace or action).

  • Constraints: Allowable values are: normal, pending, disabled, critical
StatusJobId This property is required. string
(String) Job id reference for this status.
StatusMessage This property is required. string
(String) Automation status message - to be displayed along with the status_code.
StatusCode This property is required. string
(String) Status of automation (workspace or action).

  • Constraints: Allowable values are: normal, pending, disabled, critical
StatusJobId This property is required. string
(String) Job id reference for this status.
StatusMessage This property is required. string
(String) Automation status message - to be displayed along with the status_code.
statusCode This property is required. String
(String) Status of automation (workspace or action).

  • Constraints: Allowable values are: normal, pending, disabled, critical
statusJobId This property is required. String
(String) Job id reference for this status.
statusMessage This property is required. String
(String) Automation status message - to be displayed along with the status_code.
statusCode This property is required. string
(String) Status of automation (workspace or action).

  • Constraints: Allowable values are: normal, pending, disabled, critical
statusJobId This property is required. string
(String) Job id reference for this status.
statusMessage This property is required. string
(String) Automation status message - to be displayed along with the status_code.
status_code This property is required. str
(String) Status of automation (workspace or action).

  • Constraints: Allowable values are: normal, pending, disabled, critical
status_job_id This property is required. str
(String) Job id reference for this status.
status_message This property is required. str
(String) Automation status message - to be displayed along with the status_code.
statusCode This property is required. String
(String) Status of automation (workspace or action).

  • Constraints: Allowable values are: normal, pending, disabled, critical
statusJobId This property is required. String
(String) Job id reference for this status.
statusMessage This property is required. String
(String) Automation status message - to be displayed along with the status_code.

SchematicsActionSysLock
, SchematicsActionSysLockArgs

SysLocked This property is required. bool
(Boolean) Is the automation locked by a Schematic job ?.
SysLockedAt This property is required. string
(String) When the User performed the job that lead to locking of the automation ?.
SysLockedBy This property is required. string
(String) Name of the User who performed the job, that lead to the locking of the automation.
SysLocked This property is required. bool
(Boolean) Is the automation locked by a Schematic job ?.
SysLockedAt This property is required. string
(String) When the User performed the job that lead to locking of the automation ?.
SysLockedBy This property is required. string
(String) Name of the User who performed the job, that lead to the locking of the automation.
sysLocked This property is required. Boolean
(Boolean) Is the automation locked by a Schematic job ?.
sysLockedAt This property is required. String
(String) When the User performed the job that lead to locking of the automation ?.
sysLockedBy This property is required. String
(String) Name of the User who performed the job, that lead to the locking of the automation.
sysLocked This property is required. boolean
(Boolean) Is the automation locked by a Schematic job ?.
sysLockedAt This property is required. string
(String) When the User performed the job that lead to locking of the automation ?.
sysLockedBy This property is required. string
(String) Name of the User who performed the job, that lead to the locking of the automation.
sys_locked This property is required. bool
(Boolean) Is the automation locked by a Schematic job ?.
sys_locked_at This property is required. str
(String) When the User performed the job that lead to locking of the automation ?.
sys_locked_by This property is required. str
(String) Name of the User who performed the job, that lead to the locking of the automation.
sysLocked This property is required. Boolean
(Boolean) Is the automation locked by a Schematic job ?.
sysLockedAt This property is required. String
(String) When the User performed the job that lead to locking of the automation ?.
sysLockedBy This property is required. String
(String) Name of the User who performed the job, that lead to the locking of the automation.

SchematicsActionUserState
, SchematicsActionUserStateArgs

SetAt string
When the User who set the state of the Object.
SetBy string
Name of the User who set the state of the Object.
State string
User-defined states * draft Object can be modified; can be used by Jobs run by the author, during execution * live Object can be modified; can be used by Jobs during execution * locked Object cannot be modified; can be used by Jobs during execution * disable Object can be modified. cannot be used by Jobs during execution.

  • Constraints: Allowable values are: draft, live, locked, disable
SetAt string
When the User who set the state of the Object.
SetBy string
Name of the User who set the state of the Object.
State string
User-defined states * draft Object can be modified; can be used by Jobs run by the author, during execution * live Object can be modified; can be used by Jobs during execution * locked Object cannot be modified; can be used by Jobs during execution * disable Object can be modified. cannot be used by Jobs during execution.

  • Constraints: Allowable values are: draft, live, locked, disable
setAt String
When the User who set the state of the Object.
setBy String
Name of the User who set the state of the Object.
state String
User-defined states * draft Object can be modified; can be used by Jobs run by the author, during execution * live Object can be modified; can be used by Jobs during execution * locked Object cannot be modified; can be used by Jobs during execution * disable Object can be modified. cannot be used by Jobs during execution.

  • Constraints: Allowable values are: draft, live, locked, disable
setAt string
When the User who set the state of the Object.
setBy string
Name of the User who set the state of the Object.
state string
User-defined states * draft Object can be modified; can be used by Jobs run by the author, during execution * live Object can be modified; can be used by Jobs during execution * locked Object cannot be modified; can be used by Jobs during execution * disable Object can be modified. cannot be used by Jobs during execution.

  • Constraints: Allowable values are: draft, live, locked, disable
set_at str
When the User who set the state of the Object.
set_by str
Name of the User who set the state of the Object.
state str
User-defined states * draft Object can be modified; can be used by Jobs run by the author, during execution * live Object can be modified; can be used by Jobs during execution * locked Object cannot be modified; can be used by Jobs during execution * disable Object can be modified. cannot be used by Jobs during execution.

  • Constraints: Allowable values are: draft, live, locked, disable
setAt String
When the User who set the state of the Object.
setBy String
Name of the User who set the state of the Object.
state String
User-defined states * draft Object can be modified; can be used by Jobs run by the author, during execution * live Object can be modified; can be used by Jobs during execution * locked Object cannot be modified; can be used by Jobs during execution * disable Object can be modified. cannot be used by Jobs during execution.

  • Constraints: Allowable values are: draft, live, locked, disable

Import

You can import the ibm_schematics_action resource by using id. Action ID.

Syntax

$ pulumi import ibm:index/schematicsAction:SchematicsAction schematics_action <id>
Copy

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

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm