NatsServerResource

Docs / Reference / TypeScript APIs / Aspire.Hosting.Nats / NatsServerResource

NatsServerResource

Docs Reference TypeScript APIs Aspire.Hosting.Nats NatsServerResource

Handle TypeScript

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

interface NatsServerResource
  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;
  readonly userNameReference: ReferenceExpression;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): NatsServerResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): NatsServerResource;
  withJetStream(): NatsServerResource;
}

Implements

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

Search members of NatsServerResource…

method property

14 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

property userNameReference ReferenceExpression get

Gets the UserNameReference property

Methods

method withDataBindMount builder

Mounts a host directory as the NATS data directory.

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

Parameters

source string

isReadOnly boolean optional = False

Returns

NatsServerResource

method withDataVolume builder

Adds a persistent data volume to the NATS resource.

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

Parameters

name string optional

isReadOnly boolean optional = False

Returns

NatsServerResource

method withJetStream builder

Configures the NATS resource to enable JetStream.

withJetStream(): NatsServerResource

Returns

NatsServerResource