1. Packages
  2. Etcd Provider
  3. API Docs
  4. getKeyRange
etcd 0.10.0 published on Tuesday, Apr 15, 2025 by ferlab-ste-justine

etcd.getKeyRange

Explore with Pulumi AI

etcd logo
etcd 0.10.0 published on Tuesday, Apr 15, 2025 by ferlab-ste-justine

    Retrieves information about the keys contained in a given range.

    Using getKeyRange

    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 getKeyRange(args: GetKeyRangeArgs, opts?: InvokeOptions): Promise<GetKeyRangeResult>
    function getKeyRangeOutput(args: GetKeyRangeOutputArgs, opts?: InvokeOptions): Output<GetKeyRangeResult>
    def get_key_range(id: Optional[str] = None,
                      key: Optional[str] = None,
                      range_end: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetKeyRangeResult
    def get_key_range_output(id: Optional[pulumi.Input[str]] = None,
                      key: Optional[pulumi.Input[str]] = None,
                      range_end: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetKeyRangeResult]
    func LookupKeyRange(ctx *Context, args *LookupKeyRangeArgs, opts ...InvokeOption) (*LookupKeyRangeResult, error)
    func LookupKeyRangeOutput(ctx *Context, args *LookupKeyRangeOutputArgs, opts ...InvokeOption) LookupKeyRangeResultOutput

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

    public static class GetKeyRange 
    {
        public static Task<GetKeyRangeResult> InvokeAsync(GetKeyRangeArgs args, InvokeOptions? opts = null)
        public static Output<GetKeyRangeResult> Invoke(GetKeyRangeInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetKeyRangeResult> getKeyRange(GetKeyRangeArgs args, InvokeOptions options)
    public static Output<GetKeyRangeResult> getKeyRange(GetKeyRangeArgs args, InvokeOptions options)
    
    fn::invoke:
      function: etcd:index/getKeyRange:getKeyRange
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Key string
    Key specifying the beginning of the key range.
    RangeEnd string
    Key specifying the end of the key range (exclusive). To you set it to the value of the key scopes the range to a single key. If you would like the range to be anything prefixed by the key, you can use the etcdprefixrange_end data helper.
    Id string
    The ID of this resource.
    Key string
    Key specifying the beginning of the key range.
    RangeEnd string
    Key specifying the end of the key range (exclusive). To you set it to the value of the key scopes the range to a single key. If you would like the range to be anything prefixed by the key, you can use the etcdprefixrange_end data helper.
    Id string
    The ID of this resource.
    key String
    Key specifying the beginning of the key range.
    rangeEnd String
    Key specifying the end of the key range (exclusive). To you set it to the value of the key scopes the range to a single key. If you would like the range to be anything prefixed by the key, you can use the etcdprefixrange_end data helper.
    id String
    The ID of this resource.
    key string
    Key specifying the beginning of the key range.
    rangeEnd string
    Key specifying the end of the key range (exclusive). To you set it to the value of the key scopes the range to a single key. If you would like the range to be anything prefixed by the key, you can use the etcdprefixrange_end data helper.
    id string
    The ID of this resource.
    key str
    Key specifying the beginning of the key range.
    range_end str
    Key specifying the end of the key range (exclusive). To you set it to the value of the key scopes the range to a single key. If you would like the range to be anything prefixed by the key, you can use the etcdprefixrange_end data helper.
    id str
    The ID of this resource.
    key String
    Key specifying the beginning of the key range.
    rangeEnd String
    Key specifying the end of the key range (exclusive). To you set it to the value of the key scopes the range to a single key. If you would like the range to be anything prefixed by the key, you can use the etcdprefixrange_end data helper.
    id String
    The ID of this resource.

    getKeyRange Result

    The following output properties are available:

    Id string
    The ID of this resource.
    Key string
    Key specifying the beginning of the key range.
    RangeEnd string
    Key specifying the end of the key range (exclusive). To you set it to the value of the key scopes the range to a single key. If you would like the range to be anything prefixed by the key, you can use the etcdprefixrange_end data helper.
    Results List<GetKeyRangeResult>
    List of keys that were read. Note that numerical values returned by etcd are in int64 format which might cause problems in int32 platforms.
    Id string
    The ID of this resource.
    Key string
    Key specifying the beginning of the key range.
    RangeEnd string
    Key specifying the end of the key range (exclusive). To you set it to the value of the key scopes the range to a single key. If you would like the range to be anything prefixed by the key, you can use the etcdprefixrange_end data helper.
    Results []GetKeyRangeResult
    List of keys that were read. Note that numerical values returned by etcd are in int64 format which might cause problems in int32 platforms.
    id String
    The ID of this resource.
    key String
    Key specifying the beginning of the key range.
    rangeEnd String
    Key specifying the end of the key range (exclusive). To you set it to the value of the key scopes the range to a single key. If you would like the range to be anything prefixed by the key, you can use the etcdprefixrange_end data helper.
    results List<GetKeyRangeResult>
    List of keys that were read. Note that numerical values returned by etcd are in int64 format which might cause problems in int32 platforms.
    id string
    The ID of this resource.
    key string
    Key specifying the beginning of the key range.
    rangeEnd string
    Key specifying the end of the key range (exclusive). To you set it to the value of the key scopes the range to a single key. If you would like the range to be anything prefixed by the key, you can use the etcdprefixrange_end data helper.
    results GetKeyRangeResult[]
    List of keys that were read. Note that numerical values returned by etcd are in int64 format which might cause problems in int32 platforms.
    id str
    The ID of this resource.
    key str
    Key specifying the beginning of the key range.
    range_end str
    Key specifying the end of the key range (exclusive). To you set it to the value of the key scopes the range to a single key. If you would like the range to be anything prefixed by the key, you can use the etcdprefixrange_end data helper.
    results Sequence[GetKeyRangeResult]
    List of keys that were read. Note that numerical values returned by etcd are in int64 format which might cause problems in int32 platforms.
    id String
    The ID of this resource.
    key String
    Key specifying the beginning of the key range.
    rangeEnd String
    Key specifying the end of the key range (exclusive). To you set it to the value of the key scopes the range to a single key. If you would like the range to be anything prefixed by the key, you can use the etcdprefixrange_end data helper.
    results List<Property Map>
    List of keys that were read. Note that numerical values returned by etcd are in int64 format which might cause problems in int32 platforms.

    Supporting Types

    GetKeyRangeResult

    CreateRevision double
    Key string
    Lease double
    ModRevision double
    Value string
    Version double
    CreateRevision float64
    Key string
    Lease float64
    ModRevision float64
    Value string
    Version float64
    createRevision Double
    key String
    lease Double
    modRevision Double
    value String
    version Double
    createRevision number
    key string
    lease number
    modRevision number
    value string
    version number
    create_revision float
    key str
    lease float
    mod_revision float
    value str
    version float
    createRevision Number
    key String
    lease Number
    modRevision Number
    value String
    version Number

    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.10.0 published on Tuesday, Apr 15, 2025 by ferlab-ste-justine