Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Kafka
  3. API Docs
  4. UserScramCredential
Kafka v3.8.0 published on Monday, Aug 26, 2024 by Pulumi
pulumi/pulumi-kafka

kafka.UserScramCredential

Explore with Pulumi AI

kafka logo
Kafka v3.8.0 published on Monday, Aug 26, 2024 by Pulumi
pulumi/pulumi-kafka

    Create UserScramCredential Resource

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

    Constructor syntax

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

@overload
def UserScramCredential(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        password: Optional[str] = None,
                        scram_mechanism: Optional[str] = None,
                        username: Optional[str] = None,
                        scram_iterations: Optional[int] = None)
    func NewUserScramCredential(ctx *Context, name string, args UserScramCredentialArgs, opts ...ResourceOption) (*UserScramCredential, error)
    public UserScramCredential(string name, UserScramCredentialArgs args, CustomResourceOptions? opts = null)
    public UserScramCredential(String name, UserScramCredentialArgs args)
public UserScramCredential(String name, UserScramCredentialArgs args, CustomResourceOptions options)

    type: kafka:UserScramCredential
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 UserScramCredentialArgs
    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 UserScramCredentialArgs
    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 UserScramCredentialArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserScramCredentialArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserScramCredentialArgs
    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 userScramCredentialResource = new Kafka.UserScramCredential("userScramCredentialResource", new()
{
    Password = "string",
    ScramMechanism = "string",
    Username = "string",
    ScramIterations = 0,
});

    example, err := kafka.NewUserScramCredential(ctx, "userScramCredentialResource", &kafka.UserScramCredentialArgs{
	Password:        pulumi.String("string"),
	ScramMechanism:  pulumi.String("string"),
	Username:        pulumi.String("string"),
	ScramIterations: pulumi.Int(0),
})

    var userScramCredentialResource = new UserScramCredential("userScramCredentialResource", UserScramCredentialArgs.builder()
    .password("string")
    .scramMechanism("string")
    .username("string")
    .scramIterations(0)
    .build());

    user_scram_credential_resource = kafka.UserScramCredential("userScramCredentialResource",
    password="string",
    scram_mechanism="string",
    username="string",
    scram_iterations=0)

    const userScramCredentialResource = new kafka.UserScramCredential("userScramCredentialResource", {
    password: "string",
    scramMechanism: "string",
    username: "string",
    scramIterations: 0,
});

    type: kafka:UserScramCredential
properties:
    password: string
    scramIterations: 0
    scramMechanism: string
    username: string

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

    Password string
    The password of the credential
    ScramMechanism string
    The SCRAM mechanism used to generate the credential (SCRAM-SHA-256, SCRAM-SHA-512)
    Username string
    The name of the credential
    ScramIterations int
    The number of SCRAM iterations used when generating the credential
    Password string
    The password of the credential
    ScramMechanism string
    The SCRAM mechanism used to generate the credential (SCRAM-SHA-256, SCRAM-SHA-512)
    Username string
    The name of the credential
    ScramIterations int
    The number of SCRAM iterations used when generating the credential
    password String
    The password of the credential
    scramMechanism String
    The SCRAM mechanism used to generate the credential (SCRAM-SHA-256, SCRAM-SHA-512)
    username String
    The name of the credential
    scramIterations Integer
    The number of SCRAM iterations used when generating the credential
    password string
    The password of the credential
    scramMechanism string
    The SCRAM mechanism used to generate the credential (SCRAM-SHA-256, SCRAM-SHA-512)
    username string
    The name of the credential
    scramIterations number
    The number of SCRAM iterations used when generating the credential
    password str
    The password of the credential
    scram_mechanism str
    The SCRAM mechanism used to generate the credential (SCRAM-SHA-256, SCRAM-SHA-512)
    username str
    The name of the credential
    scram_iterations int
    The number of SCRAM iterations used when generating the credential
    password String
    The password of the credential
    scramMechanism String
    The SCRAM mechanism used to generate the credential (SCRAM-SHA-256, SCRAM-SHA-512)
    username String
    The name of the credential
    scramIterations Number
    The number of SCRAM iterations used when generating the credential

    Outputs

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

    Get an existing UserScramCredential 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?: UserScramCredentialState, opts?: CustomResourceOptions): UserScramCredential
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        password: Optional[str] = None,
        scram_iterations: Optional[int] = None,
        scram_mechanism: Optional[str] = None,
        username: Optional[str] = None) -> UserScramCredential
    func GetUserScramCredential(ctx *Context, name string, id IDInput, state *UserScramCredentialState, opts ...ResourceOption) (*UserScramCredential, error)
    public static UserScramCredential Get(string name, Input<string> id, UserScramCredentialState? state, CustomResourceOptions? opts = null)
    public static UserScramCredential get(String name, Output<String> id, UserScramCredentialState 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:
    Password string
    The password of the credential
    ScramIterations int
    The number of SCRAM iterations used when generating the credential
    ScramMechanism string
    The SCRAM mechanism used to generate the credential (SCRAM-SHA-256, SCRAM-SHA-512)
    Username string
    The name of the credential
    Password string
    The password of the credential
    ScramIterations int
    The number of SCRAM iterations used when generating the credential
    ScramMechanism string
    The SCRAM mechanism used to generate the credential (SCRAM-SHA-256, SCRAM-SHA-512)
    Username string
    The name of the credential
    password String
    The password of the credential
    scramIterations Integer
    The number of SCRAM iterations used when generating the credential
    scramMechanism String
    The SCRAM mechanism used to generate the credential (SCRAM-SHA-256, SCRAM-SHA-512)
    username String
    The name of the credential
    password string
    The password of the credential
    scramIterations number
    The number of SCRAM iterations used when generating the credential
    scramMechanism string
    The SCRAM mechanism used to generate the credential (SCRAM-SHA-256, SCRAM-SHA-512)
    username string
    The name of the credential
    password str
    The password of the credential
    scram_iterations int
    The number of SCRAM iterations used when generating the credential
    scram_mechanism str
    The SCRAM mechanism used to generate the credential (SCRAM-SHA-256, SCRAM-SHA-512)
    username str
    The name of the credential
    password String
    The password of the credential
    scramIterations Number
    The number of SCRAM iterations used when generating the credential
    scramMechanism String
    The SCRAM mechanism used to generate the credential (SCRAM-SHA-256, SCRAM-SHA-512)
    username String
    The name of the credential

    Package Details

    Repository
    Kafka pulumi/pulumi-kafka
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the kafka Terraform Provider.
    kafka logo
    Kafka v3.8.0 published on Monday, Aug 26, 2024 by Pulumi
    pulumi/pulumi-kafka