Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Akeyless Provider
  3. API Docs
  4. TargetSsh
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
akeyless-community/terraform-provider-akeyless

akeyless.TargetSsh

Explore with Pulumi AI

akeyless logo
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
akeyless-community/terraform-provider-akeyless

    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,
              key: Optional[str] = None,
              name: Optional[str] = None,
              port: Optional[str] = None,
              private_key: Optional[str] = None,
              private_key_password: Optional[str] = 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.

    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",
    Key = "string",
    Name = "string",
    Port = "string",
    PrivateKey = "string",
    PrivateKeyPassword = "string",
    SshPassword = "string",
    SshUsername = "string",
    TargetSshId = "string",
});

    example, err := akeyless.NewTargetSsh(ctx, "targetSshResource", &akeyless.TargetSshArgs{
	Description:        pulumi.String("string"),
	Host:               pulumi.String("string"),
	Key:                pulumi.String("string"),
	Name:               pulumi.String("string"),
	Port:               pulumi.String("string"),
	PrivateKey:         pulumi.String("string"),
	PrivateKeyPassword: pulumi.String("string"),
	SshPassword:        pulumi.String("string"),
	SshUsername:        pulumi.String("string"),
	TargetSshId:        pulumi.String("string"),
})

    var targetSshResource = new TargetSsh("targetSshResource", TargetSshArgs.builder()
    .description("string")
    .host("string")
    .key("string")
    .name("string")
    .port("string")
    .privateKey("string")
    .privateKeyPassword("string")
    .sshPassword("string")
    .sshUsername("string")
    .targetSshId("string")
    .build());

    target_ssh_resource = akeyless.TargetSsh("targetSshResource",
    description="string",
    host="string",
    key="string",
    name="string",
    port="string",
    private_key="string",
    private_key_password="string",
    ssh_password="string",
    ssh_username="string",
    target_ssh_id="string")

    const targetSshResource = new akeyless.TargetSsh("targetSshResource", {
    description: "string",
    host: "string",
    key: "string",
    name: "string",
    port: "string",
    privateKey: "string",
    privateKeyPassword: "string",
    sshPassword: "string",
    sshUsername: "string",
    targetSshId: "string",
});

    type: akeyless:TargetSsh
properties:
    description: string
    host: string
    key: string
    name: string
    port: string
    privateKey: string
    privateKeyPassword: string
    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
    Key string
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    Name string
    Target name
    Port string
    SSH port
    PrivateKey string
    SSH private key
    PrivateKeyPassword string
    SSH private key password
    SshPassword string
    SSH password to rotate
    SshUsername string
    SSH username
    TargetSshId string
    The ID of this resource.
    Description string
    Description of the object
    Host string
    SSH host name
    Key string
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    Name string
    Target name
    Port string
    SSH port
    PrivateKey string
    SSH private key
    PrivateKeyPassword string
    SSH private key password
    SshPassword string
    SSH password to rotate
    SshUsername string
    SSH username
    TargetSshId string
    The ID of this resource.
    description String
    Description of the object
    host String
    SSH host name
    key String
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    name String
    Target name
    port String
    SSH port
    privateKey String
    SSH private key
    privateKeyPassword String
    SSH private key password
    sshPassword String
    SSH password to rotate
    sshUsername String
    SSH username
    targetSshId String
    The ID of this resource.
    description string
    Description of the object
    host string
    SSH host name
    key string
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    name string
    Target name
    port string
    SSH port
    privateKey string
    SSH private key
    privateKeyPassword string
    SSH private key password
    sshPassword string
    SSH password to rotate
    sshUsername string
    SSH username
    targetSshId string
    The ID of this resource.
    description str
    Description of the object
    host str
    SSH host name
    key str
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    name str
    Target name
    port str
    SSH port
    private_key str
    SSH private key
    private_key_password str
    SSH private key password
    ssh_password str
    SSH password to rotate
    ssh_username str
    SSH username
    target_ssh_id str
    The ID of this resource.
    description String
    Description of the object
    host String
    SSH host name
    key String
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    name String
    Target name
    port String
    SSH port
    privateKey String
    SSH private key
    privateKeyPassword String
    SSH private key password
    sshPassword String
    SSH password to rotate
    sshUsername String
    SSH username
    targetSshId String
    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 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,
        key: Optional[str] = None,
        name: Optional[str] = None,
        port: Optional[str] = None,
        private_key: Optional[str] = None,
        private_key_password: Optional[str] = None,
        ssh_password: Optional[str] = None,
        ssh_username: Optional[str] = None,
        target_ssh_id: Optional[str] = None) -> TargetSsh
    func 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:  _:    type: akeyless:TargetSsh    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:
    Description string
    Description of the object
    Host string
    SSH host name
    Key string
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    Name string
    Target name
    Port string
    SSH port
    PrivateKey string
    SSH private key
    PrivateKeyPassword string
    SSH private key password
    SshPassword string
    SSH password to rotate
    SshUsername string
    SSH username
    TargetSshId string
    The ID of this resource.
    Description string
    Description of the object
    Host string
    SSH host name
    Key string
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    Name string
    Target name
    Port string
    SSH port
    PrivateKey string
    SSH private key
    PrivateKeyPassword string
    SSH private key password
    SshPassword string
    SSH password to rotate
    SshUsername string
    SSH username
    TargetSshId string
    The ID of this resource.
    description String
    Description of the object
    host String
    SSH host name
    key String
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    name String
    Target name
    port String
    SSH port
    privateKey String
    SSH private key
    privateKeyPassword String
    SSH private key password
    sshPassword String
    SSH password to rotate
    sshUsername String
    SSH username
    targetSshId String
    The ID of this resource.
    description string
    Description of the object
    host string
    SSH host name
    key string
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    name string
    Target name
    port string
    SSH port
    privateKey string
    SSH private key
    privateKeyPassword string
    SSH private key password
    sshPassword string
    SSH password to rotate
    sshUsername string
    SSH username
    targetSshId string
    The ID of this resource.
    description str
    Description of the object
    host str
    SSH host name
    key str
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    name str
    Target name
    port str
    SSH port
    private_key str
    SSH private key
    private_key_password str
    SSH private key password
    ssh_password str
    SSH password to rotate
    ssh_username str
    SSH username
    target_ssh_id str
    The ID of this resource.
    description String
    Description of the object
    host String
    SSH host name
    key String
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    name String
    Target name
    port String
    SSH port
    privateKey String
    SSH private key
    privateKeyPassword String
    SSH private key password
    sshPassword String
    SSH password to rotate
    sshUsername String
    SSH username
    targetSshId String
    The ID of this resource.

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless logo
    akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
    akeyless-community/terraform-provider-akeyless