1. Packages
  2. Zitadel
  3. API Docs
  4. DefaultLockoutPolicy
zitadel v0.1.7 published on Tuesday, Mar 26, 2024 by pulumiverse

zitadel.DefaultLockoutPolicy

Explore with Pulumi AI

zitadel logo
zitadel v0.1.7 published on Tuesday, Mar 26, 2024 by pulumiverse

    Resource representing the default lockout policy.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Zitadel = Pulumiverse.Zitadel;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = new Zitadel.DefaultLockoutPolicy("default", new()
        {
            MaxPasswordAttempts = 5,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-zitadel/sdk/go/zitadel"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := zitadel.NewDefaultLockoutPolicy(ctx, "default", &zitadel.DefaultLockoutPolicyArgs{
    			MaxPasswordAttempts: pulumi.Int(5),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.zitadel.DefaultLockoutPolicy;
    import com.pulumi.zitadel.DefaultLockoutPolicyArgs;
    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 DefaultLockoutPolicy("default", DefaultLockoutPolicyArgs.builder()        
                .maxPasswordAttempts("5")
                .build());
    
        }
    }
    
    import pulumi
    import pulumiverse_zitadel as zitadel
    
    default = zitadel.DefaultLockoutPolicy("default", max_password_attempts=5)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as zitadel from "@pulumiverse/zitadel";
    
    const _default = new zitadel.DefaultLockoutPolicy("default", {maxPasswordAttempts: 5});
    
    resources:
      default:
        type: zitadel:DefaultLockoutPolicy
        properties:
          maxPasswordAttempts: '5'
    

    Create DefaultLockoutPolicy Resource

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

    Constructor syntax

    new DefaultLockoutPolicy(name: string, args: DefaultLockoutPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def DefaultLockoutPolicy(resource_name: str,
                             args: DefaultLockoutPolicyArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def DefaultLockoutPolicy(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             max_password_attempts: Optional[int] = None)
    func NewDefaultLockoutPolicy(ctx *Context, name string, args DefaultLockoutPolicyArgs, opts ...ResourceOption) (*DefaultLockoutPolicy, error)
    public DefaultLockoutPolicy(string name, DefaultLockoutPolicyArgs args, CustomResourceOptions? opts = null)
    public DefaultLockoutPolicy(String name, DefaultLockoutPolicyArgs args)
    public DefaultLockoutPolicy(String name, DefaultLockoutPolicyArgs args, CustomResourceOptions options)
    
    type: zitadel:DefaultLockoutPolicy
    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 DefaultLockoutPolicyArgs
    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 DefaultLockoutPolicyArgs
    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 DefaultLockoutPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DefaultLockoutPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DefaultLockoutPolicyArgs
    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 defaultLockoutPolicyResource = new Zitadel.DefaultLockoutPolicy("defaultLockoutPolicyResource", new()
    {
        MaxPasswordAttempts = 0,
    });
    
    example, err := zitadel.NewDefaultLockoutPolicy(ctx, "defaultLockoutPolicyResource", &zitadel.DefaultLockoutPolicyArgs{
    	MaxPasswordAttempts: pulumi.Int(0),
    })
    
    var defaultLockoutPolicyResource = new DefaultLockoutPolicy("defaultLockoutPolicyResource", DefaultLockoutPolicyArgs.builder()        
        .maxPasswordAttempts(0)
        .build());
    
    default_lockout_policy_resource = zitadel.DefaultLockoutPolicy("defaultLockoutPolicyResource", max_password_attempts=0)
    
    const defaultLockoutPolicyResource = new zitadel.DefaultLockoutPolicy("defaultLockoutPolicyResource", {maxPasswordAttempts: 0});
    
    type: zitadel:DefaultLockoutPolicy
    properties:
        maxPasswordAttempts: 0
    

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

    MaxPasswordAttempts int
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correctly or the password is reset.
    MaxPasswordAttempts int
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correctly or the password is reset.
    maxPasswordAttempts Integer
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correctly or the password is reset.
    maxPasswordAttempts number
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correctly or the password is reset.
    max_password_attempts int
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correctly or the password is reset.
    maxPasswordAttempts Number
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correctly or the password is reset.

    Outputs

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

    Get an existing DefaultLockoutPolicy 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?: DefaultLockoutPolicyState, opts?: CustomResourceOptions): DefaultLockoutPolicy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            max_password_attempts: Optional[int] = None) -> DefaultLockoutPolicy
    func GetDefaultLockoutPolicy(ctx *Context, name string, id IDInput, state *DefaultLockoutPolicyState, opts ...ResourceOption) (*DefaultLockoutPolicy, error)
    public static DefaultLockoutPolicy Get(string name, Input<string> id, DefaultLockoutPolicyState? state, CustomResourceOptions? opts = null)
    public static DefaultLockoutPolicy get(String name, Output<String> id, DefaultLockoutPolicyState 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:
    MaxPasswordAttempts int
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correctly or the password is reset.
    MaxPasswordAttempts int
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correctly or the password is reset.
    maxPasswordAttempts Integer
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correctly or the password is reset.
    maxPasswordAttempts number
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correctly or the password is reset.
    max_password_attempts int
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correctly or the password is reset.
    maxPasswordAttempts Number
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correctly or the password is reset.

    Import

    terraform The resource can be imported using the ID format <>, e.g.

     $ pulumi import zitadel:index/defaultLockoutPolicy:DefaultLockoutPolicy imported ''
    

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

    Package Details

    Repository
    zitadel pulumiverse/pulumi-zitadel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the zitadel Terraform Provider.
    zitadel logo
    zitadel v0.1.7 published on Tuesday, Mar 26, 2024 by pulumiverse