Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

ActiveMQServerResourceBase

Handle
📦 CommunityToolkit.Aspire.Hosting.ActiveMQ v13.6.1

Base class form ActiveMQ Classic and Artemis server resources.

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

Properties

propertyConnectionStringExpression*ReferenceExpressionget
Gets the ConnectionStringExpression property
ConnectionStringExpression() *ReferenceExpression
propertyHostEndpointReferenceExpressionget
Gets the host endpoint reference for this resource.
Host() EndpointReferenceExpression
propertyPasswordParameterParameterResourceget
Gets the parameter that contains the ActiveMQ server password.
PasswordParameter() ParameterResource
propertyPortEndpointReferenceExpressionget
Gets the port endpoint reference for this resource.
Port() EndpointReferenceExpression
propertyPrimaryEndpointEndpointReferenceget
Gets the primary endpoint for the ActiveMQ server.
PrimaryEndpoint() EndpointReference
propertyUriExpression*ReferenceExpressionget
Gets the connection URI expression for the ActiveMQ server.
UriExpression() *ReferenceExpression
propertyUserNameParameterParameterResourceget
Gets the parameter that contains the ActiveMQ server username.
UserNameParameter() ParameterResource

Methods

methodWithConfBindMountbuilder
Adds a bind mount for the conf folder to a ActiveMQ container resource.
WithConfBindMount(
source string,
options ...*WithConfBindMountOptions,
) ActiveMQServerResourceBase
sourcestringThe source directory on the host to mount into the container.
options...*WithConfBindMountOptionsOptional settings, described under Options.

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

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

The IResourceBuilder.

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

methodWithConfVolumebuilder
Adds a named volume for the config folder to a ActiveMQ container resource.
WithConfVolume(options ...*WithConfVolumeOptions) ActiveMQServerResourceBase
options...*WithConfVolumeOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithConfVolumeOptions 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.
ActiveMQServerResourceBase

The IResourceBuilder.

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

methodWithDataBindMountbuilder
Adds a bind mount for the data folder to a ActiveMQ container resource.
WithDataBindMount(
source string,
options ...*WithDataBindMountOptions,
) ActiveMQServerResourceBase
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.
ActiveMQServerResourceBase

The IResourceBuilder.

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

methodWithDataVolumebuilder
Adds a named volume for the data folder to a ActiveMQ container resource.
WithDataVolume(options ...*WithDataVolumeOptions) ActiveMQServerResourceBase
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.
ActiveMQServerResourceBase

The IResourceBuilder.

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