amazonka-ecs-0.3.5: Amazon EC2 Container Service SDK.

Safe HaskellNone
LanguageHaskell2010

Network.AWS.ECS.Types

Contents

Synopsis

Service

data ECS Source

Version 2014-11-13 of the Amazon EC2 Container Service service.

Instances

AWSService ECS 
type Er ECS = JSONError 
type Sg ECS = V4 

Error

data JSONError :: *

Instances

Eq JSONError 
Show JSONError 
Generic JSONError 
FromJSON JSONError 
AWSErrorCode JSONError 
type Rep JSONError = D1 D1JSONError (C1 C1_0JSONError ((:*:) (S1 S1_0_0JSONError (Rec0 (Maybe Text))) ((:*:) (S1 S1_0_1JSONError (Rec0 (Maybe ErrorCode))) (S1 S1_0_2JSONError (Rec0 Text))))) 

NetworkBinding

data NetworkBinding Source

Instances

networkBinding :: NetworkBinding Source

NetworkBinding constructor.

The fields accessible through corresponding lenses are:

nbBindIP :: Lens' NetworkBinding (Maybe Text) Source

The IP address that the container is bound to on the container instance.

nbContainerPort :: Lens' NetworkBinding (Maybe Int) Source

The port number on the container that is be used with the network binding.

nbHostPort :: Lens' NetworkBinding (Maybe Int) Source

The port number on the host that is used with the network binding.

ContainerService

data ContainerService Source

Instances

containerService :: ContainerService Source

ContainerService constructor.

The fields accessible through corresponding lenses are:

csClusterArn :: Lens' ContainerService (Maybe Text) Source

The Amazon Resource Name (ARN) of the of the cluster that hosts the service.

csDeployments :: Lens' ContainerService [Deployment] Source

The current state of deployments for the service.

csDesiredCount :: Lens' ContainerService (Maybe Int) Source

The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

csEvents :: Lens' ContainerService [ServiceEvent] Source

The event stream for your service. A maximum of 100 of the latest events are displayed.

csLoadBalancers :: Lens' ContainerService [LoadBalancer] Source

A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

csPendingCount :: Lens' ContainerService (Maybe Int) Source

The number of tasks in the cluster that are in the PENDING state.

csRoleArn :: Lens' ContainerService (Maybe Text) Source

The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.

csRunningCount :: Lens' ContainerService (Maybe Int) Source

The number of tasks in the cluster that are in the RUNNING state.

csServiceArn :: Lens' ContainerService (Maybe Text) Source

The Amazon Resource Name (ARN) that identifies the service. The ARN contains the 'arn:aws:ecs' namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service.

csServiceName :: Lens' ContainerService (Maybe Text) Source

A user-generated string that you can use to identify your service.

csStatus :: Lens' ContainerService (Maybe Text) Source

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

csTaskDefinition :: Lens' ContainerService (Maybe Text) Source

The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

Cluster

data Cluster Source

Instances

cluster :: Cluster Source

Cluster constructor.

The fields accessible through corresponding lenses are:

cClusterArn :: Lens' Cluster (Maybe Text) Source

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the 'arn:aws:ecs' namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

cClusterName :: Lens' Cluster (Maybe Text) Source

A user-generated string that you can use to identify your cluster.

cPendingTasksCount :: Lens' Cluster (Maybe Int) Source

The number of tasks in the cluster that are in the PENDING state.

cRegisteredContainerInstancesCount :: Lens' Cluster (Maybe Int) Source

The number of container instances registered into the cluster.

cRunningTasksCount :: Lens' Cluster (Maybe Int) Source

The number of tasks in the cluster that are in the RUNNING state.

cStatus :: Lens' Cluster (Maybe Text) Source

The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.

Volume

data Volume Source

Instances

volume :: Volume Source

Volume constructor.

The fields accessible through corresponding lenses are:

vHost :: Lens' Volume (Maybe HostVolumeProperties) Source

The path on the host container instance that is presented to the containers which access the volume. If this parameter is empty, then the Docker daemon assigns a host path for you.

vName :: Lens' Volume (Maybe Text) Source

The name of the volume. This name is referenced in the sourceVolume parameter of container definition mountPoints.

ContainerOverride

data ContainerOverride Source

Instances

containerOverride :: ContainerOverride Source

ContainerOverride constructor.

The fields accessible through corresponding lenses are:

coCommand :: Lens' ContainerOverride [Text] Source

The command to send to the container that overrides the default command from the Docker image or the task definition.

coName :: Lens' ContainerOverride (Maybe Text) Source

The name of the container that receives the override.

KeyValuePair

data KeyValuePair Source

Instances

keyValuePair :: KeyValuePair Source

KeyValuePair constructor.

The fields accessible through corresponding lenses are:

kvpName :: Lens' KeyValuePair (Maybe Text) Source

The name of the key value pair.

kvpValue :: Lens' KeyValuePair (Maybe Text) Source

The value of the key value pair.

VolumeFrom

data VolumeFrom Source

Instances

volumeFrom :: VolumeFrom Source

VolumeFrom constructor.

The fields accessible through corresponding lenses are:

vfReadOnly :: Lens' VolumeFrom (Maybe Bool) Source

If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

vfSourceContainer :: Lens' VolumeFrom (Maybe Text) Source

The name of the container to mount volumes from.

TaskOverride

data TaskOverride Source

Instances

taskOverride :: TaskOverride Source

TaskOverride constructor.

The fields accessible through corresponding lenses are:

toContainerOverrides :: Lens' TaskOverride [ContainerOverride] Source

One or more container overrides sent to a task.

HostVolumeProperties

data HostVolumeProperties Source

Instances

hostVolumeProperties :: HostVolumeProperties Source

HostVolumeProperties constructor.

The fields accessible through corresponding lenses are:

hvpSourcePath :: Lens' HostVolumeProperties (Maybe Text) Source

The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you.

VersionInfo

data VersionInfo Source

Instances

versionInfo :: VersionInfo Source

VersionInfo constructor.

The fields accessible through corresponding lenses are:

viAgentHash :: Lens' VersionInfo (Maybe Text) Source

The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.

viAgentVersion :: Lens' VersionInfo (Maybe Text) Source

The version number of the Amazon ECS container agent.

viDockerVersion :: Lens' VersionInfo (Maybe Text) Source

The Docker version running on the container instance.

Container

data Container Source

Instances

container :: Container Source

Container constructor.

The fields accessible through corresponding lenses are:

cContainerArn :: Lens' Container (Maybe Text) Source

The Amazon Resource Name (ARN) of the container.

cExitCode :: Lens' Container (Maybe Int) Source

The exit code returned from the container.

cLastStatus :: Lens' Container (Maybe Text) Source

The last known status of the container.

cName :: Lens' Container (Maybe Text) Source

The name of the container.

cNetworkBindings :: Lens' Container [NetworkBinding] Source

cReason :: Lens' Container (Maybe Text) Source

A short (255 max characters) human-readable string to provide additional detail about a running or stopped container.

cTaskArn :: Lens' Container (Maybe Text) Source

The Amazon Resource Name (ARN) of the task.

LoadBalancer

data LoadBalancer Source

Instances

loadBalancer :: LoadBalancer Source

LoadBalancer constructor.

The fields accessible through corresponding lenses are:

lbContainerName :: Lens' LoadBalancer (Maybe Text) Source

The name of the container to associate with the load balancer.

lbContainerPort :: Lens' LoadBalancer (Maybe Int) Source

The port on the container to associate with the load balancer.

lbLoadBalancerName :: Lens' LoadBalancer (Maybe Text) Source

The name of the load balancer.

ContainerDefinition

data ContainerDefinition Source

Instances

containerDefinition :: ContainerDefinition Source

ContainerDefinition constructor.

The fields accessible through corresponding lenses are:

cdCommand :: Lens' ContainerDefinition [Text] Source

The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd.

cdCpu :: Lens' ContainerDefinition (Maybe Int) Source

The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core.

cdEntryPoint :: Lens' ContainerDefinition [Text] Source

Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

The ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint.

cdEnvironment :: Lens' ContainerDefinition [KeyValuePair] Source

The environment variables to pass to a container.

cdEssential :: Lens' ContainerDefinition (Maybe Bool) Source

If the essential parameter of a container is marked as true, the failure of that container will stop the task. If the essential parameter of a container is marked as false, then its failure will not affect the rest of the containers in a task.

cdImage :: Lens' ContainerDefinition (Maybe Text) Source

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with 'repository-url/image:tag.

cdLinks :: Lens' ContainerDefinition [Text] Source

The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/.

cdMemory :: Lens' ContainerDefinition (Maybe Int) Source

The number of MiB of memory reserved for the container. Docker will allocate a minimum of 4 MiB of memory to a container.

cdMountPoints :: Lens' ContainerDefinition [MountPoint] Source

The mount points for data volumes in your container.

cdName :: Lens' ContainerDefinition (Maybe Text) Source

The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers.

cdPortMappings :: Lens' ContainerDefinition [PortMapping] Source

The list of port mappings for the container.

cdVolumesFrom :: Lens' ContainerDefinition [VolumeFrom] Source

Data volumes to mount from another container.

Resource

data Resource Source

Instances

resource :: Resource Source

Resource constructor.

The fields accessible through corresponding lenses are:

rDoubleValue :: Lens' Resource (Maybe Double) Source

When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

rIntegerValue :: Lens' Resource (Maybe Int) Source

When the integerValue type is set, the value of the resource must be an integer.

rLongValue :: Lens' Resource (Maybe Integer) Source

When the longValue type is set, the value of the resource must be an extended precision floating-point type.

rName :: Lens' Resource (Maybe Text) Source

The name of the resource, such as CPU, MEMORY, PORTS, or a user-defined resource.

rStringSetValue :: Lens' Resource [Text] Source

When the stringSetValue type is set, the value of the resource must be a string type.

rType :: Lens' Resource (Maybe Text) Source

The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET.

Task

data Task Source

Instances

task :: Task Source

Task constructor.

The fields accessible through corresponding lenses are:

tClusterArn :: Lens' Task (Maybe Text) Source

The Amazon Resource Name (ARN) of the of the cluster that hosts the task.

tContainerInstanceArn :: Lens' Task (Maybe Text) Source

The Amazon Resource Name (ARN) of the container instances that host the task.

tContainers :: Lens' Task [Container] Source

The containers associated with the task.

tDesiredStatus :: Lens' Task (Maybe Text) Source

The desired status of the task.

tLastStatus :: Lens' Task (Maybe Text) Source

The last known status of the task.

tOverrides :: Lens' Task (Maybe TaskOverride) Source

One or more container overrides.

tStartedBy :: Lens' Task (Maybe Text) Source

The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

tTaskArn :: Lens' Task (Maybe Text) Source

The Amazon Resource Name (ARN) of the task.

tTaskDefinitionArn :: Lens' Task (Maybe Text) Source

The Amazon Resource Name (ARN) of the of the task definition that creates the task.

PortMapping

data PortMapping Source

Instances

portMapping :: PortMapping Source

PortMapping constructor.

The fields accessible through corresponding lenses are:

pmContainerPort :: Lens' PortMapping (Maybe Int) Source

The port number on the container that is bound to the user-specified or automatically assigned host port. If you specify a container port and not a host port, your container will automatically receive a host port in the 49153 to 65535 port range.

pmHostPort :: Lens' PortMapping (Maybe Int) Source

The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit the hostPort while specifying a containerPort and your container will automatically receive a port in the 49153 to 65535 port range. You should not attempt to specify a host port in the 49153 to 65535 port range, since these are reserved for automatic assignment.

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS Container Agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (once a task stops, the host port is released).The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output, and a container instance may have up to 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this limit).

TaskDefinition

data TaskDefinition Source

Instances

taskDefinition :: TaskDefinition Source

TaskDefinition constructor.

The fields accessible through corresponding lenses are:

tdContainerDefinitions :: Lens' TaskDefinition [ContainerDefinition] Source

A list of container definitions in JSON format that describe the different containers that make up your task. For more information on container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

tdFamily :: Lens' TaskDefinition (Maybe Text) Source

The family of your task definition. You can think of the family as the name of your task definition.

tdRevision :: Lens' TaskDefinition (Maybe Int) Source

The revision of the task in a particular family. You can think of the revision as a version number of a task definition in a family. When you register a task definition for the first time, the revision is '1', and each time you register a task definition in the same family, the revision value increases by one.

tdTaskDefinitionArn :: Lens' TaskDefinition (Maybe Text) Source

The full Amazon Resource Name (ARN) of the of the task definition.

tdVolumes :: Lens' TaskDefinition [Volume] Source

The list of volumes in a task. For more information on volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2Container Service Developer Guide.

Failure

data Failure Source

Instances

failure :: Failure Source

Failure constructor.

The fields accessible through corresponding lenses are:

fArn :: Lens' Failure (Maybe Text) Source

The Amazon Resource Name (ARN) of the failed resource.

fReason :: Lens' Failure (Maybe Text) Source

The reason for the failure.

ContainerInstance

data ContainerInstance Source

Instances

containerInstance :: ContainerInstance Source

ContainerInstance constructor.

The fields accessible through corresponding lenses are:

ciAgentConnected :: Lens' ContainerInstance (Maybe Bool) Source

This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped will return false, and instances without a connected agent cannot accept placement request.

ciContainerInstanceArn :: Lens' ContainerInstance (Maybe Text) Source

The Amazon Resource Name (ARN) of the container instance. The ARN contains the 'arn:aws:ecs' namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the 'container-instance' namespace, and then the container instance UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.

ciEc2InstanceId :: Lens' ContainerInstance (Maybe Text) Source

The Amazon EC2 instance ID of the container instance.

ciPendingTasksCount :: Lens' ContainerInstance (Maybe Int) Source

The number of tasks on the container instance that are in the PENDING status.

ciRegisteredResources :: Lens' ContainerInstance [Resource] Source

The registered resources on the container instance that are in use by current tasks.

ciRemainingResources :: Lens' ContainerInstance [Resource] Source

The remaining resources of the container instance that are available for new tasks.

ciRunningTasksCount :: Lens' ContainerInstance (Maybe Int) Source

The number of tasks on the container instance that are in the RUNNING status.

ciStatus :: Lens' ContainerInstance (Maybe Text) Source

The status of the container instance. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that the container instance can accept tasks.

ServiceEvent

data ServiceEvent Source

Instances

serviceEvent :: ServiceEvent Source

ServiceEvent constructor.

The fields accessible through corresponding lenses are:

seCreatedAt :: Lens' ServiceEvent (Maybe UTCTime) Source

The Unix time in seconds and milliseconds when the event was triggered.

seId :: Lens' ServiceEvent (Maybe Text) Source

The ID string of the event.

seMessage :: Lens' ServiceEvent (Maybe Text) Source

The event message.

Deployment

data Deployment Source

Instances

deployment :: Deployment Source

Deployment constructor.

The fields accessible through corresponding lenses are:

dCreatedAt :: Lens' Deployment (Maybe UTCTime) Source

The Unix time in seconds and milliseconds when the service was created.

dDesiredCount :: Lens' Deployment (Maybe Int) Source

The most recent desired count of tasks that was specified for the service to deploy and/or maintain.

dId :: Lens' Deployment (Maybe Text) Source

The ID of the deployment.

dPendingCount :: Lens' Deployment (Maybe Int) Source

The number of tasks in the deployment that are in the PENDING status.

dRunningCount :: Lens' Deployment (Maybe Int) Source

The number of tasks in the deployment that are in the RUNNING status.

dStatus :: Lens' Deployment (Maybe Text) Source

The status of the deployment. Valid values are PRIMARY (for the most recent deployment), ACTIVE (for previous deployments that still have tasks running, but are being replaced with the PRIMARY deployment), and INACTIVE (for deployments that have been completely replaced).

dTaskDefinition :: Lens' Deployment (Maybe Text) Source

The most recent task definition that was specified for the service to use.

dUpdatedAt :: Lens' Deployment (Maybe UTCTime) Source

The Unix time in seconds and milliseconds when the service was last updated.

MountPoint

data MountPoint Source

Instances

mountPoint :: MountPoint Source

MountPoint constructor.

The fields accessible through corresponding lenses are:

mpContainerPath :: Lens' MountPoint (Maybe Text) Source

The path on the container to mount the host volume at.

mpReadOnly :: Lens' MountPoint (Maybe Bool) Source

If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

mpSourceVolume :: Lens' MountPoint (Maybe Text) Source

The name of the volume to mount.