RabbitMQServerResource

Handle

📦 Aspire.Hosting.RabbitMQ v13.4.0

interface RabbitMQServerResource
  extends IComputeResource,
    IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly connectionStringExpression: ReferenceExpression;
  readonly host: EndpointReferenceExpression;
  readonly managementEndpoint: EndpointReference;
  readonly passwordParameter: ParameterResource;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  readonly uriExpression: ReferenceExpression;
  readonly userNameParameter: ParameterResource;
  readonly userNameReference: ReferenceExpression;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): RabbitMQServerResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): RabbitMQServerResource;
  withManagementPlugin(port?: number): RabbitMQServerResource;
}

12 members

Properties

property connectionStringExpression ReferenceExpression get

Gets the connection string expression for the RabbitMQ server.

property host EndpointReferenceExpression get

Gets the host endpoint reference for this resource.

property managementEndpoint EndpointReference get

Gets the management endpoint for the RabbitMQ server.

property passwordParameter ParameterResource get

Gets the parameter that contains the RabbitMQ server password.

property port EndpointReferenceExpression get

Gets the port endpoint reference for this resource.

property primaryEndpoint EndpointReference get

Gets the primary endpoint for the RabbitMQ server.

property uriExpression ReferenceExpression get

Gets the connection URI expression for the RabbitMQ server.

property userNameParameter ParameterResource get

Gets the parameter that contains the RabbitMQ server user name.

property userNameReference ReferenceExpression get

Gets a reference to the user name for the RabbitMQ server.

Methods

method withDataBindMount builder

Adds a bind mount for the data folder to a RabbitMQ container resource.

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

Parameters

source string

isReadOnly boolean optional = False

Returns

RabbitMQServerResource

method withDataVolume builder

Adds a named volume for the data folder to a RabbitMQ container resource.

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

Parameters

name string optional

isReadOnly boolean optional = False

Returns

RabbitMQServerResource

method withManagementPlugin builder

Enables the RabbitMQ management plugin

withManagementPlugin(port?: number): RabbitMQServerResource

Parameters

port number optional

Returns

RabbitMQServerResource