1. Packages
  2. TLS
  3. API Docs
  4. PrivateKey
TLS v5.0.0 published on Monday, Dec 4, 2023 by Pulumi

tls.PrivateKey

Explore with Pulumi AI

tls logo
TLS v5.0.0 published on Monday, Dec 4, 2023 by Pulumi

    Create PrivateKey Resource

    new PrivateKey(name: string, args: PrivateKeyArgs, opts?: CustomResourceOptions);
    @overload
    def PrivateKey(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   algorithm: Optional[str] = None,
                   ecdsa_curve: Optional[str] = None,
                   rsa_bits: Optional[int] = None)
    @overload
    def PrivateKey(resource_name: str,
                   args: PrivateKeyArgs,
                   opts: Optional[ResourceOptions] = None)
    func NewPrivateKey(ctx *Context, name string, args PrivateKeyArgs, opts ...ResourceOption) (*PrivateKey, error)
    public PrivateKey(string name, PrivateKeyArgs args, CustomResourceOptions? opts = null)
    public PrivateKey(String name, PrivateKeyArgs args)
    public PrivateKey(String name, PrivateKeyArgs args, CustomResourceOptions options)
    
    type: tls:PrivateKey
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args PrivateKeyArgs
    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 PrivateKeyArgs
    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 PrivateKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateKeyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    PrivateKey Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The PrivateKey resource accepts the following input properties:

    Algorithm string
    Name of the algorithm to use when generating the private key. Currently-supported values are: RSA, ECDSA, ED25519.
    EcdsaCurve string
    When algorithm is ECDSA, the name of the elliptic curve to use. Currently-supported values are: P224, P256, P384, P521. (default: P224).
    RsaBits int
    When algorithm is RSA, the size of the generated RSA key, in bits (default: 2048).
    Algorithm string
    Name of the algorithm to use when generating the private key. Currently-supported values are: RSA, ECDSA, ED25519.
    EcdsaCurve string
    When algorithm is ECDSA, the name of the elliptic curve to use. Currently-supported values are: P224, P256, P384, P521. (default: P224).
    RsaBits int
    When algorithm is RSA, the size of the generated RSA key, in bits (default: 2048).
    algorithm String
    Name of the algorithm to use when generating the private key. Currently-supported values are: RSA, ECDSA, ED25519.
    ecdsaCurve String
    When algorithm is ECDSA, the name of the elliptic curve to use. Currently-supported values are: P224, P256, P384, P521. (default: P224).
    rsaBits Integer
    When algorithm is RSA, the size of the generated RSA key, in bits (default: 2048).
    algorithm string
    Name of the algorithm to use when generating the private key. Currently-supported values are: RSA, ECDSA, ED25519.
    ecdsaCurve string
    When algorithm is ECDSA, the name of the elliptic curve to use. Currently-supported values are: P224, P256, P384, P521. (default: P224).
    rsaBits number
    When algorithm is RSA, the size of the generated RSA key, in bits (default: 2048).
    algorithm str
    Name of the algorithm to use when generating the private key. Currently-supported values are: RSA, ECDSA, ED25519.
    ecdsa_curve str
    When algorithm is ECDSA, the name of the elliptic curve to use. Currently-supported values are: P224, P256, P384, P521. (default: P224).
    rsa_bits int
    When algorithm is RSA, the size of the generated RSA key, in bits (default: 2048).
    algorithm String
    Name of the algorithm to use when generating the private key. Currently-supported values are: RSA, ECDSA, ED25519.
    ecdsaCurve String
    When algorithm is ECDSA, the name of the elliptic curve to use. Currently-supported values are: P224, P256, P384, P521. (default: P224).
    rsaBits Number
    When algorithm is RSA, the size of the generated RSA key, in bits (default: 2048).

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PrivateKey resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateKeyOpenssh string
    Private key data in OpenSSH PEM (RFC 4716) format.
    PrivateKeyPem string
    Private key data in PEM (RFC 1421) format.
    PrivateKeyPemPkcs8 string
    Private key data in PKCS#8 PEM (RFC 5208) format.
    PublicKeyFingerprintMd5 string
    The fingerprint 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, similarly to public_key_openssh and the ECDSA P224 limitations.
    PublicKeyFingerprintSha256 string
    The fingerprint of the public key data in OpenSSH SHA256 hash format, e.g. SHA256:.... Only available if the selected private key format is compatible, similarly to public_key_openssh and the ECDSA P224 limitations.
    PublicKeyOpenssh string
    The public key data in "Authorized Keys".
    PublicKeyPem string
    Public key data in PEM (RFC 1421).
    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateKeyOpenssh string
    Private key data in OpenSSH PEM (RFC 4716) format.
    PrivateKeyPem string
    Private key data in PEM (RFC 1421) format.
    PrivateKeyPemPkcs8 string
    Private key data in PKCS#8 PEM (RFC 5208) format.
    PublicKeyFingerprintMd5 string
    The fingerprint 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, similarly to public_key_openssh and the ECDSA P224 limitations.
    PublicKeyFingerprintSha256 string
    The fingerprint of the public key data in OpenSSH SHA256 hash format, e.g. SHA256:.... Only available if the selected private key format is compatible, similarly to public_key_openssh and the ECDSA P224 limitations.
    PublicKeyOpenssh string
    The public key data in "Authorized Keys".
    PublicKeyPem string
    Public key data in PEM (RFC 1421).
    id String
    The provider-assigned unique ID for this managed resource.
    privateKeyOpenssh String
    Private key data in OpenSSH PEM (RFC 4716) format.
    privateKeyPem String
    Private key data in PEM (RFC 1421) format.
    privateKeyPemPkcs8 String
    Private key data in PKCS#8 PEM (RFC 5208) format.
    publicKeyFingerprintMd5 String
    The fingerprint 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, similarly to public_key_openssh and the ECDSA P224 limitations.
    publicKeyFingerprintSha256 String
    The fingerprint of the public key data in OpenSSH SHA256 hash format, e.g. SHA256:.... Only available if the selected private key format is compatible, similarly to public_key_openssh and the ECDSA P224 limitations.
    publicKeyOpenssh String
    The public key data in "Authorized Keys".
    publicKeyPem String
    Public key data in PEM (RFC 1421).
    id string
    The provider-assigned unique ID for this managed resource.
    privateKeyOpenssh string
    Private key data in OpenSSH PEM (RFC 4716) format.
    privateKeyPem string
    Private key data in PEM (RFC 1421) format.
    privateKeyPemPkcs8 string
    Private key data in PKCS#8 PEM (RFC 5208) format.
    publicKeyFingerprintMd5 string
    The fingerprint 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, similarly to public_key_openssh and the ECDSA P224 limitations.
    publicKeyFingerprintSha256 string
    The fingerprint of the public key data in OpenSSH SHA256 hash format, e.g. SHA256:.... Only available if the selected private key format is compatible, similarly to public_key_openssh and the ECDSA P224 limitations.
    publicKeyOpenssh string
    The public key data in "Authorized Keys".
    publicKeyPem string
    Public key data in PEM (RFC 1421).
    id str
    The provider-assigned unique ID for this managed resource.
    private_key_openssh str
    Private key data in OpenSSH PEM (RFC 4716) format.
    private_key_pem str
    Private key data in PEM (RFC 1421) format.
    private_key_pem_pkcs8 str
    Private key data in PKCS#8 PEM (RFC 5208) format.
    public_key_fingerprint_md5 str
    The fingerprint 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, similarly to public_key_openssh and the ECDSA P224 limitations.
    public_key_fingerprint_sha256 str
    The fingerprint of the public key data in OpenSSH SHA256 hash format, e.g. SHA256:.... Only available if the selected private key format is compatible, similarly to public_key_openssh and the ECDSA P224 limitations.
    public_key_openssh str
    The public key data in "Authorized Keys".
    public_key_pem str
    Public key data in PEM (RFC 1421).
    id String
    The provider-assigned unique ID for this managed resource.
    privateKeyOpenssh String
    Private key data in OpenSSH PEM (RFC 4716) format.
    privateKeyPem String
    Private key data in PEM (RFC 1421) format.
    privateKeyPemPkcs8 String
    Private key data in PKCS#8 PEM (RFC 5208) format.
    publicKeyFingerprintMd5 String
    The fingerprint 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, similarly to public_key_openssh and the ECDSA P224 limitations.
    publicKeyFingerprintSha256 String
    The fingerprint of the public key data in OpenSSH SHA256 hash format, e.g. SHA256:.... Only available if the selected private key format is compatible, similarly to public_key_openssh and the ECDSA P224 limitations.
    publicKeyOpenssh String
    The public key data in "Authorized Keys".
    publicKeyPem String
    Public key data in PEM (RFC 1421).

    Look up Existing PrivateKey Resource

    Get an existing PrivateKey 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?: PrivateKeyState, opts?: CustomResourceOptions): PrivateKey
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            algorithm: Optional[str] = None,
            ecdsa_curve: Optional[str] = None,
            private_key_openssh: Optional[str] = None,
            private_key_pem: Optional[str] = None,
            private_key_pem_pkcs8: Optional[str] = None,
            public_key_fingerprint_md5: Optional[str] = None,
            public_key_fingerprint_sha256: Optional[str] = None,
            public_key_openssh: Optional[str] = None,
            public_key_pem: Optional[str] = None,
            rsa_bits: Optional[int] = None) -> PrivateKey
    func GetPrivateKey(ctx *Context, name string, id IDInput, state *PrivateKeyState, opts ...ResourceOption) (*PrivateKey, error)
    public static PrivateKey Get(string name, Input<string> id, PrivateKeyState? state, CustomResourceOptions? opts = null)
    public static PrivateKey get(String name, Output<String> id, PrivateKeyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Algorithm string
    Name of the algorithm to use when generating the private key. Currently-supported values are: RSA, ECDSA, ED25519.
    EcdsaCurve string
    When algorithm is ECDSA, the name of the elliptic curve to use. Currently-supported values are: P224, P256, P384, P521. (default: P224).
    PrivateKeyOpenssh string
    Private key data in OpenSSH PEM (RFC 4716) format.
    PrivateKeyPem string
    Private key data in PEM (RFC 1421) format.
    PrivateKeyPemPkcs8 string
    Private key data in PKCS#8 PEM (RFC 5208) format.
    PublicKeyFingerprintMd5 string
    The fingerprint 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, similarly to public_key_openssh and the ECDSA P224 limitations.
    PublicKeyFingerprintSha256 string
    The fingerprint of the public key data in OpenSSH SHA256 hash format, e.g. SHA256:.... Only available if the selected private key format is compatible, similarly to public_key_openssh and the ECDSA P224 limitations.
    PublicKeyOpenssh string
    The public key data in "Authorized Keys".
    PublicKeyPem string
    Public key data in PEM (RFC 1421).
    RsaBits int
    When algorithm is RSA, the size of the generated RSA key, in bits (default: 2048).
    Algorithm string
    Name of the algorithm to use when generating the private key. Currently-supported values are: RSA, ECDSA, ED25519.
    EcdsaCurve string
    When algorithm is ECDSA, the name of the elliptic curve to use. Currently-supported values are: P224, P256, P384, P521. (default: P224).
    PrivateKeyOpenssh string
    Private key data in OpenSSH PEM (RFC 4716) format.
    PrivateKeyPem string
    Private key data in PEM (RFC 1421) format.
    PrivateKeyPemPkcs8 string
    Private key data in PKCS#8 PEM (RFC 5208) format.
    PublicKeyFingerprintMd5 string
    The fingerprint 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, similarly to public_key_openssh and the ECDSA P224 limitations.
    PublicKeyFingerprintSha256 string
    The fingerprint of the public key data in OpenSSH SHA256 hash format, e.g. SHA256:.... Only available if the selected private key format is compatible, similarly to public_key_openssh and the ECDSA P224 limitations.
    PublicKeyOpenssh string
    The public key data in "Authorized Keys".
    PublicKeyPem string
    Public key data in PEM (RFC 1421).
    RsaBits int
    When algorithm is RSA, the size of the generated RSA key, in bits (default: 2048).
    algorithm String
    Name of the algorithm to use when generating the private key. Currently-supported values are: RSA, ECDSA, ED25519.
    ecdsaCurve String
    When algorithm is ECDSA, the name of the elliptic curve to use. Currently-supported values are: P224, P256, P384, P521. (default: P224).
    privateKeyOpenssh String
    Private key data in OpenSSH PEM (RFC 4716) format.
    privateKeyPem String
    Private key data in PEM (RFC 1421) format.
    privateKeyPemPkcs8 String
    Private key data in PKCS#8 PEM (RFC 5208) format.
    publicKeyFingerprintMd5 String
    The fingerprint 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, similarly to public_key_openssh and the ECDSA P224 limitations.
    publicKeyFingerprintSha256 String
    The fingerprint of the public key data in OpenSSH SHA256 hash format, e.g. SHA256:.... Only available if the selected private key format is compatible, similarly to public_key_openssh and the ECDSA P224 limitations.
    publicKeyOpenssh String
    The public key data in "Authorized Keys".
    publicKeyPem String
    Public key data in PEM (RFC 1421).
    rsaBits Integer
    When algorithm is RSA, the size of the generated RSA key, in bits (default: 2048).
    algorithm string
    Name of the algorithm to use when generating the private key. Currently-supported values are: RSA, ECDSA, ED25519.
    ecdsaCurve string
    When algorithm is ECDSA, the name of the elliptic curve to use. Currently-supported values are: P224, P256, P384, P521. (default: P224).
    privateKeyOpenssh string
    Private key data in OpenSSH PEM (RFC 4716) format.
    privateKeyPem string
    Private key data in PEM (RFC 1421) format.
    privateKeyPemPkcs8 string
    Private key data in PKCS#8 PEM (RFC 5208) format.
    publicKeyFingerprintMd5 string
    The fingerprint 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, similarly to public_key_openssh and the ECDSA P224 limitations.
    publicKeyFingerprintSha256 string
    The fingerprint of the public key data in OpenSSH SHA256 hash format, e.g. SHA256:.... Only available if the selected private key format is compatible, similarly to public_key_openssh and the ECDSA P224 limitations.
    publicKeyOpenssh string
    The public key data in "Authorized Keys".
    publicKeyPem string
    Public key data in PEM (RFC 1421).
    rsaBits number
    When algorithm is RSA, the size of the generated RSA key, in bits (default: 2048).
    algorithm str
    Name of the algorithm to use when generating the private key. Currently-supported values are: RSA, ECDSA, ED25519.
    ecdsa_curve str
    When algorithm is ECDSA, the name of the elliptic curve to use. Currently-supported values are: P224, P256, P384, P521. (default: P224).
    private_key_openssh str
    Private key data in OpenSSH PEM (RFC 4716) format.
    private_key_pem str
    Private key data in PEM (RFC 1421) format.
    private_key_pem_pkcs8 str
    Private key data in PKCS#8 PEM (RFC 5208) format.
    public_key_fingerprint_md5 str
    The fingerprint 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, similarly to public_key_openssh and the ECDSA P224 limitations.
    public_key_fingerprint_sha256 str
    The fingerprint of the public key data in OpenSSH SHA256 hash format, e.g. SHA256:.... Only available if the selected private key format is compatible, similarly to public_key_openssh and the ECDSA P224 limitations.
    public_key_openssh str
    The public key data in "Authorized Keys".
    public_key_pem str
    Public key data in PEM (RFC 1421).
    rsa_bits int
    When algorithm is RSA, the size of the generated RSA key, in bits (default: 2048).
    algorithm String
    Name of the algorithm to use when generating the private key. Currently-supported values are: RSA, ECDSA, ED25519.
    ecdsaCurve String
    When algorithm is ECDSA, the name of the elliptic curve to use. Currently-supported values are: P224, P256, P384, P521. (default: P224).
    privateKeyOpenssh String
    Private key data in OpenSSH PEM (RFC 4716) format.
    privateKeyPem String
    Private key data in PEM (RFC 1421) format.
    privateKeyPemPkcs8 String
    Private key data in PKCS#8 PEM (RFC 5208) format.
    publicKeyFingerprintMd5 String
    The fingerprint 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, similarly to public_key_openssh and the ECDSA P224 limitations.
    publicKeyFingerprintSha256 String
    The fingerprint of the public key data in OpenSSH SHA256 hash format, e.g. SHA256:.... Only available if the selected private key format is compatible, similarly to public_key_openssh and the ECDSA P224 limitations.
    publicKeyOpenssh String
    The public key data in "Authorized Keys".
    publicKeyPem String
    Public key data in PEM (RFC 1421).
    rsaBits Number
    When algorithm is RSA, the size of the generated RSA key, in bits (default: 2048).

    Package Details

    Repository
    TLS pulumi/pulumi-tls
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the tls Terraform Provider.
    tls logo
    TLS v5.0.0 published on Monday, Dec 4, 2023 by Pulumi