1. Packages
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. RotatedSecretSsh
Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community
Schema (JSON)
akeyless-community/terraform-provider-akeyless

akeyless.RotatedSecretSsh

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community
Schema (JSON)
akeyless-community/terraform-provider-akeyless

    Ssh rotated secret resource

    Create RotatedSecretSsh Resource

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

    Constructor syntax

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

@overload
def RotatedSecretSsh(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     rotator_type: Optional[str] = None,
                     target_name: Optional[str] = None,
                     rotation_event_ins: Optional[Sequence[str]] = None,
                     secure_access_allow_external_user: Optional[bool] = None,
                     item_custom_fields: Optional[Mapping[str, str]] = None,
                     keep_prev_version: Optional[str] = None,
                     key: Optional[str] = None,
                     key_data_base64: Optional[str] = None,
                     max_versions: Optional[str] = None,
                     name: Optional[str] = None,
                     password_length: Optional[str] = None,
                     public_key_remote_path: Optional[str] = None,
                     rotate_after_disconnect: Optional[str] = None,
                     rotated_password: Optional[str] = None,
                     rotated_secret_ssh_id: Optional[str] = None,
                     rotated_username: Optional[str] = None,
                     description: Optional[str] = None,
                     authentication_credentials: Optional[str] = None,
                     secure_access_enable: Optional[str] = None,
                     rotator_custom_cmd: Optional[str] = None,
                     delete_protection: Optional[str] = None,
                     same_password: Optional[str] = None,
                     rotation_hour: Optional[float] = None,
                     secure_access_certificate_issuer: Optional[str] = None,
                     rotation_interval: Optional[str] = None,
                     secure_access_hosts: Optional[Sequence[str]] = None,
                     secure_access_rdp_domain: Optional[str] = None,
                     secure_access_rdp_user: Optional[str] = None,
                     secure_access_ssh_user: Optional[str] = None,
                     secure_access_target_type: Optional[str] = None,
                     tags: Optional[Sequence[str]] = None,
                     auto_rotate: Optional[str] = None)
    func NewRotatedSecretSsh(ctx *Context, name string, args RotatedSecretSshArgs, opts ...ResourceOption) (*RotatedSecretSsh, error)
    public RotatedSecretSsh(string name, RotatedSecretSshArgs args, CustomResourceOptions? opts = null)
    public RotatedSecretSsh(String name, RotatedSecretSshArgs args)
public RotatedSecretSsh(String name, RotatedSecretSshArgs args, CustomResourceOptions options)

    type: akeyless:RotatedSecretSsh
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 RotatedSecretSshArgs
    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 RotatedSecretSshArgs
    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 RotatedSecretSshArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RotatedSecretSshArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RotatedSecretSshArgs
    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 rotatedSecretSshResource = new Akeyless.RotatedSecretSsh("rotatedSecretSshResource", new()
{
    RotatorType = "string",
    TargetName = "string",
    RotationEventIns = new[]
    {
        "string",
    },
    SecureAccessAllowExternalUser = false,
    ItemCustomFields = 
    {
        { "string", "string" },
    },
    KeepPrevVersion = "string",
    Key = "string",
    KeyDataBase64 = "string",
    MaxVersions = "string",
    Name = "string",
    PasswordLength = "string",
    PublicKeyRemotePath = "string",
    RotateAfterDisconnect = "string",
    RotatedPassword = "string",
    RotatedSecretSshId = "string",
    RotatedUsername = "string",
    Description = "string",
    AuthenticationCredentials = "string",
    SecureAccessEnable = "string",
    RotatorCustomCmd = "string",
    DeleteProtection = "string",
    SamePassword = "string",
    RotationHour = 0,
    SecureAccessCertificateIssuer = "string",
    RotationInterval = "string",
    SecureAccessHosts = new[]
    {
        "string",
    },
    SecureAccessRdpDomain = "string",
    SecureAccessRdpUser = "string",
    SecureAccessSshUser = "string",
    SecureAccessTargetType = "string",
    Tags = new[]
    {
        "string",
    },
    AutoRotate = "string",
});

    example, err := akeyless.NewRotatedSecretSsh(ctx, "rotatedSecretSshResource", &akeyless.RotatedSecretSshArgs{
	RotatorType: pulumi.String("string"),
	TargetName:  pulumi.String("string"),
	RotationEventIns: pulumi.StringArray{
		pulumi.String("string"),
	},
	SecureAccessAllowExternalUser: pulumi.Bool(false),
	ItemCustomFields: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	KeepPrevVersion:               pulumi.String("string"),
	Key:                           pulumi.String("string"),
	KeyDataBase64:                 pulumi.String("string"),
	MaxVersions:                   pulumi.String("string"),
	Name:                          pulumi.String("string"),
	PasswordLength:                pulumi.String("string"),
	PublicKeyRemotePath:           pulumi.String("string"),
	RotateAfterDisconnect:         pulumi.String("string"),
	RotatedPassword:               pulumi.String("string"),
	RotatedSecretSshId:            pulumi.String("string"),
	RotatedUsername:               pulumi.String("string"),
	Description:                   pulumi.String("string"),
	AuthenticationCredentials:     pulumi.String("string"),
	SecureAccessEnable:            pulumi.String("string"),
	RotatorCustomCmd:              pulumi.String("string"),
	DeleteProtection:              pulumi.String("string"),
	SamePassword:                  pulumi.String("string"),
	RotationHour:                  pulumi.Float64(0),
	SecureAccessCertificateIssuer: pulumi.String("string"),
	RotationInterval:              pulumi.String("string"),
	SecureAccessHosts: pulumi.StringArray{
		pulumi.String("string"),
	},
	SecureAccessRdpDomain:  pulumi.String("string"),
	SecureAccessRdpUser:    pulumi.String("string"),
	SecureAccessSshUser:    pulumi.String("string"),
	SecureAccessTargetType: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	AutoRotate: pulumi.String("string"),
})

    var rotatedSecretSshResource = new RotatedSecretSsh("rotatedSecretSshResource", RotatedSecretSshArgs.builder()
    .rotatorType("string")
    .targetName("string")
    .rotationEventIns("string")
    .secureAccessAllowExternalUser(false)
    .itemCustomFields(Map.of("string", "string"))
    .keepPrevVersion("string")
    .key("string")
    .keyDataBase64("string")
    .maxVersions("string")
    .name("string")
    .passwordLength("string")
    .publicKeyRemotePath("string")
    .rotateAfterDisconnect("string")
    .rotatedPassword("string")
    .rotatedSecretSshId("string")
    .rotatedUsername("string")
    .description("string")
    .authenticationCredentials("string")
    .secureAccessEnable("string")
    .rotatorCustomCmd("string")
    .deleteProtection("string")
    .samePassword("string")
    .rotationHour(0.0)
    .secureAccessCertificateIssuer("string")
    .rotationInterval("string")
    .secureAccessHosts("string")
    .secureAccessRdpDomain("string")
    .secureAccessRdpUser("string")
    .secureAccessSshUser("string")
    .secureAccessTargetType("string")
    .tags("string")
    .autoRotate("string")
    .build());

    rotated_secret_ssh_resource = akeyless.RotatedSecretSsh("rotatedSecretSshResource",
    rotator_type="string",
    target_name="string",
    rotation_event_ins=["string"],
    secure_access_allow_external_user=False,
    item_custom_fields={
        "string": "string",
    },
    keep_prev_version="string",
    key="string",
    key_data_base64="string",
    max_versions="string",
    name="string",
    password_length="string",
    public_key_remote_path="string",
    rotate_after_disconnect="string",
    rotated_password="string",
    rotated_secret_ssh_id="string",
    rotated_username="string",
    description="string",
    authentication_credentials="string",
    secure_access_enable="string",
    rotator_custom_cmd="string",
    delete_protection="string",
    same_password="string",
    rotation_hour=float(0),
    secure_access_certificate_issuer="string",
    rotation_interval="string",
    secure_access_hosts=["string"],
    secure_access_rdp_domain="string",
    secure_access_rdp_user="string",
    secure_access_ssh_user="string",
    secure_access_target_type="string",
    tags=["string"],
    auto_rotate="string")

    const rotatedSecretSshResource = new akeyless.RotatedSecretSsh("rotatedSecretSshResource", {
    rotatorType: "string",
    targetName: "string",
    rotationEventIns: ["string"],
    secureAccessAllowExternalUser: false,
    itemCustomFields: {
        string: "string",
    },
    keepPrevVersion: "string",
    key: "string",
    keyDataBase64: "string",
    maxVersions: "string",
    name: "string",
    passwordLength: "string",
    publicKeyRemotePath: "string",
    rotateAfterDisconnect: "string",
    rotatedPassword: "string",
    rotatedSecretSshId: "string",
    rotatedUsername: "string",
    description: "string",
    authenticationCredentials: "string",
    secureAccessEnable: "string",
    rotatorCustomCmd: "string",
    deleteProtection: "string",
    samePassword: "string",
    rotationHour: 0,
    secureAccessCertificateIssuer: "string",
    rotationInterval: "string",
    secureAccessHosts: ["string"],
    secureAccessRdpDomain: "string",
    secureAccessRdpUser: "string",
    secureAccessSshUser: "string",
    secureAccessTargetType: "string",
    tags: ["string"],
    autoRotate: "string",
});

    type: akeyless:RotatedSecretSsh
properties:
    authenticationCredentials: string
    autoRotate: string
    deleteProtection: string
    description: string
    itemCustomFields:
        string: string
    keepPrevVersion: string
    key: string
    keyDataBase64: string
    maxVersions: string
    name: string
    passwordLength: string
    publicKeyRemotePath: string
    rotateAfterDisconnect: string
    rotatedPassword: string
    rotatedSecretSshId: string
    rotatedUsername: string
    rotationEventIns:
        - string
    rotationHour: 0
    rotationInterval: string
    rotatorCustomCmd: string
    rotatorType: string
    samePassword: string
    secureAccessAllowExternalUser: false
    secureAccessCertificateIssuer: string
    secureAccessEnable: string
    secureAccessHosts:
        - string
    secureAccessRdpDomain: string
    secureAccessRdpUser: string
    secureAccessSshUser: string
    secureAccessTargetType: string
    tags:
        - string
    targetName: string

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

    RotatorType string
    The rotator type. options: [target/password/key]
    TargetName string
    The target name to associate
    AuthenticationCredentials string
    The credentials to connect with use-self-creds/use-target-creds
    AutoRotate string
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    ItemCustomFields Dictionary<string, string>
    Additional custom fields to associate with the item
    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 is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    KeyDataBase64 string
    Private key file contents encoded using base64
    MaxVersions string
    Set the maximum number of versions, limited by the account settings defaults
    Name string
    Secret name
    PasswordLength string
    The length of the password to be generated
    PublicKeyRemotePath string
    The path to the public key that will be rotated on the server
    RotateAfterDisconnect string
    Rotate the value of the secret after SRA session ends [true/false]
    RotatedPassword string
    rotated-username password (relevant only for rotator-type=password)
    RotatedSecretSshId string
    The ID of this resource.
    RotatedUsername string
    username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password)
    RotationEventIns List<string>
    How many days before the rotation of the item would you like to be notified
    RotationHour double
    The Hour of the rotation in UTC
    RotationInterval string
    The number of days to wait between every automatic key rotation (1-365)
    RotatorCustomCmd string
    Custom rotation command
    SamePassword string
    Rotate same password for each host from the Linked Target (relevant only for Linked Target)
    SecureAccessAllowExternalUser bool
    Allow providing external user for a domain users
    SecureAccessCertificateIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    SecureAccessEnable string
    Enable/Disable secure remote access [true/false]
    SecureAccessHosts List<string>
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    SecureAccessRdpDomain string
    Default domain name server. i.e. microsoft.com
    SecureAccessRdpUser string
    Override the RDP Domain username
    SecureAccessSshUser string
    Override the SSH username as indicated in SSH Certificate Issuer
    SecureAccessTargetType string
    Specify target type. Options are ssh or rdp
    Tags List<string>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    RotatorType string
    The rotator type. options: [target/password/key]
    TargetName string
    The target name to associate
    AuthenticationCredentials string
    The credentials to connect with use-self-creds/use-target-creds
    AutoRotate string
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    ItemCustomFields map[string]string
    Additional custom fields to associate with the item
    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 is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    KeyDataBase64 string
    Private key file contents encoded using base64
    MaxVersions string
    Set the maximum number of versions, limited by the account settings defaults
    Name string
    Secret name
    PasswordLength string
    The length of the password to be generated
    PublicKeyRemotePath string
    The path to the public key that will be rotated on the server
    RotateAfterDisconnect string
    Rotate the value of the secret after SRA session ends [true/false]
    RotatedPassword string
    rotated-username password (relevant only for rotator-type=password)
    RotatedSecretSshId string
    The ID of this resource.
    RotatedUsername string
    username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password)
    RotationEventIns []string
    How many days before the rotation of the item would you like to be notified
    RotationHour float64
    The Hour of the rotation in UTC
    RotationInterval string
    The number of days to wait between every automatic key rotation (1-365)
    RotatorCustomCmd string
    Custom rotation command
    SamePassword string
    Rotate same password for each host from the Linked Target (relevant only for Linked Target)
    SecureAccessAllowExternalUser bool
    Allow providing external user for a domain users
    SecureAccessCertificateIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    SecureAccessEnable string
    Enable/Disable secure remote access [true/false]
    SecureAccessHosts []string
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    SecureAccessRdpDomain string
    Default domain name server. i.e. microsoft.com
    SecureAccessRdpUser string
    Override the RDP Domain username
    SecureAccessSshUser string
    Override the SSH username as indicated in SSH Certificate Issuer
    SecureAccessTargetType string
    Specify target type. Options are ssh or rdp
    Tags []string
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    rotatorType String
    The rotator type. options: [target/password/key]
    targetName String
    The target name to associate
    authenticationCredentials String
    The credentials to connect with use-self-creds/use-target-creds
    autoRotate String
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    itemCustomFields Map<String,String>
    Additional custom fields to associate with the item
    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 is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    keyDataBase64 String
    Private key file contents encoded using base64
    maxVersions String
    Set the maximum number of versions, limited by the account settings defaults
    name String
    Secret name
    passwordLength String
    The length of the password to be generated
    publicKeyRemotePath String
    The path to the public key that will be rotated on the server
    rotateAfterDisconnect String
    Rotate the value of the secret after SRA session ends [true/false]
    rotatedPassword String
    rotated-username password (relevant only for rotator-type=password)
    rotatedSecretSshId String
    The ID of this resource.
    rotatedUsername String
    username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password)
    rotationEventIns List<String>
    How many days before the rotation of the item would you like to be notified
    rotationHour Double
    The Hour of the rotation in UTC
    rotationInterval String
    The number of days to wait between every automatic key rotation (1-365)
    rotatorCustomCmd String
    Custom rotation command
    samePassword String
    Rotate same password for each host from the Linked Target (relevant only for Linked Target)
    secureAccessAllowExternalUser Boolean
    Allow providing external user for a domain users
    secureAccessCertificateIssuer String
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secureAccessEnable String
    Enable/Disable secure remote access [true/false]
    secureAccessHosts List<String>
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    secureAccessRdpDomain String
    Default domain name server. i.e. microsoft.com
    secureAccessRdpUser String
    Override the RDP Domain username
    secureAccessSshUser String
    Override the SSH username as indicated in SSH Certificate Issuer
    secureAccessTargetType String
    Specify target type. Options are ssh or rdp
    tags List<String>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    rotatorType string
    The rotator type. options: [target/password/key]
    targetName string
    The target name to associate
    authenticationCredentials string
    The credentials to connect with use-self-creds/use-target-creds
    autoRotate string
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    deleteProtection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    itemCustomFields {[key: string]: string}
    Additional custom fields to associate with the item
    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 is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    keyDataBase64 string
    Private key file contents encoded using base64
    maxVersions string
    Set the maximum number of versions, limited by the account settings defaults
    name string
    Secret name
    passwordLength string
    The length of the password to be generated
    publicKeyRemotePath string
    The path to the public key that will be rotated on the server
    rotateAfterDisconnect string
    Rotate the value of the secret after SRA session ends [true/false]
    rotatedPassword string
    rotated-username password (relevant only for rotator-type=password)
    rotatedSecretSshId string
    The ID of this resource.
    rotatedUsername string
    username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password)
    rotationEventIns string[]
    How many days before the rotation of the item would you like to be notified
    rotationHour number
    The Hour of the rotation in UTC
    rotationInterval string
    The number of days to wait between every automatic key rotation (1-365)
    rotatorCustomCmd string
    Custom rotation command
    samePassword string
    Rotate same password for each host from the Linked Target (relevant only for Linked Target)
    secureAccessAllowExternalUser boolean
    Allow providing external user for a domain users
    secureAccessCertificateIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secureAccessEnable string
    Enable/Disable secure remote access [true/false]
    secureAccessHosts string[]
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    secureAccessRdpDomain string
    Default domain name server. i.e. microsoft.com
    secureAccessRdpUser string
    Override the RDP Domain username
    secureAccessSshUser string
    Override the SSH username as indicated in SSH Certificate Issuer
    secureAccessTargetType string
    Specify target type. Options are ssh or rdp
    tags string[]
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    rotator_type str
    The rotator type. options: [target/password/key]
    target_name str
    The target name to associate
    authentication_credentials str
    The credentials to connect with use-self-creds/use-target-creds
    auto_rotate str
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    delete_protection str
    Protection from accidental deletion of this object [true/false]
    description str
    Description of the object
    item_custom_fields Mapping[str, str]
    Additional custom fields to associate with the item
    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 is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    key_data_base64 str
    Private key file contents encoded using base64
    max_versions str
    Set the maximum number of versions, limited by the account settings defaults
    name str
    Secret name
    password_length str
    The length of the password to be generated
    public_key_remote_path str
    The path to the public key that will be rotated on the server
    rotate_after_disconnect str
    Rotate the value of the secret after SRA session ends [true/false]
    rotated_password str
    rotated-username password (relevant only for rotator-type=password)
    rotated_secret_ssh_id str
    The ID of this resource.
    rotated_username str
    username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password)
    rotation_event_ins Sequence[str]
    How many days before the rotation of the item would you like to be notified
    rotation_hour float
    The Hour of the rotation in UTC
    rotation_interval str
    The number of days to wait between every automatic key rotation (1-365)
    rotator_custom_cmd str
    Custom rotation command
    same_password str
    Rotate same password for each host from the Linked Target (relevant only for Linked Target)
    secure_access_allow_external_user bool
    Allow providing external user for a domain users
    secure_access_certificate_issuer str
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secure_access_enable str
    Enable/Disable secure remote access [true/false]
    secure_access_hosts Sequence[str]
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    secure_access_rdp_domain str
    Default domain name server. i.e. microsoft.com
    secure_access_rdp_user str
    Override the RDP Domain username
    secure_access_ssh_user str
    Override the SSH username as indicated in SSH Certificate Issuer
    secure_access_target_type str
    Specify target type. Options are ssh or rdp
    tags Sequence[str]
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    rotatorType String
    The rotator type. options: [target/password/key]
    targetName String
    The target name to associate
    authenticationCredentials String
    The credentials to connect with use-self-creds/use-target-creds
    autoRotate String
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    itemCustomFields Map<String>
    Additional custom fields to associate with the item
    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 is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    keyDataBase64 String
    Private key file contents encoded using base64
    maxVersions String
    Set the maximum number of versions, limited by the account settings defaults
    name String
    Secret name
    passwordLength String
    The length of the password to be generated
    publicKeyRemotePath String
    The path to the public key that will be rotated on the server
    rotateAfterDisconnect String
    Rotate the value of the secret after SRA session ends [true/false]
    rotatedPassword String
    rotated-username password (relevant only for rotator-type=password)
    rotatedSecretSshId String
    The ID of this resource.
    rotatedUsername String
    username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password)
    rotationEventIns List<String>
    How many days before the rotation of the item would you like to be notified
    rotationHour Number
    The Hour of the rotation in UTC
    rotationInterval String
    The number of days to wait between every automatic key rotation (1-365)
    rotatorCustomCmd String
    Custom rotation command
    samePassword String
    Rotate same password for each host from the Linked Target (relevant only for Linked Target)
    secureAccessAllowExternalUser Boolean
    Allow providing external user for a domain users
    secureAccessCertificateIssuer String
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secureAccessEnable String
    Enable/Disable secure remote access [true/false]
    secureAccessHosts List<String>
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    secureAccessRdpDomain String
    Default domain name server. i.e. microsoft.com
    secureAccessRdpUser String
    Override the RDP Domain username
    secureAccessSshUser String
    Override the SSH username as indicated in SSH Certificate Issuer
    secureAccessTargetType String
    Specify target type. Options are ssh or rdp
    tags List<String>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2

    Outputs

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

    Get an existing RotatedSecretSsh 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?: RotatedSecretSshState, opts?: CustomResourceOptions): RotatedSecretSsh
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication_credentials: Optional[str] = None,
        auto_rotate: Optional[str] = None,
        delete_protection: Optional[str] = None,
        description: Optional[str] = None,
        item_custom_fields: Optional[Mapping[str, str]] = None,
        keep_prev_version: Optional[str] = None,
        key: Optional[str] = None,
        key_data_base64: Optional[str] = None,
        max_versions: Optional[str] = None,
        name: Optional[str] = None,
        password_length: Optional[str] = None,
        public_key_remote_path: Optional[str] = None,
        rotate_after_disconnect: Optional[str] = None,
        rotated_password: Optional[str] = None,
        rotated_secret_ssh_id: Optional[str] = None,
        rotated_username: Optional[str] = None,
        rotation_event_ins: Optional[Sequence[str]] = None,
        rotation_hour: Optional[float] = None,
        rotation_interval: Optional[str] = None,
        rotator_custom_cmd: Optional[str] = None,
        rotator_type: Optional[str] = None,
        same_password: Optional[str] = None,
        secure_access_allow_external_user: Optional[bool] = None,
        secure_access_certificate_issuer: Optional[str] = None,
        secure_access_enable: Optional[str] = None,
        secure_access_hosts: Optional[Sequence[str]] = None,
        secure_access_rdp_domain: Optional[str] = None,
        secure_access_rdp_user: Optional[str] = None,
        secure_access_ssh_user: Optional[str] = None,
        secure_access_target_type: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        target_name: Optional[str] = None) -> RotatedSecretSsh
    func GetRotatedSecretSsh(ctx *Context, name string, id IDInput, state *RotatedSecretSshState, opts ...ResourceOption) (*RotatedSecretSsh, error)
    public static RotatedSecretSsh Get(string name, Input<string> id, RotatedSecretSshState? state, CustomResourceOptions? opts = null)
    public static RotatedSecretSsh get(String name, Output<String> id, RotatedSecretSshState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:RotatedSecretSsh    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:
    AuthenticationCredentials string
    The credentials to connect with use-self-creds/use-target-creds
    AutoRotate string
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    ItemCustomFields Dictionary<string, string>
    Additional custom fields to associate with the item
    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 is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    KeyDataBase64 string
    Private key file contents encoded using base64
    MaxVersions string
    Set the maximum number of versions, limited by the account settings defaults
    Name string
    Secret name
    PasswordLength string
    The length of the password to be generated
    PublicKeyRemotePath string
    The path to the public key that will be rotated on the server
    RotateAfterDisconnect string
    Rotate the value of the secret after SRA session ends [true/false]
    RotatedPassword string
    rotated-username password (relevant only for rotator-type=password)
    RotatedSecretSshId string
    The ID of this resource.
    RotatedUsername string
    username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password)
    RotationEventIns List<string>
    How many days before the rotation of the item would you like to be notified
    RotationHour double
    The Hour of the rotation in UTC
    RotationInterval string
    The number of days to wait between every automatic key rotation (1-365)
    RotatorCustomCmd string
    Custom rotation command
    RotatorType string
    The rotator type. options: [target/password/key]
    SamePassword string
    Rotate same password for each host from the Linked Target (relevant only for Linked Target)
    SecureAccessAllowExternalUser bool
    Allow providing external user for a domain users
    SecureAccessCertificateIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    SecureAccessEnable string
    Enable/Disable secure remote access [true/false]
    SecureAccessHosts List<string>
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    SecureAccessRdpDomain string
    Default domain name server. i.e. microsoft.com
    SecureAccessRdpUser string
    Override the RDP Domain username
    SecureAccessSshUser string
    Override the SSH username as indicated in SSH Certificate Issuer
    SecureAccessTargetType string
    Specify target type. Options are ssh or rdp
    Tags List<string>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    TargetName string
    The target name to associate
    AuthenticationCredentials string
    The credentials to connect with use-self-creds/use-target-creds
    AutoRotate string
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    ItemCustomFields map[string]string
    Additional custom fields to associate with the item
    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 is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    KeyDataBase64 string
    Private key file contents encoded using base64
    MaxVersions string
    Set the maximum number of versions, limited by the account settings defaults
    Name string
    Secret name
    PasswordLength string
    The length of the password to be generated
    PublicKeyRemotePath string
    The path to the public key that will be rotated on the server
    RotateAfterDisconnect string
    Rotate the value of the secret after SRA session ends [true/false]
    RotatedPassword string
    rotated-username password (relevant only for rotator-type=password)
    RotatedSecretSshId string
    The ID of this resource.
    RotatedUsername string
    username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password)
    RotationEventIns []string
    How many days before the rotation of the item would you like to be notified
    RotationHour float64
    The Hour of the rotation in UTC
    RotationInterval string
    The number of days to wait between every automatic key rotation (1-365)
    RotatorCustomCmd string
    Custom rotation command
    RotatorType string
    The rotator type. options: [target/password/key]
    SamePassword string
    Rotate same password for each host from the Linked Target (relevant only for Linked Target)
    SecureAccessAllowExternalUser bool
    Allow providing external user for a domain users
    SecureAccessCertificateIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    SecureAccessEnable string
    Enable/Disable secure remote access [true/false]
    SecureAccessHosts []string
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    SecureAccessRdpDomain string
    Default domain name server. i.e. microsoft.com
    SecureAccessRdpUser string
    Override the RDP Domain username
    SecureAccessSshUser string
    Override the SSH username as indicated in SSH Certificate Issuer
    SecureAccessTargetType string
    Specify target type. Options are ssh or rdp
    Tags []string
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    TargetName string
    The target name to associate
    authenticationCredentials String
    The credentials to connect with use-self-creds/use-target-creds
    autoRotate String
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    itemCustomFields Map<String,String>
    Additional custom fields to associate with the item
    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 is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    keyDataBase64 String
    Private key file contents encoded using base64
    maxVersions String
    Set the maximum number of versions, limited by the account settings defaults
    name String
    Secret name
    passwordLength String
    The length of the password to be generated
    publicKeyRemotePath String
    The path to the public key that will be rotated on the server
    rotateAfterDisconnect String
    Rotate the value of the secret after SRA session ends [true/false]
    rotatedPassword String
    rotated-username password (relevant only for rotator-type=password)
    rotatedSecretSshId String
    The ID of this resource.
    rotatedUsername String
    username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password)
    rotationEventIns List<String>
    How many days before the rotation of the item would you like to be notified
    rotationHour Double
    The Hour of the rotation in UTC
    rotationInterval String
    The number of days to wait between every automatic key rotation (1-365)
    rotatorCustomCmd String
    Custom rotation command
    rotatorType String
    The rotator type. options: [target/password/key]
    samePassword String
    Rotate same password for each host from the Linked Target (relevant only for Linked Target)
    secureAccessAllowExternalUser Boolean
    Allow providing external user for a domain users
    secureAccessCertificateIssuer String
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secureAccessEnable String
    Enable/Disable secure remote access [true/false]
    secureAccessHosts List<String>
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    secureAccessRdpDomain String
    Default domain name server. i.e. microsoft.com
    secureAccessRdpUser String
    Override the RDP Domain username
    secureAccessSshUser String
    Override the SSH username as indicated in SSH Certificate Issuer
    secureAccessTargetType String
    Specify target type. Options are ssh or rdp
    tags List<String>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    targetName String
    The target name to associate
    authenticationCredentials string
    The credentials to connect with use-self-creds/use-target-creds
    autoRotate string
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    deleteProtection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    itemCustomFields {[key: string]: string}
    Additional custom fields to associate with the item
    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 is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    keyDataBase64 string
    Private key file contents encoded using base64
    maxVersions string
    Set the maximum number of versions, limited by the account settings defaults
    name string
    Secret name
    passwordLength string
    The length of the password to be generated
    publicKeyRemotePath string
    The path to the public key that will be rotated on the server
    rotateAfterDisconnect string
    Rotate the value of the secret after SRA session ends [true/false]
    rotatedPassword string
    rotated-username password (relevant only for rotator-type=password)
    rotatedSecretSshId string
    The ID of this resource.
    rotatedUsername string
    username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password)
    rotationEventIns string[]
    How many days before the rotation of the item would you like to be notified
    rotationHour number
    The Hour of the rotation in UTC
    rotationInterval string
    The number of days to wait between every automatic key rotation (1-365)
    rotatorCustomCmd string
    Custom rotation command
    rotatorType string
    The rotator type. options: [target/password/key]
    samePassword string
    Rotate same password for each host from the Linked Target (relevant only for Linked Target)
    secureAccessAllowExternalUser boolean
    Allow providing external user for a domain users
    secureAccessCertificateIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secureAccessEnable string
    Enable/Disable secure remote access [true/false]
    secureAccessHosts string[]
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    secureAccessRdpDomain string
    Default domain name server. i.e. microsoft.com
    secureAccessRdpUser string
    Override the RDP Domain username
    secureAccessSshUser string
    Override the SSH username as indicated in SSH Certificate Issuer
    secureAccessTargetType string
    Specify target type. Options are ssh or rdp
    tags string[]
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    targetName string
    The target name to associate
    authentication_credentials str
    The credentials to connect with use-self-creds/use-target-creds
    auto_rotate str
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    delete_protection str
    Protection from accidental deletion of this object [true/false]
    description str
    Description of the object
    item_custom_fields Mapping[str, str]
    Additional custom fields to associate with the item
    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 is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    key_data_base64 str
    Private key file contents encoded using base64
    max_versions str
    Set the maximum number of versions, limited by the account settings defaults
    name str
    Secret name
    password_length str
    The length of the password to be generated
    public_key_remote_path str
    The path to the public key that will be rotated on the server
    rotate_after_disconnect str
    Rotate the value of the secret after SRA session ends [true/false]
    rotated_password str
    rotated-username password (relevant only for rotator-type=password)
    rotated_secret_ssh_id str
    The ID of this resource.
    rotated_username str
    username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password)
    rotation_event_ins Sequence[str]
    How many days before the rotation of the item would you like to be notified
    rotation_hour float
    The Hour of the rotation in UTC
    rotation_interval str
    The number of days to wait between every automatic key rotation (1-365)
    rotator_custom_cmd str
    Custom rotation command
    rotator_type str
    The rotator type. options: [target/password/key]
    same_password str
    Rotate same password for each host from the Linked Target (relevant only for Linked Target)
    secure_access_allow_external_user bool
    Allow providing external user for a domain users
    secure_access_certificate_issuer str
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secure_access_enable str
    Enable/Disable secure remote access [true/false]
    secure_access_hosts Sequence[str]
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    secure_access_rdp_domain str
    Default domain name server. i.e. microsoft.com
    secure_access_rdp_user str
    Override the RDP Domain username
    secure_access_ssh_user str
    Override the SSH username as indicated in SSH Certificate Issuer
    secure_access_target_type str
    Specify target type. Options are ssh or rdp
    tags Sequence[str]
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    target_name str
    The target name to associate
    authenticationCredentials String
    The credentials to connect with use-self-creds/use-target-creds
    autoRotate String
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    itemCustomFields Map<String>
    Additional custom fields to associate with the item
    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 is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    keyDataBase64 String
    Private key file contents encoded using base64
    maxVersions String
    Set the maximum number of versions, limited by the account settings defaults
    name String
    Secret name
    passwordLength String
    The length of the password to be generated
    publicKeyRemotePath String
    The path to the public key that will be rotated on the server
    rotateAfterDisconnect String
    Rotate the value of the secret after SRA session ends [true/false]
    rotatedPassword String
    rotated-username password (relevant only for rotator-type=password)
    rotatedSecretSshId String
    The ID of this resource.
    rotatedUsername String
    username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password)
    rotationEventIns List<String>
    How many days before the rotation of the item would you like to be notified
    rotationHour Number
    The Hour of the rotation in UTC
    rotationInterval String
    The number of days to wait between every automatic key rotation (1-365)
    rotatorCustomCmd String
    Custom rotation command
    rotatorType String
    The rotator type. options: [target/password/key]
    samePassword String
    Rotate same password for each host from the Linked Target (relevant only for Linked Target)
    secureAccessAllowExternalUser Boolean
    Allow providing external user for a domain users
    secureAccessCertificateIssuer String
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secureAccessEnable String
    Enable/Disable secure remote access [true/false]
    secureAccessHosts List<String>
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    secureAccessRdpDomain String
    Default domain name server. i.e. microsoft.com
    secureAccessRdpUser String
    Override the RDP Domain username
    secureAccessSshUser String
    Override the SSH username as indicated in SSH Certificate Issuer
    secureAccessTargetType String
    Specify target type. Options are ssh or rdp
    tags List<String>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    targetName String
    The target name to associate

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    Viewing docs for akeyless 2.0.1
    published on Monday, Apr 27, 2026 by akeyless-community
    Schema (JSON)
    akeyless-community/terraform-provider-akeyless
      Try Pulumi Cloud free. Your team will thank you.