ValkeyResource

Docs / Reference / TypeScript APIs / Aspire.Hosting.Valkey / ValkeyResource

ValkeyResource

Docs Reference TypeScript APIs Aspire.Hosting.Valkey ValkeyResource

Handle TypeScript

📦 Aspire.Hosting.Valkey v13.2.0-preview.1.26159.1

interface ValkeyResource
  extends IComputeResource,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly connectionStringExpression: ReferenceExpression;
  entrypoint: string;
  readonly host: EndpointReferenceExpression;
  readonly name: string;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  shellExecution: boolean;
  readonly uriExpression: ReferenceExpression;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): ValkeyResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): ValkeyResource;
  withPersistence(
      interval?: timespan,
      keysChangedThreshold?: number): ValkeyResource;
}

Implements

• IComputeResource
• IManifestExpressionProvider
• IResource
• IResourceWithArgs
• IResourceWithConnectionString
• IResourceWithEndpoints
• IResourceWithEnvironment
• IResourceWithProbes
• IResourceWithWaitSupport
• IValueProvider
• IValueWithReferences

Search members of ValkeyResource…

method property

13 members Clear filters

Properties

property connectionStringExpression ReferenceExpression get

Gets the ConnectionStringExpression property

property entrypoint string get · set

Gets the Entrypoint property

property host EndpointReferenceExpression get

Gets the Host property

property name string get

Gets the Name property

property port EndpointReferenceExpression get

Gets the Port property

property primaryEndpoint EndpointReference get

Gets the PrimaryEndpoint property

property shellExecution boolean get · set

Gets the ShellExecution property

property uriExpression ReferenceExpression get

Gets the UriExpression property

Methods

method withDataBindMount builder

Adds a data bind mount for Valkey and enables persistence

withDataBindMount(
    source: string,
    isReadOnly?: boolean): ValkeyResource

Parameters

source string

isReadOnly boolean optional = False

Returns

ValkeyResource

method withDataVolume builder

Adds a data volume for Valkey and enables persistence

withDataVolume(
    name?: string,
    isReadOnly?: boolean): ValkeyResource

Parameters

name string optional

isReadOnly boolean optional = False

Returns

ValkeyResource

method withPersistence builder

Configures Valkey persistence

withPersistence(
    interval?: timespan,
    keysChangedThreshold?: number): ValkeyResource

Parameters

interval timespan optional

keysChangedThreshold number optional = 1

Returns

ValkeyResource