PrimaryEndpoint EndpointReference getPrimaryEndpoint() EndpointReferenceAPI references are intentionally omitted from this search. To find API references, please search these dedicated API pages instead:
A resource that represents a Valkey resource independent of the hosting model.
type ValkeyResource interface { ExpressionValue IComputeResource Resource ResourceWithArgs ResourceWithConnectionString ResourceWithEndpoints ResourceWithEnvironment ResourceWithWaitSupport}ConnectionStringExpression *ReferenceExpression getConnectionStringExpression() *ReferenceExpressionHostEndpointReferenceExpression getHost() EndpointReferenceExpressionPasswordParameter ParameterResource getPasswordParameter() ParameterResourcePortEndpointReferenceExpression getPort() EndpointReferenceExpressionPrimaryEndpoint EndpointReference getPrimaryEndpoint() EndpointReferenceResourceTypeDisplayName stringgetResourceTypeDisplayName() (string, error)UriExpression *ReferenceExpression getUriExpression() *ReferenceExpressionWithDataBindMount( source string, options ...*WithDataBindMountOptions,) ValkeyResourceParameters
sourcestringThe source directory on the host to mount into the container.options...*WithDataBindMountOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithDataBindMountOptions argument.
IsReadOnly *boolA flag that indicates if this is a read-only mount. Setting this to true will disable Valkey persistence. Defaults to false.Returns
ValkeyResource The resource builder.
Returns a handle; failures surface later via Err().
WithDataVolume(options ...*WithDataVolumeOptions) ValkeyResourceParameters
options...*WithDataVolumeOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithDataVolumeOptions argument.
Name*stringThe name of the volume. Defaults to an auto-generated name based on the application and resource names.IsReadOnly *boolA flag that indicates if this is a read-only volume. Setting this to true will disable Valkey persistence. Defaults to false.Returns
ValkeyResource The resource builder.
Returns a handle; failures surface later via Err().
WithPersistence(options ...*WithPersistenceOptions) ValkeyResourceParameters
options...*WithPersistenceOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*WithPersistenceOptions argument.
Interval*float64The interval between snapshot exports. Defaults to 60 seconds.KeysChangedThreshold *float64The number of key change operations required to trigger a snapshot at the interval. Defaults to 1.Returns
ValkeyResource The resource builder.
Returns a handle; failures surface later via Err().
WithRepl() ValkeyResourceReturns
ValkeyResource The resource builder for chaining.
Returns a handle; failures surface later via Err().