FlociAwsContainerResource

Handle

📦 CommunityToolkit.Aspire.Hosting.Floci v13.5.0

interface FlociAwsContainerResource
  extends IComputeResource,
    IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly connectionStringExpression: ReferenceExpression;
  readonly host: EndpointReferenceExpression;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  readonly scheme: EndpointReferenceExpression;
  withConfigFile(hostPath: string): FlociAwsContainerResource;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): FlociAwsContainerResource;
  withDataVolume(
      name: string,
      isReadOnly?: boolean): FlociAwsContainerResource;
  withDockerSocket(socketPath?: string): FlociAwsContainerResource;
  withFlociUI(configureContainer?: (obj: FlociUIContainerResource) => Promise<void>, containerName?: string): FlociAwsContainerResource;
}

10 members

Properties

propertyconnectionStringExpressionReferenceExpressionget

Gets the emulator endpoint URL, following the primary endpoint's `Scheme`.

propertyhostEndpointReferenceExpressionget

Gets the host endpoint reference for the primary endpoint.

propertyportEndpointReferenceExpressionget

Gets the port endpoint reference for the primary endpoint.

propertyprimaryEndpointEndpointReferenceget

Gets the primary endpoint reference for the Floci container.

propertyschemeEndpointReferenceExpressionget

Gets the scheme endpoint reference for the primary endpoint. `http` unless a TLS certificate has been configured, in which case the endpoint is switched to `https` before the application starts. Floci serves both on the same port, so the port never changes.

Methods

methodwithConfigFilebuilder

Mounts a custom Quarkus `application.yml` configuration file into the Floci container. The file is mounted read-only at `/deployments/config/application.yml`, which Quarkus reads on startup and merges with built-in defaults.

withConfigFile(hostPath: string): FlociAwsContainerResource

Parameters

hostPathstring

Returns

FlociAwsContainerResource

methodwithDataBindMountbuilder

Configures a bind mount for persistent Floci state.

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

Parameters

sourcestring

isReadOnlybooleanoptional= False

Returns

FlociAwsContainerResource

methodwithDataVolumebuilder

Configures a named data volume for persistent Floci state.

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

Parameters

namestring

isReadOnlybooleanoptional= False

Returns

FlociAwsContainerResource

methodwithDockerSocketbuilder

Mounts the Docker socket into the Floci container so that Lambda and other container-backed AWS services can launch sibling containers. Also sets `FLOCI_DOCKER_DOCKER_HOST` to `unix:///var/run/docker.sock` (the container-side path where the socket is always mounted) so Floci can connect to it.

withDockerSocket(socketPath?: string): FlociAwsContainerResource

Parameters

socketPathstringoptional= /var/run/docker.sock

Returns

FlociAwsContainerResource

methodwithFlociUIbuilder

Adds a Floci UI web console container for the Floci resource

withFlociUI(configureContainer?: (obj: FlociUIContainerResource) => Promise<void>, containerName?: string): FlociAwsContainerResource

Parameters

configureContainer(obj: FlociUIContainerResource) => Promise<void>optional

containerNamestringoptional

Returns

FlociAwsContainerResource