1. Packages
  2. Etcd Provider
  3. API Docs
  4. Auth
etcd 0.10.0 published on Tuesday, Apr 15, 2025 by ferlab-ste-justine

etcd.Auth

Explore with Pulumi AI

etcd logo
etcd 0.10.0 published on Tuesday, Apr 15, 2025 by ferlab-ste-justine

    Controls the authentication status (enabled or disabled) of the etcd cluster.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as etcd from "@pulumi/etcd";
    
    const auth = new etcd.Auth("auth", {enabled: true});
    
    import pulumi
    import pulumi_etcd as etcd
    
    auth = etcd.Auth("auth", enabled=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/etcd/etcd"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := etcd.NewAuth(ctx, "auth", &etcd.AuthArgs{
    			Enabled: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Etcd = Pulumi.Etcd;
    
    return await Deployment.RunAsync(() => 
    {
        var auth = new Etcd.Auth("auth", new()
        {
            Enabled = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.etcd.Auth;
    import com.pulumi.etcd.AuthArgs;
    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 auth = new Auth("auth", AuthArgs.builder()
                .enabled(true)
                .build());
    
        }
    }
    
    resources:
      auth:
        type: etcd:Auth
        properties:
          enabled: true
    

    Create Auth Resource

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

    Constructor syntax

    new Auth(name: string, args: AuthArgs, opts?: CustomResourceOptions);
    @overload
    def Auth(resource_name: str,
             args: AuthArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Auth(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             enabled: Optional[bool] = None,
             auth_id: Optional[str] = None)
    func NewAuth(ctx *Context, name string, args AuthArgs, opts ...ResourceOption) (*Auth, error)
    public Auth(string name, AuthArgs args, CustomResourceOptions? opts = null)
    public Auth(String name, AuthArgs args)
    public Auth(String name, AuthArgs args, CustomResourceOptions options)
    
    type: etcd:Auth
    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 AuthArgs
    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 AuthArgs
    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 AuthArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthArgs
    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 authResource = new Etcd.Auth("authResource", new()
    {
        Enabled = false,
        AuthId = "string",
    });
    
    example, err := etcd.NewAuth(ctx, "authResource", &etcd.AuthArgs{
    Enabled: pulumi.Bool(false),
    AuthId: pulumi.String("string"),
    })
    
    var authResource = new Auth("authResource", AuthArgs.builder()
        .enabled(false)
        .authId("string")
        .build());
    
    auth_resource = etcd.Auth("authResource",
        enabled=False,
        auth_id="string")
    
    const authResource = new etcd.Auth("authResource", {
        enabled: false,
        authId: "string",
    });
    
    type: etcd:Auth
    properties:
        authId: string
        enabled: false
    

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

    Enabled bool
    Enable or disable auth on etcd.
    AuthId string
    The ID of this resource.
    Enabled bool
    Enable or disable auth on etcd.
    AuthId string
    The ID of this resource.
    enabled Boolean
    Enable or disable auth on etcd.
    authId String
    The ID of this resource.
    enabled boolean
    Enable or disable auth on etcd.
    authId string
    The ID of this resource.
    enabled bool
    Enable or disable auth on etcd.
    auth_id str
    The ID of this resource.
    enabled Boolean
    Enable or disable auth on etcd.
    authId String
    The ID of this resource.

    Outputs

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

    Get an existing Auth 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?: AuthState, opts?: CustomResourceOptions): Auth
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auth_id: Optional[str] = None,
            enabled: Optional[bool] = None) -> Auth
    func GetAuth(ctx *Context, name string, id IDInput, state *AuthState, opts ...ResourceOption) (*Auth, error)
    public static Auth Get(string name, Input<string> id, AuthState? state, CustomResourceOptions? opts = null)
    public static Auth get(String name, Output<String> id, AuthState state, CustomResourceOptions options)
    resources:  _:    type: etcd:Auth    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:
    AuthId string
    The ID of this resource.
    Enabled bool
    Enable or disable auth on etcd.
    AuthId string
    The ID of this resource.
    Enabled bool
    Enable or disable auth on etcd.
    authId String
    The ID of this resource.
    enabled Boolean
    Enable or disable auth on etcd.
    authId string
    The ID of this resource.
    enabled boolean
    Enable or disable auth on etcd.
    auth_id str
    The ID of this resource.
    enabled bool
    Enable or disable auth on etcd.
    authId String
    The ID of this resource.
    enabled Boolean
    Enable or disable auth on etcd.

    Package Details

    Repository
    etcd ferlab-ste-justine/terraform-provider-etcd
    License
    Notes
    This Pulumi package is based on the etcd Terraform Provider.
    etcd logo
    etcd 0.10.0 published on Tuesday, Apr 15, 2025 by ferlab-ste-justine