Port v1.10.6 published on Friday, Apr 19, 2024 by port-labs
port.Action
Explore with Pulumi AI
Create Action Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Action(name: string, args: ActionArgs, opts?: CustomResourceOptions);
@overload
def Action(resource_name: str,
args: ActionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Action(resource_name: str,
opts: Optional[ResourceOptions] = None,
identifier: Optional[str] = None,
trigger: Optional[str] = None,
title: Optional[str] = None,
blueprint: Optional[str] = None,
description: Optional[str] = None,
github_method: Optional[ActionGithubMethodArgs] = None,
gitlab_method: Optional[ActionGitlabMethodArgs] = None,
icon: Optional[str] = None,
approval_email_notification: Optional[ActionApprovalEmailNotificationArgs] = None,
kafka_method: Optional[ActionKafkaMethodArgs] = None,
order_properties: Optional[Sequence[str]] = None,
required_approval: Optional[bool] = None,
required_jq_query: Optional[str] = None,
azure_method: Optional[ActionAzureMethodArgs] = None,
approval_webhook_notification: Optional[ActionApprovalWebhookNotificationArgs] = None,
user_properties: Optional[ActionUserPropertiesArgs] = None,
webhook_method: Optional[ActionWebhookMethodArgs] = None)
func NewAction(ctx *Context, name string, args ActionArgs, opts ...ResourceOption) (*Action, error)
public Action(string name, ActionArgs args, CustomResourceOptions? opts = null)
public Action(String name, ActionArgs args)
public Action(String name, ActionArgs args, CustomResourceOptions options)
type: port:Action
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ActionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ActionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ActionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ActionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ActionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
var actionResource = new Port.Action("actionResource", new()
{
Identifier = "string",
Trigger = "string",
Title = "string",
Blueprint = "string",
Description = "string",
GithubMethod = new Port.Inputs.ActionGithubMethodArgs
{
Org = "string",
Repo = "string",
Workflow = "string",
OmitPayload = false,
OmitUserInputs = false,
ReportWorkflowStatus = false,
},
GitlabMethod = new Port.Inputs.ActionGitlabMethodArgs
{
GroupName = "string",
ProjectName = "string",
Agent = false,
DefaultRef = "string",
OmitPayload = false,
OmitUserInputs = false,
},
Icon = "string",
ApprovalEmailNotification = null,
KafkaMethod = null,
OrderProperties = new[]
{
"string",
},
RequiredApproval = false,
RequiredJqQuery = "string",
AzureMethod = new Port.Inputs.ActionAzureMethodArgs
{
Org = "string",
Webhook = "string",
},
ApprovalWebhookNotification = new Port.Inputs.ActionApprovalWebhookNotificationArgs
{
Url = "string",
Format = "string",
},
UserProperties = new Port.Inputs.ActionUserPropertiesArgs
{
ArrayProps =
{
{ "string", new Port.Inputs.ActionUserPropertiesArrayPropsArgs
{
BooleanItems = new Port.Inputs.ActionUserPropertiesArrayPropsBooleanItemsArgs
{
Defaults = new[]
{
false,
},
},
DefaultJqQuery = "string",
DependsOns = new[]
{
"string",
},
Description = "string",
Icon = "string",
MaxItems = 0,
MinItems = 0,
NumberItems = new Port.Inputs.ActionUserPropertiesArrayPropsNumberItemsArgs
{
Defaults = new[]
{
0,
},
EnumJqQuery = "string",
Enums = new[]
{
0,
},
},
ObjectItems = new Port.Inputs.ActionUserPropertiesArrayPropsObjectItemsArgs
{
Defaults = new[]
{
{
{ "string", "string" },
},
},
},
Required = false,
StringItems = new Port.Inputs.ActionUserPropertiesArrayPropsStringItemsArgs
{
Blueprint = "string",
Dataset = "string",
Defaults = new[]
{
"string",
},
EnumJqQuery = "string",
Enums = new[]
{
"string",
},
Format = "string",
},
Title = "string",
Visible = false,
VisibleJqQuery = "string",
} },
},
BooleanProps =
{
{ "string", new Port.Inputs.ActionUserPropertiesBooleanPropsArgs
{
Default = false,
DefaultJqQuery = "string",
DependsOns = new[]
{
"string",
},
Description = "string",
Icon = "string",
Required = false,
Title = "string",
Visible = false,
VisibleJqQuery = "string",
} },
},
NumberProps =
{
{ "string", new Port.Inputs.ActionUserPropertiesNumberPropsArgs
{
Default = 0,
DefaultJqQuery = "string",
DependsOns = new[]
{
"string",
},
Description = "string",
EnumJqQuery = "string",
Enums = new[]
{
0,
},
Icon = "string",
Maximum = 0,
Minimum = 0,
Required = false,
Title = "string",
Visible = false,
VisibleJqQuery = "string",
} },
},
ObjectProps =
{
{ "string", new Port.Inputs.ActionUserPropertiesObjectPropsArgs
{
Default = "string",
DefaultJqQuery = "string",
DependsOns = new[]
{
"string",
},
Description = "string",
Encryption = "string",
Icon = "string",
Required = false,
Title = "string",
Visible = false,
VisibleJqQuery = "string",
} },
},
StringProps =
{
{ "string", new Port.Inputs.ActionUserPropertiesStringPropsArgs
{
Blueprint = "string",
Dataset = new Port.Inputs.ActionUserPropertiesStringPropsDatasetArgs
{
Combinator = "string",
Rules = new[]
{
new Port.Inputs.ActionUserPropertiesStringPropsDatasetRuleArgs
{
Operator = "string",
Value = new Port.Inputs.ActionUserPropertiesStringPropsDatasetRuleValueArgs
{
JqQuery = "string",
},
Blueprint = "string",
Property = "string",
},
},
},
Default = "string",
DefaultJqQuery = "string",
DependsOns = new[]
{
"string",
},
Description = "string",
Encryption = "string",
EnumJqQuery = "string",
Enums = new[]
{
"string",
},
Format = "string",
Icon = "string",
MaxLength = 0,
MinLength = 0,
Pattern = "string",
Required = false,
Title = "string",
Visible = false,
VisibleJqQuery = "string",
} },
},
},
WebhookMethod = new Port.Inputs.ActionWebhookMethodArgs
{
Url = "string",
Agent = false,
Method = "string",
Synchronized = false,
},
});
example, err := port.NewAction(ctx, "actionResource", &port.ActionArgs{
Identifier: pulumi.String("string"),
Trigger: pulumi.String("string"),
Title: pulumi.String("string"),
Blueprint: pulumi.String("string"),
Description: pulumi.String("string"),
GithubMethod: &port.ActionGithubMethodArgs{
Org: pulumi.String("string"),
Repo: pulumi.String("string"),
Workflow: pulumi.String("string"),
OmitPayload: pulumi.Bool(false),
OmitUserInputs: pulumi.Bool(false),
ReportWorkflowStatus: pulumi.Bool(false),
},
GitlabMethod: &port.ActionGitlabMethodArgs{
GroupName: pulumi.String("string"),
ProjectName: pulumi.String("string"),
Agent: pulumi.Bool(false),
DefaultRef: pulumi.String("string"),
OmitPayload: pulumi.Bool(false),
OmitUserInputs: pulumi.Bool(false),
},
Icon: pulumi.String("string"),
ApprovalEmailNotification: nil,
KafkaMethod: nil,
OrderProperties: pulumi.StringArray{
pulumi.String("string"),
},
RequiredApproval: pulumi.Bool(false),
RequiredJqQuery: pulumi.String("string"),
AzureMethod: &port.ActionAzureMethodArgs{
Org: pulumi.String("string"),
Webhook: pulumi.String("string"),
},
ApprovalWebhookNotification: &port.ActionApprovalWebhookNotificationArgs{
Url: pulumi.String("string"),
Format: pulumi.String("string"),
},
UserProperties: &port.ActionUserPropertiesArgs{
ArrayProps: port.ActionUserPropertiesArrayPropsMap{
"string": &port.ActionUserPropertiesArrayPropsArgs{
BooleanItems: &port.ActionUserPropertiesArrayPropsBooleanItemsArgs{
Defaults: pulumi.BoolArray{
pulumi.Bool(false),
},
},
DefaultJqQuery: pulumi.String("string"),
DependsOns: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
Icon: pulumi.String("string"),
MaxItems: pulumi.Int(0),
MinItems: pulumi.Int(0),
NumberItems: &port.ActionUserPropertiesArrayPropsNumberItemsArgs{
Defaults: pulumi.Float64Array{
pulumi.Float64(0),
},
EnumJqQuery: pulumi.String("string"),
Enums: pulumi.Float64Array{
pulumi.Float64(0),
},
},
ObjectItems: &port.ActionUserPropertiesArrayPropsObjectItemsArgs{
Defaults: pulumi.StringMapArray{
pulumi.StringMap{
"string": pulumi.String("string"),
},
},
},
Required: pulumi.Bool(false),
StringItems: &port.ActionUserPropertiesArrayPropsStringItemsArgs{
Blueprint: pulumi.String("string"),
Dataset: pulumi.String("string"),
Defaults: pulumi.StringArray{
pulumi.String("string"),
},
EnumJqQuery: pulumi.String("string"),
Enums: pulumi.StringArray{
pulumi.String("string"),
},
Format: pulumi.String("string"),
},
Title: pulumi.String("string"),
Visible: pulumi.Bool(false),
VisibleJqQuery: pulumi.String("string"),
},
},
BooleanProps: port.ActionUserPropertiesBooleanPropsMap{
"string": &port.ActionUserPropertiesBooleanPropsArgs{
Default: pulumi.Bool(false),
DefaultJqQuery: pulumi.String("string"),
DependsOns: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
Icon: pulumi.String("string"),
Required: pulumi.Bool(false),
Title: pulumi.String("string"),
Visible: pulumi.Bool(false),
VisibleJqQuery: pulumi.String("string"),
},
},
NumberProps: port.ActionUserPropertiesNumberPropsMap{
"string": &port.ActionUserPropertiesNumberPropsArgs{
Default: pulumi.Float64(0),
DefaultJqQuery: pulumi.String("string"),
DependsOns: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
EnumJqQuery: pulumi.String("string"),
Enums: pulumi.Float64Array{
pulumi.Float64(0),
},
Icon: pulumi.String("string"),
Maximum: pulumi.Float64(0),
Minimum: pulumi.Float64(0),
Required: pulumi.Bool(false),
Title: pulumi.String("string"),
Visible: pulumi.Bool(false),
VisibleJqQuery: pulumi.String("string"),
},
},
ObjectProps: port.ActionUserPropertiesObjectPropsMap{
"string": &port.ActionUserPropertiesObjectPropsArgs{
Default: pulumi.String("string"),
DefaultJqQuery: pulumi.String("string"),
DependsOns: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
Encryption: pulumi.String("string"),
Icon: pulumi.String("string"),
Required: pulumi.Bool(false),
Title: pulumi.String("string"),
Visible: pulumi.Bool(false),
VisibleJqQuery: pulumi.String("string"),
},
},
StringProps: port.ActionUserPropertiesStringPropsMap{
"string": &port.ActionUserPropertiesStringPropsArgs{
Blueprint: pulumi.String("string"),
Dataset: &port.ActionUserPropertiesStringPropsDatasetArgs{
Combinator: pulumi.String("string"),
Rules: port.ActionUserPropertiesStringPropsDatasetRuleArray{
&port.ActionUserPropertiesStringPropsDatasetRuleArgs{
Operator: pulumi.String("string"),
Value: &port.ActionUserPropertiesStringPropsDatasetRuleValueArgs{
JqQuery: pulumi.String("string"),
},
Blueprint: pulumi.String("string"),
Property: pulumi.String("string"),
},
},
},
Default: pulumi.String("string"),
DefaultJqQuery: pulumi.String("string"),
DependsOns: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
Encryption: pulumi.String("string"),
EnumJqQuery: pulumi.String("string"),
Enums: pulumi.StringArray{
pulumi.String("string"),
},
Format: pulumi.String("string"),
Icon: pulumi.String("string"),
MaxLength: pulumi.Int(0),
MinLength: pulumi.Int(0),
Pattern: pulumi.String("string"),
Required: pulumi.Bool(false),
Title: pulumi.String("string"),
Visible: pulumi.Bool(false),
VisibleJqQuery: pulumi.String("string"),
},
},
},
WebhookMethod: &port.ActionWebhookMethodArgs{
Url: pulumi.String("string"),
Agent: pulumi.Bool(false),
Method: pulumi.String("string"),
Synchronized: pulumi.Bool(false),
},
})
var actionResource = new Action("actionResource", ActionArgs.builder()
.identifier("string")
.trigger("string")
.title("string")
.blueprint("string")
.description("string")
.githubMethod(ActionGithubMethodArgs.builder()
.org("string")
.repo("string")
.workflow("string")
.omitPayload(false)
.omitUserInputs(false)
.reportWorkflowStatus(false)
.build())
.gitlabMethod(ActionGitlabMethodArgs.builder()
.groupName("string")
.projectName("string")
.agent(false)
.defaultRef("string")
.omitPayload(false)
.omitUserInputs(false)
.build())
.icon("string")
.approvalEmailNotification()
.kafkaMethod()
.orderProperties("string")
.requiredApproval(false)
.requiredJqQuery("string")
.azureMethod(ActionAzureMethodArgs.builder()
.org("string")
.webhook("string")
.build())
.approvalWebhookNotification(ActionApprovalWebhookNotificationArgs.builder()
.url("string")
.format("string")
.build())
.userProperties(ActionUserPropertiesArgs.builder()
.arrayProps(Map.of("string", Map.ofEntries(
Map.entry("booleanItems", Map.of("defaults", false)),
Map.entry("defaultJqQuery", "string"),
Map.entry("dependsOns", "string"),
Map.entry("description", "string"),
Map.entry("icon", "string"),
Map.entry("maxItems", 0),
Map.entry("minItems", 0),
Map.entry("numberItems", Map.ofEntries(
Map.entry("defaults", 0),
Map.entry("enumJqQuery", "string"),
Map.entry("enums", 0)
)),
Map.entry("objectItems", Map.of("defaults", Map.of("string", "string"))),
Map.entry("required", false),
Map.entry("stringItems", Map.ofEntries(
Map.entry("blueprint", "string"),
Map.entry("dataset", "string"),
Map.entry("defaults", "string"),
Map.entry("enumJqQuery", "string"),
Map.entry("enums", "string"),
Map.entry("format", "string")
)),
Map.entry("title", "string"),
Map.entry("visible", false),
Map.entry("visibleJqQuery", "string")
)))
.booleanProps(Map.of("string", Map.ofEntries(
Map.entry("default", false),
Map.entry("defaultJqQuery", "string"),
Map.entry("dependsOns", "string"),
Map.entry("description", "string"),
Map.entry("icon", "string"),
Map.entry("required", false),
Map.entry("title", "string"),
Map.entry("visible", false),
Map.entry("visibleJqQuery", "string")
)))
.numberProps(Map.of("string", Map.ofEntries(
Map.entry("default", 0),
Map.entry("defaultJqQuery", "string"),
Map.entry("dependsOns", "string"),
Map.entry("description", "string"),
Map.entry("enumJqQuery", "string"),
Map.entry("enums", 0),
Map.entry("icon", "string"),
Map.entry("maximum", 0),
Map.entry("minimum", 0),
Map.entry("required", false),
Map.entry("title", "string"),
Map.entry("visible", false),
Map.entry("visibleJqQuery", "string")
)))
.objectProps(Map.of("string", Map.ofEntries(
Map.entry("default", "string"),
Map.entry("defaultJqQuery", "string"),
Map.entry("dependsOns", "string"),
Map.entry("description", "string"),
Map.entry("encryption", "string"),
Map.entry("icon", "string"),
Map.entry("required", false),
Map.entry("title", "string"),
Map.entry("visible", false),
Map.entry("visibleJqQuery", "string")
)))
.stringProps(Map.of("string", Map.ofEntries(
Map.entry("blueprint", "string"),
Map.entry("dataset", Map.ofEntries(
Map.entry("combinator", "string"),
Map.entry("rules", Map.ofEntries(
Map.entry("operator", "string"),
Map.entry("value", Map.of("jqQuery", "string")),
Map.entry("blueprint", "string"),
Map.entry("property", "string")
))
)),
Map.entry("default", "string"),
Map.entry("defaultJqQuery", "string"),
Map.entry("dependsOns", "string"),
Map.entry("description", "string"),
Map.entry("encryption", "string"),
Map.entry("enumJqQuery", "string"),
Map.entry("enums", "string"),
Map.entry("format", "string"),
Map.entry("icon", "string"),
Map.entry("maxLength", 0),
Map.entry("minLength", 0),
Map.entry("pattern", "string"),
Map.entry("required", false),
Map.entry("title", "string"),
Map.entry("visible", false),
Map.entry("visibleJqQuery", "string")
)))
.build())
.webhookMethod(ActionWebhookMethodArgs.builder()
.url("string")
.agent(false)
.method("string")
.synchronized_(false)
.build())
.build());
action_resource = port.Action("actionResource",
identifier="string",
trigger="string",
title="string",
blueprint="string",
description="string",
github_method=port.ActionGithubMethodArgs(
org="string",
repo="string",
workflow="string",
omit_payload=False,
omit_user_inputs=False,
report_workflow_status=False,
),
gitlab_method=port.ActionGitlabMethodArgs(
group_name="string",
project_name="string",
agent=False,
default_ref="string",
omit_payload=False,
omit_user_inputs=False,
),
icon="string",
approval_email_notification=port.ActionApprovalEmailNotificationArgs(),
kafka_method=port.ActionKafkaMethodArgs(),
order_properties=["string"],
required_approval=False,
required_jq_query="string",
azure_method=port.ActionAzureMethodArgs(
org="string",
webhook="string",
),
approval_webhook_notification=port.ActionApprovalWebhookNotificationArgs(
url="string",
format="string",
),
user_properties=port.ActionUserPropertiesArgs(
array_props={
"string": port.ActionUserPropertiesArrayPropsArgs(
boolean_items=port.ActionUserPropertiesArrayPropsBooleanItemsArgs(
defaults=[False],
),
default_jq_query="string",
depends_ons=["string"],
description="string",
icon="string",
max_items=0,
min_items=0,
number_items=port.ActionUserPropertiesArrayPropsNumberItemsArgs(
defaults=[0],
enum_jq_query="string",
enums=[0],
),
object_items=port.ActionUserPropertiesArrayPropsObjectItemsArgs(
defaults=[{
"string": "string",
}],
),
required=False,
string_items=port.ActionUserPropertiesArrayPropsStringItemsArgs(
blueprint="string",
dataset="string",
defaults=["string"],
enum_jq_query="string",
enums=["string"],
format="string",
),
title="string",
visible=False,
visible_jq_query="string",
),
},
boolean_props={
"string": port.ActionUserPropertiesBooleanPropsArgs(
default=False,
default_jq_query="string",
depends_ons=["string"],
description="string",
icon="string",
required=False,
title="string",
visible=False,
visible_jq_query="string",
),
},
number_props={
"string": port.ActionUserPropertiesNumberPropsArgs(
default=0,
default_jq_query="string",
depends_ons=["string"],
description="string",
enum_jq_query="string",
enums=[0],
icon="string",
maximum=0,
minimum=0,
required=False,
title="string",
visible=False,
visible_jq_query="string",
),
},
object_props={
"string": port.ActionUserPropertiesObjectPropsArgs(
default="string",
default_jq_query="string",
depends_ons=["string"],
description="string",
encryption="string",
icon="string",
required=False,
title="string",
visible=False,
visible_jq_query="string",
),
},
string_props={
"string": port.ActionUserPropertiesStringPropsArgs(
blueprint="string",
dataset=port.ActionUserPropertiesStringPropsDatasetArgs(
combinator="string",
rules=[port.ActionUserPropertiesStringPropsDatasetRuleArgs(
operator="string",
value=port.ActionUserPropertiesStringPropsDatasetRuleValueArgs(
jq_query="string",
),
blueprint="string",
property="string",
)],
),
default="string",
default_jq_query="string",
depends_ons=["string"],
description="string",
encryption="string",
enum_jq_query="string",
enums=["string"],
format="string",
icon="string",
max_length=0,
min_length=0,
pattern="string",
required=False,
title="string",
visible=False,
visible_jq_query="string",
),
},
),
webhook_method=port.ActionWebhookMethodArgs(
url="string",
agent=False,
method="string",
synchronized=False,
))
const actionResource = new port.Action("actionResource", {
identifier: "string",
trigger: "string",
title: "string",
blueprint: "string",
description: "string",
githubMethod: {
org: "string",
repo: "string",
workflow: "string",
omitPayload: false,
omitUserInputs: false,
reportWorkflowStatus: false,
},
gitlabMethod: {
groupName: "string",
projectName: "string",
agent: false,
defaultRef: "string",
omitPayload: false,
omitUserInputs: false,
},
icon: "string",
approvalEmailNotification: {},
kafkaMethod: {},
orderProperties: ["string"],
requiredApproval: false,
requiredJqQuery: "string",
azureMethod: {
org: "string",
webhook: "string",
},
approvalWebhookNotification: {
url: "string",
format: "string",
},
userProperties: {
arrayProps: {
string: {
booleanItems: {
defaults: [false],
},
defaultJqQuery: "string",
dependsOns: ["string"],
description: "string",
icon: "string",
maxItems: 0,
minItems: 0,
numberItems: {
defaults: [0],
enumJqQuery: "string",
enums: [0],
},
objectItems: {
defaults: [{
string: "string",
}],
},
required: false,
stringItems: {
blueprint: "string",
dataset: "string",
defaults: ["string"],
enumJqQuery: "string",
enums: ["string"],
format: "string",
},
title: "string",
visible: false,
visibleJqQuery: "string",
},
},
booleanProps: {
string: {
"default": false,
defaultJqQuery: "string",
dependsOns: ["string"],
description: "string",
icon: "string",
required: false,
title: "string",
visible: false,
visibleJqQuery: "string",
},
},
numberProps: {
string: {
"default": 0,
defaultJqQuery: "string",
dependsOns: ["string"],
description: "string",
enumJqQuery: "string",
enums: [0],
icon: "string",
maximum: 0,
minimum: 0,
required: false,
title: "string",
visible: false,
visibleJqQuery: "string",
},
},
objectProps: {
string: {
"default": "string",
defaultJqQuery: "string",
dependsOns: ["string"],
description: "string",
encryption: "string",
icon: "string",
required: false,
title: "string",
visible: false,
visibleJqQuery: "string",
},
},
stringProps: {
string: {
blueprint: "string",
dataset: {
combinator: "string",
rules: [{
operator: "string",
value: {
jqQuery: "string",
},
blueprint: "string",
property: "string",
}],
},
"default": "string",
defaultJqQuery: "string",
dependsOns: ["string"],
description: "string",
encryption: "string",
enumJqQuery: "string",
enums: ["string"],
format: "string",
icon: "string",
maxLength: 0,
minLength: 0,
pattern: "string",
required: false,
title: "string",
visible: false,
visibleJqQuery: "string",
},
},
},
webhookMethod: {
url: "string",
agent: false,
method: "string",
synchronized: false,
},
});
type: port:Action
properties:
approvalEmailNotification: {}
approvalWebhookNotification:
format: string
url: string
azureMethod:
org: string
webhook: string
blueprint: string
description: string
githubMethod:
omitPayload: false
omitUserInputs: false
org: string
repo: string
reportWorkflowStatus: false
workflow: string
gitlabMethod:
agent: false
defaultRef: string
groupName: string
omitPayload: false
omitUserInputs: false
projectName: string
icon: string
identifier: string
kafkaMethod: {}
orderProperties:
- string
requiredApproval: false
requiredJqQuery: string
title: string
trigger: string
userProperties:
arrayProps:
string:
booleanItems:
defaults:
- false
defaultJqQuery: string
dependsOns:
- string
description: string
icon: string
maxItems: 0
minItems: 0
numberItems:
defaults:
- 0
enumJqQuery: string
enums:
- 0
objectItems:
defaults:
- string: string
required: false
stringItems:
blueprint: string
dataset: string
defaults:
- string
enumJqQuery: string
enums:
- string
format: string
title: string
visible: false
visibleJqQuery: string
booleanProps:
string:
default: false
defaultJqQuery: string
dependsOns:
- string
description: string
icon: string
required: false
title: string
visible: false
visibleJqQuery: string
numberProps:
string:
default: 0
defaultJqQuery: string
dependsOns:
- string
description: string
enumJqQuery: string
enums:
- 0
icon: string
maximum: 0
minimum: 0
required: false
title: string
visible: false
visibleJqQuery: string
objectProps:
string:
default: string
defaultJqQuery: string
dependsOns:
- string
description: string
encryption: string
icon: string
required: false
title: string
visible: false
visibleJqQuery: string
stringProps:
string:
blueprint: string
dataset:
combinator: string
rules:
- blueprint: string
operator: string
property: string
value:
jqQuery: string
default: string
defaultJqQuery: string
dependsOns:
- string
description: string
encryption: string
enumJqQuery: string
enums:
- string
format: string
icon: string
maxLength: 0
minLength: 0
pattern: string
required: false
title: string
visible: false
visibleJqQuery: string
webhookMethod:
agent: false
method: string
synchronized: false
url: string
Action Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Action resource accepts the following input properties:
- Blueprint string
- The blueprint identifier the action relates to
- Identifier string
- Identifier
- Title string
- Title
- Trigger string
- The trigger type of the action
- Approval
Email port_Notification labs. Port. Inputs. Action Approval Email Notification - The email notification of the approval
- Approval
Webhook port_Notification labs. Port. Inputs. Action Approval Webhook Notification - The webhook notification of the approval
- Azure
Method port_labs. Port. Inputs. Action Azure Method - The invocation method of the action
- Description string
- Description
- Github
Method port_labs. Port. Inputs. Action Github Method - The invocation method of the action
- Gitlab
Method port_labs. Port. Inputs. Action Gitlab Method - The invocation method of the action
- Icon string
- Icon
- Kafka
Method port_labs. Port. Inputs. Action Kafka Method - The invocation method of the action
- Order
Properties List<string> - Order properties
- Required
Approval bool - Require approval before invoking the action
- Required
Jq stringQuery - The required jq query of the property
- User
Properties port_labs. Port. Inputs. Action User Properties - User properties
- Webhook
Method port_labs. Port. Inputs. Action Webhook Method - The invocation method of the action
- Blueprint string
- The blueprint identifier the action relates to
- Identifier string
- Identifier
- Title string
- Title
- Trigger string
- The trigger type of the action
- Approval
Email ActionNotification Approval Email Notification Args - The email notification of the approval
- Approval
Webhook ActionNotification Approval Webhook Notification Args - The webhook notification of the approval
- Azure
Method ActionAzure Method Args - The invocation method of the action
- Description string
- Description
- Github
Method ActionGithub Method Args - The invocation method of the action
- Gitlab
Method ActionGitlab Method Args - The invocation method of the action
- Icon string
- Icon
- Kafka
Method ActionKafka Method Args - The invocation method of the action
- Order
Properties []string - Order properties
- Required
Approval bool - Require approval before invoking the action
- Required
Jq stringQuery - The required jq query of the property
- User
Properties ActionUser Properties Args - User properties
- Webhook
Method ActionWebhook Method Args - The invocation method of the action
- blueprint String
- The blueprint identifier the action relates to
- identifier String
- Identifier
- title String
- Title
- trigger String
- The trigger type of the action
- approval
Email ActionNotification Approval Email Notification - The email notification of the approval
- approval
Webhook ActionNotification Approval Webhook Notification - The webhook notification of the approval
- azure
Method ActionAzure Method - The invocation method of the action
- description String
- Description
- github
Method ActionGithub Method - The invocation method of the action
- gitlab
Method ActionGitlab Method - The invocation method of the action
- icon String
- Icon
- kafka
Method ActionKafka Method - The invocation method of the action
- order
Properties List<String> - Order properties
- required
Approval Boolean - Require approval before invoking the action
- required
Jq StringQuery - The required jq query of the property
- user
Properties ActionUser Properties - User properties
- webhook
Method ActionWebhook Method - The invocation method of the action
- blueprint string
- The blueprint identifier the action relates to
- identifier string
- Identifier
- title string
- Title
- trigger string
- The trigger type of the action
- approval
Email ActionNotification Approval Email Notification - The email notification of the approval
- approval
Webhook ActionNotification Approval Webhook Notification - The webhook notification of the approval
- azure
Method ActionAzure Method - The invocation method of the action
- description string
- Description
- github
Method ActionGithub Method - The invocation method of the action
- gitlab
Method ActionGitlab Method - The invocation method of the action
- icon string
- Icon
- kafka
Method ActionKafka Method - The invocation method of the action
- order
Properties string[] - Order properties
- required
Approval boolean - Require approval before invoking the action
- required
Jq stringQuery - The required jq query of the property
- user
Properties ActionUser Properties - User properties
- webhook
Method ActionWebhook Method - The invocation method of the action
- blueprint str
- The blueprint identifier the action relates to
- identifier str
- Identifier
- title str
- Title
- trigger str
- The trigger type of the action
- approval_
email_ Actionnotification Approval Email Notification Args - The email notification of the approval
- approval_
webhook_ Actionnotification Approval Webhook Notification Args - The webhook notification of the approval
- azure_
method ActionAzure Method Args - The invocation method of the action
- description str
- Description
- github_
method ActionGithub Method Args - The invocation method of the action
- gitlab_
method ActionGitlab Method Args - The invocation method of the action
- icon str
- Icon
- kafka_
method ActionKafka Method Args - The invocation method of the action
- order_
properties Sequence[str] - Order properties
- required_
approval bool - Require approval before invoking the action
- required_
jq_ strquery - The required jq query of the property
- user_
properties ActionUser Properties Args - User properties
- webhook_
method ActionWebhook Method Args - The invocation method of the action
- blueprint String
- The blueprint identifier the action relates to
- identifier String
- Identifier
- title String
- Title
- trigger String
- The trigger type of the action
- approval
Email Property MapNotification - The email notification of the approval
- approval
Webhook Property MapNotification - The webhook notification of the approval
- azure
Method Property Map - The invocation method of the action
- description String
- Description
- github
Method Property Map - The invocation method of the action
- gitlab
Method Property Map - The invocation method of the action
- icon String
- Icon
- kafka
Method Property Map - The invocation method of the action
- order
Properties List<String> - Order properties
- required
Approval Boolean - Require approval before invoking the action
- required
Jq StringQuery - The required jq query of the property
- user
Properties Property Map - User properties
- webhook
Method Property Map - The invocation method of the action
Outputs
All input properties are implicitly available as output properties. Additionally, the Action resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Action Resource
Get an existing Action resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ActionState, opts?: CustomResourceOptions): Action
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
approval_email_notification: Optional[ActionApprovalEmailNotificationArgs] = None,
approval_webhook_notification: Optional[ActionApprovalWebhookNotificationArgs] = None,
azure_method: Optional[ActionAzureMethodArgs] = None,
blueprint: Optional[str] = None,
description: Optional[str] = None,
github_method: Optional[ActionGithubMethodArgs] = None,
gitlab_method: Optional[ActionGitlabMethodArgs] = None,
icon: Optional[str] = None,
identifier: Optional[str] = None,
kafka_method: Optional[ActionKafkaMethodArgs] = None,
order_properties: Optional[Sequence[str]] = None,
required_approval: Optional[bool] = None,
required_jq_query: Optional[str] = None,
title: Optional[str] = None,
trigger: Optional[str] = None,
user_properties: Optional[ActionUserPropertiesArgs] = None,
webhook_method: Optional[ActionWebhookMethodArgs] = None) -> Action
func GetAction(ctx *Context, name string, id IDInput, state *ActionState, opts ...ResourceOption) (*Action, error)
public static Action Get(string name, Input<string> id, ActionState? state, CustomResourceOptions? opts = null)
public static Action get(String name, Output<String> id, ActionState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Approval
Email port_Notification labs. Port. Inputs. Action Approval Email Notification - The email notification of the approval
- Approval
Webhook port_Notification labs. Port. Inputs. Action Approval Webhook Notification - The webhook notification of the approval
- Azure
Method port_labs. Port. Inputs. Action Azure Method - The invocation method of the action
- Blueprint string
- The blueprint identifier the action relates to
- Description string
- Description
- Github
Method port_labs. Port. Inputs. Action Github Method - The invocation method of the action
- Gitlab
Method port_labs. Port. Inputs. Action Gitlab Method - The invocation method of the action
- Icon string
- Icon
- Identifier string
- Identifier
- Kafka
Method port_labs. Port. Inputs. Action Kafka Method - The invocation method of the action
- Order
Properties List<string> - Order properties
- Required
Approval bool - Require approval before invoking the action
- Required
Jq stringQuery - The required jq query of the property
- Title string
- Title
- Trigger string
- The trigger type of the action
- User
Properties port_labs. Port. Inputs. Action User Properties - User properties
- Webhook
Method port_labs. Port. Inputs. Action Webhook Method - The invocation method of the action
- Approval
Email ActionNotification Approval Email Notification Args - The email notification of the approval
- Approval
Webhook ActionNotification Approval Webhook Notification Args - The webhook notification of the approval
- Azure
Method ActionAzure Method Args - The invocation method of the action
- Blueprint string
- The blueprint identifier the action relates to
- Description string
- Description
- Github
Method ActionGithub Method Args - The invocation method of the action
- Gitlab
Method ActionGitlab Method Args - The invocation method of the action
- Icon string
- Icon
- Identifier string
- Identifier
- Kafka
Method ActionKafka Method Args - The invocation method of the action
- Order
Properties []string - Order properties
- Required
Approval bool - Require approval before invoking the action
- Required
Jq stringQuery - The required jq query of the property
- Title string
- Title
- Trigger string
- The trigger type of the action
- User
Properties ActionUser Properties Args - User properties
- Webhook
Method ActionWebhook Method Args - The invocation method of the action
- approval
Email ActionNotification Approval Email Notification - The email notification of the approval
- approval
Webhook ActionNotification Approval Webhook Notification - The webhook notification of the approval
- azure
Method ActionAzure Method - The invocation method of the action
- blueprint String
- The blueprint identifier the action relates to
- description String
- Description
- github
Method ActionGithub Method - The invocation method of the action
- gitlab
Method ActionGitlab Method - The invocation method of the action
- icon String
- Icon
- identifier String
- Identifier
- kafka
Method ActionKafka Method - The invocation method of the action
- order
Properties List<String> - Order properties
- required
Approval Boolean - Require approval before invoking the action
- required
Jq StringQuery - The required jq query of the property
- title String
- Title
- trigger String
- The trigger type of the action
- user
Properties ActionUser Properties - User properties
- webhook
Method ActionWebhook Method - The invocation method of the action
- approval
Email ActionNotification Approval Email Notification - The email notification of the approval
- approval
Webhook ActionNotification Approval Webhook Notification - The webhook notification of the approval
- azure
Method ActionAzure Method - The invocation method of the action
- blueprint string
- The blueprint identifier the action relates to
- description string
- Description
- github
Method ActionGithub Method - The invocation method of the action
- gitlab
Method ActionGitlab Method - The invocation method of the action
- icon string
- Icon
- identifier string
- Identifier
- kafka
Method ActionKafka Method - The invocation method of the action
- order
Properties string[] - Order properties
- required
Approval boolean - Require approval before invoking the action
- required
Jq stringQuery - The required jq query of the property
- title string
- Title
- trigger string
- The trigger type of the action
- user
Properties ActionUser Properties - User properties
- webhook
Method ActionWebhook Method - The invocation method of the action
- approval_
email_ Actionnotification Approval Email Notification Args - The email notification of the approval
- approval_
webhook_ Actionnotification Approval Webhook Notification Args - The webhook notification of the approval
- azure_
method ActionAzure Method Args - The invocation method of the action
- blueprint str
- The blueprint identifier the action relates to
- description str
- Description
- github_
method ActionGithub Method Args - The invocation method of the action
- gitlab_
method ActionGitlab Method Args - The invocation method of the action
- icon str
- Icon
- identifier str
- Identifier
- kafka_
method ActionKafka Method Args - The invocation method of the action
- order_
properties Sequence[str] - Order properties
- required_
approval bool - Require approval before invoking the action
- required_
jq_ strquery - The required jq query of the property
- title str
- Title
- trigger str
- The trigger type of the action
- user_
properties ActionUser Properties Args - User properties
- webhook_
method ActionWebhook Method Args - The invocation method of the action
- approval
Email Property MapNotification - The email notification of the approval
- approval
Webhook Property MapNotification - The webhook notification of the approval
- azure
Method Property Map - The invocation method of the action
- blueprint String
- The blueprint identifier the action relates to
- description String
- Description
- github
Method Property Map - The invocation method of the action
- gitlab
Method Property Map - The invocation method of the action
- icon String
- Icon
- identifier String
- Identifier
- kafka
Method Property Map - The invocation method of the action
- order
Properties List<String> - Order properties
- required
Approval Boolean - Require approval before invoking the action
- required
Jq StringQuery - The required jq query of the property
- title String
- Title
- trigger String
- The trigger type of the action
- user
Properties Property Map - User properties
- webhook
Method Property Map - The invocation method of the action
Supporting Types
ActionApprovalWebhookNotification, ActionApprovalWebhookNotificationArgs
ActionAzureMethod, ActionAzureMethodArgs
ActionGithubMethod, ActionGithubMethodArgs
- Org string
- Required when selecting type GITHUB. The GitHub org that the workflow belongs to
- Repo string
- Required when selecting type GITHUB. The GitHub repo that the workflow belongs to
- Workflow string
- The GitHub workflow that the action belongs to
- Omit
Payload bool - Omit the payload when invoking the action
- Omit
User boolInputs - Omit the user inputs when invoking the action
- Report
Workflow boolStatus - Report the workflow status when invoking the action
- Org string
- Required when selecting type GITHUB. The GitHub org that the workflow belongs to
- Repo string
- Required when selecting type GITHUB. The GitHub repo that the workflow belongs to
- Workflow string
- The GitHub workflow that the action belongs to
- Omit
Payload bool - Omit the payload when invoking the action
- Omit
User boolInputs - Omit the user inputs when invoking the action
- Report
Workflow boolStatus - Report the workflow status when invoking the action
- org String
- Required when selecting type GITHUB. The GitHub org that the workflow belongs to
- repo String
- Required when selecting type GITHUB. The GitHub repo that the workflow belongs to
- workflow String
- The GitHub workflow that the action belongs to
- omit
Payload Boolean - Omit the payload when invoking the action
- omit
User BooleanInputs - Omit the user inputs when invoking the action
- report
Workflow BooleanStatus - Report the workflow status when invoking the action
- org string
- Required when selecting type GITHUB. The GitHub org that the workflow belongs to
- repo string
- Required when selecting type GITHUB. The GitHub repo that the workflow belongs to
- workflow string
- The GitHub workflow that the action belongs to
- omit
Payload boolean - Omit the payload when invoking the action
- omit
User booleanInputs - Omit the user inputs when invoking the action
- report
Workflow booleanStatus - Report the workflow status when invoking the action
- org str
- Required when selecting type GITHUB. The GitHub org that the workflow belongs to
- repo str
- Required when selecting type GITHUB. The GitHub repo that the workflow belongs to
- workflow str
- The GitHub workflow that the action belongs to
- omit_
payload bool - Omit the payload when invoking the action
- omit_
user_ boolinputs - Omit the user inputs when invoking the action
- report_
workflow_ boolstatus - Report the workflow status when invoking the action
- org String
- Required when selecting type GITHUB. The GitHub org that the workflow belongs to
- repo String
- Required when selecting type GITHUB. The GitHub repo that the workflow belongs to
- workflow String
- The GitHub workflow that the action belongs to
- omit
Payload Boolean - Omit the payload when invoking the action
- omit
User BooleanInputs - Omit the user inputs when invoking the action
- report
Workflow BooleanStatus - Report the workflow status when invoking the action
ActionGitlabMethod, ActionGitlabMethodArgs
- Group
Name string - Required when selecting type GITLAB. The GitLab group name that the workflow belongs to
- Project
Name string - Required when selecting type GITLAB. The GitLab project name that the workflow belongs to
- Agent bool
- Use the agent to invoke the action
- Default
Ref string - The default ref of the action
- Omit
Payload bool - Omit the payload when invoking the action
- Omit
User boolInputs - Omit the user inputs when invoking the action
- Group
Name string - Required when selecting type GITLAB. The GitLab group name that the workflow belongs to
- Project
Name string - Required when selecting type GITLAB. The GitLab project name that the workflow belongs to
- Agent bool
- Use the agent to invoke the action
- Default
Ref string - The default ref of the action
- Omit
Payload bool - Omit the payload when invoking the action
- Omit
User boolInputs - Omit the user inputs when invoking the action
- group
Name String - Required when selecting type GITLAB. The GitLab group name that the workflow belongs to
- project
Name String - Required when selecting type GITLAB. The GitLab project name that the workflow belongs to
- agent Boolean
- Use the agent to invoke the action
- default
Ref String - The default ref of the action
- omit
Payload Boolean - Omit the payload when invoking the action
- omit
User BooleanInputs - Omit the user inputs when invoking the action
- group
Name string - Required when selecting type GITLAB. The GitLab group name that the workflow belongs to
- project
Name string - Required when selecting type GITLAB. The GitLab project name that the workflow belongs to
- agent boolean
- Use the agent to invoke the action
- default
Ref string - The default ref of the action
- omit
Payload boolean - Omit the payload when invoking the action
- omit
User booleanInputs - Omit the user inputs when invoking the action
- group_
name str - Required when selecting type GITLAB. The GitLab group name that the workflow belongs to
- project_
name str - Required when selecting type GITLAB. The GitLab project name that the workflow belongs to
- agent bool
- Use the agent to invoke the action
- default_
ref str - The default ref of the action
- omit_
payload bool - Omit the payload when invoking the action
- omit_
user_ boolinputs - Omit the user inputs when invoking the action
- group
Name String - Required when selecting type GITLAB. The GitLab group name that the workflow belongs to
- project
Name String - Required when selecting type GITLAB. The GitLab project name that the workflow belongs to
- agent Boolean
- Use the agent to invoke the action
- default
Ref String - The default ref of the action
- omit
Payload Boolean - Omit the payload when invoking the action
- omit
User BooleanInputs - Omit the user inputs when invoking the action
ActionUserProperties, ActionUserPropertiesArgs
- Array
Props Dictionary<string, port_labs. Port. Inputs. Action User Properties Array Props> - The array property of the action
- Boolean
Props Dictionary<string, port_labs. Port. Inputs. Action User Properties Boolean Props> - The boolean property of the action
- Number
Props Dictionary<string, port_labs. Port. Inputs. Action User Properties Number Props> - The number property of the action
- Object
Props Dictionary<string, port_labs. Port. Inputs. Action User Properties Object Props> - The object property of the action
- String
Props Dictionary<string, port_labs. Port. Inputs. Action User Properties String Props> - The string property of the action
- Array
Props map[string]ActionUser Properties Array Props - The array property of the action
- Boolean
Props map[string]ActionUser Properties Boolean Props - The boolean property of the action
- Number
Props map[string]ActionUser Properties Number Props - The number property of the action
- Object
Props map[string]ActionUser Properties Object Props - The object property of the action
- String
Props map[string]ActionUser Properties String Props - The string property of the action
- array
Props Map<String,ActionUser Properties Array Props> - The array property of the action
- boolean
Props Map<String,ActionUser Properties Boolean Props> - The boolean property of the action
- number
Props Map<String,ActionUser Properties Number Props> - The number property of the action
- object
Props Map<String,ActionUser Properties Object Props> - The object property of the action
- string
Props Map<String,ActionUser Properties String Props> - The string property of the action
- array
Props {[key: string]: ActionUser Properties Array Props} - The array property of the action
- boolean
Props {[key: string]: ActionUser Properties Boolean Props} - The boolean property of the action
- number
Props {[key: string]: ActionUser Properties Number Props} - The number property of the action
- object
Props {[key: string]: ActionUser Properties Object Props} - The object property of the action
- string
Props {[key: string]: ActionUser Properties String Props} - The string property of the action
- array_
props Mapping[str, ActionUser Properties Array Props] - The array property of the action
- boolean_
props Mapping[str, ActionUser Properties Boolean Props] - The boolean property of the action
- number_
props Mapping[str, ActionUser Properties Number Props] - The number property of the action
- object_
props Mapping[str, ActionUser Properties Object Props] - The object property of the action
- string_
props Mapping[str, ActionUser Properties String Props] - The string property of the action
- array
Props Map<Property Map> - The array property of the action
- boolean
Props Map<Property Map> - The boolean property of the action
- number
Props Map<Property Map> - The number property of the action
- object
Props Map<Property Map> - The object property of the action
- string
Props Map<Property Map> - The string property of the action
ActionUserPropertiesArrayProps, ActionUserPropertiesArrayPropsArgs
- Boolean
Items port_labs. Port. Inputs. Action User Properties Array Props Boolean Items - The items of the array property
- Default
Jq stringQuery - The default jq query of the array property
- Depends
Ons List<string> - The properties that this property depends on
- Description string
- The description of the property
- Icon string
- The icon of the property
- Max
Items int - The max items of the array property
- Min
Items int - The min items of the array property
- Number
Items port_labs. Port. Inputs. Action User Properties Array Props Number Items - The items of the array property
- Object
Items port_labs. Port. Inputs. Action User Properties Array Props Object Items - The items of the array property
- Required bool
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - String
Items port_labs. Port. Inputs. Action User Properties Array Props String Items - The items of the array property
- Title string
- The title of the property
- Visible bool
- The visibility of the array property
- Visible
Jq stringQuery - The visibility condition jq query of the array property
- Boolean
Items ActionUser Properties Array Props Boolean Items - The items of the array property
- Default
Jq stringQuery - The default jq query of the array property
- Depends
Ons []string - The properties that this property depends on
- Description string
- The description of the property
- Icon string
- The icon of the property
- Max
Items int - The max items of the array property
- Min
Items int - The min items of the array property
- Number
Items ActionUser Properties Array Props Number Items - The items of the array property
- Object
Items ActionUser Properties Array Props Object Items - The items of the array property
- Required bool
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - String
Items ActionUser Properties Array Props String Items - The items of the array property
- Title string
- The title of the property
- Visible bool
- The visibility of the array property
- Visible
Jq stringQuery - The visibility condition jq query of the array property
- boolean
Items ActionUser Properties Array Props Boolean Items - The items of the array property
- default
Jq StringQuery - The default jq query of the array property
- depends
Ons List<String> - The properties that this property depends on
- description String
- The description of the property
- icon String
- The icon of the property
- max
Items Integer - The max items of the array property
- min
Items Integer - The min items of the array property
- number
Items ActionUser Properties Array Props Number Items - The items of the array property
- object
Items ActionUser Properties Array Props Object Items - The items of the array property
- required Boolean
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - string
Items ActionUser Properties Array Props String Items - The items of the array property
- title String
- The title of the property
- visible Boolean
- The visibility of the array property
- visible
Jq StringQuery - The visibility condition jq query of the array property
- boolean
Items ActionUser Properties Array Props Boolean Items - The items of the array property
- default
Jq stringQuery - The default jq query of the array property
- depends
Ons string[] - The properties that this property depends on
- description string
- The description of the property
- icon string
- The icon of the property
- max
Items number - The max items of the array property
- min
Items number - The min items of the array property
- number
Items ActionUser Properties Array Props Number Items - The items of the array property
- object
Items ActionUser Properties Array Props Object Items - The items of the array property
- required boolean
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - string
Items ActionUser Properties Array Props String Items - The items of the array property
- title string
- The title of the property
- visible boolean
- The visibility of the array property
- visible
Jq stringQuery - The visibility condition jq query of the array property
- boolean_
items ActionUser Properties Array Props Boolean Items - The items of the array property
- default_
jq_ strquery - The default jq query of the array property
- depends_
ons Sequence[str] - The properties that this property depends on
- description str
- The description of the property
- icon str
- The icon of the property
- max_
items int - The max items of the array property
- min_
items int - The min items of the array property
- number_
items ActionUser Properties Array Props Number Items - The items of the array property
- object_
items ActionUser Properties Array Props Object Items - The items of the array property
- required bool
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - string_
items ActionUser Properties Array Props String Items - The items of the array property
- title str
- The title of the property
- visible bool
- The visibility of the array property
- visible_
jq_ strquery - The visibility condition jq query of the array property
- boolean
Items Property Map - The items of the array property
- default
Jq StringQuery - The default jq query of the array property
- depends
Ons List<String> - The properties that this property depends on
- description String
- The description of the property
- icon String
- The icon of the property
- max
Items Number - The max items of the array property
- min
Items Number - The min items of the array property
- number
Items Property Map - The items of the array property
- object
Items Property Map - The items of the array property
- required Boolean
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - string
Items Property Map - The items of the array property
- title String
- The title of the property
- visible Boolean
- The visibility of the array property
- visible
Jq StringQuery - The visibility condition jq query of the array property
ActionUserPropertiesArrayPropsBooleanItems, ActionUserPropertiesArrayPropsBooleanItemsArgs
- Defaults List<bool>
- The default of the items
- Defaults []bool
- The default of the items
- defaults List<Boolean>
- The default of the items
- defaults boolean[]
- The default of the items
- defaults Sequence[bool]
- The default of the items
- defaults List<Boolean>
- The default of the items
ActionUserPropertiesArrayPropsNumberItems, ActionUserPropertiesArrayPropsNumberItemsArgs
- Defaults List<double>
- The default of the items
- Enum
Jq stringQuery - The enum jq query of the number items
- Enums List<double>
- The enum of the items
- Defaults []float64
- The default of the items
- Enum
Jq stringQuery - The enum jq query of the number items
- Enums []float64
- The enum of the items
- defaults List<Double>
- The default of the items
- enum
Jq StringQuery - The enum jq query of the number items
- enums List<Double>
- The enum of the items
- defaults number[]
- The default of the items
- enum
Jq stringQuery - The enum jq query of the number items
- enums number[]
- The enum of the items
- defaults Sequence[float]
- The default of the items
- enum_
jq_ strquery - The enum jq query of the number items
- enums Sequence[float]
- The enum of the items
- defaults List<Number>
- The default of the items
- enum
Jq StringQuery - The enum jq query of the number items
- enums List<Number>
- The enum of the items
ActionUserPropertiesArrayPropsObjectItems, ActionUserPropertiesArrayPropsObjectItemsArgs
- Defaults
List<Immutable
Dictionary<string, string>> - The default of the items
- Defaults []map[string]string
- The default of the items
- defaults List<Map<String,String>>
- The default of the items
- defaults {[key: string]: string}[]
- The default of the items
- defaults Sequence[Mapping[str, str]]
- The default of the items
- defaults List<Map<String>>
- The default of the items
ActionUserPropertiesArrayPropsStringItems, ActionUserPropertiesArrayPropsStringItemsArgs
ActionUserPropertiesBooleanProps, ActionUserPropertiesBooleanPropsArgs
- Default bool
- The default of the boolean property
- Default
Jq stringQuery - The default jq query of the boolean property
- Depends
Ons List<string> - The properties that this property depends on
- Description string
- The description of the property
- Icon string
- The icon of the property
- Required bool
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - Title string
- The title of the property
- Visible bool
- The visibility of the boolean property
- Visible
Jq stringQuery - The visibility condition jq query of the boolean property
- Default bool
- The default of the boolean property
- Default
Jq stringQuery - The default jq query of the boolean property
- Depends
Ons []string - The properties that this property depends on
- Description string
- The description of the property
- Icon string
- The icon of the property
- Required bool
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - Title string
- The title of the property
- Visible bool
- The visibility of the boolean property
- Visible
Jq stringQuery - The visibility condition jq query of the boolean property
- default
Jq StringQuery - The default jq query of the boolean property
- default_ Boolean
- The default of the boolean property
- depends
Ons List<String> - The properties that this property depends on
- description String
- The description of the property
- icon String
- The icon of the property
- required Boolean
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - title String
- The title of the property
- visible Boolean
- The visibility of the boolean property
- visible
Jq StringQuery - The visibility condition jq query of the boolean property
- default boolean
- The default of the boolean property
- default
Jq stringQuery - The default jq query of the boolean property
- depends
Ons string[] - The properties that this property depends on
- description string
- The description of the property
- icon string
- The icon of the property
- required boolean
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - title string
- The title of the property
- visible boolean
- The visibility of the boolean property
- visible
Jq stringQuery - The visibility condition jq query of the boolean property
- default bool
- The default of the boolean property
- default_
jq_ strquery - The default jq query of the boolean property
- depends_
ons Sequence[str] - The properties that this property depends on
- description str
- The description of the property
- icon str
- The icon of the property
- required bool
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - title str
- The title of the property
- visible bool
- The visibility of the boolean property
- visible_
jq_ strquery - The visibility condition jq query of the boolean property
- default Boolean
- The default of the boolean property
- default
Jq StringQuery - The default jq query of the boolean property
- depends
Ons List<String> - The properties that this property depends on
- description String
- The description of the property
- icon String
- The icon of the property
- required Boolean
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - title String
- The title of the property
- visible Boolean
- The visibility of the boolean property
- visible
Jq StringQuery - The visibility condition jq query of the boolean property
ActionUserPropertiesNumberProps, ActionUserPropertiesNumberPropsArgs
- Default double
- The default of the number property
- Default
Jq stringQuery - The default jq query of the number property
- Depends
Ons List<string> - The properties that this property depends on
- Description string
- The description of the property
- Enum
Jq stringQuery - The enum jq query of the string property
- Enums List<double>
- The enum of the number property
- Icon string
- The icon of the property
- Maximum double
- The min of the number property
- Minimum double
- The max of the number property
- Required bool
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - Title string
- The title of the property
- Visible bool
- The visibility of the number property
- Visible
Jq stringQuery - The visibility condition jq query of the number property
- Default float64
- The default of the number property
- Default
Jq stringQuery - The default jq query of the number property
- Depends
Ons []string - The properties that this property depends on
- Description string
- The description of the property
- Enum
Jq stringQuery - The enum jq query of the string property
- Enums []float64
- The enum of the number property
- Icon string
- The icon of the property
- Maximum float64
- The min of the number property
- Minimum float64
- The max of the number property
- Required bool
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - Title string
- The title of the property
- Visible bool
- The visibility of the number property
- Visible
Jq stringQuery - The visibility condition jq query of the number property
- default
Jq StringQuery - The default jq query of the number property
- default_ Double
- The default of the number property
- depends
Ons List<String> - The properties that this property depends on
- description String
- The description of the property
- enum
Jq StringQuery - The enum jq query of the string property
- enums List<Double>
- The enum of the number property
- icon String
- The icon of the property
- maximum Double
- The min of the number property
- minimum Double
- The max of the number property
- required Boolean
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - title String
- The title of the property
- visible Boolean
- The visibility of the number property
- visible
Jq StringQuery - The visibility condition jq query of the number property
- default number
- The default of the number property
- default
Jq stringQuery - The default jq query of the number property
- depends
Ons string[] - The properties that this property depends on
- description string
- The description of the property
- enum
Jq stringQuery - The enum jq query of the string property
- enums number[]
- The enum of the number property
- icon string
- The icon of the property
- maximum number
- The min of the number property
- minimum number
- The max of the number property
- required boolean
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - title string
- The title of the property
- visible boolean
- The visibility of the number property
- visible
Jq stringQuery - The visibility condition jq query of the number property
- default float
- The default of the number property
- default_
jq_ strquery - The default jq query of the number property
- depends_
ons Sequence[str] - The properties that this property depends on
- description str
- The description of the property
- enum_
jq_ strquery - The enum jq query of the string property
- enums Sequence[float]
- The enum of the number property
- icon str
- The icon of the property
- maximum float
- The min of the number property
- minimum float
- The max of the number property
- required bool
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - title str
- The title of the property
- visible bool
- The visibility of the number property
- visible_
jq_ strquery - The visibility condition jq query of the number property
- default Number
- The default of the number property
- default
Jq StringQuery - The default jq query of the number property
- depends
Ons List<String> - The properties that this property depends on
- description String
- The description of the property
- enum
Jq StringQuery - The enum jq query of the string property
- enums List<Number>
- The enum of the number property
- icon String
- The icon of the property
- maximum Number
- The min of the number property
- minimum Number
- The max of the number property
- required Boolean
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - title String
- The title of the property
- visible Boolean
- The visibility of the number property
- visible
Jq StringQuery - The visibility condition jq query of the number property
ActionUserPropertiesObjectProps, ActionUserPropertiesObjectPropsArgs
- Default string
- The default of the object property
- Default
Jq stringQuery - The default jq query of the object property
- Depends
Ons List<string> - The properties that this property depends on
- Description string
- The description of the property
- Encryption string
- The algorithm to encrypt the property with
- Icon string
- The icon of the property
- Required bool
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - Title string
- The title of the property
- Visible bool
- The visibility of the object property
- Visible
Jq stringQuery - The visibility condition jq query of the object property
- Default string
- The default of the object property
- Default
Jq stringQuery - The default jq query of the object property
- Depends
Ons []string - The properties that this property depends on
- Description string
- The description of the property
- Encryption string
- The algorithm to encrypt the property with
- Icon string
- The icon of the property
- Required bool
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - Title string
- The title of the property
- Visible bool
- The visibility of the object property
- Visible
Jq stringQuery - The visibility condition jq query of the object property
- default
Jq StringQuery - The default jq query of the object property
- default_ String
- The default of the object property
- depends
Ons List<String> - The properties that this property depends on
- description String
- The description of the property
- encryption String
- The algorithm to encrypt the property with
- icon String
- The icon of the property
- required Boolean
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - title String
- The title of the property
- visible Boolean
- The visibility of the object property
- visible
Jq StringQuery - The visibility condition jq query of the object property
- default string
- The default of the object property
- default
Jq stringQuery - The default jq query of the object property
- depends
Ons string[] - The properties that this property depends on
- description string
- The description of the property
- encryption string
- The algorithm to encrypt the property with
- icon string
- The icon of the property
- required boolean
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - title string
- The title of the property
- visible boolean
- The visibility of the object property
- visible
Jq stringQuery - The visibility condition jq query of the object property
- default str
- The default of the object property
- default_
jq_ strquery - The default jq query of the object property
- depends_
ons Sequence[str] - The properties that this property depends on
- description str
- The description of the property
- encryption str
- The algorithm to encrypt the property with
- icon str
- The icon of the property
- required bool
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - title str
- The title of the property
- visible bool
- The visibility of the object property
- visible_
jq_ strquery - The visibility condition jq query of the object property
- default String
- The default of the object property
- default
Jq StringQuery - The default jq query of the object property
- depends
Ons List<String> - The properties that this property depends on
- description String
- The description of the property
- encryption String
- The algorithm to encrypt the property with
- icon String
- The icon of the property
- required Boolean
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - title String
- The title of the property
- visible Boolean
- The visibility of the object property
- visible
Jq StringQuery - The visibility condition jq query of the object property
ActionUserPropertiesStringProps, ActionUserPropertiesStringPropsArgs
- Blueprint string
- The blueprint identifier the string property relates to
- Dataset
port_
labs. Port. Inputs. Action User Properties String Props Dataset - The dataset of an the entity-format property
- Default string
- The default of the string property
- Default
Jq stringQuery - The default jq query of the string property
- Depends
Ons List<string> - The properties that this property depends on
- Description string
- The description of the property
- Encryption string
- The algorithm to encrypt the property with
- Enum
Jq stringQuery - The enum jq query of the string property
- Enums List<string>
- The enum of the string property
- Format string
- The format of the string property
- Icon string
- The icon of the property
- Max
Length int - The max length of the string property
- Min
Length int - The min length of the string property
- Pattern string
- The pattern of the string property
- Required bool
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - Title string
- The title of the property
- Visible bool
- The visibility of the string property
- Visible
Jq stringQuery - The visibility condition jq query of the string property
- Blueprint string
- The blueprint identifier the string property relates to
- Dataset
Action
User Properties String Props Dataset - The dataset of an the entity-format property
- Default string
- The default of the string property
- Default
Jq stringQuery - The default jq query of the string property
- Depends
Ons []string - The properties that this property depends on
- Description string
- The description of the property
- Encryption string
- The algorithm to encrypt the property with
- Enum
Jq stringQuery - The enum jq query of the string property
- Enums []string
- The enum of the string property
- Format string
- The format of the string property
- Icon string
- The icon of the property
- Max
Length int - The max length of the string property
- Min
Length int - The min length of the string property
- Pattern string
- The pattern of the string property
- Required bool
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - Title string
- The title of the property
- Visible bool
- The visibility of the string property
- Visible
Jq stringQuery - The visibility condition jq query of the string property
- blueprint String
- The blueprint identifier the string property relates to
- dataset
Action
User Properties String Props Dataset - The dataset of an the entity-format property
- default
Jq StringQuery - The default jq query of the string property
- default_ String
- The default of the string property
- depends
Ons List<String> - The properties that this property depends on
- description String
- The description of the property
- encryption String
- The algorithm to encrypt the property with
- enum
Jq StringQuery - The enum jq query of the string property
- enums List<String>
- The enum of the string property
- format String
- The format of the string property
- icon String
- The icon of the property
- max
Length Integer - The max length of the string property
- min
Length Integer - The min length of the string property
- pattern String
- The pattern of the string property
- required Boolean
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - title String
- The title of the property
- visible Boolean
- The visibility of the string property
- visible
Jq StringQuery - The visibility condition jq query of the string property
- blueprint string
- The blueprint identifier the string property relates to
- dataset
Action
User Properties String Props Dataset - The dataset of an the entity-format property
- default string
- The default of the string property
- default
Jq stringQuery - The default jq query of the string property
- depends
Ons string[] - The properties that this property depends on
- description string
- The description of the property
- encryption string
- The algorithm to encrypt the property with
- enum
Jq stringQuery - The enum jq query of the string property
- enums string[]
- The enum of the string property
- format string
- The format of the string property
- icon string
- The icon of the property
- max
Length number - The max length of the string property
- min
Length number - The min length of the string property
- pattern string
- The pattern of the string property
- required boolean
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - title string
- The title of the property
- visible boolean
- The visibility of the string property
- visible
Jq stringQuery - The visibility condition jq query of the string property
- blueprint str
- The blueprint identifier the string property relates to
- dataset
Action
User Properties String Props Dataset - The dataset of an the entity-format property
- default str
- The default of the string property
- default_
jq_ strquery - The default jq query of the string property
- depends_
ons Sequence[str] - The properties that this property depends on
- description str
- The description of the property
- encryption str
- The algorithm to encrypt the property with
- enum_
jq_ strquery - The enum jq query of the string property
- enums Sequence[str]
- The enum of the string property
- format str
- The format of the string property
- icon str
- The icon of the property
- max_
length int - The max length of the string property
- min_
length int - The min length of the string property
- pattern str
- The pattern of the string property
- required bool
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - title str
- The title of the property
- visible bool
- The visibility of the string property
- visible_
jq_ strquery - The visibility condition jq query of the string property
- blueprint String
- The blueprint identifier the string property relates to
- dataset Property Map
- The dataset of an the entity-format property
- default String
- The default of the string property
- default
Jq StringQuery - The default jq query of the string property
- depends
Ons List<String> - The properties that this property depends on
- description String
- The description of the property
- encryption String
- The algorithm to encrypt the property with
- enum
Jq StringQuery - The enum jq query of the string property
- enums List<String>
- The enum of the string property
- format String
- The format of the string property
- icon String
- The icon of the property
- max
Length Number - The max length of the string property
- min
Length Number - The min length of the string property
- pattern String
- The pattern of the string property
- required Boolean
- Whether the property is required, by default not required, this property can't be set at the same time if
required_jq_query
is set, and only supports true as value - title String
- The title of the property
- visible Boolean
- The visibility of the string property
- visible
Jq StringQuery - The visibility condition jq query of the string property
ActionUserPropertiesStringPropsDataset, ActionUserPropertiesStringPropsDatasetArgs
- Combinator string
- The combinator of the dataset
- Rules
List<port_
labs. Port. Inputs. Action User Properties String Props Dataset Rule> - The rules of the dataset
- Combinator string
- The combinator of the dataset
- Rules
[]Action
User Properties String Props Dataset Rule - The rules of the dataset
- combinator String
- The combinator of the dataset
- rules
List<Action
User Properties String Props Dataset Rule> - The rules of the dataset
- combinator string
- The combinator of the dataset
- rules
Action
User Properties String Props Dataset Rule[] - The rules of the dataset
- combinator str
- The combinator of the dataset
- rules
Sequence[Action
User Properties String Props Dataset Rule] - The rules of the dataset
- combinator String
- The combinator of the dataset
- rules List<Property Map>
- The rules of the dataset
ActionUserPropertiesStringPropsDatasetRule, ActionUserPropertiesStringPropsDatasetRuleArgs
- Operator string
- The operator of the rule
- Value
port_
labs. Port. Inputs. Action User Properties String Props Dataset Rule Value - The value of the rule
- Blueprint string
- The blueprint identifier of the rule
- Property string
- The property identifier of the rule
- Operator string
- The operator of the rule
- Value
Action
User Properties String Props Dataset Rule Value - The value of the rule
- Blueprint string
- The blueprint identifier of the rule
- Property string
- The property identifier of the rule
- operator String
- The operator of the rule
- value
Action
User Properties String Props Dataset Rule Value - The value of the rule
- blueprint String
- The blueprint identifier of the rule
- property String
- The property identifier of the rule
- operator string
- The operator of the rule
- value
Action
User Properties String Props Dataset Rule Value - The value of the rule
- blueprint string
- The blueprint identifier of the rule
- property string
- The property identifier of the rule
- operator str
- The operator of the rule
- value
Action
User Properties String Props Dataset Rule Value - The value of the rule
- blueprint str
- The blueprint identifier of the rule
- property str
- The property identifier of the rule
- operator String
- The operator of the rule
- value Property Map
- The value of the rule
- blueprint String
- The blueprint identifier of the rule
- property String
- The property identifier of the rule
ActionUserPropertiesStringPropsDatasetRuleValue, ActionUserPropertiesStringPropsDatasetRuleValueArgs
- Jq
Query string
- Jq
Query string
- jq
Query String
- jq
Query string
- jq_
query str
- jq
Query String
ActionWebhookMethod, ActionWebhookMethodArgs
- Url string
- Required when selecting type WEBHOOK. The URL to invoke the action
- Agent bool
- Use the agent to invoke the action
- Method string
- The HTTP method to invoke the action
- Synchronized bool
- Synchronize the action
- Url string
- Required when selecting type WEBHOOK. The URL to invoke the action
- Agent bool
- Use the agent to invoke the action
- Method string
- The HTTP method to invoke the action
- Synchronized bool
- Synchronize the action
- url String
- Required when selecting type WEBHOOK. The URL to invoke the action
- agent Boolean
- Use the agent to invoke the action
- method String
- The HTTP method to invoke the action
- synchronized_ Boolean
- Synchronize the action
- url string
- Required when selecting type WEBHOOK. The URL to invoke the action
- agent boolean
- Use the agent to invoke the action
- method string
- The HTTP method to invoke the action
- synchronized boolean
- Synchronize the action
- url str
- Required when selecting type WEBHOOK. The URL to invoke the action
- agent bool
- Use the agent to invoke the action
- method str
- The HTTP method to invoke the action
- synchronized bool
- Synchronize the action
- url String
- Required when selecting type WEBHOOK. The URL to invoke the action
- agent Boolean
- Use the agent to invoke the action
- method String
- The HTTP method to invoke the action
- synchronized Boolean
- Synchronize the action
Package Details
- Repository
- port port-labs/pulumi-port
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
port
Terraform Provider.