Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aiven Provider
  3. API Docs
  4. ValkeyUser
Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-aiven

aiven.ValkeyUser

Explore with Pulumi AI

aiven logo
Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-aiven

    Creates and manages an Aiven for Valkey user.

    Create ValkeyUser Resource

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

    Constructor syntax

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

@overload
def ValkeyUser(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               project: Optional[str] = None,
               service_name: Optional[str] = None,
               username: Optional[str] = None,
               password: Optional[str] = None,
               valkey_acl_categories: Optional[Sequence[str]] = None,
               valkey_acl_channels: Optional[Sequence[str]] = None,
               valkey_acl_commands: Optional[Sequence[str]] = None,
               valkey_acl_keys: Optional[Sequence[str]] = None)
    func NewValkeyUser(ctx *Context, name string, args ValkeyUserArgs, opts ...ResourceOption) (*ValkeyUser, error)
    public ValkeyUser(string name, ValkeyUserArgs args, CustomResourceOptions? opts = null)
    public ValkeyUser(String name, ValkeyUserArgs args)
public ValkeyUser(String name, ValkeyUserArgs args, CustomResourceOptions options)

    type: aiven:ValkeyUser
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 ValkeyUserArgs
    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 ValkeyUserArgs
    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 ValkeyUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ValkeyUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ValkeyUserArgs
    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 valkeyUserResource = new Aiven.ValkeyUser("valkeyUserResource", new()
{
    Project = "string",
    ServiceName = "string",
    Username = "string",
    Password = "string",
    ValkeyAclCategories = new[]
    {
        "string",
    },
    ValkeyAclChannels = new[]
    {
        "string",
    },
    ValkeyAclCommands = new[]
    {
        "string",
    },
    ValkeyAclKeys = new[]
    {
        "string",
    },
});

    example, err := aiven.NewValkeyUser(ctx, "valkeyUserResource", &aiven.ValkeyUserArgs{
	Project:     pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	Username:    pulumi.String("string"),
	Password:    pulumi.String("string"),
	ValkeyAclCategories: pulumi.StringArray{
		pulumi.String("string"),
	},
	ValkeyAclChannels: pulumi.StringArray{
		pulumi.String("string"),
	},
	ValkeyAclCommands: pulumi.StringArray{
		pulumi.String("string"),
	},
	ValkeyAclKeys: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var valkeyUserResource = new ValkeyUser("valkeyUserResource", ValkeyUserArgs.builder()
    .project("string")
    .serviceName("string")
    .username("string")
    .password("string")
    .valkeyAclCategories("string")
    .valkeyAclChannels("string")
    .valkeyAclCommands("string")
    .valkeyAclKeys("string")
    .build());

    valkey_user_resource = aiven.ValkeyUser("valkeyUserResource",
    project="string",
    service_name="string",
    username="string",
    password="string",
    valkey_acl_categories=["string"],
    valkey_acl_channels=["string"],
    valkey_acl_commands=["string"],
    valkey_acl_keys=["string"])

    const valkeyUserResource = new aiven.ValkeyUser("valkeyUserResource", {
    project: "string",
    serviceName: "string",
    username: "string",
    password: "string",
    valkeyAclCategories: ["string"],
    valkeyAclChannels: ["string"],
    valkeyAclCommands: ["string"],
    valkeyAclKeys: ["string"],
});

    type: aiven:ValkeyUser
properties:
    password: string
    project: string
    serviceName: string
    username: string
    valkeyAclCategories:
        - string
    valkeyAclChannels:
        - string
    valkeyAclCommands:
        - string
    valkeyAclKeys:
        - string

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

    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    Username string
    The actual name of the Valkey User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    Password string
    The password of the Valkey User.
    ValkeyAclCategories List<string>
    Defines command category rules. The field is required withvalkey_acl_commands and valkey_acl_keys. Changing this property forces recreation of the resource.
    ValkeyAclChannels List<string>
    Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
    ValkeyAclCommands List<string>
    Defines rules for individual commands. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    ValkeyAclKeys List<string>
    Defines key access rules. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    Username string
    The actual name of the Valkey User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    Password string
    The password of the Valkey User.
    ValkeyAclCategories []string
    Defines command category rules. The field is required withvalkey_acl_commands and valkey_acl_keys. Changing this property forces recreation of the resource.
    ValkeyAclChannels []string
    Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
    ValkeyAclCommands []string
    Defines rules for individual commands. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    ValkeyAclKeys []string
    Defines key access rules. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    username String
    The actual name of the Valkey User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    password String
    The password of the Valkey User.
    valkeyAclCategories List<String>
    Defines command category rules. The field is required withvalkey_acl_commands and valkey_acl_keys. Changing this property forces recreation of the resource.
    valkeyAclChannels List<String>
    Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
    valkeyAclCommands List<String>
    Defines rules for individual commands. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    valkeyAclKeys List<String>
    Defines key access rules. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    username string
    The actual name of the Valkey User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    password string
    The password of the Valkey User.
    valkeyAclCategories string[]
    Defines command category rules. The field is required withvalkey_acl_commands and valkey_acl_keys. Changing this property forces recreation of the resource.
    valkeyAclChannels string[]
    Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
    valkeyAclCommands string[]
    Defines rules for individual commands. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    valkeyAclKeys string[]
    Defines key access rules. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    service_name str
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    username str
    The actual name of the Valkey User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    password str
    The password of the Valkey User.
    valkey_acl_categories Sequence[str]
    Defines command category rules. The field is required withvalkey_acl_commands and valkey_acl_keys. Changing this property forces recreation of the resource.
    valkey_acl_channels Sequence[str]
    Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
    valkey_acl_commands Sequence[str]
    Defines rules for individual commands. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    valkey_acl_keys Sequence[str]
    Defines key access rules. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    username String
    The actual name of the Valkey User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    password String
    The password of the Valkey User.
    valkeyAclCategories List<String>
    Defines command category rules. The field is required withvalkey_acl_commands and valkey_acl_keys. Changing this property forces recreation of the resource.
    valkeyAclChannels List<String>
    Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
    valkeyAclCommands List<String>
    Defines rules for individual commands. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    valkeyAclKeys List<String>
    Defines key access rules. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Type of the user account. Tells whether the user is the primary account or a regular account.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Type of the user account. Tells whether the user is the primary account or a regular account.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Type of the user account. Tells whether the user is the primary account or a regular account.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    Type of the user account. Tells whether the user is the primary account or a regular account.
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    Type of the user account. Tells whether the user is the primary account or a regular account.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Type of the user account. Tells whether the user is the primary account or a regular account.

    Look up Existing ValkeyUser Resource

    Get an existing ValkeyUser 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?: ValkeyUserState, opts?: CustomResourceOptions): ValkeyUser
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        password: Optional[str] = None,
        project: Optional[str] = None,
        service_name: Optional[str] = None,
        type: Optional[str] = None,
        username: Optional[str] = None,
        valkey_acl_categories: Optional[Sequence[str]] = None,
        valkey_acl_channels: Optional[Sequence[str]] = None,
        valkey_acl_commands: Optional[Sequence[str]] = None,
        valkey_acl_keys: Optional[Sequence[str]] = None) -> ValkeyUser
    func GetValkeyUser(ctx *Context, name string, id IDInput, state *ValkeyUserState, opts ...ResourceOption) (*ValkeyUser, error)
    public static ValkeyUser Get(string name, Input<string> id, ValkeyUserState? state, CustomResourceOptions? opts = null)
    public static ValkeyUser get(String name, Output<String> id, ValkeyUserState 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 Valkey User.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    Type string
    Type of the user account. Tells whether the user is the primary account or a regular account.
    Username string
    The actual name of the Valkey User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ValkeyAclCategories List<string>
    Defines command category rules. The field is required withvalkey_acl_commands and valkey_acl_keys. Changing this property forces recreation of the resource.
    ValkeyAclChannels List<string>
    Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
    ValkeyAclCommands List<string>
    Defines rules for individual commands. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    ValkeyAclKeys List<string>
    Defines key access rules. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    Password string
    The password of the Valkey User.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    Type string
    Type of the user account. Tells whether the user is the primary account or a regular account.
    Username string
    The actual name of the Valkey User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ValkeyAclCategories []string
    Defines command category rules. The field is required withvalkey_acl_commands and valkey_acl_keys. Changing this property forces recreation of the resource.
    ValkeyAclChannels []string
    Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
    ValkeyAclCommands []string
    Defines rules for individual commands. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    ValkeyAclKeys []string
    Defines key access rules. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    password String
    The password of the Valkey User.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    type String
    Type of the user account. Tells whether the user is the primary account or a regular account.
    username String
    The actual name of the Valkey User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    valkeyAclCategories List<String>
    Defines command category rules. The field is required withvalkey_acl_commands and valkey_acl_keys. Changing this property forces recreation of the resource.
    valkeyAclChannels List<String>
    Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
    valkeyAclCommands List<String>
    Defines rules for individual commands. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    valkeyAclKeys List<String>
    Defines key access rules. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    password string
    The password of the Valkey User.
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    type string
    Type of the user account. Tells whether the user is the primary account or a regular account.
    username string
    The actual name of the Valkey User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    valkeyAclCategories string[]
    Defines command category rules. The field is required withvalkey_acl_commands and valkey_acl_keys. Changing this property forces recreation of the resource.
    valkeyAclChannels string[]
    Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
    valkeyAclCommands string[]
    Defines rules for individual commands. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    valkeyAclKeys string[]
    Defines key access rules. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    password str
    The password of the Valkey User.
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    service_name str
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    type str
    Type of the user account. Tells whether the user is the primary account or a regular account.
    username str
    The actual name of the Valkey User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    valkey_acl_categories Sequence[str]
    Defines command category rules. The field is required withvalkey_acl_commands and valkey_acl_keys. Changing this property forces recreation of the resource.
    valkey_acl_channels Sequence[str]
    Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
    valkey_acl_commands Sequence[str]
    Defines rules for individual commands. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    valkey_acl_keys Sequence[str]
    Defines key access rules. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    password String
    The password of the Valkey User.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    type String
    Type of the user account. Tells whether the user is the primary account or a regular account.
    username String
    The actual name of the Valkey User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    valkeyAclCategories List<String>
    Defines command category rules. The field is required withvalkey_acl_commands and valkey_acl_keys. Changing this property forces recreation of the resource.
    valkeyAclChannels List<String>
    Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
    valkeyAclCommands List<String>
    Defines rules for individual commands. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.
    valkeyAclKeys List<String>
    Defines key access rules. The field is required withvalkey_acl_categories and valkey_acl_keys. Changing this property forces recreation of the resource.

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-aiven