Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

RabbitMQServerResource

Handle
📦 Aspire.Hosting.RabbitMQ v17.0.0

A resource that represents a RabbitMQ resource.

type RabbitMQServerResource interface {
ExpressionValue
IComputeResource
Resource
ResourceWithArgs
ResourceWithConnectionString
ResourceWithEndpoints
ResourceWithEnvironment
ResourceWithWaitSupport
}

Properties

propertyConnectionStringExpression*ReferenceExpressionget
Gets the connection string expression for the RabbitMQ server.
ConnectionStringExpression() *ReferenceExpression
propertyHostEndpointReferenceExpressionget
Gets the host endpoint reference for this resource.
Host() EndpointReferenceExpression
propertyManagementEndpointEndpointReferenceget
Gets the management endpoint for the RabbitMQ server.
ManagementEndpoint() EndpointReference
propertyPasswordParameterParameterResourceget
Gets the parameter that contains the RabbitMQ server password.
PasswordParameter() ParameterResource
propertyPortEndpointReferenceExpressionget
Gets the port endpoint reference for this resource.
Port() EndpointReferenceExpression
propertyPrimaryEndpointEndpointReferenceget
Gets the primary endpoint for the RabbitMQ server.
PrimaryEndpoint() EndpointReference
propertyResourceTypeDisplayNamestringget
Gets the ResourceTypeDisplayName property
ResourceTypeDisplayName() (string, error)
propertyUriExpression*ReferenceExpressionget
Gets the connection URI expression for the RabbitMQ server.
UriExpression() *ReferenceExpression
propertyUserNameParameterParameterResourceget
Gets the parameter that contains the RabbitMQ server user name.
UserNameParameter() ParameterResource
propertyUserNameReference*ReferenceExpressionget
Gets a reference to the user name for the RabbitMQ server.
UserNameReference() *ReferenceExpression

Methods

methodWithDataBindMountbuilder
Adds a bind mount for the data folder to a RabbitMQ container resource.
WithDataBindMount(
source string,
options ...*WithDataBindMountOptions,
) RabbitMQServerResource
sourcestringThe source directory on the host to mount into the container.
options...*WithDataBindMountOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithDataBindMountOptions argument.

IsReadOnly*boolA flag that indicates if this is a read-only mount.
RabbitMQServerResource

The resource builder.

Returns a handle; failures surface later via Err().

methodWithDataVolumebuilder
Adds a named volume for the data folder to a RabbitMQ container resource.
WithDataVolume(options ...*WithDataVolumeOptions) RabbitMQServerResource
options...*WithDataVolumeOptionsOptional settings, described under 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.
RabbitMQServerResource

The resource builder.

Returns a handle; failures surface later via Err().

Enables the RabbitMQ management plugin
WithManagementPlugin(options ...*WithManagementPluginOptions) RabbitMQServerResource
options...*WithManagementPluginOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithManagementPluginOptions argument.

Port*float64
RabbitMQServerResource

Returns a handle; failures surface later via Err().