Docs Home
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm.SchematicsAction
Explore with Pulumi AI
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",
});
import pulumi
import pulumi_ibm as ibm
schematics_action = ibm.SchematicsAction("schematicsAction",
description="<action_description>",
location="us-east",
resource_group="default")
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
})
}
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",
});
});
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());
}
}
resources:
schematicsAction:
type: ibm:SchematicsAction
properties:
description: <action_description>
location: us-east
resourceGroup: default
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 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 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 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 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 String
- The unique name of the resource.
- args 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",
});
example, err := ibm.NewSchematicsAction(ctx, "schematicsActionResource", &ibm.SchematicsActionArgs{
ActionInputs: ibm.SchematicsActionActionInputArray{
&ibm.SchematicsActionActionInputArgs{
Link: pulumi.String("string"),
Metadatas: ibm.SchematicsActionActionInputMetadataArray{
&ibm.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: ibm.SchematicsActionActionOutputArray{
ibm.SchematicsActionActionOutputArgs{
Link: pulumi.String("string"),
Metadatas: ibm.SchematicsActionActionOutputMetadataArray{
&ibm.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: &ibm.SchematicsActionBastionArgs{
Host: pulumi.String("string"),
Name: pulumi.String("string"),
},
BastionCredential: &ibm.SchematicsActionBastionCredentialArgs{
Link: pulumi.String("string"),
Metadatas: ibm.SchematicsActionBastionCredentialMetadataArray{
&ibm.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: &ibm.SchematicsActionCredentialsArgs{
Link: pulumi.String("string"),
Metadatas: ibm.SchematicsActionCredentialsMetadataArray{
&ibm.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: ibm.SchematicsActionSettingArray{
&ibm.SchematicsActionSettingArgs{
Link: pulumi.String("string"),
Metadatas: ibm.SchematicsActionSettingMetadataArray{
&ibm.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: ibm.SchematicsActionSourceArray{
&ibm.SchematicsActionSourceArgs{
SourceType: pulumi.String("string"),
Catalog: &ibm.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: ibm.SchematicsActionSourceGitArray{
&ibm.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: ibm.SchematicsActionUserStateArray{
&ibm.SchematicsActionUserStateArgs{
SetAt: pulumi.String("string"),
SetBy: pulumi.String("string"),
State: pulumi.String("string"),
},
},
XGithubToken: pulumi.String("string"),
})
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());
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")
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",
});
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
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:
- Action
Inputs List<SchematicsAction Action Input> - Input variables for the Action. Nested scheme for action_inputs:
- Action
Outputs List<SchematicsAction Action Output> - Output variables for the Action. Nested scheme for action_outputs:
- Bastion
Schematics
Action Bastion - Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
- Bastion
Credential SchematicsAction Bastion Credential - User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
- Command
Parameter string - Schematics job command parameter (playbook-name).
- Credentials
Schematics
Action Credentials - 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.
- Resource
Group string - Resource-group name for an action. By default, action is created in default resource group.
- Schematics
Action stringId - The unique identifier of the schematics_action.
- Settings
List<Schematics
Action Setting> - Environment variables for the Action. Nested scheme for settings:
- Source
Readme stringUrl - URL of the
READMEfile, for the source URL. - Source
Type 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<Schematics
Action Source> - Source of templates, playbooks, or controls. Nested scheme for source:
- List<string>
- Action tags.
- Targets
Ini string - Inventory of host and host group for the playbook in
INIfile 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 List<SchematicsAction User State> - User defined status of the Schematics object. Nested scheme for user_state:
- XGithub
Token string
- Action
Inputs []SchematicsAction Action Input Args - Input variables for the Action. Nested scheme for action_inputs:
- Action
Outputs []SchematicsAction Action Output Args - Output variables for the Action. Nested scheme for action_outputs:
- Bastion
Schematics
Action Bastion Args - Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
- Bastion
Credential SchematicsAction Bastion Credential Args - User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
- Command
Parameter string - Schematics job command parameter (playbook-name).
- Credentials
Schematics
Action Credentials Args - 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.
- Resource
Group string - Resource-group name for an action. By default, action is created in default resource group.
- Schematics
Action stringId - The unique identifier of the schematics_action.
- Settings
[]Schematics
Action Setting Args - Environment variables for the Action. Nested scheme for settings:
- Source
Readme stringUrl - URL of the
READMEfile, for the source URL. - Source
Type 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
[]Schematics
Action Source Args - Source of templates, playbooks, or controls. Nested scheme for source:
- []string
- Action tags.
- Targets
Ini string - Inventory of host and host group for the playbook in
INIfile 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 []SchematicsAction User State Args - User defined status of the Schematics object. Nested scheme for user_state:
- XGithub
Token string
- action
Inputs List<SchematicsAction Action Input> - Input variables for the Action. Nested scheme for action_inputs:
- action
Outputs List<SchematicsAction Action Output> - Output variables for the Action. Nested scheme for action_outputs:
- bastion
Schematics
Action Bastion - Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
- bastion
Credential SchematicsAction Bastion Credential - User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
- command
Parameter String - Schematics job command parameter (playbook-name).
- credentials
Schematics
Action Credentials - 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.
- resource
Group String - Resource-group name for an action. By default, action is created in default resource group.
- schematics
Action StringId - The unique identifier of the schematics_action.
- settings
List<Schematics
Action Setting> - Environment variables for the Action. Nested scheme for settings:
- source
Readme StringUrl - URL of the
READMEfile, for the source URL. - source
Type 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<Schematics
Action Source> - Source of templates, playbooks, or controls. Nested scheme for source:
- List<String>
- Action tags.
- targets
Ini String - Inventory of host and host group for the playbook in
INIfile 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 List<SchematicsAction User State> - User defined status of the Schematics object. Nested scheme for user_state:
- x
Github StringToken
- action
Inputs SchematicsAction Action Input[] - Input variables for the Action. Nested scheme for action_inputs:
- action
Outputs SchematicsAction Action Output[] - Output variables for the Action. Nested scheme for action_outputs:
- bastion
Schematics
Action Bastion - Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
- bastion
Credential SchematicsAction Bastion Credential - User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
- command
Parameter string - Schematics job command parameter (playbook-name).
- credentials
Schematics
Action Credentials - 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.
- resource
Group string - Resource-group name for an action. By default, action is created in default resource group.
- schematics
Action stringId - The unique identifier of the schematics_action.
- settings
Schematics
Action Setting[] - Environment variables for the Action. Nested scheme for settings:
- source
Readme stringUrl - URL of the
READMEfile, for the source URL. - source
Type 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
Schematics
Action Source[] - Source of templates, playbooks, or controls. Nested scheme for source:
- string[]
- Action tags.
- targets
Ini string - Inventory of host and host group for the playbook in
INIfile 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 SchematicsAction User State[] - User defined status of the Schematics object. Nested scheme for user_state:
- x
Github stringToken
- action_
inputs Sequence[SchematicsAction Action Input Args] - Input variables for the Action. Nested scheme for action_inputs:
- action_
outputs Sequence[SchematicsAction Action Output Args] - Output variables for the Action. Nested scheme for action_outputs:
- bastion
Schematics
Action Bastion Args - Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
- bastion_
credential SchematicsAction Bastion Credential Args - 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
Schematics
Action Credentials Args - 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_ strid - The unique identifier of the schematics_action.
- settings
Sequence[Schematics
Action Setting Args] - Environment variables for the Action. Nested scheme for settings:
- source_
readme_ strurl - URL of the
READMEfile, 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[Schematics
Action Source Args] - Source of templates, playbooks, or controls. Nested scheme for source:
- Sequence[str]
- Action tags.
- targets_
ini str - Inventory of host and host group for the playbook in
INIfile 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[SchematicsAction User State Args] - User defined status of the Schematics object. Nested scheme for user_state:
- x_
github_ strtoken
- action
Inputs List<Property Map> - Input variables for the Action. Nested scheme for action_inputs:
- action
Outputs 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:
- bastion
Credential Property Map - User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
- command
Parameter 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.
- resource
Group String - Resource-group name for an action. By default, action is created in default resource group.
- schematics
Action StringId - The unique identifier of the schematics_action.
- settings List<Property Map>
- Environment variables for the Action. Nested scheme for settings:
- source
Readme StringUrl - URL of the
READMEfile, for the source URL. - source
Type 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:
- List<String>
- Action tags.
- targets
Ini String - Inventory of host and host group for the playbook in
INIfile 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 List<Property Map> - User defined status of the Schematics object. Nested scheme for user_state:
- x
Github StringToken
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.
- Created
At string - (String) Action creation time.
- Created
By 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.
- Playbook
Names List<string> - (Optional, List) Playbook names retrieved from the respository.
- Source
Created stringAt - (String) Action Playbook Source creation time.
- Source
Created stringBy - (String) E-mail address of user who created the Action Playbook Source.
- Source
Updated stringAt - (String) The action playbook updation time.
- Source
Updated stringBy - (String) E-mail address of user who updated the action playbook source.
- States
List<Schematics
Action State> - (List) Computed state of the Action. Nested scheme for state:
- Sys
Locks List<SchematicsAction Sys Lock> - (List) System lock status. Nested scheme for sys_lock:
- Updated
At string - (String) Action updation time.
- Updated
By string - (String) E-mail address of the user who updated an action.
- Account string
- (Optional, String) Action account ID.
- Created
At string - (String) Action creation time.
- Created
By 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.
- Playbook
Names []string - (Optional, List) Playbook names retrieved from the respository.
- Source
Created stringAt - (String) Action Playbook Source creation time.
- Source
Created stringBy - (String) E-mail address of user who created the Action Playbook Source.
- Source
Updated stringAt - (String) The action playbook updation time.
- Source
Updated stringBy - (String) E-mail address of user who updated the action playbook source.
- States
[]Schematics
Action State Type - (List) Computed state of the Action. Nested scheme for state:
- Sys
Locks []SchematicsAction Sys Lock - (List) System lock status. Nested scheme for sys_lock:
- Updated
At string - (String) Action updation time.
- Updated
By string - (String) E-mail address of the user who updated an action.
- account String
- (Optional, String) Action account ID.
- created
At String - (String) Action creation time.
- created
By 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.
- playbook
Names List<String> - (Optional, List) Playbook names retrieved from the respository.
- source
Created StringAt - (String) Action Playbook Source creation time.
- source
Created StringBy - (String) E-mail address of user who created the Action Playbook Source.
- source
Updated StringAt - (String) The action playbook updation time.
- source
Updated StringBy - (String) E-mail address of user who updated the action playbook source.
- states
List<Schematics
Action State> - (List) Computed state of the Action. Nested scheme for state:
- sys
Locks List<SchematicsAction Sys Lock> - (List) System lock status. Nested scheme for sys_lock:
- updated
At String - (String) Action updation time.
- updated
By String - (String) E-mail address of the user who updated an action.
- account string
- (Optional, String) Action account ID.
- created
At string - (String) Action creation time.
- created
By 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.
- playbook
Names string[] - (Optional, List) Playbook names retrieved from the respository.
- source
Created stringAt - (String) Action Playbook Source creation time.
- source
Created stringBy - (String) E-mail address of user who created the Action Playbook Source.
- source
Updated stringAt - (String) The action playbook updation time.
- source
Updated stringBy - (String) E-mail address of user who updated the action playbook source.
- states
Schematics
Action State[] - (List) Computed state of the Action. Nested scheme for state:
- sys
Locks SchematicsAction Sys Lock[] - (List) System lock status. Nested scheme for sys_lock:
- updated
At string - (String) Action updation time.
- updated
By 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_ strat - (String) Action Playbook Source creation time.
- source_
created_ strby - (String) E-mail address of user who created the Action Playbook Source.
- source_
updated_ strat - (String) The action playbook updation time.
- source_
updated_ strby - (String) E-mail address of user who updated the action playbook source.
- states
Sequence[Schematics
Action State] - (List) Computed state of the Action. Nested scheme for state:
- sys_
locks Sequence[SchematicsAction Sys Lock] - (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.
- created
At String - (String) Action creation time.
- created
By 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.
- playbook
Names List<String> - (Optional, List) Playbook names retrieved from the respository.
- source
Created StringAt - (String) Action Playbook Source creation time.
- source
Created StringBy - (String) E-mail address of user who created the Action Playbook Source.
- source
Updated StringAt - (String) The action playbook updation time.
- source
Updated StringBy - (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:
- sys
Locks List<Property Map> - (List) System lock status. Nested scheme for sys_lock:
- updated
At String - (String) Action updation time.
- updated
By 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) -> SchematicsActionfunc 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Account string
- (Optional, String) Action account ID.
- Action
Inputs List<SchematicsAction Action Input> - Input variables for the Action. Nested scheme for action_inputs:
- Action
Outputs List<SchematicsAction Action Output> - Output variables for the Action. Nested scheme for action_outputs:
- Bastion
Schematics
Action Bastion - Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
- Bastion
Credential SchematicsAction Bastion Credential - User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
- Command
Parameter string - Schematics job command parameter (playbook-name).
- Created
At string - (String) Action creation time.
- Created
By string - (String) E-mail address of the user who created an action.
- Credentials
Schematics
Action Credentials - 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.
- Playbook
Names List<string> - (Optional, List) Playbook names retrieved from the respository.
- Resource
Group string - Resource-group name for an action. By default, action is created in default resource group.
- Schematics
Action stringId - The unique identifier of the schematics_action.
- Settings
List<Schematics
Action Setting> - Environment variables for the Action. Nested scheme for settings:
- Source
Created stringAt - (String) Action Playbook Source creation time.
- Source
Created stringBy - (String) E-mail address of user who created the Action Playbook Source.
- Source
Readme stringUrl - URL of the
READMEfile, for the source URL. - Source
Type 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
- Source
Updated stringAt - (String) The action playbook updation time.
- Source
Updated stringBy - (String) E-mail address of user who updated the action playbook source.
- Sources
List<Schematics
Action Source> - Source of templates, playbooks, or controls. Nested scheme for source:
- States
List<Schematics
Action State> - (List) Computed state of the Action. Nested scheme for state:
- Sys
Locks List<SchematicsAction Sys Lock> - (List) System lock status. Nested scheme for sys_lock:
- List<string>
- Action tags.
- Targets
Ini string - Inventory of host and host group for the playbook in
INIfile 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 string - (String) Action updation time.
- Updated
By string - (String) E-mail address of the user who updated an action.
- User
States List<SchematicsAction User State> - User defined status of the Schematics object. Nested scheme for user_state:
- XGithub
Token string
- Account string
- (Optional, String) Action account ID.
- Action
Inputs []SchematicsAction Action Input Args - Input variables for the Action. Nested scheme for action_inputs:
- Action
Outputs []SchematicsAction Action Output Args - Output variables for the Action. Nested scheme for action_outputs:
- Bastion
Schematics
Action Bastion Args - Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
- Bastion
Credential SchematicsAction Bastion Credential Args - User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
- Command
Parameter string - Schematics job command parameter (playbook-name).
- Created
At string - (String) Action creation time.
- Created
By string - (String) E-mail address of the user who created an action.
- Credentials
Schematics
Action Credentials Args - 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.
- Playbook
Names []string - (Optional, List) Playbook names retrieved from the respository.
- Resource
Group string - Resource-group name for an action. By default, action is created in default resource group.
- Schematics
Action stringId - The unique identifier of the schematics_action.
- Settings
[]Schematics
Action Setting Args - Environment variables for the Action. Nested scheme for settings:
- Source
Created stringAt - (String) Action Playbook Source creation time.
- Source
Created stringBy - (String) E-mail address of user who created the Action Playbook Source.
- Source
Readme stringUrl - URL of the
READMEfile, for the source URL. - Source
Type 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
- Source
Updated stringAt - (String) The action playbook updation time.
- Source
Updated stringBy - (String) E-mail address of user who updated the action playbook source.
- Sources
[]Schematics
Action Source Args - Source of templates, playbooks, or controls. Nested scheme for source:
- States
[]Schematics
Action State Type Args - (List) Computed state of the Action. Nested scheme for state:
- Sys
Locks []SchematicsAction Sys Lock Args - (List) System lock status. Nested scheme for sys_lock:
- []string
- Action tags.
- Targets
Ini string - Inventory of host and host group for the playbook in
INIfile 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 string - (String) Action updation time.
- Updated
By string - (String) E-mail address of the user who updated an action.
- User
States []SchematicsAction User State Args - User defined status of the Schematics object. Nested scheme for user_state:
- XGithub
Token string
- account String
- (Optional, String) Action account ID.
- action
Inputs List<SchematicsAction Action Input> - Input variables for the Action. Nested scheme for action_inputs:
- action
Outputs List<SchematicsAction Action Output> - Output variables for the Action. Nested scheme for action_outputs:
- bastion
Schematics
Action Bastion - Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
- bastion
Credential SchematicsAction Bastion Credential - User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
- command
Parameter String - Schematics job command parameter (playbook-name).
- created
At String - (String) Action creation time.
- created
By String - (String) E-mail address of the user who created an action.
- credentials
Schematics
Action Credentials - 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.
- playbook
Names List<String> - (Optional, List) Playbook names retrieved from the respository.
- resource
Group String - Resource-group name for an action. By default, action is created in default resource group.
- schematics
Action StringId - The unique identifier of the schematics_action.
- settings
List<Schematics
Action Setting> - Environment variables for the Action. Nested scheme for settings:
- source
Created StringAt - (String) Action Playbook Source creation time.
- source
Created StringBy - (String) E-mail address of user who created the Action Playbook Source.
- source
Readme StringUrl - URL of the
READMEfile, for the source URL. - source
Type 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
- source
Updated StringAt - (String) The action playbook updation time.
- source
Updated StringBy - (String) E-mail address of user who updated the action playbook source.
- sources
List<Schematics
Action Source> - Source of templates, playbooks, or controls. Nested scheme for source:
- states
List<Schematics
Action State> - (List) Computed state of the Action. Nested scheme for state:
- sys
Locks List<SchematicsAction Sys Lock> - (List) System lock status. Nested scheme for sys_lock:
- List<String>
- Action tags.
- targets
Ini String - Inventory of host and host group for the playbook in
INIfile 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 String - (String) Action updation time.
- updated
By String - (String) E-mail address of the user who updated an action.
- user
States List<SchematicsAction User State> - User defined status of the Schematics object. Nested scheme for user_state:
- x
Github StringToken
- account string
- (Optional, String) Action account ID.
- action
Inputs SchematicsAction Action Input[] - Input variables for the Action. Nested scheme for action_inputs:
- action
Outputs SchematicsAction Action Output[] - Output variables for the Action. Nested scheme for action_outputs:
- bastion
Schematics
Action Bastion - Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
- bastion
Credential SchematicsAction Bastion Credential - User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
- command
Parameter string - Schematics job command parameter (playbook-name).
- created
At string - (String) Action creation time.
- created
By string - (String) E-mail address of the user who created an action.
- credentials
Schematics
Action Credentials - 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.
- playbook
Names string[] - (Optional, List) Playbook names retrieved from the respository.
- resource
Group string - Resource-group name for an action. By default, action is created in default resource group.
- schematics
Action stringId - The unique identifier of the schematics_action.
- settings
Schematics
Action Setting[] - Environment variables for the Action. Nested scheme for settings:
- source
Created stringAt - (String) Action Playbook Source creation time.
- source
Created stringBy - (String) E-mail address of user who created the Action Playbook Source.
- source
Readme stringUrl - URL of the
READMEfile, for the source URL. - source
Type 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
- source
Updated stringAt - (String) The action playbook updation time.
- source
Updated stringBy - (String) E-mail address of user who updated the action playbook source.
- sources
Schematics
Action Source[] - Source of templates, playbooks, or controls. Nested scheme for source:
- states
Schematics
Action State[] - (List) Computed state of the Action. Nested scheme for state:
- sys
Locks SchematicsAction Sys Lock[] - (List) System lock status. Nested scheme for sys_lock:
- string[]
- Action tags.
- targets
Ini string - Inventory of host and host group for the playbook in
INIfile 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 string - (String) Action updation time.
- updated
By string - (String) E-mail address of the user who updated an action.
- user
States SchematicsAction User State[] - User defined status of the Schematics object. Nested scheme for user_state:
- x
Github stringToken
- account str
- (Optional, String) Action account ID.
- action_
inputs Sequence[SchematicsAction Action Input Args] - Input variables for the Action. Nested scheme for action_inputs:
- action_
outputs Sequence[SchematicsAction Action Output Args] - Output variables for the Action. Nested scheme for action_outputs:
- bastion
Schematics
Action Bastion Args - Describes a bastion resource. MaxItems: 1. Nested scheme for bastion:
- bastion_
credential SchematicsAction Bastion Credential Args - 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
Schematics
Action Credentials Args - 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_ strid - The unique identifier of the schematics_action.
- settings
Sequence[Schematics
Action Setting Args] - Environment variables for the Action. Nested scheme for settings:
- source_
created_ strat - (String) Action Playbook Source creation time.
- source_
created_ strby - (String) E-mail address of user who created the Action Playbook Source.
- source_
readme_ strurl - URL of the
READMEfile, 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_ strat - (String) The action playbook updation time.
- source_
updated_ strby - (String) E-mail address of user who updated the action playbook source.
- sources
Sequence[Schematics
Action Source Args] - Source of templates, playbooks, or controls. Nested scheme for source:
- states
Sequence[Schematics
Action State Args] - (List) Computed state of the Action. Nested scheme for state:
- sys_
locks Sequence[SchematicsAction Sys Lock Args] - (List) System lock status. Nested scheme for sys_lock:
- Sequence[str]
- Action tags.
- targets_
ini str - Inventory of host and host group for the playbook in
INIfile 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[SchematicsAction User State Args] - User defined status of the Schematics object. Nested scheme for user_state:
- x_
github_ strtoken
- account String
- (Optional, String) Action account ID.
- action
Inputs List<Property Map> - Input variables for the Action. Nested scheme for action_inputs:
- action
Outputs 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:
- bastion
Credential Property Map - User editable variable data & system generated reference to value. MaxItems: 1 Nested scheme for bastion_credential:
- command
Parameter String - Schematics job command parameter (playbook-name).
- created
At String - (String) Action creation time.
- created
By 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.
- playbook
Names List<String> - (Optional, List) Playbook names retrieved from the respository.
- resource
Group String - Resource-group name for an action. By default, action is created in default resource group.
- schematics
Action StringId - The unique identifier of the schematics_action.
- settings List<Property Map>
- Environment variables for the Action. Nested scheme for settings:
- source
Created StringAt - (String) Action Playbook Source creation time.
- source
Created StringBy - (String) E-mail address of user who created the Action Playbook Source.
- source
Readme StringUrl - URL of the
READMEfile, for the source URL. - source
Type 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
- source
Updated StringAt - (String) The action playbook updation time.
- source
Updated StringBy - (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:
- sys
Locks List<Property Map> - (List) System lock status. Nested scheme for sys_lock:
- List<String>
- Action tags.
- targets
Ini String - Inventory of host and host group for the playbook in
INIfile 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 String - (String) Action updation time.
- updated
By String - (String) E-mail address of the user who updated an action.
- user
States List<Property Map> - User defined status of the Schematics object. Nested scheme for user_state:
- x
Github StringToken
Supporting Types
SchematicsActionActionInput, SchematicsActionActionInputArgs
- Link string
- Reference link to the variable value By default the expression will point to self.value.
- Metadatas
List<Schematics
Action Action Input Metadata> - 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
[]Schematics
Action Action Input Metadata - 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<Schematics
Action Action Input Metadata> - 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
Schematics
Action Action Input Metadata[] - 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[Schematics
Action Action Input Metadata] - 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.
- Default
Value string - Default value for the variable, if the override value is not specified.
- Description string
- Description of the meta data.
- Group
By string - Display name of the group this variable belongs to.
- 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.
- Max
Length double - Maximum length of the variable value. Applicable for string type.
- Max
Value double - Maximum value of the variable. Applicable for integer type.
- Min
Length double - Minimum length of the variable value. Applicable for string type.
- Min
Value 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.
- Default
Value string - Default value for the variable, if the override value is not specified.
- Description string
- Description of the meta data.
- Group
By string - Display name of the group this variable belongs to.
- 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.
- Max
Length float64 - Maximum length of the variable value. Applicable for string type.
- Max
Value float64 - Maximum value of the variable. Applicable for integer type.
- Min
Length float64 - Minimum length of the variable value. Applicable for string type.
- Min
Value 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.
- default
Value String - Default value for the variable, if the override value is not specified.
- description String
- Description of the meta data.
- group
By String - Display name of the group this variable belongs to.
- 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.
- max
Length Double - Maximum length of the variable value. Applicable for string type.
- max
Value Double - Maximum value of the variable. Applicable for integer type.
- min
Length Double - Minimum length of the variable value. Applicable for string type.
- min
Value 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.
- default
Value string - Default value for the variable, if the override value is not specified.
- description string
- Description of the meta data.
- group
By string - Display name of the group this variable belongs to.
- 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.
- max
Length number - Maximum length of the variable value. Applicable for string type.
- max
Value number - Maximum value of the variable. Applicable for integer type.
- min
Length number - Minimum length of the variable value. Applicable for string type.
- min
Value 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.
- 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.
- default
Value String - Default value for the variable, if the override value is not specified.
- description String
- Description of the meta data.
- group
By String - Display name of the group this variable belongs to.
- 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.
- max
Length Number - Maximum length of the variable value. Applicable for string type.
- max
Value Number - Maximum value of the variable. Applicable for integer type.
- min
Length Number - Minimum length of the variable value. Applicable for string type.
- min
Value 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<Schematics
Action Action Output Metadata> - 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
[]Schematics
Action Action Output Metadata - 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<Schematics
Action Action Output Metadata> - 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
Schematics
Action Action Output Metadata[] - 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[Schematics
Action Action Output Metadata] - 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.
- Default
Value string - Default value for the variable, if the override value is not specified.
- Description string
- Description of the meta data.
- Group
By string - Display name of the group this variable belongs to.
- 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.
- Max
Length double - Maximum length of the variable value. Applicable for string type.
- Max
Value double - Maximum value of the variable. Applicable for integer type.
- Min
Length double - Minimum length of the variable value. Applicable for string type.
- Min
Value 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.
- Default
Value string - Default value for the variable, if the override value is not specified.
- Description string
- Description of the meta data.
- Group
By string - Display name of the group this variable belongs to.
- 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.
- Max
Length float64 - Maximum length of the variable value. Applicable for string type.
- Max
Value float64 - Maximum value of the variable. Applicable for integer type.
- Min
Length float64 - Minimum length of the variable value. Applicable for string type.
- Min
Value 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.
- default
Value String - Default value for the variable, if the override value is not specified.
- description String
- Description of the meta data.
- group
By String - Display name of the group this variable belongs to.
- 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.
- max
Length Double - Maximum length of the variable value. Applicable for string type.
- max
Value Double - Maximum value of the variable. Applicable for integer type.
- min
Length Double - Minimum length of the variable value. Applicable for string type.
- min
Value 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.
- default
Value string - Default value for the variable, if the override value is not specified.
- description string
- Description of the meta data.
- group
By string - Display name of the group this variable belongs to.
- 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.
- max
Length number - Maximum length of the variable value. Applicable for string type.
- max
Value number - Maximum value of the variable. Applicable for integer type.
- min
Length number - Minimum length of the variable value. Applicable for string type.
- min
Value 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.
- 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.
- default
Value String - Default value for the variable, if the override value is not specified.
- description String
- Description of the meta data.
- group
By String - Display name of the group this variable belongs to.
- 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.
- max
Length Number - Maximum length of the variable value. Applicable for string type.
- max
Value Number - Maximum value of the variable. Applicable for integer type.
- min
Length Number - Minimum length of the variable value. Applicable for string type.
- min
Value 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
SchematicsActionBastionCredential, SchematicsActionBastionCredentialArgs
- Link string
- Reference link to the variable value By default the expression will point to self.value.
- Metadatas
List<Schematics
Action Bastion Credential Metadata> - 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
[]Schematics
Action Bastion Credential Metadata - 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<Schematics
Action Bastion Credential Metadata> - 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
Schematics
Action Bastion Credential Metadata[] - 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[Schematics
Action Bastion Credential Metadata] - 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.
- Default
Value string - Default value for the variable, if the override value is not specified.
- Description string
- Description of the meta data.
- Group
By string - Display name of the group this variable belongs to.
- 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.
- Max
Length double - Maximum length of the variable value. Applicable for string type.
- Max
Value double - Maximum value of the variable. Applicable for integer type.
- Min
Length double - Minimum length of the variable value. Applicable for string type.
- Min
Value 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.
- Default
Value string - Default value for the variable, if the override value is not specified.
- Description string
- Description of the meta data.
- Group
By string - Display name of the group this variable belongs to.
- 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.
- Max
Length float64 - Maximum length of the variable value. Applicable for string type.
- Max
Value float64 - Maximum value of the variable. Applicable for integer type.
- Min
Length float64 - Minimum length of the variable value. Applicable for string type.
- Min
Value 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.
- default
Value String - Default value for the variable, if the override value is not specified.
- description String
- Description of the meta data.
- group
By String - Display name of the group this variable belongs to.
- 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.
- max
Length Double - Maximum length of the variable value. Applicable for string type.
- max
Value Double - Maximum value of the variable. Applicable for integer type.
- min
Length Double - Minimum length of the variable value. Applicable for string type.
- min
Value 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.
- default
Value string - Default value for the variable, if the override value is not specified.
- description string
- Description of the meta data.
- group
By string - Display name of the group this variable belongs to.
- 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.
- max
Length number - Maximum length of the variable value. Applicable for string type.
- max
Value number - Maximum value of the variable. Applicable for integer type.
- min
Length number - Minimum length of the variable value. Applicable for string type.
- min
Value 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.
- 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.
- default
Value String - Default value for the variable, if the override value is not specified.
- description String
- Description of the meta data.
- group
By String - Display name of the group this variable belongs to.
- 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.
- max
Length Number - Maximum length of the variable value. Applicable for string type.
- max
Value Number - Maximum value of the variable. Applicable for integer type.
- min
Length Number - Minimum length of the variable value. Applicable for string type.
- min
Value 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<Schematics
Action Credentials Metadata> - 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
[]Schematics
Action Credentials Metadata - 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<Schematics
Action Credentials Metadata> - 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
Schematics
Action Credentials Metadata[] - 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[Schematics
Action Credentials Metadata] - 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.
- Default
Value string - Default value for the variable, if the override value is not specified.
- Description string
- Description of the meta data.
- Group
By string - Display name of the group this variable belongs to.
- 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.
- Max
Length double - Maximum length of the variable value. Applicable for string type.
- Max
Value double - Maximum value of the variable. Applicable for integer type.
- Min
Length double - Minimum length of the variable value. Applicable for string type.
- Min
Value 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.
- Default
Value string - Default value for the variable, if the override value is not specified.
- Description string
- Description of the meta data.
- Group
By string - Display name of the group this variable belongs to.
- 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.
- Max
Length float64 - Maximum length of the variable value. Applicable for string type.
- Max
Value float64 - Maximum value of the variable. Applicable for integer type.
- Min
Length float64 - Minimum length of the variable value. Applicable for string type.
- Min
Value 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.
- default
Value String - Default value for the variable, if the override value is not specified.
- description String
- Description of the meta data.
- group
By String - Display name of the group this variable belongs to.
- 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.
- max
Length Double - Maximum length of the variable value. Applicable for string type.
- max
Value Double - Maximum value of the variable. Applicable for integer type.
- min
Length Double - Minimum length of the variable value. Applicable for string type.
- min
Value 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.
- default
Value string - Default value for the variable, if the override value is not specified.
- description string
- Description of the meta data.
- group
By string - Display name of the group this variable belongs to.
- 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.
- max
Length number - Maximum length of the variable value. Applicable for string type.
- max
Value number - Maximum value of the variable. Applicable for integer type.
- min
Length number - Minimum length of the variable value. Applicable for string type.
- min
Value 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.
- 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.
- default
Value String - Default value for the variable, if the override value is not specified.
- description String
- Description of the meta data.
- group
By String - Display name of the group this variable belongs to.
- 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.
- max
Length Number - Maximum length of the variable value. Applicable for string type.
- max
Value Number - Maximum value of the variable. Applicable for integer type.
- min
Length Number - Minimum length of the variable value. Applicable for string type.
- min
Value 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<Schematics
Action Setting Metadata> - 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
[]Schematics
Action Setting Metadata - 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<Schematics
Action Setting Metadata> - 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
Schematics
Action Setting Metadata[] - 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[Schematics
Action Setting Metadata] - 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.
- Default
Value string - Default value for the variable, if the override value is not specified.
- Description string
- Description of the meta data.
- Group
By string - Display name of the group this variable belongs to.
- 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.
- Max
Length double - Maximum length of the variable value. Applicable for string type.
- Max
Value double - Maximum value of the variable. Applicable for integer type.
- Min
Length double - Minimum length of the variable value. Applicable for string type.
- Min
Value 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.
- Default
Value string - Default value for the variable, if the override value is not specified.
- Description string
- Description of the meta data.
- Group
By string - Display name of the group this variable belongs to.
- 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.
- Max
Length float64 - Maximum length of the variable value. Applicable for string type.
- Max
Value float64 - Maximum value of the variable. Applicable for integer type.
- Min
Length float64 - Minimum length of the variable value. Applicable for string type.
- Min
Value 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.
- default
Value String - Default value for the variable, if the override value is not specified.
- description String
- Description of the meta data.
- group
By String - Display name of the group this variable belongs to.
- 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.
- max
Length Double - Maximum length of the variable value. Applicable for string type.
- max
Value Double - Maximum value of the variable. Applicable for integer type.
- min
Length Double - Minimum length of the variable value. Applicable for string type.
- min
Value 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.
- default
Value string - Default value for the variable, if the override value is not specified.
- description string
- Description of the meta data.
- group
By string - Display name of the group this variable belongs to.
- 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.
- max
Length number - Maximum length of the variable value. Applicable for string type.
- max
Value number - Maximum value of the variable. Applicable for integer type.
- min
Length number - Minimum length of the variable value. Applicable for string type.
- min
Value 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.
- 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.
- default
Value String - Default value for the variable, if the override value is not specified.
- description String
- Description of the meta data.
- group
By String - Display name of the group this variable belongs to.
- 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.
- max
Length Number - Maximum length of the variable value. Applicable for string type.
- max
Value Number - Maximum value of the variable. Applicable for integer type.
- min
Length Number - Minimum length of the variable value. Applicable for string type.
- min
Value 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
- Source
Type 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
Schematics
Action Source Catalog - Connection details to IBM Cloud Catalog source. MaxItems:1. Nested scheme for catalog:
- Gits
List<Schematics
Action Source Git> - Connection details to Git source. Nested scheme for git:
- Source
Type 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
Schematics
Action Source Catalog - Connection details to IBM Cloud Catalog source. MaxItems:1. Nested scheme for catalog:
- Gits
[]Schematics
Action Source Git - Connection details to Git source. Nested scheme for git:
- source
Type 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
Schematics
Action Source Catalog - Connection details to IBM Cloud Catalog source. MaxItems:1. Nested scheme for catalog:
- gits
List<Schematics
Action Source Git> - Connection details to Git source. Nested scheme for git:
- source
Type 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
Schematics
Action Source Catalog - Connection details to IBM Cloud Catalog source. MaxItems:1. Nested scheme for catalog:
- gits
Schematics
Action Source Git[] - Connection details to Git source. Nested scheme for git:
- 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
- catalog
Schematics
Action Source Catalog - Connection details to IBM Cloud Catalog source. MaxItems:1. Nested scheme for catalog:
- gits
Sequence[Schematics
Action Source Git] - Connection details to Git source. Nested scheme for git:
- source
Type 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
- Catalog
Name string - name of the private catalog.
- Offering
Id string - Id of the offering the IBM Catalog.
- Offering
Kind string - Type of the offering, in the IBM Catalog.
- Offering
Name string - Name of the offering in the IBM Catalog.
- Offering
Repo stringUrl - Repo Url of the offering, in the IBM Catalog.
- Offering
Version string - Version string of the offering in the IBM Catalog.
- Offering
Version stringId - Id of the offering version the IBM Catalog.
- Catalog
Name string - name of the private catalog.
- Offering
Id string - Id of the offering the IBM Catalog.
- Offering
Kind string - Type of the offering, in the IBM Catalog.
- Offering
Name string - Name of the offering in the IBM Catalog.
- Offering
Repo stringUrl - Repo Url of the offering, in the IBM Catalog.
- Offering
Version string - Version string of the offering in the IBM Catalog.
- Offering
Version stringId - Id of the offering version the IBM Catalog.
- catalog
Name String - name of the private catalog.
- offering
Id String - Id of the offering the IBM Catalog.
- offering
Kind String - Type of the offering, in the IBM Catalog.
- offering
Name String - Name of the offering in the IBM Catalog.
- offering
Repo StringUrl - Repo Url of the offering, in the IBM Catalog.
- offering
Version String - Version string of the offering in the IBM Catalog.
- offering
Version StringId - Id of the offering version the IBM Catalog.
- catalog
Name string - name of the private catalog.
- offering
Id string - Id of the offering the IBM Catalog.
- offering
Kind string - Type of the offering, in the IBM Catalog.
- offering
Name string - Name of the offering in the IBM Catalog.
- offering
Repo stringUrl - Repo Url of the offering, in the IBM Catalog.
- offering
Version string - Version string of the offering in the IBM Catalog.
- offering
Version stringId - 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_ strurl - Repo Url of the offering, in the IBM Catalog.
- offering_
version str - Version string of the offering in the IBM Catalog.
- offering_
version_ strid - Id of the offering version the IBM Catalog.
- catalog
Name String - name of the private catalog.
- offering
Id String - Id of the offering the IBM Catalog.
- offering
Kind String - Type of the offering, in the IBM Catalog.
- offering
Name String - Name of the offering in the IBM Catalog.
- offering
Repo StringUrl - Repo Url of the offering, in the IBM Catalog.
- offering
Version String - Version string of the offering in the IBM Catalog.
- offering
Version StringId - Id of the offering version the IBM Catalog.
SchematicsActionSourceGit, SchematicsActionSourceGitArgs
- Computed
Git stringRepo Url - The Complete URL which is computed by git_repo_url, git_repo_folder and branch.
- Git
Branch string - Name of the branch, used to fetch the Git Repo.
- Git
Release string - Name of the release tag, used to fetch the Git Repo.
- Git
Repo stringFolder - Name of the folder in the Git Repo, that contains the template.
- Git
Repo stringUrl - URL to the GIT Repo that can be used to clone the template.
- Git
Token string - Personal Access Token to connect to Git URLs.
- Computed
Git stringRepo Url - The Complete URL which is computed by git_repo_url, git_repo_folder and branch.
- Git
Branch string - Name of the branch, used to fetch the Git Repo.
- Git
Release string - Name of the release tag, used to fetch the Git Repo.
- Git
Repo stringFolder - Name of the folder in the Git Repo, that contains the template.
- Git
Repo stringUrl - URL to the GIT Repo that can be used to clone the template.
- Git
Token string - Personal Access Token to connect to Git URLs.
- computed
Git StringRepo Url - The Complete URL which is computed by git_repo_url, git_repo_folder and branch.
- git
Branch String - Name of the branch, used to fetch the Git Repo.
- git
Release String - Name of the release tag, used to fetch the Git Repo.
- git
Repo StringFolder - Name of the folder in the Git Repo, that contains the template.
- git
Repo StringUrl - URL to the GIT Repo that can be used to clone the template.
- git
Token String - Personal Access Token to connect to Git URLs.
- computed
Git stringRepo Url - The Complete URL which is computed by git_repo_url, git_repo_folder and branch.
- git
Branch string - Name of the branch, used to fetch the Git Repo.
- git
Release string - Name of the release tag, used to fetch the Git Repo.
- git
Repo stringFolder - Name of the folder in the Git Repo, that contains the template.
- git
Repo stringUrl - URL to the GIT Repo that can be used to clone the template.
- git
Token string - Personal Access Token to connect to Git URLs.
- computed_
git_ strrepo_ url - 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_ strfolder - Name of the folder in the Git Repo, that contains the template.
- git_
repo_ strurl - URL to the GIT Repo that can be used to clone the template.
- git_
token str - Personal Access Token to connect to Git URLs.
- computed
Git StringRepo Url - The Complete URL which is computed by git_repo_url, git_repo_folder and branch.
- git
Branch String - Name of the branch, used to fetch the Git Repo.
- git
Release String - Name of the release tag, used to fetch the Git Repo.
- git
Repo StringFolder - Name of the folder in the Git Repo, that contains the template.
- git
Repo StringUrl - URL to the GIT Repo that can be used to clone the template.
- git
Token String - Personal Access Token to connect to Git URLs.
SchematicsActionState, SchematicsActionStateArgs
- Status
Code string - (String) Status of automation (workspace or action).
- Constraints: Allowable values are: normal, pending, disabled, critical
- Status
Job stringId - (String) Job id reference for this status.
- Status
Message string - (String) Automation status message - to be displayed along with the status_code.
- Status
Code string - (String) Status of automation (workspace or action).
- Constraints: Allowable values are: normal, pending, disabled, critical
- Status
Job stringId - (String) Job id reference for this status.
- Status
Message string - (String) Automation status message - to be displayed along with the status_code.
- status
Code String - (String) Status of automation (workspace or action).
- Constraints: Allowable values are: normal, pending, disabled, critical
- status
Job StringId - (String) Job id reference for this status.
- status
Message String - (String) Automation status message - to be displayed along with the status_code.
- status
Code string - (String) Status of automation (workspace or action).
- Constraints: Allowable values are: normal, pending, disabled, critical
- status
Job stringId - (String) Job id reference for this status.
- status
Message string - (String) Automation status message - to be displayed along with the status_code.
- status_
code str - (String) Status of automation (workspace or action).
- Constraints: Allowable values are: normal, pending, disabled, critical
- status_
job_ strid - (String) Job id reference for this status.
- status_
message str - (String) Automation status message - to be displayed along with the status_code.
- status
Code String - (String) Status of automation (workspace or action).
- Constraints: Allowable values are: normal, pending, disabled, critical
- status
Job StringId - (String) Job id reference for this status.
- status
Message String - (String) Automation status message - to be displayed along with the status_code.
SchematicsActionSysLock, SchematicsActionSysLockArgs
- Sys
Locked bool - (Boolean) Is the automation locked by a Schematic job ?.
- Sys
Locked stringAt - (String) When the User performed the job that lead to locking of the automation ?.
- Sys
Locked stringBy - (String) Name of the User who performed the job, that lead to the locking of the automation.
- Sys
Locked bool - (Boolean) Is the automation locked by a Schematic job ?.
- Sys
Locked stringAt - (String) When the User performed the job that lead to locking of the automation ?.
- Sys
Locked stringBy - (String) Name of the User who performed the job, that lead to the locking of the automation.
- sys
Locked Boolean - (Boolean) Is the automation locked by a Schematic job ?.
- sys
Locked StringAt - (String) When the User performed the job that lead to locking of the automation ?.
- sys
Locked StringBy - (String) Name of the User who performed the job, that lead to the locking of the automation.
- sys
Locked boolean - (Boolean) Is the automation locked by a Schematic job ?.
- sys
Locked stringAt - (String) When the User performed the job that lead to locking of the automation ?.
- sys
Locked stringBy - (String) Name of the User who performed the job, that lead to the locking of the automation.
- sys_
locked bool - (Boolean) Is the automation locked by a Schematic job ?.
- sys_
locked_ strat - (String) When the User performed the job that lead to locking of the automation ?.
- sys_
locked_ strby - (String) Name of the User who performed the job, that lead to the locking of the automation.
- sys
Locked Boolean - (Boolean) Is the automation locked by a Schematic job ?.
- sys
Locked StringAt - (String) When the User performed the job that lead to locking of the automation ?.
- sys
Locked StringBy - (String) Name of the User who performed the job, that lead to the locking of the automation.
SchematicsActionUserState, SchematicsActionUserStateArgs
- Set
At string - When the User who set the state of the Object.
- Set
By string - Name of the User who set the state of the Object.
- State string
- User-defined states *
draftObject can be modified; can be used by Jobs run by the author, during execution *liveObject can be modified; can be used by Jobs during execution *lockedObject cannot be modified; can be used by Jobs during execution *disableObject can be modified. cannot be used by Jobs during execution.- Constraints: Allowable values are: draft, live, locked, disable
- Set
At string - When the User who set the state of the Object.
- Set
By string - Name of the User who set the state of the Object.
- State string
- User-defined states *
draftObject can be modified; can be used by Jobs run by the author, during execution *liveObject can be modified; can be used by Jobs during execution *lockedObject cannot be modified; can be used by Jobs during execution *disableObject can be modified. cannot be used by Jobs during execution.- Constraints: Allowable values are: draft, live, locked, disable
- set
At String - When the User who set the state of the Object.
- set
By String - Name of the User who set the state of the Object.
- state String
- User-defined states *
draftObject can be modified; can be used by Jobs run by the author, during execution *liveObject can be modified; can be used by Jobs during execution *lockedObject cannot be modified; can be used by Jobs during execution *disableObject can be modified. cannot be used by Jobs during execution.- Constraints: Allowable values are: draft, live, locked, disable
- set
At string - When the User who set the state of the Object.
- set
By string - Name of the User who set the state of the Object.
- state string
- User-defined states *
draftObject can be modified; can be used by Jobs run by the author, during execution *liveObject can be modified; can be used by Jobs during execution *lockedObject cannot be modified; can be used by Jobs during execution *disableObject 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 *
draftObject can be modified; can be used by Jobs run by the author, during execution *liveObject can be modified; can be used by Jobs during execution *lockedObject cannot be modified; can be used by Jobs during execution *disableObject can be modified. cannot be used by Jobs during execution.- Constraints: Allowable values are: draft, live, locked, disable
- set
At String - When the User who set the state of the Object.
- set
By String - Name of the User who set the state of the Object.
- state String
- User-defined states *
draftObject can be modified; can be used by Jobs run by the author, during execution *liveObject can be modified; can be used by Jobs during execution *lockedObject cannot be modified; can be used by Jobs during execution *disableObject 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>
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
ibmTerraform Provider.