Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Etcd Provider
  3. API Docs
  4. getKey
etcd 0.11.0 published on Sunday, Jul 13, 2025 by ferlab-ste-justine
ferlab-ste-justine/terraform-provider-etcd

etcd.getKey

Explore with Pulumi AI

etcd logo
etcd 0.11.0 published on Sunday, Jul 13, 2025 by ferlab-ste-justine
ferlab-ste-justine/terraform-provider-etcd

    Retrieves information about a key.

    Using getKey

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getKey(args: GetKeyArgs, opts?: InvokeOptions): Promise<GetKeyResult>
function getKeyOutput(args: GetKeyOutputArgs, opts?: InvokeOptions): Output<GetKeyResult>
    def get_key(id: Optional[str] = None,
            key: Optional[str] = None,
            must_exist: Optional[bool] = None,
            opts: Optional[InvokeOptions] = None) -> GetKeyResult
def get_key_output(id: Optional[pulumi.Input[str]] = None,
            key: Optional[pulumi.Input[str]] = None,
            must_exist: Optional[pulumi.Input[bool]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetKeyResult]
    func LookupKey(ctx *Context, args *LookupKeyArgs, opts ...InvokeOption) (*LookupKeyResult, error)
func LookupKeyOutput(ctx *Context, args *LookupKeyOutputArgs, opts ...InvokeOption) LookupKeyResultOutput

    > Note: This function is named LookupKey in the Go SDK.

    public static class GetKey 
{
    public static Task<GetKeyResult> InvokeAsync(GetKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetKeyResult> Invoke(GetKeyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKeyResult> getKey(GetKeyArgs args, InvokeOptions options)
public static Output<GetKeyResult> getKey(GetKeyArgs args, InvokeOptions options)

    fn::invoke:
  function: etcd:index/getKey:getKey
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Key string
    Key to retrieve.
    Id string
    The ID of this resource.
    MustExist bool
    Whether to cause an error if the key is not found.
    Key string
    Key to retrieve.
    Id string
    The ID of this resource.
    MustExist bool
    Whether to cause an error if the key is not found.
    key String
    Key to retrieve.
    id String
    The ID of this resource.
    mustExist Boolean
    Whether to cause an error if the key is not found.
    key string
    Key to retrieve.
    id string
    The ID of this resource.
    mustExist boolean
    Whether to cause an error if the key is not found.
    key str
    Key to retrieve.
    id str
    The ID of this resource.
    must_exist bool
    Whether to cause an error if the key is not found.
    key String
    Key to retrieve.
    id String
    The ID of this resource.
    mustExist Boolean
    Whether to cause an error if the key is not found.

    getKey Result

    The following output properties are available:

    CreateRevision double
    Revision of the etcd keystore when the key was created
    Found bool
    Whether the key was found.
    Id string
    The ID of this resource.
    Key string
    Key to retrieve.
    Lease double
    Id of the lease that the key is attached to. Will be 0 if the key is not attached to a lease.
    ModRevision double
    Revision of the etcd keystore when the key was last modified
    Value string
    Value of the key.
    Version double
    Current version of the key. Note that version is reset to 0 on deletion
    MustExist bool
    Whether to cause an error if the key is not found.
    CreateRevision float64
    Revision of the etcd keystore when the key was created
    Found bool
    Whether the key was found.
    Id string
    The ID of this resource.
    Key string
    Key to retrieve.
    Lease float64
    Id of the lease that the key is attached to. Will be 0 if the key is not attached to a lease.
    ModRevision float64
    Revision of the etcd keystore when the key was last modified
    Value string
    Value of the key.
    Version float64
    Current version of the key. Note that version is reset to 0 on deletion
    MustExist bool
    Whether to cause an error if the key is not found.
    createRevision Double
    Revision of the etcd keystore when the key was created
    found Boolean
    Whether the key was found.
    id String
    The ID of this resource.
    key String
    Key to retrieve.
    lease Double
    Id of the lease that the key is attached to. Will be 0 if the key is not attached to a lease.
    modRevision Double
    Revision of the etcd keystore when the key was last modified
    value String
    Value of the key.
    version Double
    Current version of the key. Note that version is reset to 0 on deletion
    mustExist Boolean
    Whether to cause an error if the key is not found.
    createRevision number
    Revision of the etcd keystore when the key was created
    found boolean
    Whether the key was found.
    id string
    The ID of this resource.
    key string
    Key to retrieve.
    lease number
    Id of the lease that the key is attached to. Will be 0 if the key is not attached to a lease.
    modRevision number
    Revision of the etcd keystore when the key was last modified
    value string
    Value of the key.
    version number
    Current version of the key. Note that version is reset to 0 on deletion
    mustExist boolean
    Whether to cause an error if the key is not found.
    create_revision float
    Revision of the etcd keystore when the key was created
    found bool
    Whether the key was found.
    id str
    The ID of this resource.
    key str
    Key to retrieve.
    lease float
    Id of the lease that the key is attached to. Will be 0 if the key is not attached to a lease.
    mod_revision float
    Revision of the etcd keystore when the key was last modified
    value str
    Value of the key.
    version float
    Current version of the key. Note that version is reset to 0 on deletion
    must_exist bool
    Whether to cause an error if the key is not found.
    createRevision Number
    Revision of the etcd keystore when the key was created
    found Boolean
    Whether the key was found.
    id String
    The ID of this resource.
    key String
    Key to retrieve.
    lease Number
    Id of the lease that the key is attached to. Will be 0 if the key is not attached to a lease.
    modRevision Number
    Revision of the etcd keystore when the key was last modified
    value String
    Value of the key.
    version Number
    Current version of the key. Note that version is reset to 0 on deletion
    mustExist Boolean
    Whether to cause an error if the key is not found.

    Package Details

    Repository
    etcd ferlab-ste-justine/terraform-provider-etcd
    License
    Notes
    This Pulumi package is based on the etcd Terraform Provider.
    etcd logo
    etcd 0.11.0 published on Sunday, Jul 13, 2025 by ferlab-ste-justine
    ferlab-ste-justine/terraform-provider-etcd