1. Packages
  2. Sysdig Provider
  3. API Docs
  4. SecureMlPolicy
sysdig 1.56.0 published on Wednesday, Apr 30, 2025 by sysdiglabs

sysdig.SecureMlPolicy

Explore with Pulumi AI

sysdig logo
sysdig 1.56.0 published on Wednesday, Apr 30, 2025 by sysdiglabs

    Example Usage

    Create SecureMlPolicy Resource

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

    Constructor syntax

    new SecureMlPolicy(name: string, args: SecureMlPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def SecureMlPolicy(resource_name: str,
                       args: SecureMlPolicyArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def SecureMlPolicy(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       description: Optional[str] = None,
                       rules: Optional[Sequence[SecureMlPolicyRuleArgs]] = None,
                       enabled: Optional[bool] = None,
                       name: Optional[str] = None,
                       notification_channels: Optional[Sequence[float]] = None,
                       runbook: Optional[str] = None,
                       scope: Optional[str] = None,
                       secure_ml_policy_id: Optional[str] = None,
                       severity: Optional[float] = None,
                       timeouts: Optional[SecureMlPolicyTimeoutsArgs] = None,
                       type: Optional[str] = None)
    func NewSecureMlPolicy(ctx *Context, name string, args SecureMlPolicyArgs, opts ...ResourceOption) (*SecureMlPolicy, error)
    public SecureMlPolicy(string name, SecureMlPolicyArgs args, CustomResourceOptions? opts = null)
    public SecureMlPolicy(String name, SecureMlPolicyArgs args)
    public SecureMlPolicy(String name, SecureMlPolicyArgs args, CustomResourceOptions options)
    
    type: sysdig:SecureMlPolicy
    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 SecureMlPolicyArgs
    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 SecureMlPolicyArgs
    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 SecureMlPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecureMlPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SecureMlPolicyArgs
    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 secureMlPolicyResource = new Sysdig.SecureMlPolicy("secureMlPolicyResource", new()
    {
        Description = "string",
        Rules = new[]
        {
            new Sysdig.Inputs.SecureMlPolicyRuleArgs
            {
                Description = "string",
                CryptominingTrigger = new Sysdig.Inputs.SecureMlPolicyRuleCryptominingTriggerArgs
                {
                    Threshold = 0,
                    Enabled = false,
                },
                Id = 0,
                Name = "string",
                Tags = new[]
                {
                    "string",
                },
                Version = 0,
            },
        },
        Enabled = false,
        Name = "string",
        NotificationChannels = new[]
        {
            0,
        },
        Runbook = "string",
        Scope = "string",
        SecureMlPolicyId = "string",
        Severity = 0,
        Timeouts = new Sysdig.Inputs.SecureMlPolicyTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Read = "string",
            Update = "string",
        },
        Type = "string",
    });
    
    example, err := sysdig.NewSecureMlPolicy(ctx, "secureMlPolicyResource", &sysdig.SecureMlPolicyArgs{
    	Description: pulumi.String("string"),
    	Rules: sysdig.SecureMlPolicyRuleArray{
    		&sysdig.SecureMlPolicyRuleArgs{
    			Description: pulumi.String("string"),
    			CryptominingTrigger: &sysdig.SecureMlPolicyRuleCryptominingTriggerArgs{
    				Threshold: pulumi.Float64(0),
    				Enabled:   pulumi.Bool(false),
    			},
    			Id:   pulumi.Float64(0),
    			Name: pulumi.String("string"),
    			Tags: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			Version: pulumi.Float64(0),
    		},
    	},
    	Enabled: pulumi.Bool(false),
    	Name:    pulumi.String("string"),
    	NotificationChannels: pulumi.Float64Array{
    		pulumi.Float64(0),
    	},
    	Runbook:          pulumi.String("string"),
    	Scope:            pulumi.String("string"),
    	SecureMlPolicyId: pulumi.String("string"),
    	Severity:         pulumi.Float64(0),
    	Timeouts: &sysdig.SecureMlPolicyTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Read:   pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    	Type: pulumi.String("string"),
    })
    
    var secureMlPolicyResource = new SecureMlPolicy("secureMlPolicyResource", SecureMlPolicyArgs.builder()
        .description("string")
        .rules(SecureMlPolicyRuleArgs.builder()
            .description("string")
            .cryptominingTrigger(SecureMlPolicyRuleCryptominingTriggerArgs.builder()
                .threshold(0)
                .enabled(false)
                .build())
            .id(0)
            .name("string")
            .tags("string")
            .version(0)
            .build())
        .enabled(false)
        .name("string")
        .notificationChannels(0)
        .runbook("string")
        .scope("string")
        .secureMlPolicyId("string")
        .severity(0)
        .timeouts(SecureMlPolicyTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .read("string")
            .update("string")
            .build())
        .type("string")
        .build());
    
    secure_ml_policy_resource = sysdig.SecureMlPolicy("secureMlPolicyResource",
        description="string",
        rules=[{
            "description": "string",
            "cryptomining_trigger": {
                "threshold": 0,
                "enabled": False,
            },
            "id": 0,
            "name": "string",
            "tags": ["string"],
            "version": 0,
        }],
        enabled=False,
        name="string",
        notification_channels=[0],
        runbook="string",
        scope="string",
        secure_ml_policy_id="string",
        severity=0,
        timeouts={
            "create": "string",
            "delete": "string",
            "read": "string",
            "update": "string",
        },
        type="string")
    
    const secureMlPolicyResource = new sysdig.SecureMlPolicy("secureMlPolicyResource", {
        description: "string",
        rules: [{
            description: "string",
            cryptominingTrigger: {
                threshold: 0,
                enabled: false,
            },
            id: 0,
            name: "string",
            tags: ["string"],
            version: 0,
        }],
        enabled: false,
        name: "string",
        notificationChannels: [0],
        runbook: "string",
        scope: "string",
        secureMlPolicyId: "string",
        severity: 0,
        timeouts: {
            create: "string",
            "delete": "string",
            read: "string",
            update: "string",
        },
        type: "string",
    });
    
    type: sysdig:SecureMlPolicy
    properties:
        description: string
        enabled: false
        name: string
        notificationChannels:
            - 0
        rules:
            - cryptominingTrigger:
                enabled: false
                threshold: 0
              description: string
              id: 0
              name: string
              tags:
                - string
              version: 0
        runbook: string
        scope: string
        secureMlPolicyId: string
        severity: 0
        timeouts:
            create: string
            delete: string
            read: string
            update: string
        type: string
    

    SecureMlPolicy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SecureMlPolicy resource accepts the following input properties:

    Description string
    (Required) Rule description.
    Rules List<SecureMlPolicyRule>
    Enabled bool
    Whether the policy is enabled or not.
    Name string
    The name of the Secure managed policy.
    NotificationChannels List<double>
    IDs of the notification channels to send alerts to when the policy is fired.
    Runbook string
    Customer provided url that provides a runbook for a given policy.
    Scope string
    The application scope for the policy.
    SecureMlPolicyId string
    The id for the policy.
    Severity double
    The severity of Secure policy. The accepted values are: 0, 1, 2, 3 (High), 4, 5 (Medium), 6 (Low) and 7 (Info).
    Timeouts SecureMlPolicyTimeouts
    Type string
    Description string
    (Required) Rule description.
    Rules []SecureMlPolicyRuleArgs
    Enabled bool
    Whether the policy is enabled or not.
    Name string
    The name of the Secure managed policy.
    NotificationChannels []float64
    IDs of the notification channels to send alerts to when the policy is fired.
    Runbook string
    Customer provided url that provides a runbook for a given policy.
    Scope string
    The application scope for the policy.
    SecureMlPolicyId string
    The id for the policy.
    Severity float64
    The severity of Secure policy. The accepted values are: 0, 1, 2, 3 (High), 4, 5 (Medium), 6 (Low) and 7 (Info).
    Timeouts SecureMlPolicyTimeoutsArgs
    Type string
    description String
    (Required) Rule description.
    rules List<SecureMlPolicyRule>
    enabled Boolean
    Whether the policy is enabled or not.
    name String
    The name of the Secure managed policy.
    notificationChannels List<Double>
    IDs of the notification channels to send alerts to when the policy is fired.
    runbook String
    Customer provided url that provides a runbook for a given policy.
    scope String
    The application scope for the policy.
    secureMlPolicyId String
    The id for the policy.
    severity Double
    The severity of Secure policy. The accepted values are: 0, 1, 2, 3 (High), 4, 5 (Medium), 6 (Low) and 7 (Info).
    timeouts SecureMlPolicyTimeouts
    type String
    description string
    (Required) Rule description.
    rules SecureMlPolicyRule[]
    enabled boolean
    Whether the policy is enabled or not.
    name string
    The name of the Secure managed policy.
    notificationChannels number[]
    IDs of the notification channels to send alerts to when the policy is fired.
    runbook string
    Customer provided url that provides a runbook for a given policy.
    scope string
    The application scope for the policy.
    secureMlPolicyId string
    The id for the policy.
    severity number
    The severity of Secure policy. The accepted values are: 0, 1, 2, 3 (High), 4, 5 (Medium), 6 (Low) and 7 (Info).
    timeouts SecureMlPolicyTimeouts
    type string
    description str
    (Required) Rule description.
    rules Sequence[SecureMlPolicyRuleArgs]
    enabled bool
    Whether the policy is enabled or not.
    name str
    The name of the Secure managed policy.
    notification_channels Sequence[float]
    IDs of the notification channels to send alerts to when the policy is fired.
    runbook str
    Customer provided url that provides a runbook for a given policy.
    scope str
    The application scope for the policy.
    secure_ml_policy_id str
    The id for the policy.
    severity float
    The severity of Secure policy. The accepted values are: 0, 1, 2, 3 (High), 4, 5 (Medium), 6 (Low) and 7 (Info).
    timeouts SecureMlPolicyTimeoutsArgs
    type str
    description String
    (Required) Rule description.
    rules List<Property Map>
    enabled Boolean
    Whether the policy is enabled or not.
    name String
    The name of the Secure managed policy.
    notificationChannels List<Number>
    IDs of the notification channels to send alerts to when the policy is fired.
    runbook String
    Customer provided url that provides a runbook for a given policy.
    scope String
    The application scope for the policy.
    secureMlPolicyId String
    The id for the policy.
    severity Number
    The severity of Secure policy. The accepted values are: 0, 1, 2, 3 (High), 4, 5 (Medium), 6 (Low) and 7 (Info).
    timeouts Property Map
    type String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Version double
    Id string
    The provider-assigned unique ID for this managed resource.
    Version float64
    id String
    The provider-assigned unique ID for this managed resource.
    version Double
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    id str
    The provider-assigned unique ID for this managed resource.
    version float
    id String
    The provider-assigned unique ID for this managed resource.
    version Number

    Look up Existing SecureMlPolicy Resource

    Get an existing SecureMlPolicy 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?: SecureMlPolicyState, opts?: CustomResourceOptions): SecureMlPolicy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            enabled: Optional[bool] = None,
            name: Optional[str] = None,
            notification_channels: Optional[Sequence[float]] = None,
            rules: Optional[Sequence[SecureMlPolicyRuleArgs]] = None,
            runbook: Optional[str] = None,
            scope: Optional[str] = None,
            secure_ml_policy_id: Optional[str] = None,
            severity: Optional[float] = None,
            timeouts: Optional[SecureMlPolicyTimeoutsArgs] = None,
            type: Optional[str] = None,
            version: Optional[float] = None) -> SecureMlPolicy
    func GetSecureMlPolicy(ctx *Context, name string, id IDInput, state *SecureMlPolicyState, opts ...ResourceOption) (*SecureMlPolicy, error)
    public static SecureMlPolicy Get(string name, Input<string> id, SecureMlPolicyState? state, CustomResourceOptions? opts = null)
    public static SecureMlPolicy get(String name, Output<String> id, SecureMlPolicyState state, CustomResourceOptions options)
    resources:  _:    type: sysdig:SecureMlPolicy    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    (Required) Rule description.
    Enabled bool
    Whether the policy is enabled or not.
    Name string
    The name of the Secure managed policy.
    NotificationChannels List<double>
    IDs of the notification channels to send alerts to when the policy is fired.
    Rules List<SecureMlPolicyRule>
    Runbook string
    Customer provided url that provides a runbook for a given policy.
    Scope string
    The application scope for the policy.
    SecureMlPolicyId string
    The id for the policy.
    Severity double
    The severity of Secure policy. The accepted values are: 0, 1, 2, 3 (High), 4, 5 (Medium), 6 (Low) and 7 (Info).
    Timeouts SecureMlPolicyTimeouts
    Type string
    Version double
    Description string
    (Required) Rule description.
    Enabled bool
    Whether the policy is enabled or not.
    Name string
    The name of the Secure managed policy.
    NotificationChannels []float64
    IDs of the notification channels to send alerts to when the policy is fired.
    Rules []SecureMlPolicyRuleArgs
    Runbook string
    Customer provided url that provides a runbook for a given policy.
    Scope string
    The application scope for the policy.
    SecureMlPolicyId string
    The id for the policy.
    Severity float64
    The severity of Secure policy. The accepted values are: 0, 1, 2, 3 (High), 4, 5 (Medium), 6 (Low) and 7 (Info).
    Timeouts SecureMlPolicyTimeoutsArgs
    Type string
    Version float64
    description String
    (Required) Rule description.
    enabled Boolean
    Whether the policy is enabled or not.
    name String
    The name of the Secure managed policy.
    notificationChannels List<Double>
    IDs of the notification channels to send alerts to when the policy is fired.
    rules List<SecureMlPolicyRule>
    runbook String
    Customer provided url that provides a runbook for a given policy.
    scope String
    The application scope for the policy.
    secureMlPolicyId String
    The id for the policy.
    severity Double
    The severity of Secure policy. The accepted values are: 0, 1, 2, 3 (High), 4, 5 (Medium), 6 (Low) and 7 (Info).
    timeouts SecureMlPolicyTimeouts
    type String
    version Double
    description string
    (Required) Rule description.
    enabled boolean
    Whether the policy is enabled or not.
    name string
    The name of the Secure managed policy.
    notificationChannels number[]
    IDs of the notification channels to send alerts to when the policy is fired.
    rules SecureMlPolicyRule[]
    runbook string
    Customer provided url that provides a runbook for a given policy.
    scope string
    The application scope for the policy.
    secureMlPolicyId string
    The id for the policy.
    severity number
    The severity of Secure policy. The accepted values are: 0, 1, 2, 3 (High), 4, 5 (Medium), 6 (Low) and 7 (Info).
    timeouts SecureMlPolicyTimeouts
    type string
    version number
    description str
    (Required) Rule description.
    enabled bool
    Whether the policy is enabled or not.
    name str
    The name of the Secure managed policy.
    notification_channels Sequence[float]
    IDs of the notification channels to send alerts to when the policy is fired.
    rules Sequence[SecureMlPolicyRuleArgs]
    runbook str
    Customer provided url that provides a runbook for a given policy.
    scope str
    The application scope for the policy.
    secure_ml_policy_id str
    The id for the policy.
    severity float
    The severity of Secure policy. The accepted values are: 0, 1, 2, 3 (High), 4, 5 (Medium), 6 (Low) and 7 (Info).
    timeouts SecureMlPolicyTimeoutsArgs
    type str
    version float
    description String
    (Required) Rule description.
    enabled Boolean
    Whether the policy is enabled or not.
    name String
    The name of the Secure managed policy.
    notificationChannels List<Number>
    IDs of the notification channels to send alerts to when the policy is fired.
    rules List<Property Map>
    runbook String
    Customer provided url that provides a runbook for a given policy.
    scope String
    The application scope for the policy.
    secureMlPolicyId String
    The id for the policy.
    severity Number
    The severity of Secure policy. The accepted values are: 0, 1, 2, 3 (High), 4, 5 (Medium), 6 (Low) and 7 (Info).
    timeouts Property Map
    type String
    version Number

    Supporting Types

    SecureMlPolicyRule, SecureMlPolicyRuleArgs

    Description string
    (Required) Rule description.
    CryptominingTrigger SecureMlPolicyRuleCryptominingTrigger
    (Required) Cryptomining detection: Detect unusual activity in the Activity Audit based on the set confidence level.
    Id double
    The id for the policy.
    Name string
    The name of the Secure managed policy.
    Tags List<string>
    Version double
    Description string
    (Required) Rule description.
    CryptominingTrigger SecureMlPolicyRuleCryptominingTrigger
    (Required) Cryptomining detection: Detect unusual activity in the Activity Audit based on the set confidence level.
    Id float64
    The id for the policy.
    Name string
    The name of the Secure managed policy.
    Tags []string
    Version float64
    description String
    (Required) Rule description.
    cryptominingTrigger SecureMlPolicyRuleCryptominingTrigger
    (Required) Cryptomining detection: Detect unusual activity in the Activity Audit based on the set confidence level.
    id Double
    The id for the policy.
    name String
    The name of the Secure managed policy.
    tags List<String>
    version Double
    description string
    (Required) Rule description.
    cryptominingTrigger SecureMlPolicyRuleCryptominingTrigger
    (Required) Cryptomining detection: Detect unusual activity in the Activity Audit based on the set confidence level.
    id number
    The id for the policy.
    name string
    The name of the Secure managed policy.
    tags string[]
    version number
    description str
    (Required) Rule description.
    cryptomining_trigger SecureMlPolicyRuleCryptominingTrigger
    (Required) Cryptomining detection: Detect unusual activity in the Activity Audit based on the set confidence level.
    id float
    The id for the policy.
    name str
    The name of the Secure managed policy.
    tags Sequence[str]
    version float
    description String
    (Required) Rule description.
    cryptominingTrigger Property Map
    (Required) Cryptomining detection: Detect unusual activity in the Activity Audit based on the set confidence level.
    id Number
    The id for the policy.
    name String
    The name of the Secure managed policy.
    tags List<String>
    version Number

    SecureMlPolicyRuleCryptominingTrigger, SecureMlPolicyRuleCryptominingTriggerArgs

    Threshold double
    (Required) Trigger at or above confidence level. Accepted values are 3 (Highest), 2 (Higher), 1 (Default)
    Enabled bool
    Whether the policy is enabled or not.
    Threshold float64
    (Required) Trigger at or above confidence level. Accepted values are 3 (Highest), 2 (Higher), 1 (Default)
    Enabled bool
    Whether the policy is enabled or not.
    threshold Double
    (Required) Trigger at or above confidence level. Accepted values are 3 (Highest), 2 (Higher), 1 (Default)
    enabled Boolean
    Whether the policy is enabled or not.
    threshold number
    (Required) Trigger at or above confidence level. Accepted values are 3 (Highest), 2 (Higher), 1 (Default)
    enabled boolean
    Whether the policy is enabled or not.
    threshold float
    (Required) Trigger at or above confidence level. Accepted values are 3 (Highest), 2 (Higher), 1 (Default)
    enabled bool
    Whether the policy is enabled or not.
    threshold Number
    (Required) Trigger at or above confidence level. Accepted values are 3 (Highest), 2 (Higher), 1 (Default)
    enabled Boolean
    Whether the policy is enabled or not.

    SecureMlPolicyTimeouts, SecureMlPolicyTimeoutsArgs

    Create string
    Delete string
    Read string
    Update string
    Create string
    Delete string
    Read string
    Update string
    create String
    delete String
    read String
    update String
    create string
    delete string
    read string
    update string
    create str
    delete str
    read str
    update str
    create String
    delete String
    read String
    update String

    Package Details

    Repository
    sysdig sysdiglabs/terraform-provider-sysdig
    License
    Notes
    This Pulumi package is based on the sysdig Terraform Provider.
    sysdig logo
    sysdig 1.56.0 published on Wednesday, Apr 30, 2025 by sysdiglabs