akeyless.DynamicSecretRedis

akeyless 2.0.1, Apr 27 26

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Create DynamicSecretRedis Resource

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

Constructor syntax

new DynamicSecretRedis(name: string, args?: DynamicSecretRedisArgs, opts?: CustomResourceOptions);

@overload
def DynamicSecretRedis(resource_name: str,
                       args: Optional[DynamicSecretRedisArgs] = None,
                       opts: Optional[ResourceOptions] = None)

@overload
def DynamicSecretRedis(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       acl_rules: Optional[str] = None,
                       custom_username_template: Optional[str] = None,
                       delete_protection: Optional[str] = None,
                       dynamic_secret_redis_id: Optional[str] = None,
                       host: Optional[str] = None,
                       item_custom_fields: Optional[Mapping[str, str]] = None,
                       name: Optional[str] = None,
                       password: Optional[str] = None,
                       password_length: Optional[str] = None,
                       port: Optional[str] = None,
                       producer_encryption_key_name: Optional[str] = None,
                       ssl: Optional[bool] = None,
                       ssl_certificate: Optional[str] = None,
                       tags: Optional[Sequence[str]] = None,
                       target_name: Optional[str] = None,
                       user_ttl: Optional[str] = None,
                       username: Optional[str] = None)

func NewDynamicSecretRedis(ctx *Context, name string, args *DynamicSecretRedisArgs, opts ...ResourceOption) (*DynamicSecretRedis, error)

public DynamicSecretRedis(string name, DynamicSecretRedisArgs? args = null, CustomResourceOptions? opts = null)

public DynamicSecretRedis(String name, DynamicSecretRedisArgs args)
public DynamicSecretRedis(String name, DynamicSecretRedisArgs args, CustomResourceOptions options)

type: akeyless:DynamicSecretRedis
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 DynamicSecretRedisArgs: 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 DynamicSecretRedisArgs: 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 DynamicSecretRedisArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DynamicSecretRedisArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DynamicSecretRedisArgs: 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 dynamicSecretRedisResource = new Akeyless.DynamicSecretRedis("dynamicSecretRedisResource", new()
{
    AclRules = "string",
    CustomUsernameTemplate = "string",
    DeleteProtection = "string",
    DynamicSecretRedisId = "string",
    Host = "string",
    ItemCustomFields = 
    {
        { "string", "string" },
    },
    Name = "string",
    Password = "string",
    PasswordLength = "string",
    Port = "string",
    ProducerEncryptionKeyName = "string",
    Ssl = false,
    SslCertificate = "string",
    Tags = new[]
    {
        "string",
    },
    TargetName = "string",
    UserTtl = "string",
    Username = "string",
});

example, err := akeyless.NewDynamicSecretRedis(ctx, "dynamicSecretRedisResource", &akeyless.DynamicSecretRedisArgs{
	AclRules:               pulumi.String("string"),
	CustomUsernameTemplate: pulumi.String("string"),
	DeleteProtection:       pulumi.String("string"),
	DynamicSecretRedisId:   pulumi.String("string"),
	Host:                   pulumi.String("string"),
	ItemCustomFields: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:                      pulumi.String("string"),
	Password:                  pulumi.String("string"),
	PasswordLength:            pulumi.String("string"),
	Port:                      pulumi.String("string"),
	ProducerEncryptionKeyName: pulumi.String("string"),
	Ssl:                       pulumi.Bool(false),
	SslCertificate:            pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TargetName: pulumi.String("string"),
	UserTtl:    pulumi.String("string"),
	Username:   pulumi.String("string"),
})

var dynamicSecretRedisResource = new DynamicSecretRedis("dynamicSecretRedisResource", DynamicSecretRedisArgs.builder()
    .aclRules("string")
    .customUsernameTemplate("string")
    .deleteProtection("string")
    .dynamicSecretRedisId("string")
    .host("string")
    .itemCustomFields(Map.of("string", "string"))
    .name("string")
    .password("string")
    .passwordLength("string")
    .port("string")
    .producerEncryptionKeyName("string")
    .ssl(false)
    .sslCertificate("string")
    .tags("string")
    .targetName("string")
    .userTtl("string")
    .username("string")
    .build());

dynamic_secret_redis_resource = akeyless.DynamicSecretRedis("dynamicSecretRedisResource",
    acl_rules="string",
    custom_username_template="string",
    delete_protection="string",
    dynamic_secret_redis_id="string",
    host="string",
    item_custom_fields={
        "string": "string",
    },
    name="string",
    password="string",
    password_length="string",
    port="string",
    producer_encryption_key_name="string",
    ssl=False,
    ssl_certificate="string",
    tags=["string"],
    target_name="string",
    user_ttl="string",
    username="string")

const dynamicSecretRedisResource = new akeyless.DynamicSecretRedis("dynamicSecretRedisResource", {
    aclRules: "string",
    customUsernameTemplate: "string",
    deleteProtection: "string",
    dynamicSecretRedisId: "string",
    host: "string",
    itemCustomFields: {
        string: "string",
    },
    name: "string",
    password: "string",
    passwordLength: "string",
    port: "string",
    producerEncryptionKeyName: "string",
    ssl: false,
    sslCertificate: "string",
    tags: ["string"],
    targetName: "string",
    userTtl: "string",
    username: "string",
});

type: akeyless:DynamicSecretRedis
properties:
    aclRules: string
    customUsernameTemplate: string
    deleteProtection: string
    dynamicSecretRedisId: string
    host: string
    itemCustomFields:
        string: string
    name: string
    password: string
    passwordLength: string
    port: string
    producerEncryptionKeyName: string
    ssl: false
    sslCertificate: string
    tags:
        - string
    targetName: string
    userTtl: string
    username: string

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

AclRules string: A JSON array list of redis ACL rules to attach to the created user. For available rules see the ACL CAT command https://redis.io/commands/acl-cat By default the user will have permissions to read all keys '["~*", "+@read"]'
CustomUsernameTemplate string: Customize how temporary usernames are generated using go template
DeleteProtection string: Protection from accidental deletion of this object [true/false]
DynamicSecretRedisId string: The ID of this resource.
Host string: Redis Host
ItemCustomFields Dictionary<string, string>: Additional custom fields to associate with the item
Name string: Dynamic secret name
Password string: Redis Password
PasswordLength string: The length of the password to be generated
Port string: Redis Port
ProducerEncryptionKeyName string: Dynamic producer encryption key
Ssl bool: Enable/Disable SSL [true/false]
SslCertificate string: SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
Tags List<string>: Add tags attached to this object
TargetName string: Target name
UserTtl string: User TTL
Username string: Redis Username

AclRules string: A JSON array list of redis ACL rules to attach to the created user. For available rules see the ACL CAT command https://redis.io/commands/acl-cat By default the user will have permissions to read all keys '["~*", "+@read"]'
CustomUsernameTemplate string: Customize how temporary usernames are generated using go template
DeleteProtection string: Protection from accidental deletion of this object [true/false]
DynamicSecretRedisId string: The ID of this resource.
Host string: Redis Host
ItemCustomFields map[string]string: Additional custom fields to associate with the item
Name string: Dynamic secret name
Password string: Redis Password
PasswordLength string: The length of the password to be generated
Port string: Redis Port
ProducerEncryptionKeyName string: Dynamic producer encryption key
Ssl bool: Enable/Disable SSL [true/false]
SslCertificate string: SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
Tags []string: Add tags attached to this object
TargetName string: Target name
UserTtl string: User TTL
Username string: Redis Username

aclRules String: A JSON array list of redis ACL rules to attach to the created user. For available rules see the ACL CAT command https://redis.io/commands/acl-cat By default the user will have permissions to read all keys '["~*", "+@read"]'
customUsernameTemplate String: Customize how temporary usernames are generated using go template
deleteProtection String: Protection from accidental deletion of this object [true/false]
dynamicSecretRedisId String: The ID of this resource.
host String: Redis Host
itemCustomFields Map<String,String>: Additional custom fields to associate with the item
name String: Dynamic secret name
password String: Redis Password
passwordLength String: The length of the password to be generated
port String: Redis Port
producerEncryptionKeyName String: Dynamic producer encryption key
ssl Boolean: Enable/Disable SSL [true/false]
sslCertificate String: SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
tags List<String>: Add tags attached to this object
targetName String: Target name
userTtl String: User TTL
username String: Redis Username

aclRules string: A JSON array list of redis ACL rules to attach to the created user. For available rules see the ACL CAT command https://redis.io/commands/acl-cat By default the user will have permissions to read all keys '["~*", "+@read"]'
customUsernameTemplate string: Customize how temporary usernames are generated using go template
deleteProtection string: Protection from accidental deletion of this object [true/false]
dynamicSecretRedisId string: The ID of this resource.
host string: Redis Host
itemCustomFields {[key: string]: string}: Additional custom fields to associate with the item
name string: Dynamic secret name
password string: Redis Password
passwordLength string: The length of the password to be generated
port string: Redis Port
producerEncryptionKeyName string: Dynamic producer encryption key
ssl boolean: Enable/Disable SSL [true/false]
sslCertificate string: SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
tags string[]: Add tags attached to this object
targetName string: Target name
userTtl string: User TTL
username string: Redis Username

acl_rules str: A JSON array list of redis ACL rules to attach to the created user. For available rules see the ACL CAT command https://redis.io/commands/acl-cat By default the user will have permissions to read all keys '["~*", "+@read"]'
custom_username_template str: Customize how temporary usernames are generated using go template
delete_protection str: Protection from accidental deletion of this object [true/false]
dynamic_secret_redis_id str: The ID of this resource.
host str: Redis Host
item_custom_fields Mapping[str, str]: Additional custom fields to associate with the item
name str: Dynamic secret name
password str: Redis Password
password_length str: The length of the password to be generated
port str: Redis Port
producer_encryption_key_name str: Dynamic producer encryption key
ssl bool: Enable/Disable SSL [true/false]
ssl_certificate str: SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
tags Sequence[str]: Add tags attached to this object
target_name str: Target name
user_ttl str: User TTL
username str: Redis Username

aclRules String: A JSON array list of redis ACL rules to attach to the created user. For available rules see the ACL CAT command https://redis.io/commands/acl-cat By default the user will have permissions to read all keys '["~*", "+@read"]'
customUsernameTemplate String: Customize how temporary usernames are generated using go template
deleteProtection String: Protection from accidental deletion of this object [true/false]
dynamicSecretRedisId String: The ID of this resource.
host String: Redis Host
itemCustomFields Map<String>: Additional custom fields to associate with the item
name String: Dynamic secret name
password String: Redis Password
passwordLength String: The length of the password to be generated
port String: Redis Port
producerEncryptionKeyName String: Dynamic producer encryption key
ssl Boolean: Enable/Disable SSL [true/false]
sslCertificate String: SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
tags List<String>: Add tags attached to this object
targetName String: Target name
userTtl String: User TTL
username String: Redis Username

Outputs

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

Get an existing DynamicSecretRedis 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?: DynamicSecretRedisState, opts?: CustomResourceOptions): DynamicSecretRedis

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acl_rules: Optional[str] = None,
        custom_username_template: Optional[str] = None,
        delete_protection: Optional[str] = None,
        dynamic_secret_redis_id: Optional[str] = None,
        host: Optional[str] = None,
        item_custom_fields: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        password_length: Optional[str] = None,
        port: Optional[str] = None,
        producer_encryption_key_name: Optional[str] = None,
        ssl: Optional[bool] = None,
        ssl_certificate: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        target_name: Optional[str] = None,
        user_ttl: Optional[str] = None,
        username: Optional[str] = None) -> DynamicSecretRedis

func GetDynamicSecretRedis(ctx *Context, name string, id IDInput, state *DynamicSecretRedisState, opts ...ResourceOption) (*DynamicSecretRedis, error)

public static DynamicSecretRedis Get(string name, Input<string> id, DynamicSecretRedisState? state, CustomResourceOptions? opts = null)

public static DynamicSecretRedis get(String name, Output<String> id, DynamicSecretRedisState state, CustomResourceOptions options)

resources:  _:    type: akeyless:DynamicSecretRedis    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:

AclRules string: A JSON array list of redis ACL rules to attach to the created user. For available rules see the ACL CAT command https://redis.io/commands/acl-cat By default the user will have permissions to read all keys '["~*", "+@read"]'
CustomUsernameTemplate string: Customize how temporary usernames are generated using go template
DeleteProtection string: Protection from accidental deletion of this object [true/false]
DynamicSecretRedisId string: The ID of this resource.
Host string: Redis Host
ItemCustomFields Dictionary<string, string>: Additional custom fields to associate with the item
Name string: Dynamic secret name
Password string: Redis Password
PasswordLength string: The length of the password to be generated
Port string: Redis Port
ProducerEncryptionKeyName string: Dynamic producer encryption key
Ssl bool: Enable/Disable SSL [true/false]
SslCertificate string: SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
Tags List<string>: Add tags attached to this object
TargetName string: Target name
UserTtl string: User TTL
Username string: Redis Username

AclRules string: A JSON array list of redis ACL rules to attach to the created user. For available rules see the ACL CAT command https://redis.io/commands/acl-cat By default the user will have permissions to read all keys '["~*", "+@read"]'
CustomUsernameTemplate string: Customize how temporary usernames are generated using go template
DeleteProtection string: Protection from accidental deletion of this object [true/false]
DynamicSecretRedisId string: The ID of this resource.
Host string: Redis Host
ItemCustomFields map[string]string: Additional custom fields to associate with the item
Name string: Dynamic secret name
Password string: Redis Password
PasswordLength string: The length of the password to be generated
Port string: Redis Port
ProducerEncryptionKeyName string: Dynamic producer encryption key
Ssl bool: Enable/Disable SSL [true/false]
SslCertificate string: SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
Tags []string: Add tags attached to this object
TargetName string: Target name
UserTtl string: User TTL
Username string: Redis Username

aclRules String: A JSON array list of redis ACL rules to attach to the created user. For available rules see the ACL CAT command https://redis.io/commands/acl-cat By default the user will have permissions to read all keys '["~*", "+@read"]'
customUsernameTemplate String: Customize how temporary usernames are generated using go template
deleteProtection String: Protection from accidental deletion of this object [true/false]
dynamicSecretRedisId String: The ID of this resource.
host String: Redis Host
itemCustomFields Map<String,String>: Additional custom fields to associate with the item
name String: Dynamic secret name
password String: Redis Password
passwordLength String: The length of the password to be generated
port String: Redis Port
producerEncryptionKeyName String: Dynamic producer encryption key
ssl Boolean: Enable/Disable SSL [true/false]
sslCertificate String: SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
tags List<String>: Add tags attached to this object
targetName String: Target name
userTtl String: User TTL
username String: Redis Username

aclRules string: A JSON array list of redis ACL rules to attach to the created user. For available rules see the ACL CAT command https://redis.io/commands/acl-cat By default the user will have permissions to read all keys '["~*", "+@read"]'
customUsernameTemplate string: Customize how temporary usernames are generated using go template
deleteProtection string: Protection from accidental deletion of this object [true/false]
dynamicSecretRedisId string: The ID of this resource.
host string: Redis Host
itemCustomFields {[key: string]: string}: Additional custom fields to associate with the item
name string: Dynamic secret name
password string: Redis Password
passwordLength string: The length of the password to be generated
port string: Redis Port
producerEncryptionKeyName string: Dynamic producer encryption key
ssl boolean: Enable/Disable SSL [true/false]
sslCertificate string: SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
tags string[]: Add tags attached to this object
targetName string: Target name
userTtl string: User TTL
username string: Redis Username

acl_rules str: A JSON array list of redis ACL rules to attach to the created user. For available rules see the ACL CAT command https://redis.io/commands/acl-cat By default the user will have permissions to read all keys '["~*", "+@read"]'
custom_username_template str: Customize how temporary usernames are generated using go template
delete_protection str: Protection from accidental deletion of this object [true/false]
dynamic_secret_redis_id str: The ID of this resource.
host str: Redis Host
item_custom_fields Mapping[str, str]: Additional custom fields to associate with the item
name str: Dynamic secret name
password str: Redis Password
password_length str: The length of the password to be generated
port str: Redis Port
producer_encryption_key_name str: Dynamic producer encryption key
ssl bool: Enable/Disable SSL [true/false]
ssl_certificate str: SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
tags Sequence[str]: Add tags attached to this object
target_name str: Target name
user_ttl str: User TTL
username str: Redis Username

aclRules String: A JSON array list of redis ACL rules to attach to the created user. For available rules see the ACL CAT command https://redis.io/commands/acl-cat By default the user will have permissions to read all keys '["~*", "+@read"]'
customUsernameTemplate String: Customize how temporary usernames are generated using go template
deleteProtection String: Protection from accidental deletion of this object [true/false]
dynamicSecretRedisId String: The ID of this resource.
host String: Redis Host
itemCustomFields Map<String>: Additional custom fields to associate with the item
name String: Dynamic secret name
password String: Redis Password
passwordLength String: The length of the password to be generated
port String: Redis Port
producerEncryptionKeyName String: Dynamic producer encryption key
ssl Boolean: Enable/Disable SSL [true/false]
sslCertificate String: SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
tags List<String>: Add tags attached to this object
targetName String: Target name
userTtl String: User TTL
username String: Redis Username