Fugue.Core.AWS.ECS

Table of Contents

Module Members

Cluster

(Type)

type Cluster:
  | Cluster
      clusterName: String
      region: Region

Cluster

(Constructor)

Argument:

Record {

Field: clusterName
Type: String
Field: region
Type: Region

}

ContainerDefinition

(Type)

type ContainerDefinition:
  | ContainerDefinition
      name: String
      image: String
      cpu: Optional<Int>
      memory: Optional<Int>
      memoryReservation: Optional<Int>
      links: Optional<List<ContainerDefinition>>
      portMappings: Optional<List<PortMapping>>
      essential: Optional<Bool>
      entryPoint: Optional<List<String>>
      command: Optional<List<String>>
      environment: Optional<Dictionary<String>>
      mountPoints: Optional<List<MountPoint>>
      volumesFrom: Optional<List<VolumeFrom>>
      hostname: Optional<String>
      user: Optional<String>
      workingDirectory: Optional<String>
      disableNetworking: Optional<Bool>
      privileged: Optional<Bool>
      readonlyRootFilesystem: Optional<Bool>
      dnsServers: Optional<List<String>>
      dnsSearchDomains: Optional<List<String>>
      extraHosts: Optional<List<HostEntry>>
      dockerSecurityOptions: Optional<List<String>>
      dockerLabels: Optional<Dictionary<String>>
      ulimits: Optional<List<Ulimit>>
      logConfiguration: Optional<LogConfiguration>

ContainerDefinition

(Constructor)

Argument:

Record {

Field: name
Type: String
Field: image
Type: String
Field: cpu
Type: Optional<Int>
Field: memory
Type: Optional<Int>
Field: memoryReservation
Type: Optional<Int>
Field: links
Type: Optional<List<ContainerDefinition>>
Field: portMappings
Type: Optional<List<PortMapping>>
Field: essential
Type: Optional<Bool>
Field: entryPoint
Type: Optional<List<String>>
Field: command
Type: Optional<List<String>>
Field: environment
Type: Optional<Dictionary<String>>
Field: mountPoints
Type: Optional<List<MountPoint>>
Field: volumesFrom
Type: Optional<List<VolumeFrom>>
Field: hostname
Type: Optional<String>
Field: user
Type: Optional<String>
Field: workingDirectory
Type: Optional<String>
Field: disableNetworking
Type: Optional<Bool>
Field: privileged
Type: Optional<Bool>
Field: readonlyRootFilesystem
Type: Optional<Bool>
Field: dnsServers
Type: Optional<List<String>>
Field: dnsSearchDomains
Type: Optional<List<String>>
Field: extraHosts
Type: Optional<List<HostEntry>>
Field: dockerSecurityOptions
Type: Optional<List<String>>
Field: dockerLabels
Type: Optional<Dictionary<String>>
Field: ulimits
Type: Optional<List<Ulimit>>
Field: logConfiguration
Type: Optional<LogConfiguration>

}

DeploymentConfiguration

(Type)

type DeploymentConfiguration:
  | DeploymentConfiguration
      maximumPercent: Int
      minimumHealthyPercent: Int

DeploymentConfiguration

(Constructor)

Argument:

Record {

Field: maximumPercent
Type: Int
Field: minimumHealthyPercent
Type: Int

}

HostEntry

(Type)

type HostEntry:
  | HostEntry
      hostname: String
      ipAddress: String

HostEntry

(Constructor)

Argument:

Record {

Field: hostname
Type: String
Field: ipAddress
Type: String

}

HostVolumeProperties

(Type)

type HostVolumeProperties:
  | HostVolumeProperties
      sourcePath: Optional<String>

HostVolumeProperties

(Constructor)

Argument:

Record {

Field: sourcePath
Type: Optional<String>

}

LoadBalancer

(Type)

type LoadBalancer:
  | ClassicLoadBalancer
      containerName: String
      containerPort: Int
      loadBalancer: LoadBalancer
  | TargetGroup
      containerName: String
      containerPort: Int
      targetGroup: TargetGroup

ClassicLoadBalancer

(Constructor)

Argument:

Record {

Field: containerName
Type: String
Field: containerPort
Type: Int
Field: loadBalancer
Type: LoadBalancer

}

TargetGroup

(Constructor)

Argument:

Record {

Field: containerName
Type: String
Field: containerPort
Type: Int
Field: targetGroup
Type: TargetGroup

}

LogConfiguration

(Type)

type LogConfiguration:
  | LogConfiguration
      logDriver: LogDriver
      options: Optional<Dictionary<String>>

LogConfiguration

(Constructor)

Argument:

Record {

Field: logDriver
Type: LogDriver
Field: options
Type: Optional<Dictionary<String>>

}

LogDriver

(Type)

type LogDriver:
  | JsonFile
  | Syslog
  | Journald
  | Gelf
  | Fluentd
  | Awslogs
  | Splunk

Awslogs

(Constructor)

Fluentd

(Constructor)

Gelf

(Constructor)

Journald

(Constructor)

JsonFile

(Constructor)

Splunk

(Constructor)

Syslog

(Constructor)

MountPoint

(Type)

type MountPoint:
  | MountPoint
      sourceVolume: Volume
      containerPath: String
      readOnly: Bool

MountPoint

(Constructor)

Argument:

Record {

Field: sourceVolume
Type: Volume
Field: containerPath
Type: String
Field: readOnly
Type: Bool

}

NetworkMode

(Type)

type NetworkMode:
  | Bridge
  | HostNetworkMode
  | Null

Bridge

(Constructor)

HostNetworkMode

(Constructor)

Null

(Constructor)

PlacementConstraint

(Type)

type PlacementConstraint:
  | MemberOf
      expression: String
  | DistinctInstance

DistinctInstance

(Constructor)

MemberOf

(Constructor)

Argument:

Record {

Field: expression
Type: String

}

PlacementStrategy

(Type)

type PlacementStrategy:
  | Random
  | BinpackMemory
  | BinpackCpu
  | Spread SpreadField

BinpackCpu

(Constructor)

BinpackMemory

(Constructor)

Random

(Constructor)

Spread

(Constructor)

Argument:
SpreadField

PortMapping

(Type)

type PortMapping:
  | PortMapping
      containerPort: Int
      hostPort: Int
      protocol: TransportProtocol

PortMapping

(Constructor)

Argument:

Record {

Field: containerPort
Type: Int
Field: hostPort
Type: Int
Field: protocol
Type: TransportProtocol

}

Service

(Type)

type Service:
  | Service
      serviceName: String
      cluster: Cluster
      loadBalancers: Optional<List<LoadBalancer>>
      taskDefinition: TaskDefinition
      deploymentConfiguration: DeploymentConfiguration
      placementConstraints: Optional<List<PlacementConstraint>>
      placementStrategy: Optional<List<PlacementStrategy>>
      role: Optional<Role>
      numDesired: Int

Service

(Constructor)

Argument:

Record {

Field: serviceName
Type: String
Field: cluster
Type: Cluster
Field: loadBalancers
Type: Optional<List<LoadBalancer>>
Field: taskDefinition
Type: TaskDefinition
Field: deploymentConfiguration
Type: DeploymentConfiguration
Field: placementConstraints
Type: Optional<List<PlacementConstraint>>
Field: placementStrategy
Type: Optional<List<PlacementStrategy>>
Field: role
Type: Optional<Role>
Field: numDesired
Type: Int

}

SpreadField

(Type)

type SpreadField:
  | InstanceId
  | HostSpreadField
  | AttributeSpreadField String

AttributeSpreadField

(Constructor)

Argument:
Ludwig.String

HostSpreadField

(Constructor)

InstanceId

(Constructor)

TaskDefinition

(Type)

type TaskDefinition:
  | TaskDefinition
      containerDefinitions: List<ContainerDefinition>
      family: Optional<String>
      networkMode: NetworkMode
      volumes: Optional<List<Volume>>
      placementConstraints: Optional<List<PlacementConstraint>>
      region: Region
      role: Optional<Role>

TaskDefinition

(Constructor)

Argument:

Record {

Field: containerDefinitions
Type: List<ContainerDefinition>
Field: family
Type: Optional<String>
Field: networkMode
Type: NetworkMode
Field: volumes
Type: Optional<List<Volume>>
Field: placementConstraints
Type: Optional<List<PlacementConstraint>>
Field: region
Type: Region
Field: role
Type: Optional<Role>

}

TransportProtocol

(Type)

type TransportProtocol:
  | Tcp
  | Udp

Tcp

(Constructor)

Udp

(Constructor)

Ulimit

(Type)

type Ulimit:
  | Ulimit
      name: UlimitName
      softLimit: Int
      hardLimit: Int

Ulimit

(Constructor)

Argument:

Record {

Field: name
Type: UlimitName
Field: softLimit
Type: Int
Field: hardLimit
Type: Int

}

UlimitName

(Type)

type UlimitName:
  | Core
  | Cpu
  | Data
  | Fsize
  | Locks
  | Memlock
  | Msgqueue
  | Nice
  | Nofile
  | Nproc
  | Rss
  | Rtprio
  | Rttime
  | Sigpending
  | Stack

Core

(Constructor)

Cpu

(Constructor)

Data

(Constructor)

Fsize

(Constructor)

Locks

(Constructor)

Memlock

(Constructor)

Msgqueue

(Constructor)

Nice

(Constructor)

Nofile

(Constructor)

Nproc

(Constructor)

Rss

(Constructor)

Rtprio

(Constructor)

Rttime

(Constructor)

Sigpending

(Constructor)

Stack

(Constructor)

Volume

(Type)

type Volume:
  | Volume
      name: String
      host: Optional<HostVolumeProperties>

Volume

(Constructor)

Argument:

Record {

Field: name
Type: String
Field: host
Type: Optional<HostVolumeProperties>

}

VolumeFrom

(Type)

type VolumeFrom:
  | VolumeFrom
      sourceContainer: Optional<ContainerDefinition>
      readOnly: Optional<Bool>

VolumeFrom

(Constructor)

Argument:

Record {

Field: sourceContainer
Type: Optional<ContainerDefinition>
Field: readOnly
Type: Optional<Bool>

}