TargetRabbit

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 TargetRabbit Resource

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

Constructor syntax

new TargetRabbit(name: string, args: TargetRabbitArgs, opts?: CustomResourceOptions);

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

@overload
def TargetRabbit(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 rabbitmq_server_uri: Optional[str] = None,
                 rabbitmq_server_user: Optional[str] = None,
                 description: Optional[str] = None,
                 keep_prev_version: Optional[str] = None,
                 key: Optional[str] = None,
                 max_versions: Optional[str] = None,
                 name: Optional[str] = None,
                 rabbitmq_server_password: Optional[str] = None,
                 target_rabbit_id: Optional[str] = None)

func NewTargetRabbit(ctx *Context, name string, args TargetRabbitArgs, opts ...ResourceOption) (*TargetRabbit, error)

public TargetRabbit(string name, TargetRabbitArgs args, CustomResourceOptions? opts = null)

public TargetRabbit(String name, TargetRabbitArgs args)
public TargetRabbit(String name, TargetRabbitArgs args, CustomResourceOptions options)

type: akeyless:TargetRabbit
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "akeyless_targetrabbit" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args TargetRabbitArgs: 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 TargetRabbitArgs: 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 TargetRabbitArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args TargetRabbitArgs: 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 targetRabbitResource = new Akeyless.TargetRabbit("targetRabbitResource", new()
{
    RabbitmqServerUri = "string",
    RabbitmqServerUser = "string",
    Description = "string",
    KeepPrevVersion = "string",
    Key = "string",
    MaxVersions = "string",
    Name = "string",
    RabbitmqServerPassword = "string",
    TargetRabbitId = "string",
});

example, err := akeyless.NewTargetRabbit(ctx, "targetRabbitResource", &akeyless.TargetRabbitArgs{
	RabbitmqServerUri:      pulumi.String("string"),
	RabbitmqServerUser:     pulumi.String("string"),
	Description:            pulumi.String("string"),
	KeepPrevVersion:        pulumi.String("string"),
	Key:                    pulumi.String("string"),
	MaxVersions:            pulumi.String("string"),
	Name:                   pulumi.String("string"),
	RabbitmqServerPassword: pulumi.String("string"),
	TargetRabbitId:         pulumi.String("string"),
})

resource "akeyless_targetrabbit" "targetRabbitResource" {
  rabbitmq_server_uri      = "string"
  rabbitmq_server_user     = "string"
  description              = "string"
  keep_prev_version        = "string"
  key                      = "string"
  max_versions             = "string"
  name                     = "string"
  rabbitmq_server_password = "string"
  target_rabbit_id         = "string"
}

var targetRabbitResource = new TargetRabbit("targetRabbitResource", TargetRabbitArgs.builder()
    .rabbitmqServerUri("string")
    .rabbitmqServerUser("string")
    .description("string")
    .keepPrevVersion("string")
    .key("string")
    .maxVersions("string")
    .name("string")
    .rabbitmqServerPassword("string")
    .targetRabbitId("string")
    .build());

target_rabbit_resource = akeyless.TargetRabbit("targetRabbitResource",
    rabbitmq_server_uri="string",
    rabbitmq_server_user="string",
    description="string",
    keep_prev_version="string",
    key="string",
    max_versions="string",
    name="string",
    rabbitmq_server_password="string",
    target_rabbit_id="string")

const targetRabbitResource = new akeyless.TargetRabbit("targetRabbitResource", {
    rabbitmqServerUri: "string",
    rabbitmqServerUser: "string",
    description: "string",
    keepPrevVersion: "string",
    key: "string",
    maxVersions: "string",
    name: "string",
    rabbitmqServerPassword: "string",
    targetRabbitId: "string",
});

type: akeyless:TargetRabbit
properties:
    description: string
    keepPrevVersion: string
    key: string
    maxVersions: string
    name: string
    rabbitmqServerPassword: string
    rabbitmqServerUri: string
    rabbitmqServerUser: string
    targetRabbitId: string

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

RabbitmqServerUri string: RabbitMQ server URI
RabbitmqServerUser string: RabbitMQ server user
Description string: Description of the object
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Target name
RabbitmqServerPassword string: RabbitMQ server password
TargetRabbitId string: The ID of this resource.

RabbitmqServerUri string: RabbitMQ server URI
RabbitmqServerUser string: RabbitMQ server user
Description string: Description of the object
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Target name
RabbitmqServerPassword string: RabbitMQ server password
TargetRabbitId string: The ID of this resource.

rabbitmq_server_uri string: RabbitMQ server URI
rabbitmq_server_user string: RabbitMQ server user
description string: Description of the object
keep_prev_version string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
max_versions string: Set the maximum number of versions, limited by the account settings defaults.
name string: Target name
rabbitmq_server_password string: RabbitMQ server password
target_rabbit_id string: The ID of this resource.

rabbitmqServerUri String: RabbitMQ server URI
rabbitmqServerUser String: RabbitMQ server user
description String: Description of the object
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Target name
rabbitmqServerPassword String: RabbitMQ server password
targetRabbitId String: The ID of this resource.

rabbitmqServerUri string: RabbitMQ server URI
rabbitmqServerUser string: RabbitMQ server user
description string: Description of the object
keepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions string: Set the maximum number of versions, limited by the account settings defaults.
name string: Target name
rabbitmqServerPassword string: RabbitMQ server password
targetRabbitId string: The ID of this resource.

rabbitmq_server_uri str: RabbitMQ server URI
rabbitmq_server_user str: RabbitMQ server user
description str: Description of the object
keep_prev_version str: Whether to keep previous version [true/false]. If not set, use default according to account settings
key str: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
max_versions str: Set the maximum number of versions, limited by the account settings defaults.
name str: Target name
rabbitmq_server_password str: RabbitMQ server password
target_rabbit_id str: The ID of this resource.

rabbitmqServerUri String: RabbitMQ server URI
rabbitmqServerUser String: RabbitMQ server user
description String: Description of the object
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Target name
rabbitmqServerPassword String: RabbitMQ server password
targetRabbitId String: The ID of this resource.

Outputs

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        keep_prev_version: Optional[str] = None,
        key: Optional[str] = None,
        max_versions: Optional[str] = None,
        name: Optional[str] = None,
        rabbitmq_server_password: Optional[str] = None,
        rabbitmq_server_uri: Optional[str] = None,
        rabbitmq_server_user: Optional[str] = None,
        target_rabbit_id: Optional[str] = None) -> TargetRabbit

func GetTargetRabbit(ctx *Context, name string, id IDInput, state *TargetRabbitState, opts ...ResourceOption) (*TargetRabbit, error)

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

public static TargetRabbit get(String name, Output<String> id, TargetRabbitState state, CustomResourceOptions options)

resources:  _:    type: akeyless:TargetRabbit    get:      id: ${id}

import {
  to = akeyless_targetrabbit.example
  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:

Description string: Description of the object
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Target name
RabbitmqServerPassword string: RabbitMQ server password
RabbitmqServerUri string: RabbitMQ server URI
RabbitmqServerUser string: RabbitMQ server user
TargetRabbitId string: The ID of this resource.

Description string: Description of the object
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Target name
RabbitmqServerPassword string: RabbitMQ server password
RabbitmqServerUri string: RabbitMQ server URI
RabbitmqServerUser string: RabbitMQ server user
TargetRabbitId string: The ID of this resource.

description string: Description of the object
keep_prev_version string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
max_versions string: Set the maximum number of versions, limited by the account settings defaults.
name string: Target name
rabbitmq_server_password string: RabbitMQ server password
rabbitmq_server_uri string: RabbitMQ server URI
rabbitmq_server_user string: RabbitMQ server user
target_rabbit_id string: The ID of this resource.

description String: Description of the object
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Target name
rabbitmqServerPassword String: RabbitMQ server password
rabbitmqServerUri String: RabbitMQ server URI
rabbitmqServerUser String: RabbitMQ server user
targetRabbitId String: The ID of this resource.

description string: Description of the object
keepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions string: Set the maximum number of versions, limited by the account settings defaults.
name string: Target name
rabbitmqServerPassword string: RabbitMQ server password
rabbitmqServerUri string: RabbitMQ server URI
rabbitmqServerUser string: RabbitMQ server user
targetRabbitId string: The ID of this resource.

description str: Description of the object
keep_prev_version str: Whether to keep previous version [true/false]. If not set, use default according to account settings
key str: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
max_versions str: Set the maximum number of versions, limited by the account settings defaults.
name str: Target name
rabbitmq_server_password str: RabbitMQ server password
rabbitmq_server_uri str: RabbitMQ server URI
rabbitmq_server_user str: RabbitMQ server user
target_rabbit_id str: The ID of this resource.

description String: Description of the object
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Target name
rabbitmqServerPassword String: RabbitMQ server password
rabbitmqServerUri String: RabbitMQ server URI
rabbitmqServerUser String: RabbitMQ server user
targetRabbitId String: The ID of this resource.