Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. onelogin
  3. API Docs
  4. apps
  5. Rules
onelogin v0.6.6 published on Friday, Sep 20, 2024 by Pulumi
pulumi/pulumi-onelogin

onelogin.apps.Rules

Explore with Pulumi AI

onelogin logo
onelogin v0.6.6 published on Friday, Sep 20, 2024 by Pulumi
pulumi/pulumi-onelogin

    Create Rules Resource

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

    Constructor syntax

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

@overload
def Rules(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          apps_id: Optional[str] = None,
          actions: Optional[Sequence[RulesActionArgs]] = None,
          conditions: Optional[Sequence[RulesConditionArgs]] = None,
          enabled: Optional[bool] = None,
          match: Optional[str] = None,
          name: Optional[str] = None,
          position: Optional[int] = None)
    func NewRules(ctx *Context, name string, args RulesArgs, opts ...ResourceOption) (*Rules, error)
    public Rules(string name, RulesArgs args, CustomResourceOptions? opts = null)
    public Rules(String name, RulesArgs args)
public Rules(String name, RulesArgs args, CustomResourceOptions options)

    type: onelogin:apps:Rules
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 RulesArgs
    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 RulesArgs
    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 RulesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RulesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RulesArgs
    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 rulesResource = new Onelogin.Apps.Rules("rulesResource", new()
{
    AppsId = "string",
    Actions = new[]
    {
        new Onelogin.Apps.Inputs.RulesActionArgs
        {
            Action = "string",
            Values = new[]
            {
                "string",
            },
        },
    },
    Conditions = new[]
    {
        new Onelogin.Apps.Inputs.RulesConditionArgs
        {
            Operator = "string",
            Source = "string",
            Value = "string",
        },
    },
    Enabled = false,
    Match = "string",
    Name = "string",
    Position = 0,
});

    example, err := apps.NewRules(ctx, "rulesResource", &apps.RulesArgs{
	AppsId: pulumi.String("string"),
	Actions: apps.RulesActionArray{
		&apps.RulesActionArgs{
			Action: pulumi.String("string"),
			Values: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Conditions: apps.RulesConditionArray{
		&apps.RulesConditionArgs{
			Operator: pulumi.String("string"),
			Source:   pulumi.String("string"),
			Value:    pulumi.String("string"),
		},
	},
	Enabled:  pulumi.Bool(false),
	Match:    pulumi.String("string"),
	Name:     pulumi.String("string"),
	Position: pulumi.Int(0),
})

    var rulesResource = new Rules("rulesResource", RulesArgs.builder()
    .appsId("string")
    .actions(RulesActionArgs.builder()
        .action("string")
        .values("string")
        .build())
    .conditions(RulesConditionArgs.builder()
        .operator("string")
        .source("string")
        .value("string")
        .build())
    .enabled(false)
    .match("string")
    .name("string")
    .position(0)
    .build());

    rules_resource = onelogin.apps.Rules("rulesResource",
    apps_id="string",
    actions=[onelogin.apps.RulesActionArgs(
        action="string",
        values=["string"],
    )],
    conditions=[onelogin.apps.RulesConditionArgs(
        operator="string",
        source="string",
        value="string",
    )],
    enabled=False,
    match="string",
    name="string",
    position=0)

    const rulesResource = new onelogin.apps.Rules("rulesResource", {
    appsId: "string",
    actions: [{
        action: "string",
        values: ["string"],
    }],
    conditions: [{
        operator: "string",
        source: "string",
        value: "string",
    }],
    enabled: false,
    match: "string",
    name: "string",
    position: 0,
});

    type: onelogin:apps:Rules
properties:
    actions:
        - action: string
          values:
            - string
    appsId: string
    conditions:
        - operator: string
          source: string
          value: string
    enabled: false
    match: string
    name: string
    position: 0

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

    AppsId string
    Actions List<RulesAction>
    Conditions List<RulesCondition>
    An array of conditions that the user must meet in order for the rule to be applied.
    Enabled bool
    Indicates if the rule is enabled or not.
    Match string
    Indicates how conditions should be matched.
    Name string
    Rule Name
    Position int
    Indicates the order of the rule. When null this will default to last position.
    AppsId string
    Actions []RulesActionArgs
    Conditions []RulesConditionArgs
    An array of conditions that the user must meet in order for the rule to be applied.
    Enabled bool
    Indicates if the rule is enabled or not.
    Match string
    Indicates how conditions should be matched.
    Name string
    Rule Name
    Position int
    Indicates the order of the rule. When null this will default to last position.
    appsId String
    actions List<RulesAction>
    conditions List<RulesCondition>
    An array of conditions that the user must meet in order for the rule to be applied.
    enabled Boolean
    Indicates if the rule is enabled or not.
    match String
    Indicates how conditions should be matched.
    name String
    Rule Name
    position Integer
    Indicates the order of the rule. When null this will default to last position.
    appsId string
    actions RulesAction[]
    conditions RulesCondition[]
    An array of conditions that the user must meet in order for the rule to be applied.
    enabled boolean
    Indicates if the rule is enabled or not.
    match string
    Indicates how conditions should be matched.
    name string
    Rule Name
    position number
    Indicates the order of the rule. When null this will default to last position.
    apps_id str
    actions Sequence[RulesActionArgs]
    conditions Sequence[RulesConditionArgs]
    An array of conditions that the user must meet in order for the rule to be applied.
    enabled bool
    Indicates if the rule is enabled or not.
    match str
    Indicates how conditions should be matched.
    name str
    Rule Name
    position int
    Indicates the order of the rule. When null this will default to last position.
    appsId String
    actions List<Property Map>
    conditions List<Property Map>
    An array of conditions that the user must meet in order for the rule to be applied.
    enabled Boolean
    Indicates if the rule is enabled or not.
    match String
    Indicates how conditions should be matched.
    name String
    Rule Name
    position Number
    Indicates the order of the rule. When null this will default to last position.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Rules 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 Rules Resource

    Get an existing Rules 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?: RulesState, opts?: CustomResourceOptions): Rules
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        actions: Optional[Sequence[RulesActionArgs]] = None,
        apps_id: Optional[str] = None,
        conditions: Optional[Sequence[RulesConditionArgs]] = None,
        enabled: Optional[bool] = None,
        match: Optional[str] = None,
        name: Optional[str] = None,
        position: Optional[int] = None) -> Rules
    func GetRules(ctx *Context, name string, id IDInput, state *RulesState, opts ...ResourceOption) (*Rules, error)
    public static Rules Get(string name, Input<string> id, RulesState? state, CustomResourceOptions? opts = null)
    public static Rules get(String name, Output<String> id, RulesState 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.
    The following state arguments are supported:
    Actions List<RulesAction>
    AppsId string
    Conditions List<RulesCondition>
    An array of conditions that the user must meet in order for the rule to be applied.
    Enabled bool
    Indicates if the rule is enabled or not.
    Match string
    Indicates how conditions should be matched.
    Name string
    Rule Name
    Position int
    Indicates the order of the rule. When null this will default to last position.
    Actions []RulesActionArgs
    AppsId string
    Conditions []RulesConditionArgs
    An array of conditions that the user must meet in order for the rule to be applied.
    Enabled bool
    Indicates if the rule is enabled or not.
    Match string
    Indicates how conditions should be matched.
    Name string
    Rule Name
    Position int
    Indicates the order of the rule. When null this will default to last position.
    actions List<RulesAction>
    appsId String
    conditions List<RulesCondition>
    An array of conditions that the user must meet in order for the rule to be applied.
    enabled Boolean
    Indicates if the rule is enabled or not.
    match String
    Indicates how conditions should be matched.
    name String
    Rule Name
    position Integer
    Indicates the order of the rule. When null this will default to last position.
    actions RulesAction[]
    appsId string
    conditions RulesCondition[]
    An array of conditions that the user must meet in order for the rule to be applied.
    enabled boolean
    Indicates if the rule is enabled or not.
    match string
    Indicates how conditions should be matched.
    name string
    Rule Name
    position number
    Indicates the order of the rule. When null this will default to last position.
    actions Sequence[RulesActionArgs]
    apps_id str
    conditions Sequence[RulesConditionArgs]
    An array of conditions that the user must meet in order for the rule to be applied.
    enabled bool
    Indicates if the rule is enabled or not.
    match str
    Indicates how conditions should be matched.
    name str
    Rule Name
    position int
    Indicates the order of the rule. When null this will default to last position.
    actions List<Property Map>
    appsId String
    conditions List<Property Map>
    An array of conditions that the user must meet in order for the rule to be applied.
    enabled Boolean
    Indicates if the rule is enabled or not.
    match String
    Indicates how conditions should be matched.
    name String
    Rule Name
    position Number
    Indicates the order of the rule. When null this will default to last position.

    Supporting Types

    RulesAction, RulesActionArgs

    Action string
    The action to apply
    Values List<string>
    Only applicable to provisioned and set_* actions. Items in the array will be a plain text string or valid value for the selected action.
    Action string
    The action to apply
    Values []string
    Only applicable to provisioned and set_* actions. Items in the array will be a plain text string or valid value for the selected action.
    action String
    The action to apply
    values List<String>
    Only applicable to provisioned and set_* actions. Items in the array will be a plain text string or valid value for the selected action.
    action string
    The action to apply
    values string[]
    Only applicable to provisioned and set_* actions. Items in the array will be a plain text string or valid value for the selected action.
    action str
    The action to apply
    values Sequence[str]
    Only applicable to provisioned and set_* actions. Items in the array will be a plain text string or valid value for the selected action.
    action String
    The action to apply
    values List<String>
    Only applicable to provisioned and set_* actions. Items in the array will be a plain text string or valid value for the selected action.

    RulesCondition, RulesConditionArgs

    Operator string
    A valid operator for the selected condition source
    Source string
    source field to check.
    Value string
    A plain text string or valid value for the selected condition source
    Operator string
    A valid operator for the selected condition source
    Source string
    source field to check.
    Value string
    A plain text string or valid value for the selected condition source
    operator String
    A valid operator for the selected condition source
    source String
    source field to check.
    value String
    A plain text string or valid value for the selected condition source
    operator string
    A valid operator for the selected condition source
    source string
    source field to check.
    value string
    A plain text string or valid value for the selected condition source
    operator str
    A valid operator for the selected condition source
    source str
    source field to check.
    value str
    A plain text string or valid value for the selected condition source
    operator String
    A valid operator for the selected condition source
    source String
    source field to check.
    value String
    A plain text string or valid value for the selected condition source

    Package Details

    Repository
    onelogin pulumi/pulumi-onelogin
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the onelogin Terraform Provider.
    onelogin logo
    onelogin v0.6.6 published on Friday, Sep 20, 2024 by Pulumi
    pulumi/pulumi-onelogin