ssh

Documentation

Index

• type Connection
  • func (val *Connection) Defaults() *Connection
• type ConnectionArgs
  • func (val *ConnectionArgs) Defaults() *ConnectionArgs
  • func (ConnectionArgs) ElementType() reflect.Type
  • func (i ConnectionArgs) ToConnectionOutput() ConnectionOutput
  • func (i ConnectionArgs) ToConnectionOutputWithContext(ctx context.Context) ConnectionOutput
• type ConnectionInput
• type ConnectionOutput
  • func (o ConnectionOutput) AgentSocketPath() pulumi.StringPtrOutput
  • func (o ConnectionOutput) DialErrorLimit() pulumi.IntPtrOutput
  • func (ConnectionOutput) ElementType() reflect.Type
  • func (o ConnectionOutput) Host() pulumi.StringOutput
  • func (o ConnectionOutput) Password() pulumi.StringPtrOutput
  • func (o ConnectionOutput) PerDialTimeout() pulumi.IntPtrOutput
  • func (o ConnectionOutput) Port() pulumi.Float64PtrOutput
  • func (o ConnectionOutput) PrivateKey() pulumi.StringPtrOutput
  • func (o ConnectionOutput) PrivateKeyPassword() pulumi.StringPtrOutput
  • func (o ConnectionOutput) ToConnectionOutput() ConnectionOutput
  • func (o ConnectionOutput) ToConnectionOutputWithContext(ctx context.Context) ConnectionOutput
  • func (o ConnectionOutput) User() pulumi.StringPtrOutput

Types

type Connection

type Connection struct {
	// SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
	AgentSocketPath *string `pulumi:"agentSocketPath"`
	// Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 1000.
	DialErrorLimit *int `pulumi:"dialErrorLimit"`
	// The address of the resource to connect to.
	Host string `pulumi:"host"`
	// The password we should use for the connection.
	Password *string `pulumi:"password"`
	// Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.
	PerDialTimeout *int `pulumi:"perDialTimeout"`
	// The port to connect to. Defaults to 22.
	Port *float64 `pulumi:"port"`
	// The contents of an SSH key to use for the connection. This takes preference over the password if provided.
	PrivateKey *string `pulumi:"privateKey"`
	// The password to use in case the private key is encrypted.
	PrivateKeyPassword *string `pulumi:"privateKeyPassword"`
	// The user that we should use for the connection.
	User *string `pulumi:"user"`
}

Instructions for how to connect to a remote endpoint.

func (*Connection) Defaults

func (val *Connection) Defaults() *Connection

Defaults sets the appropriate defaults for Connection

type ConnectionArgs

type ConnectionArgs struct {
	// SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
	AgentSocketPath pulumi.StringPtrInput `pulumi:"agentSocketPath"`
	// Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 1000.
	DialErrorLimit pulumi.IntPtrInput `pulumi:"dialErrorLimit"`
	// The address of the resource to connect to.
	Host pulumi.StringInput `pulumi:"host"`
	// The password we should use for the connection.
	Password pulumi.StringPtrInput `pulumi:"password"`
	// Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.
	PerDialTimeout pulumi.IntPtrInput `pulumi:"perDialTimeout"`
	// The port to connect to. Defaults to 22.
	Port pulumi.Float64PtrInput `pulumi:"port"`
	// The contents of an SSH key to use for the connection. This takes preference over the password if provided.
	PrivateKey pulumi.StringPtrInput `pulumi:"privateKey"`
	// The password to use in case the private key is encrypted.
	PrivateKeyPassword pulumi.StringPtrInput `pulumi:"privateKeyPassword"`
	// The user that we should use for the connection.
	User pulumi.StringPtrInput `pulumi:"user"`
}

Instructions for how to connect to a remote endpoint.

func (*ConnectionArgs) Defaults

func (val *ConnectionArgs) Defaults() *ConnectionArgs

Defaults sets the appropriate defaults for ConnectionArgs

func (ConnectionArgs) ElementType

func (ConnectionArgs) ElementType() reflect.Type

func (ConnectionArgs) ToConnectionOutput

func (i ConnectionArgs) ToConnectionOutput() ConnectionOutput

func (ConnectionArgs) ToConnectionOutputWithContext

func (i ConnectionArgs) ToConnectionOutputWithContext(ctx context.Context) ConnectionOutput

type ConnectionInput

type ConnectionInput interface {
	pulumi.Input

	ToConnectionOutput() ConnectionOutput
	ToConnectionOutputWithContext(context.Context) ConnectionOutput
}

ConnectionInput is an input type that accepts ConnectionArgs and ConnectionOutput values. You can construct a concrete instance of `ConnectionInput` via:

ConnectionArgs{...}

type ConnectionOutput

type ConnectionOutput struct{ *pulumi.OutputState }

Instructions for how to connect to a remote endpoint.

func (ConnectionOutput) AgentSocketPath

func (o ConnectionOutput) AgentSocketPath() pulumi.StringPtrOutput

SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.

func (ConnectionOutput) DialErrorLimit

func (o ConnectionOutput) DialErrorLimit() pulumi.IntPtrOutput

Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 1000.

func (ConnectionOutput) ElementType

func (ConnectionOutput) ElementType() reflect.Type

func (ConnectionOutput) Host

func (o ConnectionOutput) Host() pulumi.StringOutput

The address of the resource to connect to.

func (ConnectionOutput) Password

func (o ConnectionOutput) Password() pulumi.StringPtrOutput

The password we should use for the connection.

func (ConnectionOutput) PerDialTimeout

func (o ConnectionOutput) PerDialTimeout() pulumi.IntPtrOutput

Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.

func (ConnectionOutput) Port

func (o ConnectionOutput) Port() pulumi.Float64PtrOutput

The port to connect to. Defaults to 22.

func (ConnectionOutput) PrivateKey

func (o ConnectionOutput) PrivateKey() pulumi.StringPtrOutput

The contents of an SSH key to use for the connection. This takes preference over the password if provided.

func (ConnectionOutput) PrivateKeyPassword

func (o ConnectionOutput) PrivateKeyPassword() pulumi.StringPtrOutput

The password to use in case the private key is encrypted.

func (ConnectionOutput) ToConnectionOutput

func (o ConnectionOutput) ToConnectionOutput() ConnectionOutput

func (ConnectionOutput) ToConnectionOutputWithContext

func (o ConnectionOutput) ToConnectionOutputWithContext(ctx context.Context) ConnectionOutput

func (ConnectionOutput) User

func (o ConnectionOutput) User() pulumi.StringPtrOutput

The user that we should use for the connection.