RedisResource

Handle

📦 Aspire.Hosting.Redis v13.6.0

interface RedisResource
  extends IComputeResource,
    IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly connectionStringExpression: ReferenceExpression;
  readonly host: EndpointReferenceExpression;
  passwordParameter: ParameterResource;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  readonly tlsEnabled: boolean;
  readonly uriExpression: ReferenceExpression;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): RedisResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): RedisResource;
  withHostPort(port: number): RedisResource;
  withModule(path: string): RedisResource;
  withPassword(password: ParameterResource): RedisResource;
  withPersistence(
      interval?: timespan,
      keysChangedThreshold?: number): RedisResource;
  withRedisCommander(configureContainer?: (obj: RedisCommanderResource) => Promise<void>, containerName?: string): RedisResource;
  withRedisInsight(configureContainer?: (obj: RedisInsightResource) => Promise<void>, containerName?: string): RedisResource;
  withRepl(): RedisResource;
}

17 members

Properties

propertyconnectionStringExpressionReferenceExpressionget

Gets the connection string expression for the Redis server.

propertyhostEndpointReferenceExpressionget

Gets the host endpoint reference for this resource.

propertypasswordParameterParameterResourceget · set

Gets the parameter that contains the Redis server password.

propertyportEndpointReferenceExpressionget

Gets the port endpoint reference for this resource.

propertyprimaryEndpointEndpointReferenceget

Gets the primary endpoint for the Redis server.

propertytlsEnabledbooleanget

Indicates whether TLS is enabled for the Redis server.

propertyuriExpressionReferenceExpressionget

Gets the connection URI expression for the Redis server.

Methods

methodwithDataBindMountbuilder

Adds a bind mount for the data folder to a Redis container resource and enables Redis persistence.

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

Parameters

sourcestring

isReadOnlybooleanoptional= False

Returns

RedisResource

methodwithDataVolumebuilder

Adds a named volume for the data folder to a Redis container resource and enables Redis persistence.

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

Parameters

namestringoptional

isReadOnlybooleanoptional= False

Returns

RedisResource

methodwithHostPortbuilder

Configures the host port that the Redis resource is exposed on instead of using randomly assigned port.

withHostPort(port: number): RedisResource

Parameters

portnumber

Returns

RedisResource

methodwithModulebuilder

Configures the Redis resource to use the specified Redis module by providing its path inside the container.

withModule(path: string): RedisResource

Parameters

pathstring

Returns

RedisResource

methodwithPasswordbuilder

Configures the password that the Redis resource is used.

withPassword(password: ParameterResource): RedisResource

Parameters

passwordParameterResource

Returns

RedisResource

methodwithPersistencebuilder

Configures a Redis container resource for persistence.

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

Parameters

intervaltimespanoptional

keysChangedThresholdnumberoptional= 1

Returns

RedisResource

methodwithRedisCommanderbuilder

Adds Redis Commander management UI

withRedisCommander(configureContainer?: (obj: RedisCommanderResource) => Promise<void>, containerName?: string): RedisResource

Parameters

configureContainer(obj: RedisCommanderResource) => Promise<void>optional

containerNamestringoptional

Returns

RedisResource

methodwithRedisInsightbuilder

Adds Redis Insight management UI

withRedisInsight(configureContainer?: (obj: RedisInsightResource) => Promise<void>, containerName?: string): RedisResource

Parameters

configureContainer(obj: RedisInsightResource) => Promise<void>optional

containerNamestringoptional

Returns

RedisResource

methodwithReplbuilder

Adds a REPL command that opens an authenticated Redis shell in the dashboard terminal dock.

withRepl(): RedisResource

Returns

RedisResource