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

propertyconnectionStringExpressionReferenceExpressionget

Gets the connection string expression for the RabbitMQ server.

propertyhostEndpointReferenceExpressionget

Gets the host endpoint reference for this resource.

propertymanagementEndpointEndpointReferenceget

Gets the management endpoint for the RabbitMQ server.

propertypasswordParameterParameterResourceget

Gets the parameter that contains the RabbitMQ server password.

propertyportEndpointReferenceExpressionget

Gets the port endpoint reference for this resource.

propertyprimaryEndpointEndpointReferenceget

Gets the primary endpoint for the RabbitMQ server.

propertyuriExpressionReferenceExpressionget

Gets the connection URI expression for the RabbitMQ server.

propertyuserNameParameterParameterResourceget

Gets the parameter that contains the RabbitMQ server user name.

propertyuserNameReferenceReferenceExpressionget

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

Methods

methodwithDataBindMountbuilder

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

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

Parameters

sourcestring

isReadOnlybooleanoptional= False

Returns

RabbitMQServerResource

methodwithDataVolumebuilder

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

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

Parameters

namestringoptional

isReadOnlybooleanoptional= False

Returns

RabbitMQServerResource

methodwithManagementPluginbuilder

Enables the RabbitMQ management plugin

withManagementPlugin(port?: number): RabbitMQServerResource

Parameters

portnumberoptional

Returns

RabbitMQServerResource