Class PrivateKey

Inheritance

System.Object

Resource

CustomResource

PrivateKey

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Tls

Assembly: Pulumi.Tls.dll

Syntax

public class PrivateKey : CustomResource

Constructors

PrivateKey(String, PrivateKeyArgs, CustomResourceOptions)

Create a PrivateKey resource with the given unique name, arguments, and options.

Declaration

public PrivateKey(string name, PrivateKeyArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
PrivateKeyArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Algorithm

The name of the algorithm to use for the key. Currently-supported values are "RSA" and "ECDSA".

Declaration

public Output<string> Algorithm { get; }

Property Value

Type	Description
Output<System.String>

EcdsaCurve

When algorithm is "ECDSA", the name of the elliptic curve to use. May be any one of "P224", "P256", "P384" or "P521", with "P224" as the default.

Declaration

public Output<string> EcdsaCurve { get; }

Property Value

Type	Description
Output<System.String>

PrivateKeyPem

The private key data in PEM format.

Declaration

public Output<string> PrivateKeyPem { get; }

Property Value

Type	Description
Output<System.String>

PublicKeyFingerprintMd5

The md5 hash of the public key data in OpenSSH MD5 hash format, e.g. aa:bb:cc:.... Only available if the selected private key format is compatible, as per the rules for public_key_openssh.

Declaration

public Output<string> PublicKeyFingerprintMd5 { get; }

Property Value

Type	Description
Output<System.String>

PublicKeyOpenssh

The public key data in OpenSSH authorized_keys format, if the selected private key format is compatible. All RSA keys are supported, and ECDSA keys with curves "P256", "P384" and "P521" are supported. This attribute is empty if an incompatible ECDSA curve is selected.

Declaration

public Output<string> PublicKeyOpenssh { get; }

Property Value

Type	Description
Output<System.String>

PublicKeyPem

The public key data in PEM format.

Declaration

public Output<string> PublicKeyPem { get; }

Property Value

Type	Description
Output<System.String>

RsaBits

When algorithm is "RSA", the size of the generated RSA key in bits. Defaults to 2048.

Declaration

public Output<int?> RsaBits { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Methods

Get(String, Input<String>, PrivateKeyState, CustomResourceOptions)

Get an existing PrivateKey resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static PrivateKey Get(string name, Input<string> id, PrivateKeyState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
PrivateKeyState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
PrivateKey