1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. threatdetection
  5. AntiBruteForceRule
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

alicloud.threatdetection.AntiBruteForceRule

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

    Provides a Threat Detection Anti Brute Force Rule resource.

    For information about Threat Detection Anti Brute Force Rule and how to use it, see What is Anti Brute Force Rule.

    NOTE: Available since v1.195.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const _default = new alicloud.threatdetection.AntiBruteForceRule("default", {
        antiBruteForceRuleName: "apispec_example",
        forbiddenTime: 360,
        uuidLists: ["032b618f-b220-4a0d-bd37-fbdc6ef58b6a"],
        failCount: 80,
        span: 10,
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    default = alicloud.threatdetection.AntiBruteForceRule("default",
        anti_brute_force_rule_name="apispec_example",
        forbidden_time=360,
        uuid_lists=["032b618f-b220-4a0d-bd37-fbdc6ef58b6a"],
        fail_count=80,
        span=10)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/threatdetection"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := threatdetection.NewAntiBruteForceRule(ctx, "default", &threatdetection.AntiBruteForceRuleArgs{
    			AntiBruteForceRuleName: pulumi.String("apispec_example"),
    			ForbiddenTime:          pulumi.Int(360),
    			UuidLists: pulumi.StringArray{
    				pulumi.String("032b618f-b220-4a0d-bd37-fbdc6ef58b6a"),
    			},
    			FailCount: pulumi.Int(80),
    			Span:      pulumi.Int(10),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = new AliCloud.ThreatDetection.AntiBruteForceRule("default", new()
        {
            AntiBruteForceRuleName = "apispec_example",
            ForbiddenTime = 360,
            UuidLists = new[]
            {
                "032b618f-b220-4a0d-bd37-fbdc6ef58b6a",
            },
            FailCount = 80,
            Span = 10,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.threatdetection.AntiBruteForceRule;
    import com.pulumi.alicloud.threatdetection.AntiBruteForceRuleArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var default_ = new AntiBruteForceRule("default", AntiBruteForceRuleArgs.builder()
                .antiBruteForceRuleName("apispec_example")
                .forbiddenTime(360)
                .uuidLists("032b618f-b220-4a0d-bd37-fbdc6ef58b6a")
                .failCount(80)
                .span(10)
                .build());
    
        }
    }
    
    resources:
      default:
        type: alicloud:threatdetection:AntiBruteForceRule
        properties:
          antiBruteForceRuleName: apispec_example
          forbiddenTime: 360
          uuidLists:
            - 032b618f-b220-4a0d-bd37-fbdc6ef58b6a
          failCount: 80
          span: 10
    

    Create AntiBruteForceRule Resource

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

    Constructor syntax

    new AntiBruteForceRule(name: string, args: AntiBruteForceRuleArgs, opts?: CustomResourceOptions);
    @overload
    def AntiBruteForceRule(resource_name: str,
                           args: AntiBruteForceRuleArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def AntiBruteForceRule(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           anti_brute_force_rule_name: Optional[str] = None,
                           fail_count: Optional[int] = None,
                           forbidden_time: Optional[int] = None,
                           span: Optional[int] = None,
                           uuid_lists: Optional[Sequence[str]] = None,
                           default_rule: Optional[bool] = None)
    func NewAntiBruteForceRule(ctx *Context, name string, args AntiBruteForceRuleArgs, opts ...ResourceOption) (*AntiBruteForceRule, error)
    public AntiBruteForceRule(string name, AntiBruteForceRuleArgs args, CustomResourceOptions? opts = null)
    public AntiBruteForceRule(String name, AntiBruteForceRuleArgs args)
    public AntiBruteForceRule(String name, AntiBruteForceRuleArgs args, CustomResourceOptions options)
    
    type: alicloud:threatdetection:AntiBruteForceRule
    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 AntiBruteForceRuleArgs
    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 AntiBruteForceRuleArgs
    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 AntiBruteForceRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AntiBruteForceRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AntiBruteForceRuleArgs
    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 antiBruteForceRuleResource = new AliCloud.ThreatDetection.AntiBruteForceRule("antiBruteForceRuleResource", new()
    {
        AntiBruteForceRuleName = "string",
        FailCount = 0,
        ForbiddenTime = 0,
        Span = 0,
        UuidLists = new[]
        {
            "string",
        },
        DefaultRule = false,
    });
    
    example, err := threatdetection.NewAntiBruteForceRule(ctx, "antiBruteForceRuleResource", &threatdetection.AntiBruteForceRuleArgs{
    	AntiBruteForceRuleName: pulumi.String("string"),
    	FailCount:              pulumi.Int(0),
    	ForbiddenTime:          pulumi.Int(0),
    	Span:                   pulumi.Int(0),
    	UuidLists: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DefaultRule: pulumi.Bool(false),
    })
    
    var antiBruteForceRuleResource = new AntiBruteForceRule("antiBruteForceRuleResource", AntiBruteForceRuleArgs.builder()
        .antiBruteForceRuleName("string")
        .failCount(0)
        .forbiddenTime(0)
        .span(0)
        .uuidLists("string")
        .defaultRule(false)
        .build());
    
    anti_brute_force_rule_resource = alicloud.threatdetection.AntiBruteForceRule("antiBruteForceRuleResource",
        anti_brute_force_rule_name="string",
        fail_count=0,
        forbidden_time=0,
        span=0,
        uuid_lists=["string"],
        default_rule=False)
    
    const antiBruteForceRuleResource = new alicloud.threatdetection.AntiBruteForceRule("antiBruteForceRuleResource", {
        antiBruteForceRuleName: "string",
        failCount: 0,
        forbiddenTime: 0,
        span: 0,
        uuidLists: ["string"],
        defaultRule: false,
    });
    
    type: alicloud:threatdetection:AntiBruteForceRule
    properties:
        antiBruteForceRuleName: string
        defaultRule: false
        failCount: 0
        forbiddenTime: 0
        span: 0
        uuidLists:
            - string
    

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

    AntiBruteForceRuleName string
    The name of the defense rule.
    FailCount int
    The threshold for the number of failed user logins when the brute-force defense rule takes effect.
    ForbiddenTime int
    The period of time during which logons from an account are not allowed. Unit: minutes.
    Span int
    The period of time during which logon failures from an account are measured. Unit: minutes. If Span is set to 10, the defense rule takes effect when the logon failures measured within 10 minutes reaches the specified threshold. The IP address of attackers cannot be used to log on to the server in the specified period of time.
    UuidLists List<string>
    An array consisting of the UUIDs of servers to which the defense rule is applied.The binding status must be Enterprise Edition.
    DefaultRule bool
    Specifies whether to set the defense rule as the default rule.
    AntiBruteForceRuleName string
    The name of the defense rule.
    FailCount int
    The threshold for the number of failed user logins when the brute-force defense rule takes effect.
    ForbiddenTime int
    The period of time during which logons from an account are not allowed. Unit: minutes.
    Span int
    The period of time during which logon failures from an account are measured. Unit: minutes. If Span is set to 10, the defense rule takes effect when the logon failures measured within 10 minutes reaches the specified threshold. The IP address of attackers cannot be used to log on to the server in the specified period of time.
    UuidLists []string
    An array consisting of the UUIDs of servers to which the defense rule is applied.The binding status must be Enterprise Edition.
    DefaultRule bool
    Specifies whether to set the defense rule as the default rule.
    antiBruteForceRuleName String
    The name of the defense rule.
    failCount Integer
    The threshold for the number of failed user logins when the brute-force defense rule takes effect.
    forbiddenTime Integer
    The period of time during which logons from an account are not allowed. Unit: minutes.
    span Integer
    The period of time during which logon failures from an account are measured. Unit: minutes. If Span is set to 10, the defense rule takes effect when the logon failures measured within 10 minutes reaches the specified threshold. The IP address of attackers cannot be used to log on to the server in the specified period of time.
    uuidLists List<String>
    An array consisting of the UUIDs of servers to which the defense rule is applied.The binding status must be Enterprise Edition.
    defaultRule Boolean
    Specifies whether to set the defense rule as the default rule.
    antiBruteForceRuleName string
    The name of the defense rule.
    failCount number
    The threshold for the number of failed user logins when the brute-force defense rule takes effect.
    forbiddenTime number
    The period of time during which logons from an account are not allowed. Unit: minutes.
    span number
    The period of time during which logon failures from an account are measured. Unit: minutes. If Span is set to 10, the defense rule takes effect when the logon failures measured within 10 minutes reaches the specified threshold. The IP address of attackers cannot be used to log on to the server in the specified period of time.
    uuidLists string[]
    An array consisting of the UUIDs of servers to which the defense rule is applied.The binding status must be Enterprise Edition.
    defaultRule boolean
    Specifies whether to set the defense rule as the default rule.
    anti_brute_force_rule_name str
    The name of the defense rule.
    fail_count int
    The threshold for the number of failed user logins when the brute-force defense rule takes effect.
    forbidden_time int
    The period of time during which logons from an account are not allowed. Unit: minutes.
    span int
    The period of time during which logon failures from an account are measured. Unit: minutes. If Span is set to 10, the defense rule takes effect when the logon failures measured within 10 minutes reaches the specified threshold. The IP address of attackers cannot be used to log on to the server in the specified period of time.
    uuid_lists Sequence[str]
    An array consisting of the UUIDs of servers to which the defense rule is applied.The binding status must be Enterprise Edition.
    default_rule bool
    Specifies whether to set the defense rule as the default rule.
    antiBruteForceRuleName String
    The name of the defense rule.
    failCount Number
    The threshold for the number of failed user logins when the brute-force defense rule takes effect.
    forbiddenTime Number
    The period of time during which logons from an account are not allowed. Unit: minutes.
    span Number
    The period of time during which logon failures from an account are measured. Unit: minutes. If Span is set to 10, the defense rule takes effect when the logon failures measured within 10 minutes reaches the specified threshold. The IP address of attackers cannot be used to log on to the server in the specified period of time.
    uuidLists List<String>
    An array consisting of the UUIDs of servers to which the defense rule is applied.The binding status must be Enterprise Edition.
    defaultRule Boolean
    Specifies whether to set the defense rule as the default rule.

    Outputs

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

    AntiBruteForceRuleId string
    The ID of the defense rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    AntiBruteForceRuleId string
    The ID of the defense rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    antiBruteForceRuleId String
    The ID of the defense rule.
    id String
    The provider-assigned unique ID for this managed resource.
    antiBruteForceRuleId string
    The ID of the defense rule.
    id string
    The provider-assigned unique ID for this managed resource.
    anti_brute_force_rule_id str
    The ID of the defense rule.
    id str
    The provider-assigned unique ID for this managed resource.
    antiBruteForceRuleId String
    The ID of the defense rule.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AntiBruteForceRule Resource

    Get an existing AntiBruteForceRule 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?: AntiBruteForceRuleState, opts?: CustomResourceOptions): AntiBruteForceRule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            anti_brute_force_rule_id: Optional[str] = None,
            anti_brute_force_rule_name: Optional[str] = None,
            default_rule: Optional[bool] = None,
            fail_count: Optional[int] = None,
            forbidden_time: Optional[int] = None,
            span: Optional[int] = None,
            uuid_lists: Optional[Sequence[str]] = None) -> AntiBruteForceRule
    func GetAntiBruteForceRule(ctx *Context, name string, id IDInput, state *AntiBruteForceRuleState, opts ...ResourceOption) (*AntiBruteForceRule, error)
    public static AntiBruteForceRule Get(string name, Input<string> id, AntiBruteForceRuleState? state, CustomResourceOptions? opts = null)
    public static AntiBruteForceRule get(String name, Output<String> id, AntiBruteForceRuleState 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:
    AntiBruteForceRuleId string
    The ID of the defense rule.
    AntiBruteForceRuleName string
    The name of the defense rule.
    DefaultRule bool
    Specifies whether to set the defense rule as the default rule.
    FailCount int
    The threshold for the number of failed user logins when the brute-force defense rule takes effect.
    ForbiddenTime int
    The period of time during which logons from an account are not allowed. Unit: minutes.
    Span int
    The period of time during which logon failures from an account are measured. Unit: minutes. If Span is set to 10, the defense rule takes effect when the logon failures measured within 10 minutes reaches the specified threshold. The IP address of attackers cannot be used to log on to the server in the specified period of time.
    UuidLists List<string>
    An array consisting of the UUIDs of servers to which the defense rule is applied.The binding status must be Enterprise Edition.
    AntiBruteForceRuleId string
    The ID of the defense rule.
    AntiBruteForceRuleName string
    The name of the defense rule.
    DefaultRule bool
    Specifies whether to set the defense rule as the default rule.
    FailCount int
    The threshold for the number of failed user logins when the brute-force defense rule takes effect.
    ForbiddenTime int
    The period of time during which logons from an account are not allowed. Unit: minutes.
    Span int
    The period of time during which logon failures from an account are measured. Unit: minutes. If Span is set to 10, the defense rule takes effect when the logon failures measured within 10 minutes reaches the specified threshold. The IP address of attackers cannot be used to log on to the server in the specified period of time.
    UuidLists []string
    An array consisting of the UUIDs of servers to which the defense rule is applied.The binding status must be Enterprise Edition.
    antiBruteForceRuleId String
    The ID of the defense rule.
    antiBruteForceRuleName String
    The name of the defense rule.
    defaultRule Boolean
    Specifies whether to set the defense rule as the default rule.
    failCount Integer
    The threshold for the number of failed user logins when the brute-force defense rule takes effect.
    forbiddenTime Integer
    The period of time during which logons from an account are not allowed. Unit: minutes.
    span Integer
    The period of time during which logon failures from an account are measured. Unit: minutes. If Span is set to 10, the defense rule takes effect when the logon failures measured within 10 minutes reaches the specified threshold. The IP address of attackers cannot be used to log on to the server in the specified period of time.
    uuidLists List<String>
    An array consisting of the UUIDs of servers to which the defense rule is applied.The binding status must be Enterprise Edition.
    antiBruteForceRuleId string
    The ID of the defense rule.
    antiBruteForceRuleName string
    The name of the defense rule.
    defaultRule boolean
    Specifies whether to set the defense rule as the default rule.
    failCount number
    The threshold for the number of failed user logins when the brute-force defense rule takes effect.
    forbiddenTime number
    The period of time during which logons from an account are not allowed. Unit: minutes.
    span number
    The period of time during which logon failures from an account are measured. Unit: minutes. If Span is set to 10, the defense rule takes effect when the logon failures measured within 10 minutes reaches the specified threshold. The IP address of attackers cannot be used to log on to the server in the specified period of time.
    uuidLists string[]
    An array consisting of the UUIDs of servers to which the defense rule is applied.The binding status must be Enterprise Edition.
    anti_brute_force_rule_id str
    The ID of the defense rule.
    anti_brute_force_rule_name str
    The name of the defense rule.
    default_rule bool
    Specifies whether to set the defense rule as the default rule.
    fail_count int
    The threshold for the number of failed user logins when the brute-force defense rule takes effect.
    forbidden_time int
    The period of time during which logons from an account are not allowed. Unit: minutes.
    span int
    The period of time during which logon failures from an account are measured. Unit: minutes. If Span is set to 10, the defense rule takes effect when the logon failures measured within 10 minutes reaches the specified threshold. The IP address of attackers cannot be used to log on to the server in the specified period of time.
    uuid_lists Sequence[str]
    An array consisting of the UUIDs of servers to which the defense rule is applied.The binding status must be Enterprise Edition.
    antiBruteForceRuleId String
    The ID of the defense rule.
    antiBruteForceRuleName String
    The name of the defense rule.
    defaultRule Boolean
    Specifies whether to set the defense rule as the default rule.
    failCount Number
    The threshold for the number of failed user logins when the brute-force defense rule takes effect.
    forbiddenTime Number
    The period of time during which logons from an account are not allowed. Unit: minutes.
    span Number
    The period of time during which logon failures from an account are measured. Unit: minutes. If Span is set to 10, the defense rule takes effect when the logon failures measured within 10 minutes reaches the specified threshold. The IP address of attackers cannot be used to log on to the server in the specified period of time.
    uuidLists List<String>
    An array consisting of the UUIDs of servers to which the defense rule is applied.The binding status must be Enterprise Edition.

    Import

    Threat Detection Anti Brute Force Rule can be imported using the id, e.g.

    $ pulumi import alicloud:threatdetection/antiBruteForceRule:AntiBruteForceRule example <id>
    

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

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi