published on Thursday, Nov 19, 2026 by akeyless-community
published on Thursday, Nov 19, 2026 by akeyless-community
SSH Target resource
Create TargetSsh Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new TargetSsh(name: string, args?: TargetSshArgs, opts?: CustomResourceOptions);@overload
def TargetSsh(resource_name: str,
args: Optional[TargetSshArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def TargetSsh(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
host: Optional[str] = None,
keep_prev_version: Optional[str] = None,
key: Optional[str] = None,
max_versions: Optional[str] = None,
name: Optional[str] = None,
port: Optional[str] = None,
private_key: Optional[str] = None,
private_key_password: Optional[str] = None,
retry: Optional[TargetSshRetryArgs] = None,
ssh_password: Optional[str] = None,
ssh_username: Optional[str] = None,
target_ssh_id: Optional[str] = None)func NewTargetSsh(ctx *Context, name string, args *TargetSshArgs, opts ...ResourceOption) (*TargetSsh, error)public TargetSsh(string name, TargetSshArgs? args = null, CustomResourceOptions? opts = null)
public TargetSsh(String name, TargetSshArgs args)
public TargetSsh(String name, TargetSshArgs args, CustomResourceOptions options)
type: akeyless:TargetSsh
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "akeyless_target_ssh" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args TargetSshArgs
- 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 TargetSshArgs
- 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 TargetSshArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TargetSshArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TargetSshArgs
- 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 targetSshResource = new Akeyless.TargetSsh("targetSshResource", new()
{
Description = "string",
Host = "string",
KeepPrevVersion = "string",
Key = "string",
MaxVersions = "string",
Name = "string",
Port = "string",
PrivateKey = "string",
PrivateKeyPassword = "string",
Retry = new Akeyless.Inputs.TargetSshRetryArgs
{
ErrorMessageRegexes = new[]
{
"string",
},
IntervalSeconds = 0.0,
MaxIntervalSeconds = 0.0,
MaxRetries = 0.0,
RetryOnStatusCodes = new[]
{
0.0,
},
},
SshPassword = "string",
SshUsername = "string",
TargetSshId = "string",
});
example, err := akeyless.NewTargetSsh(ctx, "targetSshResource", &akeyless.TargetSshArgs{
Description: pulumi.String("string"),
Host: pulumi.String("string"),
KeepPrevVersion: pulumi.String("string"),
Key: pulumi.String("string"),
MaxVersions: pulumi.String("string"),
Name: pulumi.String("string"),
Port: pulumi.String("string"),
PrivateKey: pulumi.String("string"),
PrivateKeyPassword: pulumi.String("string"),
Retry: &akeyless.TargetSshRetryArgs{
ErrorMessageRegexes: pulumi.StringArray{
pulumi.String("string"),
},
IntervalSeconds: pulumi.Float64(0),
MaxIntervalSeconds: pulumi.Float64(0),
MaxRetries: pulumi.Float64(0),
RetryOnStatusCodes: pulumi.Float64Array{
pulumi.Float64(0),
},
},
SshPassword: pulumi.String("string"),
SshUsername: pulumi.String("string"),
TargetSshId: pulumi.String("string"),
})
resource "akeyless_target_ssh" "targetSshResource" {
lifecycle {
create_before_destroy = true
}
description = "string"
host = "string"
keep_prev_version = "string"
key = "string"
max_versions = "string"
name = "string"
port = "string"
private_key = "string"
private_key_password = "string"
retry = {
error_message_regexes = ["string"]
interval_seconds = 0
max_interval_seconds = 0
max_retries = 0
retry_on_status_codes = [0]
}
ssh_password = "string"
ssh_username = "string"
target_ssh_id = "string"
}
var targetSshResource = new TargetSsh("targetSshResource", TargetSshArgs.builder()
.description("string")
.host("string")
.keepPrevVersion("string")
.key("string")
.maxVersions("string")
.name("string")
.port("string")
.privateKey("string")
.privateKeyPassword("string")
.retry(TargetSshRetryArgs.builder()
.errorMessageRegexes("string")
.intervalSeconds(0.0)
.maxIntervalSeconds(0.0)
.maxRetries(0.0)
.retryOnStatusCodes(0.0)
.build())
.sshPassword("string")
.sshUsername("string")
.targetSshId("string")
.build());
target_ssh_resource = akeyless.TargetSsh("targetSshResource",
description="string",
host="string",
keep_prev_version="string",
key="string",
max_versions="string",
name="string",
port="string",
private_key="string",
private_key_password="string",
retry={
"error_message_regexes": ["string"],
"interval_seconds": float(0),
"max_interval_seconds": float(0),
"max_retries": float(0),
"retry_on_status_codes": [float(0)],
},
ssh_password="string",
ssh_username="string",
target_ssh_id="string")
const targetSshResource = new akeyless.TargetSsh("targetSshResource", {
description: "string",
host: "string",
keepPrevVersion: "string",
key: "string",
maxVersions: "string",
name: "string",
port: "string",
privateKey: "string",
privateKeyPassword: "string",
retry: {
errorMessageRegexes: ["string"],
intervalSeconds: 0,
maxIntervalSeconds: 0,
maxRetries: 0,
retryOnStatusCodes: [0],
},
sshPassword: "string",
sshUsername: "string",
targetSshId: "string",
});
type: akeyless:TargetSsh
properties:
description: string
host: string
keepPrevVersion: string
key: string
maxVersions: string
name: string
port: string
privateKey: string
privateKeyPassword: string
retry:
errorMessageRegexes:
- string
intervalSeconds: 0
maxIntervalSeconds: 0
maxRetries: 0
retryOnStatusCodes:
- 0
sshPassword: string
sshUsername: string
targetSshId: string
TargetSsh 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 TargetSsh resource accepts the following input properties:
- Description string
- Description of the object
- Host string
- SSH host name
- Keep
Prev stringVersion - 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
- Port string
- SSH port
- Private
Key string - SSH private key
- Private
Key stringPassword - SSH private key password
- Retry
Target
Ssh Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- Ssh
Password string - SSH password to rotate
- Ssh
Username string - SSH username
- Target
Ssh stringId - The ID of this resource.
- Description string
- Description of the object
- Host string
- SSH host name
- Keep
Prev stringVersion - 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
- Port string
- SSH port
- Private
Key string - SSH private key
- Private
Key stringPassword - SSH private key password
- Retry
Target
Ssh Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- Ssh
Password string - SSH password to rotate
- Ssh
Username string - SSH username
- Target
Ssh stringId - The ID of this resource.
- description string
- Description of the object
- host string
- SSH host name
- keep_
prev_ stringversion - 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
- port string
- SSH port
- private_
key string - SSH private key
- private_
key_ stringpassword - SSH private key password
- retry object
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- ssh_
password string - SSH password to rotate
- ssh_
username string - SSH username
- target_
ssh_ stringid - The ID of this resource.
- description String
- Description of the object
- host String
- SSH host name
- keep
Prev StringVersion - 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
- port String
- SSH port
- private
Key String - SSH private key
- private
Key StringPassword - SSH private key password
- retry
Target
Ssh Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- ssh
Password String - SSH password to rotate
- ssh
Username String - SSH username
- target
Ssh StringId - The ID of this resource.
- description string
- Description of the object
- host string
- SSH host name
- keep
Prev stringVersion - 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
- port string
- SSH port
- private
Key string - SSH private key
- private
Key stringPassword - SSH private key password
- retry
Target
Ssh Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- ssh
Password string - SSH password to rotate
- ssh
Username string - SSH username
- target
Ssh stringId - The ID of this resource.
- description str
- Description of the object
- host str
- SSH host name
- keep_
prev_ strversion - 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
- port str
- SSH port
- private_
key str - SSH private key
- private_
key_ strpassword - SSH private key password
- retry
Target
Ssh Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- ssh_
password str - SSH password to rotate
- ssh_
username str - SSH username
- target_
ssh_ strid - The ID of this resource.
- description String
- Description of the object
- host String
- SSH host name
- keep
Prev StringVersion - 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
- port String
- SSH port
- private
Key String - SSH private key
- private
Key StringPassword - SSH private key password
- retry Property Map
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- ssh
Password String - SSH password to rotate
- ssh
Username String - SSH username
- target
Ssh StringId - The ID of this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the TargetSsh 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 TargetSsh Resource
Get an existing TargetSsh 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?: TargetSshState, opts?: CustomResourceOptions): TargetSsh@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
host: Optional[str] = None,
keep_prev_version: Optional[str] = None,
key: Optional[str] = None,
max_versions: Optional[str] = None,
name: Optional[str] = None,
port: Optional[str] = None,
private_key: Optional[str] = None,
private_key_password: Optional[str] = None,
retry: Optional[TargetSshRetryArgs] = None,
ssh_password: Optional[str] = None,
ssh_username: Optional[str] = None,
target_ssh_id: Optional[str] = None) -> TargetSshfunc GetTargetSsh(ctx *Context, name string, id IDInput, state *TargetSshState, opts ...ResourceOption) (*TargetSsh, error)public static TargetSsh Get(string name, Input<string> id, TargetSshState? state, CustomResourceOptions? opts = null)public static TargetSsh get(String name, Output<String> id, TargetSshState state, CustomResourceOptions options)resources: existingTargetSsh: type: akeyless:TargetSsh get: id: ${id}import {
to = akeyless_target_ssh.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state TargetSshState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state TargetSshState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state TargetSshState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state TargetSshState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Description string
- Description of the object
- Host string
- SSH host name
- Keep
Prev stringVersion - 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
- Port string
- SSH port
- Private
Key string - SSH private key
- Private
Key stringPassword - SSH private key password
- Retry
Target
Ssh Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- Ssh
Password string - SSH password to rotate
- Ssh
Username string - SSH username
- Target
Ssh stringId - The ID of this resource.
- Description string
- Description of the object
- Host string
- SSH host name
- Keep
Prev stringVersion - 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
- Port string
- SSH port
- Private
Key string - SSH private key
- Private
Key stringPassword - SSH private key password
- Retry
Target
Ssh Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- Ssh
Password string - SSH password to rotate
- Ssh
Username string - SSH username
- Target
Ssh stringId - The ID of this resource.
- description string
- Description of the object
- host string
- SSH host name
- keep_
prev_ stringversion - 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
- port string
- SSH port
- private_
key string - SSH private key
- private_
key_ stringpassword - SSH private key password
- retry object
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- ssh_
password string - SSH password to rotate
- ssh_
username string - SSH username
- target_
ssh_ stringid - The ID of this resource.
- description String
- Description of the object
- host String
- SSH host name
- keep
Prev StringVersion - 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
- port String
- SSH port
- private
Key String - SSH private key
- private
Key StringPassword - SSH private key password
- retry
Target
Ssh Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- ssh
Password String - SSH password to rotate
- ssh
Username String - SSH username
- target
Ssh StringId - The ID of this resource.
- description string
- Description of the object
- host string
- SSH host name
- keep
Prev stringVersion - 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
- port string
- SSH port
- private
Key string - SSH private key
- private
Key stringPassword - SSH private key password
- retry
Target
Ssh Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- ssh
Password string - SSH password to rotate
- ssh
Username string - SSH username
- target
Ssh stringId - The ID of this resource.
- description str
- Description of the object
- host str
- SSH host name
- keep_
prev_ strversion - 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
- port str
- SSH port
- private_
key str - SSH private key
- private_
key_ strpassword - SSH private key password
- retry
Target
Ssh Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- ssh_
password str - SSH password to rotate
- ssh_
username str - SSH username
- target_
ssh_ strid - The ID of this resource.
- description String
- Description of the object
- host String
- SSH host name
- keep
Prev StringVersion - 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
- port String
- SSH port
- private
Key String - SSH private key
- private
Key StringPassword - SSH private key password
- retry Property Map
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- ssh
Password String - SSH password to rotate
- ssh
Username String - SSH username
- target
Ssh StringId - The ID of this resource.
Supporting Types
TargetSshRetry, TargetSshRetryArgs
- Error
Message List<string>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- Interval
Seconds double - Wait before the first retry, in seconds. The wait doubles on each retry.
- Max
Interval doubleSeconds - Maximum wait between retries, in seconds.
- Max
Retries double - Maximum number of retries after the first attempt.
- Retry
On List<double>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- Error
Message []stringRegexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- Interval
Seconds float64 - Wait before the first retry, in seconds. The wait doubles on each retry.
- Max
Interval float64Seconds - Maximum wait between retries, in seconds.
- Max
Retries float64 - Maximum number of retries after the first attempt.
- Retry
On []float64Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error_
message_ list(string)regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval_
seconds number - Wait before the first retry, in seconds. The wait doubles on each retry.
- max_
interval_ numberseconds - Maximum wait between retries, in seconds.
- max_
retries number - Maximum number of retries after the first attempt.
- retry_
on_ list(number)status_ codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message List<String>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds Double - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval DoubleSeconds - Maximum wait between retries, in seconds.
- max
Retries Double - Maximum number of retries after the first attempt.
- retry
On List<Double>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message string[]Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds number - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval numberSeconds - Maximum wait between retries, in seconds.
- max
Retries number - Maximum number of retries after the first attempt.
- retry
On number[]Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error_
message_ Sequence[str]regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval_
seconds float - Wait before the first retry, in seconds. The wait doubles on each retry.
- max_
interval_ floatseconds - Maximum wait between retries, in seconds.
- max_
retries float - Maximum number of retries after the first attempt.
- retry_
on_ Sequence[float]status_ codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message List<String>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds Number - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval NumberSeconds - Maximum wait between retries, in seconds.
- max
Retries Number - Maximum number of retries after the first attempt.
- retry
On List<Number>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
Package Details
- Repository
- akeyless akeyless-community/terraform-provider-akeyless
- License
- Notes
- This Pulumi package is based on the
akeylessTerraform Provider.
published on Thursday, Nov 19, 2026 by akeyless-community