| Copyright | (c) 2013-2017 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.ECS
Contents
- Service Configuration
- Errors
- InvalidParameterException
- ServerException
- ClusterContainsServicesException
- ClusterContainsContainerInstancesException
- ServiceNotActiveException
- ClusterNotFoundException
- NoUpdateAvailableException
- ServiceNotFoundException
- MissingVersionException
- UpdateInProgressException
- TargetNotFoundException
- AttributeLimitExceededException
- ClientException
- Waiters
- Operations
- ListServices (Paginated)
- DescribeClusters
- DeleteService
- UpdateService
- DiscoverPollEndpoint
- SubmitContainerStateChange
- StopTask
- DescribeTaskDefinition
- SubmitTaskStateChange
- DescribeContainerInstances
- UpdateContainerInstancesState
- DeleteCluster
- CreateCluster
- ListTaskDefinitions (Paginated)
- RunTask
- ListTasks (Paginated)
- RegisterContainerInstance
- UpdateContainerAgent
- ListContainerInstances (Paginated)
- ListTaskDefinitionFamilies (Paginated)
- StartTask
- ListAttributes
- DeregisterTaskDefinition
- DescribeTasks
- ListClusters (Paginated)
- DescribeServices
- DeregisterContainerInstance
- DeleteAttributes
- PutAttributes
- RegisterTaskDefinition
- CreateService
- Types
- AgentUpdateStatus
- ContainerInstanceStatus
- DesiredStatus
- DeviceCgroupPermission
- LogDriver
- NetworkMode
- PlacementConstraintType
- PlacementStrategyType
- SortOrder
- TargetType
- TaskDefinitionFamilyStatus
- TaskDefinitionPlacementConstraintType
- TaskDefinitionStatus
- TransportProtocol
- UlimitName
- Attribute
- Cluster
- Container
- ContainerDefinition
- ContainerInstance
- ContainerOverride
- ContainerService
- Deployment
- DeploymentConfiguration
- Device
- Failure
- HostEntry
- HostVolumeProperties
- KernelCapabilities
- KeyValuePair
- LinuxParameters
- LoadBalancer
- LogConfiguration
- MountPoint
- NetworkBinding
- PlacementConstraint
- PlacementStrategy
- PortMapping
- Resource
- ServiceEvent
- Task
- TaskDefinition
- TaskDefinitionPlacementConstraint
- TaskOverride
- Ulimit
- VersionInfo
- Volume
- VolumeFrom
Description
Amazon EC2 Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster of EC2 instances. Amazon ECS lets you launch and stop container-enabled applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features like security groups, Amazon EBS volumes, and IAM roles.
You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.
- ecs :: Service
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ClusterContainsServicesException :: AsError a => Getting (First ServiceError) a ServiceError
- _ClusterContainsContainerInstancesException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceNotActiveException :: AsError a => Getting (First ServiceError) a ServiceError
- _ClusterNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _NoUpdateAvailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _MissingVersionException :: AsError a => Getting (First ServiceError) a ServiceError
- _UpdateInProgressException :: AsError a => Getting (First ServiceError) a ServiceError
- _TargetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _AttributeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ClientException :: AsError a => Getting (First ServiceError) a ServiceError
- servicesInactive :: Wait DescribeServices
- tasksRunning :: Wait DescribeTasks
- tasksStopped :: Wait DescribeTasks
- module Network.AWS.ECS.ListServices
- module Network.AWS.ECS.DescribeClusters
- module Network.AWS.ECS.DeleteService
- module Network.AWS.ECS.UpdateService
- module Network.AWS.ECS.DiscoverPollEndpoint
- module Network.AWS.ECS.SubmitContainerStateChange
- module Network.AWS.ECS.StopTask
- module Network.AWS.ECS.DescribeTaskDefinition
- module Network.AWS.ECS.SubmitTaskStateChange
- module Network.AWS.ECS.DescribeContainerInstances
- module Network.AWS.ECS.UpdateContainerInstancesState
- module Network.AWS.ECS.DeleteCluster
- module Network.AWS.ECS.CreateCluster
- module Network.AWS.ECS.ListTaskDefinitions
- module Network.AWS.ECS.RunTask
- module Network.AWS.ECS.ListTasks
- module Network.AWS.ECS.RegisterContainerInstance
- module Network.AWS.ECS.UpdateContainerAgent
- module Network.AWS.ECS.ListContainerInstances
- module Network.AWS.ECS.ListTaskDefinitionFamilies
- module Network.AWS.ECS.StartTask
- module Network.AWS.ECS.ListAttributes
- module Network.AWS.ECS.DeregisterTaskDefinition
- module Network.AWS.ECS.DescribeTasks
- module Network.AWS.ECS.ListClusters
- module Network.AWS.ECS.DescribeServices
- module Network.AWS.ECS.DeregisterContainerInstance
- module Network.AWS.ECS.DeleteAttributes
- module Network.AWS.ECS.PutAttributes
- module Network.AWS.ECS.RegisterTaskDefinition
- module Network.AWS.ECS.CreateService
- data AgentUpdateStatus
- data ContainerInstanceStatus
- data DesiredStatus
- data DeviceCgroupPermission
- data LogDriver
- data NetworkMode
- data PlacementConstraintType
- data PlacementStrategyType
- data SortOrder
- data TargetType = ContainerInstance
- data TaskDefinitionFamilyStatus
- data TaskDefinitionPlacementConstraintType = MemberOf
- data TaskDefinitionStatus
- data TransportProtocol
- data UlimitName
- data Attribute
- attribute :: Text -> Attribute
- aTargetId :: Lens' Attribute (Maybe Text)
- aValue :: Lens' Attribute (Maybe Text)
- aTargetType :: Lens' Attribute (Maybe TargetType)
- aName :: Lens' Attribute Text
- data Cluster
- cluster :: Cluster
- cStatus :: Lens' Cluster (Maybe Text)
- cClusterARN :: Lens' Cluster (Maybe Text)
- cRunningTasksCount :: Lens' Cluster (Maybe Int)
- cRegisteredContainerInstancesCount :: Lens' Cluster (Maybe Int)
- cPendingTasksCount :: Lens' Cluster (Maybe Int)
- cClusterName :: Lens' Cluster (Maybe Text)
- cActiveServicesCount :: Lens' Cluster (Maybe Int)
- data Container
- container :: Container
- cNetworkBindings :: Lens' Container [NetworkBinding]
- cContainerARN :: Lens' Container (Maybe Text)
- cTaskARN :: Lens' Container (Maybe Text)
- cLastStatus :: Lens' Container (Maybe Text)
- cReason :: Lens' Container (Maybe Text)
- cName :: Lens' Container (Maybe Text)
- cExitCode :: Lens' Container (Maybe Int)
- data ContainerDefinition
- containerDefinition :: ContainerDefinition
- cdImage :: Lens' ContainerDefinition (Maybe Text)
- cdCommand :: Lens' ContainerDefinition [Text]
- cdHostname :: Lens' ContainerDefinition (Maybe Text)
- cdDockerSecurityOptions :: Lens' ContainerDefinition [Text]
- cdDisableNetworking :: Lens' ContainerDefinition (Maybe Bool)
- cdVolumesFrom :: Lens' ContainerDefinition [VolumeFrom]
- cdEnvironment :: Lens' ContainerDefinition [KeyValuePair]
- cdEntryPoint :: Lens' ContainerDefinition [Text]
- cdWorkingDirectory :: Lens' ContainerDefinition (Maybe Text)
- cdUlimits :: Lens' ContainerDefinition [Ulimit]
- cdPrivileged :: Lens' ContainerDefinition (Maybe Bool)
- cdPortMappings :: Lens' ContainerDefinition [PortMapping]
- cdDockerLabels :: Lens' ContainerDefinition (HashMap Text Text)
- cdExtraHosts :: Lens' ContainerDefinition [HostEntry]
- cdMemory :: Lens' ContainerDefinition (Maybe Int)
- cdUser :: Lens' ContainerDefinition (Maybe Text)
- cdDnsSearchDomains :: Lens' ContainerDefinition [Text]
- cdLogConfiguration :: Lens' ContainerDefinition (Maybe LogConfiguration)
- cdLinuxParameters :: Lens' ContainerDefinition (Maybe LinuxParameters)
- cdName :: Lens' ContainerDefinition (Maybe Text)
- cdDnsServers :: Lens' ContainerDefinition [Text]
- cdMountPoints :: Lens' ContainerDefinition [MountPoint]
- cdLinks :: Lens' ContainerDefinition [Text]
- cdReadonlyRootFilesystem :: Lens' ContainerDefinition (Maybe Bool)
- cdEssential :: Lens' ContainerDefinition (Maybe Bool)
- cdCpu :: Lens' ContainerDefinition (Maybe Int)
- cdMemoryReservation :: Lens' ContainerDefinition (Maybe Int)
- data ContainerInstance
- containerInstance :: ContainerInstance
- ciStatus :: Lens' ContainerInstance (Maybe Text)
- ciRunningTasksCount :: Lens' ContainerInstance (Maybe Int)
- ciRemainingResources :: Lens' ContainerInstance [Resource]
- ciEc2InstanceId :: Lens' ContainerInstance (Maybe Text)
- ciContainerInstanceARN :: Lens' ContainerInstance (Maybe Text)
- ciAgentConnected :: Lens' ContainerInstance (Maybe Bool)
- ciVersionInfo :: Lens' ContainerInstance (Maybe VersionInfo)
- ciAgentUpdateStatus :: Lens' ContainerInstance (Maybe AgentUpdateStatus)
- ciAttributes :: Lens' ContainerInstance [Attribute]
- ciVersion :: Lens' ContainerInstance (Maybe Integer)
- ciPendingTasksCount :: Lens' ContainerInstance (Maybe Int)
- ciRegisteredAt :: Lens' ContainerInstance (Maybe UTCTime)
- ciRegisteredResources :: Lens' ContainerInstance [Resource]
- data ContainerOverride
- containerOverride :: ContainerOverride
- coCommand :: Lens' ContainerOverride [Text]
- coEnvironment :: Lens' ContainerOverride [KeyValuePair]
- coMemory :: Lens' ContainerOverride (Maybe Int)
- coName :: Lens' ContainerOverride (Maybe Text)
- coCpu :: Lens' ContainerOverride (Maybe Int)
- coMemoryReservation :: Lens' ContainerOverride (Maybe Int)
- data ContainerService
- containerService :: ContainerService
- csRunningCount :: Lens' ContainerService (Maybe Int)
- csStatus :: Lens' ContainerService (Maybe Text)
- csClusterARN :: Lens' ContainerService (Maybe Text)
- csCreatedAt :: Lens' ContainerService (Maybe UTCTime)
- csDesiredCount :: Lens' ContainerService (Maybe Int)
- csLoadBalancers :: Lens' ContainerService [LoadBalancer]
- csPendingCount :: Lens' ContainerService (Maybe Int)
- csPlacementConstraints :: Lens' ContainerService [PlacementConstraint]
- csEvents :: Lens' ContainerService [ServiceEvent]
- csPlacementStrategy :: Lens' ContainerService [PlacementStrategy]
- csDeployments :: Lens' ContainerService [Deployment]
- csServiceName :: Lens' ContainerService (Maybe Text)
- csServiceARN :: Lens' ContainerService (Maybe Text)
- csTaskDefinition :: Lens' ContainerService (Maybe Text)
- csRoleARN :: Lens' ContainerService (Maybe Text)
- csDeploymentConfiguration :: Lens' ContainerService (Maybe DeploymentConfiguration)
- data Deployment
- deployment :: Deployment
- dRunningCount :: Lens' Deployment (Maybe Int)
- dStatus :: Lens' Deployment (Maybe Text)
- dCreatedAt :: Lens' Deployment (Maybe UTCTime)
- dDesiredCount :: Lens' Deployment (Maybe Int)
- dPendingCount :: Lens' Deployment (Maybe Int)
- dId :: Lens' Deployment (Maybe Text)
- dUpdatedAt :: Lens' Deployment (Maybe UTCTime)
- dTaskDefinition :: Lens' Deployment (Maybe Text)
- data DeploymentConfiguration
- deploymentConfiguration :: DeploymentConfiguration
- dcMinimumHealthyPercent :: Lens' DeploymentConfiguration (Maybe Int)
- dcMaximumPercent :: Lens' DeploymentConfiguration (Maybe Int)
- data Device
- device :: Text -> Device
- dContainerPath :: Lens' Device (Maybe Text)
- dPermissions :: Lens' Device [DeviceCgroupPermission]
- dHostPath :: Lens' Device Text
- data Failure
- failure :: Failure
- fArn :: Lens' Failure (Maybe Text)
- fReason :: Lens' Failure (Maybe Text)
- data HostEntry
- hostEntry :: Text -> Text -> HostEntry
- heHostname :: Lens' HostEntry Text
- heIpAddress :: Lens' HostEntry Text
- data HostVolumeProperties
- hostVolumeProperties :: HostVolumeProperties
- hvpSourcePath :: Lens' HostVolumeProperties (Maybe Text)
- data KernelCapabilities
- kernelCapabilities :: KernelCapabilities
- kcDrop :: Lens' KernelCapabilities [Text]
- kcAdd :: Lens' KernelCapabilities [Text]
- data KeyValuePair
- keyValuePair :: KeyValuePair
- kvpValue :: Lens' KeyValuePair (Maybe Text)
- kvpName :: Lens' KeyValuePair (Maybe Text)
- data LinuxParameters
- linuxParameters :: LinuxParameters
- lpInitProcessEnabled :: Lens' LinuxParameters (Maybe Bool)
- lpDevices :: Lens' LinuxParameters [Device]
- lpCapabilities :: Lens' LinuxParameters (Maybe KernelCapabilities)
- data LoadBalancer
- loadBalancer :: LoadBalancer
- lbLoadBalancerName :: Lens' LoadBalancer (Maybe Text)
- lbContainerName :: Lens' LoadBalancer (Maybe Text)
- lbTargetGroupARN :: Lens' LoadBalancer (Maybe Text)
- lbContainerPort :: Lens' LoadBalancer (Maybe Int)
- data LogConfiguration
- logConfiguration :: LogDriver -> LogConfiguration
- lcOptions :: Lens' LogConfiguration (HashMap Text Text)
- lcLogDriver :: Lens' LogConfiguration LogDriver
- data MountPoint
- mountPoint :: MountPoint
- mpContainerPath :: Lens' MountPoint (Maybe Text)
- mpSourceVolume :: Lens' MountPoint (Maybe Text)
- mpReadOnly :: Lens' MountPoint (Maybe Bool)
- data NetworkBinding
- networkBinding :: NetworkBinding
- nbBindIP :: Lens' NetworkBinding (Maybe Text)
- nbProtocol :: Lens' NetworkBinding (Maybe TransportProtocol)
- nbHostPort :: Lens' NetworkBinding (Maybe Int)
- nbContainerPort :: Lens' NetworkBinding (Maybe Int)
- data PlacementConstraint
- placementConstraint :: PlacementConstraint
- pcExpression :: Lens' PlacementConstraint (Maybe Text)
- pcType :: Lens' PlacementConstraint (Maybe PlacementConstraintType)
- data PlacementStrategy
- placementStrategy :: PlacementStrategy
- psField :: Lens' PlacementStrategy (Maybe Text)
- psType :: Lens' PlacementStrategy (Maybe PlacementStrategyType)
- data PortMapping
- portMapping :: PortMapping
- pmProtocol :: Lens' PortMapping (Maybe TransportProtocol)
- pmHostPort :: Lens' PortMapping (Maybe Int)
- pmContainerPort :: Lens' PortMapping (Maybe Int)
- data Resource
- resource :: Resource
- rStringSetValue :: Lens' Resource [Text]
- rIntegerValue :: Lens' Resource (Maybe Int)
- rDoubleValue :: Lens' Resource (Maybe Double)
- rLongValue :: Lens' Resource (Maybe Integer)
- rName :: Lens' Resource (Maybe Text)
- rType :: Lens' Resource (Maybe Text)
- data ServiceEvent
- serviceEvent :: ServiceEvent
- seCreatedAt :: Lens' ServiceEvent (Maybe UTCTime)
- seId :: Lens' ServiceEvent (Maybe Text)
- seMessage :: Lens' ServiceEvent (Maybe Text)
- data Task
- task :: Task
- tStoppedAt :: Lens' Task (Maybe UTCTime)
- tDesiredStatus :: Lens' Task (Maybe Text)
- tOverrides :: Lens' Task (Maybe TaskOverride)
- tClusterARN :: Lens' Task (Maybe Text)
- tGroup :: Lens' Task (Maybe Text)
- tCreatedAt :: Lens' Task (Maybe UTCTime)
- tTaskARN :: Lens' Task (Maybe Text)
- tContainerInstanceARN :: Lens' Task (Maybe Text)
- tLastStatus :: Lens' Task (Maybe Text)
- tContainers :: Lens' Task [Container]
- tStartedAt :: Lens' Task (Maybe UTCTime)
- tVersion :: Lens' Task (Maybe Integer)
- tStartedBy :: Lens' Task (Maybe Text)
- tStoppedReason :: Lens' Task (Maybe Text)
- tTaskDefinitionARN :: Lens' Task (Maybe Text)
- data TaskDefinition
- taskDefinition :: TaskDefinition
- tdStatus :: Lens' TaskDefinition (Maybe TaskDefinitionStatus)
- tdFamily :: Lens' TaskDefinition (Maybe Text)
- tdContainerDefinitions :: Lens' TaskDefinition [ContainerDefinition]
- tdTaskRoleARN :: Lens' TaskDefinition (Maybe Text)
- tdPlacementConstraints :: Lens' TaskDefinition [TaskDefinitionPlacementConstraint]
- tdNetworkMode :: Lens' TaskDefinition (Maybe NetworkMode)
- tdTaskDefinitionARN :: Lens' TaskDefinition (Maybe Text)
- tdRevision :: Lens' TaskDefinition (Maybe Int)
- tdVolumes :: Lens' TaskDefinition [Volume]
- tdRequiresAttributes :: Lens' TaskDefinition [Attribute]
- data TaskDefinitionPlacementConstraint
- taskDefinitionPlacementConstraint :: TaskDefinitionPlacementConstraint
- tdpcExpression :: Lens' TaskDefinitionPlacementConstraint (Maybe Text)
- tdpcType :: Lens' TaskDefinitionPlacementConstraint (Maybe TaskDefinitionPlacementConstraintType)
- data TaskOverride
- taskOverride :: TaskOverride
- toContainerOverrides :: Lens' TaskOverride [ContainerOverride]
- toTaskRoleARN :: Lens' TaskOverride (Maybe Text)
- data Ulimit
- ulimit :: UlimitName -> Int -> Int -> Ulimit
- uName :: Lens' Ulimit UlimitName
- uSoftLimit :: Lens' Ulimit Int
- uHardLimit :: Lens' Ulimit Int
- data VersionInfo
- versionInfo :: VersionInfo
- viAgentHash :: Lens' VersionInfo (Maybe Text)
- viAgentVersion :: Lens' VersionInfo (Maybe Text)
- viDockerVersion :: Lens' VersionInfo (Maybe Text)
- data Volume
- volume :: Volume
- vName :: Lens' Volume (Maybe Text)
- vHost :: Lens' Volume (Maybe HostVolumeProperties)
- data VolumeFrom
- volumeFrom :: VolumeFrom
- vfSourceContainer :: Lens' VolumeFrom (Maybe Text)
- vfReadOnly :: Lens' VolumeFrom (Maybe Bool)
Service Configuration
API version 2014-11-13 of the Amazon EC2 Container Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by ECS.
InvalidParameterException
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified parameter is invalid. Review the available parameters for the API request.
ServerException
_ServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
These errors are usually caused by a server issue.
ClusterContainsServicesException
_ClusterContainsServicesException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You cannot delete a cluster that contains services. You must first update the service to reduce its desired task count to 0 and then delete the service. For more information, see UpdateService and DeleteService .
ClusterContainsContainerInstancesException
_ClusterContainsContainerInstancesException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You cannot delete a cluster that has registered container instances. You must first deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance .
ServiceNotActiveException
_ServiceNotActiveException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified service is not active. You cannot update a service that is not active. If you have previously deleted a service, you can re-create it with CreateService .
ClusterNotFoundException
_ClusterNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified cluster could not be found. You can view your available clusters with ListClusters . Amazon ECS clusters are region-specific.
NoUpdateAvailableException
_NoUpdateAvailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version.
ServiceNotFoundException
_ServiceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified service could not be found. You can view your available services with ListServices . Amazon ECS services are cluster-specific and region-specific.
MissingVersionException
_MissingVersionException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information.
UpdateInProgressException
_UpdateInProgressException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as PENDING or STAGING , the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.
TargetNotFoundException
_TargetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified target could not be found. You can view your available container instances with ListContainerInstances . Amazon ECS container instances are cluster-specific and region-specific.
AttributeLimitExceededException
_AttributeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can apply up to 10 custom attributes per resource. You can view the attributes of a resource with ListAttributes . You can remove existing attributes on a resource with DeleteAttributes .
ClientException
_ClientException :: AsError a => Getting (First ServiceError) a ServiceError Source #
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
ServicesInactive
servicesInactive :: Wait DescribeServices Source #
Polls DescribeServices every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
TasksRunning
tasksRunning :: Wait DescribeTasks Source #
Polls DescribeTasks every 6 seconds until a successful state is reached. An error is returned after 100 failed checks.
TasksStopped
tasksStopped :: Wait DescribeTasks Source #
Polls DescribeTasks every 6 seconds until a successful state is reached. An error is returned after 100 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ListServices (Paginated)
module Network.AWS.ECS.ListServices
DescribeClusters
DeleteService
UpdateService
DiscoverPollEndpoint
SubmitContainerStateChange
StopTask
module Network.AWS.ECS.StopTask
DescribeTaskDefinition
SubmitTaskStateChange
DescribeContainerInstances
UpdateContainerInstancesState
DeleteCluster
CreateCluster
ListTaskDefinitions (Paginated)
RunTask
module Network.AWS.ECS.RunTask
ListTasks (Paginated)
module Network.AWS.ECS.ListTasks
RegisterContainerInstance
UpdateContainerAgent
ListContainerInstances (Paginated)
ListTaskDefinitionFamilies (Paginated)
StartTask
module Network.AWS.ECS.StartTask
ListAttributes
DeregisterTaskDefinition
DescribeTasks
ListClusters (Paginated)
module Network.AWS.ECS.ListClusters
DescribeServices
DeregisterContainerInstance
DeleteAttributes
PutAttributes
RegisterTaskDefinition
CreateService
Types
AgentUpdateStatus
data AgentUpdateStatus Source #
Constructors
| AUSFailed | |
| AUSPending | |
| AUSStaged | |
| AUSStaging | |
| AUSUpdated | |
| AUSUpdating |
Instances
ContainerInstanceStatus
data ContainerInstanceStatus Source #
Instances
DesiredStatus
data DesiredStatus Source #
Instances
DeviceCgroupPermission
data DeviceCgroupPermission Source #
Instances
LogDriver
Instances
NetworkMode
data NetworkMode Source #
Instances
PlacementConstraintType
data PlacementConstraintType Source #
Constructors
| PCTDistinctInstance | |
| PCTMemberOf |
Instances
PlacementStrategyType
data PlacementStrategyType Source #
Instances
SortOrder
Instances
TargetType
data TargetType Source #
Constructors
| ContainerInstance |
Instances
TaskDefinitionFamilyStatus
data TaskDefinitionFamilyStatus Source #
Constructors
| TDFSActive | |
| TDFSAll | |
| TDFSInactive |
Instances
TaskDefinitionPlacementConstraintType
data TaskDefinitionPlacementConstraintType Source #
Constructors
| MemberOf |
Instances
TaskDefinitionStatus
data TaskDefinitionStatus Source #
Constructors
| TDSActive | |
| TDSInactive |
Instances
TransportProtocol
data TransportProtocol Source #
Instances
UlimitName
data UlimitName Source #
Constructors
| CPU | |
| Core | |
| Data | |
| Fsize | |
| Locks | |
| Memlock | |
| Msgqueue | |
| Nice | |
| Nofile | |
| Nproc | |
| Rss | |
| Rtprio | |
| Rttime | |
| Sigpending | |
| Stack |
Instances
Attribute
An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon EC2 Container Service Developer Guide .
See: attribute smart constructor.
Creates a value of Attribute with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aTargetId- The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).aValue- The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.aTargetType- The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full Amazon Resource Name (ARN).aName- The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
aTargetId :: Lens' Attribute (Maybe Text) Source #
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
aValue :: Lens' Attribute (Maybe Text) Source #
The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
aTargetType :: Lens' Attribute (Maybe TargetType) Source #
The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full Amazon Resource Name (ARN).
aName :: Lens' Attribute Text Source #
The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
Cluster
A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
See: cluster smart constructor.
Creates a value of Cluster with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cStatus- The status of the cluster. The valid values areACTIVEorINACTIVE.ACTIVEindicates that you can register container instances with the cluster and the associated instances can accept tasks.cClusterARN- The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains thearn:aws:ecsnamespace, followed by the region of the cluster, the AWS account ID of the cluster owner, theclusternamespace, and then the cluster name. For example,arn:aws:ecs:region :012345678910 :cluster/test..cRunningTasksCount- The number of tasks in the cluster that are in theRUNNINGstate.cRegisteredContainerInstancesCount- The number of container instances registered into the cluster.cPendingTasksCount- The number of tasks in the cluster that are in thePENDINGstate.cClusterName- A user-generated string that you use to identify your cluster.cActiveServicesCount- The number of services that are running on the cluster in anACTIVEstate. You can view these services withListServices.
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.
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 ..
cRunningTasksCount :: Lens' Cluster (Maybe Int) Source #
The number of tasks in the cluster that are in the RUNNING state.
cRegisteredContainerInstancesCount :: Lens' Cluster (Maybe Int) Source #
The number of container instances registered into the cluster.
cPendingTasksCount :: Lens' Cluster (Maybe Int) Source #
The number of tasks in the cluster that are in the PENDING state.
cClusterName :: Lens' Cluster (Maybe Text) Source #
A user-generated string that you use to identify your cluster.
cActiveServicesCount :: Lens' Cluster (Maybe Int) Source #
The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices .
Container
A Docker container that is part of a task.
See: container smart constructor.
container :: Container Source #
Creates a value of Container with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cNetworkBindings- The network bindings associated with the container.cContainerARN- The Amazon Resource Name (ARN) of the container.cTaskARN- The Amazon Resource Name (ARN) of the task.cLastStatus- The last known status of the container.cReason- A short (255 max characters) human-readable string to provide additional details about a running or stopped container.cName- The name of the container.cExitCode- The exit code returned from the container.
cNetworkBindings :: Lens' Container [NetworkBinding] Source #
The network bindings associated with the container.
cContainerARN :: Lens' Container (Maybe Text) Source #
The Amazon Resource Name (ARN) of the container.
cReason :: Lens' Container (Maybe Text) Source #
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
ContainerDefinition
data ContainerDefinition Source #
Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
See: containerDefinition smart constructor.
Instances
containerDefinition :: ContainerDefinition Source #
Creates a value of ContainerDefinition with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdImage- 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 eitherrepository-url /image :tagorrepository-url /imagedigest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run . * Images in Amazon ECR repositories can be specified by either using the fullregistryrepository:tagorregistryrepositorydigest. For example,012345678910.dkr.ecr.region-name.amazonaws.com/repository-name:latestor012345678910.dkr.ecr.region-name.amazonaws.com/repository-namesha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. * Images in official repositories on Docker Hub use a single name (for example,ubuntuormongo). * Images in other repositories on Docker Hub are qualified with an organization name (for example,amazonamazon-ecs-agent). * Images in other online repositories are qualified further by a domain name (for example,quay.ioassemblyline/ubuntu@ ).cdCommand- The command that is passed to the container. This parameter maps toCmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run . For more information, see https://docs.docker.com/engine/reference/builder/#cmd .cdHostname- The hostname to use for your container. This parameter maps toHostnamein the Create a container section of the Docker Remote API and the--hostnameoption to docker run .cdDockerSecurityOptions- A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This parameter maps toSecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run .cdDisableNetworking- When this parameter is true, networking is disabled within the container. This parameter maps toNetworkDisabledin the Create a container section of the Docker Remote API .cdVolumesFrom- Data volumes to mount from another container. This parameter maps toVolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run .cdEnvironment- The environment variables to pass to a container. This parameter maps toEnvin the Create a container section of the Docker Remote API and the--envoption to docker run . Important: We do not recommend using plain text environment variables for sensitive information, such as credential data.cdEntryPoint- Important: Early versions of the Amazon ECS container agent do not properly handleentryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead. The entry point that is passed to the container. This parameter maps toEntrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run . For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint .cdWorkingDirectory- The working directory in which to run commands inside the container. This parameter maps toWorkingDirin the Create a container section of the Docker Remote API and the--workdiroption to docker run .cdUlimits- A list ofulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption to docker run . Valid naming values are displayed in theUlimitdata type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command:sudo docker version | grep "Server API version"cdPrivileged- When this parameter is true, the container is given elevated privileges on the host container instance (similar to therootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run .cdPortMappings- The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. This parameter maps toPortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run . If the network mode of a task definition is set tonone, then you cannot specify port mappings. If the network mode of a task definition is set tohost, then host ports must either be undefined or they must match the container port in the port mapping.cdDockerLabels- A keyvalue map of labels to add to the container. This parameter maps toLabelsin the <https:docs.docker.comenginereferenceapidocker_remote_api_v1.27#create-a-container Create a container> section of the Docker Remote API and the--labeloption to docker run . This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command:sudo docker version | grep "Server API version"cdExtraHosts- A list of hostnames and IP address mappings to append to theetchostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run .cdMemory- The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps toMemoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run . You must specify a non-zero integer for one or both ofmemoryormemoryReservationin container definitions. If you specify both,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value ofmemoryis used. The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.cdUser- The user name to use inside the container. This parameter maps toUserin the Create a container section of the Docker Remote API and the--useroption to docker run .cdDnsSearchDomains- A list of DNS search domains that are presented to the container. This parameter maps toDnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run .cdLogConfiguration- The log configuration specification for the container. This parameter maps toLogConfigin the Create a container section of the Docker Remote API and the--log-driveroption to docker run . By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command:sudo docker version | grep "Server API version"cdLinuxParameters- Linux-specific modifications that are applied to the container, such as LinuxKernelCapabilities.cdName- The name of a container. If you are linking multiple containers together in a task definition, thenameof one container can be entered in thelinksof another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps tonamein the Create a container section of the Docker Remote API and the--nameoption to docker run .cdDnsServers- A list of DNS servers that are presented to the container. This parameter maps toDnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run .cdMountPoints- The mount points for data volumes in your container. This parameter maps toVolumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run .cdLinks- Thelinkparameter allows containers to communicate with each other without the need for port mappings, using thenameparameter and optionally, analiasfor the link. This construct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for eachnameandalias. For more information on linking Docker containers, see https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/ . This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption to docker run . Important: Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.cdReadonlyRootFilesystem- When this parameter is true, the container is given read-only access to its root file system. This parameter maps toReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption todocker run.cdEssential- If theessentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon EC2 Container Service Developer Guide .cdCpu- The number ofcpuunits reserved for the container. A container instance has 1,024cpuunits for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount. This parameter maps toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption to docker run . For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units. The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: * Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares. * Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.cdMemoryReservation- The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit; however, your container can consume more memory when it needs to, up to either the hard limit specified with thememoryparameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps toMemoryReservationin the Create a container section of the Docker Remote API and the--memory-reservationoption to docker run . You must specify a non-zero integer for one or both ofmemoryormemoryReservationin container definitions. If you specify both,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value ofmemoryis used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set amemoryReservationof 128 MiB, and amemoryhard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.
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 either repository-url /image :tag or repository-url /image digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run . * Images in Amazon ECR repositories can be specified by either using the full registryrepository:tag or registryrepositorydigest . For example, 012345678910.dkr.ecr.region-name.amazonaws.com/repository-name:latest or 012345678910.dkr.ecr.region-name.amazonaws.com/repository-namesha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE . * Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo ). * Images in other repositories on Docker Hub are qualified with an organization name (for example, amazonamazon-ecs-agent ). * Images in other online repositories are qualified further by a domain name (for example, quay.ioassemblyline/ubuntu@ ).
cdCommand :: Lens' ContainerDefinition [Text] Source #
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run . For more information, see https://docs.docker.com/engine/reference/builder/#cmd .
cdHostname :: Lens' ContainerDefinition (Maybe Text) Source #
The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run .
cdDockerSecurityOptions :: Lens' ContainerDefinition [Text] Source #
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run .
cdDisableNetworking :: Lens' ContainerDefinition (Maybe Bool) Source #
When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API .
cdVolumesFrom :: Lens' ContainerDefinition [VolumeFrom] Source #
Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run .
cdEnvironment :: Lens' ContainerDefinition [KeyValuePair] Source #
The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run . Important: We do not recommend using plain text environment variables for sensitive information, such as credential data.
cdEntryPoint :: Lens' ContainerDefinition [Text] Source #
Important: 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 entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run . For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint .
cdWorkingDirectory :: Lens' ContainerDefinition (Maybe Text) Source #
The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run .
cdUlimits :: Lens' ContainerDefinition [Ulimit] Source #
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run . Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
cdPrivileged :: Lens' ContainerDefinition (Maybe Bool) Source #
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run .
cdPortMappings :: Lens' ContainerDefinition [PortMapping] Source #
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run . If the network mode of a task definition is set to none , then you cannot specify port mappings. If the network mode of a task definition is set to host , then host ports must either be undefined or they must match the container port in the port mapping.
cdDockerLabels :: Lens' ContainerDefinition (HashMap Text Text) Source #
A keyvalue map of labels to add to the container. This parameter maps to Labels in the <https:docs.docker.comenginereferenceapidocker_remote_api_v1.27#create-a-container Create a container> section of the Docker Remote API and the --label option to docker run . This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
cdExtraHosts :: Lens' ContainerDefinition [HostEntry] Source #
A list of hostnames and IP address mappings to append to the etchosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run .
cdMemory :: Lens' ContainerDefinition (Maybe Int) Source #
The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run . You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation . If you specify memoryReservation , then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of memory is used. The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
cdUser :: Lens' ContainerDefinition (Maybe Text) Source #
The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run .
cdDnsSearchDomains :: Lens' ContainerDefinition [Text] Source #
A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run .
cdLogConfiguration :: Lens' ContainerDefinition (Maybe LogConfiguration) Source #
The log configuration specification for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run . By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
cdLinuxParameters :: Lens' ContainerDefinition (Maybe LinuxParameters) Source #
Linux-specific modifications that are applied to the container, such as Linux KernelCapabilities .
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. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run .
cdDnsServers :: Lens' ContainerDefinition [Text] Source #
A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run .
cdMountPoints :: Lens' ContainerDefinition [MountPoint] Source #
The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run .
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 and optionally, an alias for the link. This construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for each name and alias . For more information on linking Docker containers, see https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/ . This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run . Important: Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
cdReadonlyRootFilesystem :: Lens' ContainerDefinition (Maybe Bool) Source #
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run .
cdEssential :: Lens' ContainerDefinition (Maybe Bool) Source #
If the essential parameter of a container is marked as true , and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false , then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon EC2 Container Service Developer Guide .
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. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run . For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units. The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: * Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares. * Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
cdMemoryReservation :: Lens' ContainerDefinition (Maybe Int) Source #
The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit; however, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run . You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation . If you specify memoryReservation , then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of memory is used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.
ContainerInstance
data ContainerInstance Source #
An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
See: containerInstance smart constructor.
Instances
containerInstance :: ContainerInstance Source #
Creates a value of ContainerInstance with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ciStatus- The status of the container instance. The valid values areACTIVE,INACTIVE, orDRAINING.ACTIVEindicates that the container instance can accept tasks.DRAININGindicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon EC2 Container Service Developer Guide .ciRunningTasksCount- The number of tasks on the container instance that are in theRUNNINGstatus.ciRemainingResources- For most resource types, this parameter describes the remaining resources of the container instance that are available for new tasks. For port resource types, this parameter describes the ports that are reserved by the Amazon ECS container agent and any containers that have reserved port mappings; any port that is not specified here is available for new tasks.ciEc2InstanceId- The EC2 instance ID of the container instance.ciContainerInstanceARN- The Amazon Resource Name (ARN) of the container instance. The ARN contains thearn:aws:ecsnamespace, followed by the region of the container instance, the AWS account ID of the container instance owner, thecontainer-instancenamespace, and then the container instance ID. For example,arn:aws:ecs:region :aws_account_id :container-instance/container_instance_ID.ciAgentConnected- This parameter returnstrueif the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped returnfalse, and instances without a connected agent cannot accept placement requests.ciVersionInfo- The version information for the Amazon ECS container agent and Docker daemon running on the container instance.ciAgentUpdateStatus- The status of the most recent agent update. If an update has never been requested, this value isNULL.ciAttributes- The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with thePutAttributesoperation.ciVersion- The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch events for the container instance (inside thedetailobject) to verify that the version in your event stream is current.ciPendingTasksCount- The number of tasks on the container instance that are in thePENDINGstatus.ciRegisteredAt- The Unix timestamp for when the container instance was registered.ciRegisteredResources- For most resource types, this parameter describes the registered resources on the container instance that are in use by current tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.
ciStatus :: Lens' ContainerInstance (Maybe Text) Source #
The status of the container instance. The valid values are ACTIVE , INACTIVE , or DRAINING . ACTIVE indicates that the container instance can accept tasks. DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon EC2 Container Service Developer Guide .
ciRunningTasksCount :: Lens' ContainerInstance (Maybe Int) Source #
The number of tasks on the container instance that are in the RUNNING status.
ciRemainingResources :: Lens' ContainerInstance [Resource] Source #
For most resource types, this parameter describes the remaining resources of the container instance that are available for new tasks. For port resource types, this parameter describes the ports that are reserved by the Amazon ECS container agent and any containers that have reserved port mappings; any port that is not specified here is available for new tasks.
ciEc2InstanceId :: Lens' ContainerInstance (Maybe Text) Source #
The EC2 instance ID of the container instance.
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 ID. For example, arn:aws:ecs:region :aws_account_id :container-instance/container_instance_ID .
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 return false , and instances without a connected agent cannot accept placement requests.
ciVersionInfo :: Lens' ContainerInstance (Maybe VersionInfo) Source #
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
ciAgentUpdateStatus :: Lens' ContainerInstance (Maybe AgentUpdateStatus) Source #
The status of the most recent agent update. If an update has never been requested, this value is NULL .
ciAttributes :: Lens' ContainerInstance [Attribute] Source #
The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
ciVersion :: Lens' ContainerInstance (Maybe Integer) Source #
The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch events for the container instance (inside the detail object) to verify that the version in your event stream is current.
ciPendingTasksCount :: Lens' ContainerInstance (Maybe Int) Source #
The number of tasks on the container instance that are in the PENDING status.
ciRegisteredAt :: Lens' ContainerInstance (Maybe UTCTime) Source #
The Unix timestamp for when the container instance was registered.
ciRegisteredResources :: Lens' ContainerInstance [Resource] Source #
For most resource types, this parameter describes the registered resources on the container instance that are in use by current tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.
ContainerOverride
data ContainerOverride Source #
The overrides that should be sent to a container.
See: containerOverride smart constructor.
Instances
containerOverride :: ContainerOverride Source #
Creates a value of ContainerOverride with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
coCommand- The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.coEnvironment- The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.coMemory- The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.coName- The name of the container that receives the override. This parameter is required if any override is specified.coCpu- The number ofcpuunits reserved for the container, instead of the default value from the task definition. You must also specify a container name.coMemoryReservation- The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
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. You must also specify a container name.
coEnvironment :: Lens' ContainerOverride [KeyValuePair] Source #
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
coMemory :: Lens' ContainerOverride (Maybe Int) Source #
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
coName :: Lens' ContainerOverride (Maybe Text) Source #
The name of the container that receives the override. This parameter is required if any override is specified.
coCpu :: Lens' ContainerOverride (Maybe Int) Source #
The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
coMemoryReservation :: Lens' ContainerOverride (Maybe Int) Source #
The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
ContainerService
data ContainerService Source #
Details on a service within a cluster
See: containerService smart constructor.
Instances
containerService :: ContainerService Source #
Creates a value of ContainerService with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csRunningCount- The number of tasks in the cluster that are in theRUNNINGstate.csStatus- The status of the service. The valid values areACTIVE,DRAINING, orINACTIVE.csClusterARN- The Amazon Resource Name (ARN) of the cluster that hosts the service.csCreatedAt- The Unix timestamp for when the service was created.csDesiredCount- The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created withCreateService, and it can be modified withUpdateService.csLoadBalancers- A list of Elastic Load Balancing 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- The number of tasks in the cluster that are in thePENDINGstate.csPlacementConstraints- The placement constraints for the tasks in the service.csEvents- The event stream for your service. A maximum of 100 of the latest events are displayed.csPlacementStrategy- The placement strategy that determines how tasks for the service are placed.csDeployments- The current state of deployments for the service.csServiceName- The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.csServiceARN- The Amazon Resource Name (ARN) that identifies the service. The ARN contains thearn:aws:ecsnamespace, followed by the region of the service, the AWS account ID of the service owner, theservicenamespace, and then the service name. For example,arn:aws:ecs:region :012345678910 :service/my-service.csTaskDefinition- The task definition to use for tasks in the service. This value is specified when the service is created withCreateService, and it can be modified withUpdateService.csRoleARN- 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 an Elastic Load Balancing load balancer.csDeploymentConfiguration- Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
csRunningCount :: Lens' ContainerService (Maybe Int) Source #
The number of tasks in the cluster that are in the RUNNING state.
csStatus :: Lens' ContainerService (Maybe Text) Source #
The status of the service. The valid values are ACTIVE , DRAINING , or INACTIVE .
csClusterARN :: Lens' ContainerService (Maybe Text) Source #
The Amazon Resource Name (ARN) of the cluster that hosts the service.
csCreatedAt :: Lens' ContainerService (Maybe UTCTime) Source #
The Unix timestamp for when the service was created.
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 .
csLoadBalancers :: Lens' ContainerService [LoadBalancer] Source #
A list of Elastic Load Balancing 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.
csPlacementConstraints :: Lens' ContainerService [PlacementConstraint] Source #
The placement constraints for the tasks in the service.
csEvents :: Lens' ContainerService [ServiceEvent] Source #
The event stream for your service. A maximum of 100 of the latest events are displayed.
csPlacementStrategy :: Lens' ContainerService [PlacementStrategy] Source #
The placement strategy that determines how tasks for the service are placed.
csDeployments :: Lens' ContainerService [Deployment] Source #
The current state of deployments for the service.
csServiceName :: Lens' ContainerService (Maybe Text) Source #
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.
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 .
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 .
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 an Elastic Load Balancing load balancer.
csDeploymentConfiguration :: Lens' ContainerService (Maybe DeploymentConfiguration) Source #
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Deployment
data Deployment Source #
The details of an Amazon ECS service deployment.
See: deployment smart constructor.
Instances
deployment :: Deployment Source #
Creates a value of Deployment with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dRunningCount- The number of tasks in the deployment that are in theRUNNINGstatus.dStatus- The status of the deployment. Valid values arePRIMARY(for the most recent deployment),ACTIVE(for previous deployments that still have tasks running, but are being replaced with thePRIMARYdeployment), andINACTIVE(for deployments that have been completely replaced).dCreatedAt- The Unix timestamp for when the service was created.dDesiredCount- The most recent desired count of tasks that was specified for the service to deploy or maintain.dPendingCount- The number of tasks in the deployment that are in thePENDINGstatus.dId- The ID of the deployment.dUpdatedAt- The Unix timestamp for when the service was last updated.dTaskDefinition- The most recent task definition that was specified for the service to use.
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).
dCreatedAt :: Lens' Deployment (Maybe UTCTime) Source #
The Unix timestamp for 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 or maintain.
dPendingCount :: Lens' Deployment (Maybe Int) Source #
The number of tasks in the deployment that are in the PENDING status.
dUpdatedAt :: Lens' Deployment (Maybe UTCTime) Source #
The Unix timestamp for when the service was last updated.
dTaskDefinition :: Lens' Deployment (Maybe Text) Source #
The most recent task definition that was specified for the service to use.
DeploymentConfiguration
data DeploymentConfiguration Source #
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
See: deploymentConfiguration smart constructor.
Instances
deploymentConfiguration :: DeploymentConfiguration Source #
Creates a value of DeploymentConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dcMinimumHealthyPercent- The lower limit (as a percentage of the service'sdesiredCount) of the number of running tasks that must remain in theRUNNINGstate in a service during a deployment. The minimum healthy tasks during a deployment is thedesiredCountmultiplied byminimumHealthyPercent/100, rounded up to the nearest integer value.dcMaximumPercent- The upper limit (as a percentage of the service'sdesiredCount) of the number of tasks that are allowed in theRUNNINGorPENDINGstate in a service during a deployment. The maximum number of tasks during a deployment is thedesiredCountmultiplied bymaximumPercent/100, rounded down to the nearest integer value.
dcMinimumHealthyPercent :: Lens' DeploymentConfiguration (Maybe Int) Source #
The lower limit (as a percentage of the service's desiredCount ) of the number of running tasks that must remain in the RUNNING state in a service during a deployment. The minimum healthy tasks during a deployment is the desiredCount multiplied by minimumHealthyPercent /100, rounded up to the nearest integer value.
dcMaximumPercent :: Lens' DeploymentConfiguration (Maybe Int) Source #
The upper limit (as a percentage of the service's desiredCount ) of the number of tasks that are allowed in the RUNNING or PENDING state in a service during a deployment. The maximum number of tasks during a deployment is the desiredCount multiplied by maximumPercent /100, rounded down to the nearest integer value.
Device
An object representing a container instance host device.
See: device smart constructor.
Creates a value of Device with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dContainerPath- The path inside the container at which to expose the host device.dPermissions- The explicit permissions to provide to the container for the device. By default, the container will be able toread,write, andmknodthe device.dHostPath- The path for the device on the host container instance.
dContainerPath :: Lens' Device (Maybe Text) Source #
The path inside the container at which to expose the host device.
dPermissions :: Lens' Device [DeviceCgroupPermission] Source #
The explicit permissions to provide to the container for the device. By default, the container will be able to read , write , and mknod the device.
Failure
A failed resource.
See: failure smart constructor.
HostEntry
Hostnames and IP address entries that are added to the etchosts file of a container via the extraHosts parameter of its ContainerDefinition .
See: hostEntry smart constructor.
Creates a value of HostEntry with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
heHostname- The hostname to use in theetchostsentry.heIpAddress- The IP address to use in theetchostsentry.
HostVolumeProperties
data HostVolumeProperties Source #
Details on a container instance host volume.
See: hostVolumeProperties smart constructor.
Instances
hostVolumeProperties :: HostVolumeProperties Source #
Creates a value of HostVolumeProperties with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hvpSourcePath- 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. If thehostparameter contains asourcePathfile location, then the data volume persists at the specified location on the host container instance until you delete it manually. If thesourcePathvalue does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
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. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
KernelCapabilities
data KernelCapabilities Source #
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference . For more detailed information on these Linux capabilities, see the capabilities(7) Linux manual page.
See: kernelCapabilities smart constructor.
Instances
kernelCapabilities :: KernelCapabilities Source #
Creates a value of KernelCapabilities with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
kcDrop- The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps toCapDropin the Create a container section of the Docker Remote API and the--cap-dropoption to docker run . Valid values:ALL | AUDIT_CONTROL | AUDIT_WRITE | BLOCK_SUSPEND | CHOWN | DAC_OVERRIDE | DAC_READ_SEARCH | FOWNER | FSETID | IPC_LOCK | IPC_OWNER | KILL | LEASE | LINUX_IMMUTABLE | MAC_ADMIN | MAC_OVERRIDE | MKNOD | NET_ADMIN | NET_BIND_SERVICE | NET_BROADCAST | NET_RAW | SETFCAP | SETGID | SETPCAP | SETUID | SYS_ADMIN | SYS_BOOT | SYS_CHROOT | SYS_MODULE | SYS_NICE | SYS_PACCT | SYS_PTRACE | SYS_RAWIO | SYS_RESOURCE | SYS_TIME | SYS_TTY_CONFIG | SYSLOG | WAKE_ALARMkcAdd- The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps toCapAddin the Create a container section of the Docker Remote API and the--cap-addoption to docker run . Valid values:ALL | AUDIT_CONTROL | AUDIT_WRITE | BLOCK_SUSPEND | CHOWN | DAC_OVERRIDE | DAC_READ_SEARCH | FOWNER | FSETID | IPC_LOCK | IPC_OWNER | KILL | LEASE | LINUX_IMMUTABLE | MAC_ADMIN | MAC_OVERRIDE | MKNOD | NET_ADMIN | NET_BIND_SERVICE | NET_BROADCAST | NET_RAW | SETFCAP | SETGID | SETPCAP | SETUID | SYS_ADMIN | SYS_BOOT | SYS_CHROOT | SYS_MODULE | SYS_NICE | SYS_PACCT | SYS_PTRACE | SYS_RAWIO | SYS_RESOURCE | SYS_TIME | SYS_TTY_CONFIG | SYSLOG | WAKE_ALARM
kcDrop :: Lens' KernelCapabilities [Text] Source #
The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run . Valid values: ALL | AUDIT_CONTROL | AUDIT_WRITE | BLOCK_SUSPEND | CHOWN | DAC_OVERRIDE | DAC_READ_SEARCH | FOWNER | FSETID | IPC_LOCK | IPC_OWNER | KILL | LEASE | LINUX_IMMUTABLE | MAC_ADMIN | MAC_OVERRIDE | MKNOD | NET_ADMIN | NET_BIND_SERVICE | NET_BROADCAST | NET_RAW | SETFCAP | SETGID | SETPCAP | SETUID | SYS_ADMIN | SYS_BOOT | SYS_CHROOT | SYS_MODULE | SYS_NICE | SYS_PACCT | SYS_PTRACE | SYS_RAWIO | SYS_RESOURCE | SYS_TIME | SYS_TTY_CONFIG | SYSLOG | WAKE_ALARM
kcAdd :: Lens' KernelCapabilities [Text] Source #
The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run . Valid values: ALL | AUDIT_CONTROL | AUDIT_WRITE | BLOCK_SUSPEND | CHOWN | DAC_OVERRIDE | DAC_READ_SEARCH | FOWNER | FSETID | IPC_LOCK | IPC_OWNER | KILL | LEASE | LINUX_IMMUTABLE | MAC_ADMIN | MAC_OVERRIDE | MKNOD | NET_ADMIN | NET_BIND_SERVICE | NET_BROADCAST | NET_RAW | SETFCAP | SETGID | SETPCAP | SETUID | SYS_ADMIN | SYS_BOOT | SYS_CHROOT | SYS_MODULE | SYS_NICE | SYS_PACCT | SYS_PTRACE | SYS_RAWIO | SYS_RESOURCE | SYS_TIME | SYS_TTY_CONFIG | SYSLOG | WAKE_ALARM
KeyValuePair
data KeyValuePair Source #
A key and value pair object.
See: keyValuePair smart constructor.
keyValuePair :: KeyValuePair Source #
Creates a value of KeyValuePair with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
kvpValue :: Lens' KeyValuePair (Maybe Text) Source #
The value of the key value pair. For environment variables, this is the value of the environment variable.
kvpName :: Lens' KeyValuePair (Maybe Text) Source #
The name of the key value pair. For environment variables, this is the name of the environment variable.
LinuxParameters
data LinuxParameters Source #
Linux-specific options that are applied to the container, such as Linux KernelCapabilities .
See: linuxParameters smart constructor.
Instances
linuxParameters :: LinuxParameters Source #
Creates a value of LinuxParameters with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lpInitProcessEnabled- Run aninitprocess inside the container that forwards signals and reaps processes. This parameter maps to the--initoption to docker run . This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command:sudo docker version | grep "Server API version"lpDevices- Any host devices to expose to the container. This parameter maps toDevicesin the Create a container section of the Docker Remote API and the--deviceoption to docker run .lpCapabilities- The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
lpInitProcessEnabled :: Lens' LinuxParameters (Maybe Bool) Source #
Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run . This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
lpDevices :: Lens' LinuxParameters [Device] Source #
Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run .
lpCapabilities :: Lens' LinuxParameters (Maybe KernelCapabilities) Source #
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
LoadBalancer
data LoadBalancer Source #
Details on a load balancer that is used with a service.
See: loadBalancer smart constructor.
loadBalancer :: LoadBalancer Source #
Creates a value of LoadBalancer with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lbLoadBalancerName- The name of a load balancer.lbContainerName- The name of the container (as it appears in a container definition) to associate with the load balancer.lbTargetGroupARN- The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.lbContainerPort- The port on the container to associate with the load balancer. This port must correspond to acontainerPortin the service's task definition. Your container instances must allow ingress traffic on thehostPortof the port mapping.
lbLoadBalancerName :: Lens' LoadBalancer (Maybe Text) Source #
The name of a load balancer.
lbContainerName :: Lens' LoadBalancer (Maybe Text) Source #
The name of the container (as it appears in a container definition) to associate with the load balancer.
lbTargetGroupARN :: Lens' LoadBalancer (Maybe Text) Source #
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.
lbContainerPort :: Lens' LoadBalancer (Maybe Int) Source #
The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.
LogConfiguration
data LogConfiguration Source #
Log configuration options to send to a custom log driver for the container.
See: logConfiguration smart constructor.
Instances
Arguments
| :: LogDriver | |
| -> LogConfiguration |
Creates a value of LogConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lcOptions- The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command:sudo docker version | grep "Server API version"lcLogDriver- The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command:sudo docker version | grep "Server API version"
lcOptions :: Lens' LogConfiguration (HashMap Text Text) Source #
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
lcLogDriver :: Lens' LogConfiguration LogDriver Source #
The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
MountPoint
data MountPoint Source #
Details on a volume mount point that is used in a container definition.
See: mountPoint smart constructor.
mountPoint :: MountPoint Source #
Creates a value of MountPoint with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mpContainerPath- The path on the container to mount the host volume at.mpSourceVolume- The name of the volume to mount.mpReadOnly- If this value istrue, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse.
mpContainerPath :: Lens' MountPoint (Maybe Text) Source #
The path on the container to mount the host volume at.
mpSourceVolume :: Lens' MountPoint (Maybe Text) Source #
The name of the volume to mount.
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 .
NetworkBinding
data NetworkBinding Source #
Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
See: networkBinding smart constructor.
Instances
networkBinding :: NetworkBinding Source #
Creates a value of NetworkBinding with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nbBindIP- The IP address that the container is bound to on the container instance.nbProtocol- The protocol used for the network binding.nbHostPort- The port number on the host that is used with the network binding.nbContainerPort- The port number on the container that is be used with the network binding.
nbBindIP :: Lens' NetworkBinding (Maybe Text) Source #
The IP address that the container is bound to on the container instance.
nbProtocol :: Lens' NetworkBinding (Maybe TransportProtocol) Source #
The protocol used for the network binding.
nbHostPort :: Lens' NetworkBinding (Maybe Int) Source #
The port number on the host that is used with the network binding.
nbContainerPort :: Lens' NetworkBinding (Maybe Int) Source #
The port number on the container that is be used with the network binding.
PlacementConstraint
data PlacementConstraint Source #
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon EC2 Container Service Developer Guide .
See: placementConstraint smart constructor.
Instances
placementConstraint :: PlacementConstraint Source #
Creates a value of PlacementConstraint with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pcExpression- A cluster query language expression to apply to the constraint. Note you cannot specify an expression if the constraint type isdistinctInstance. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide .pcType- The type of constraint. UsedistinctInstanceto ensure that each task in a particular group is running on a different container instance. UsememberOfto restrict selection to a group of valid candidates. Note thatdistinctInstanceis not supported in task definitions.
pcExpression :: Lens' PlacementConstraint (Maybe Text) Source #
A cluster query language expression to apply to the constraint. Note you cannot specify an expression if the constraint type is distinctInstance . For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide .
pcType :: Lens' PlacementConstraint (Maybe PlacementConstraintType) Source #
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict selection to a group of valid candidates. Note that distinctInstance is not supported in task definitions.
PlacementStrategy
data PlacementStrategy Source #
The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon EC2 Container Service Developer Guide .
See: placementStrategy smart constructor.
Instances
placementStrategy :: PlacementStrategy Source #
Creates a value of PlacementStrategy with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
psField- The field to apply the placement strategy against. For thespreadplacement strategy, valid values areinstanceId(orhost, which has the same effect), or any platform or custom attribute that is applied to a container instance, such asattribute:ecs.availability-zone. For thebinpackplacement strategy, valid values arecpuandmemory. For therandomplacement strategy, this field is not used.psType- The type of placement strategy. Therandomplacement strategy randomly places tasks on available candidates. Thespreadplacement strategy spreads placement across available candidates evenly based on thefieldparameter. Thebinpackstrategy places tasks on available candidates that have the least available amount of the resource that is specified with thefieldparameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
psField :: Lens' PlacementStrategy (Maybe Text) Source #
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host , which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone . For the binpack placement strategy, valid values are cpu and memory . For the random placement strategy, this field is not used.
psType :: Lens' PlacementStrategy (Maybe PlacementStrategyType) Source #
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
PortMapping
data PortMapping Source #
Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
See: portMapping smart constructor.
portMapping :: PortMapping Source #
Creates a value of PortMapping with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pmProtocol- The protocol used for the port mapping. Valid values aretcpandudp. The default istcp.pmHostPort- 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 thehostPort(or set it to0) while specifying acontainerPortand your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance underprocsysnetipv4/ip_local_port_range; if this kernel parameter is unavailable, the default ephemeral port range of 49153 to 65535 is used. You should not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678 and 51679. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released).The current reserved ports are displayed in theremainingResourcesofDescribeContainerInstancesoutput, and a container instance may have up to 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports limit).pmContainerPort- 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 automatically receives a host port in the ephemeral port range (for more information, seehostPort). Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
pmProtocol :: Lens' PortMapping (Maybe TransportProtocol) Source #
The protocol used for the port mapping. Valid values are tcp and udp . The default is tcp .
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 (or set it to 0 ) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under procsysnetipv4/ip_local_port_range ; if this kernel parameter is unavailable, the default ephemeral port range of 49153 to 65535 is used. You should not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678 and 51679. Any host port that was previously specified in a running task is also reserved while the task is running (after 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 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports limit).
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 automatically receives a host port in the ephemeral port range (for more information, see hostPort ). Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
Resource
Describes the resources available for a container instance.
See: resource smart constructor.
Creates a value of Resource with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rStringSetValue- When thestringSetValuetype is set, the value of the resource must be a string type.rIntegerValue- When theintegerValuetype is set, the value of the resource must be an integer.rDoubleValue- When thedoubleValuetype is set, the value of the resource must be a double precision floating-point type.rLongValue- When thelongValuetype is set, the value of the resource must be an extended precision floating-point type.rName- The name of the resource, such ascpu,memory,ports, or a user-defined resource.rType- The type of the resource, such asINTEGER,DOUBLE,LONG, orSTRINGSET.
rStringSetValue :: Lens' Resource [Text] Source #
When the stringSetValue type is set, the value of the resource must be a string type.
rIntegerValue :: Lens' Resource (Maybe Int) Source #
When the integerValue type is set, the value of the resource must be an integer.
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.
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.
rType :: Lens' Resource (Maybe Text) Source #
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
ServiceEvent
data ServiceEvent Source #
Details on an event associated with a service.
See: serviceEvent smart constructor.
serviceEvent :: ServiceEvent Source #
Creates a value of ServiceEvent with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
seCreatedAt- The Unix timestamp for when the event was triggered.seId- The ID string of the event.seMessage- The event message.
seCreatedAt :: Lens' ServiceEvent (Maybe UTCTime) Source #
The Unix timestamp for when the event was triggered.
Task
Details on a task in a cluster.
See: task smart constructor.
Creates a value of Task with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tStoppedAt- The Unix timestamp for when the task was stopped (the task transitioned from theRUNNINGstate to theSTOPPEDstate).tDesiredStatus- The desired status of the task.tOverrides- One or more container overrides.tClusterARN- The Amazon Resource Name (ARN) of the cluster that hosts the task.tGroup- The name of the task group associated with the task.tCreatedAt- The Unix timestamp for when the task was created (the task entered thePENDINGstate).tTaskARN- The Amazon Resource Name (ARN) of the task.tContainerInstanceARN- The Amazon Resource Name (ARN) of the container instances that host the task.tLastStatus- The last known status of the task.tContainers- The containers associated with the task.tStartedAt- The Unix timestamp for when the task was started (the task transitioned from thePENDINGstate to theRUNNINGstate).tVersion- The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch events for the task (inside thedetailobject) to verify that the version in your event stream is current.tStartedBy- The tag specified when a task is started. If the task is started by an Amazon ECS service, then thestartedByparameter contains the deployment ID of the service that starts it.tStoppedReason- The reason the task was stopped.tTaskDefinitionARN- The Amazon Resource Name (ARN) of the task definition that creates the task.
tStoppedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
tOverrides :: Lens' Task (Maybe TaskOverride) Source #
One or more container overrides.
tClusterARN :: Lens' Task (Maybe Text) Source #
The Amazon Resource Name (ARN) of the cluster that hosts the task.
tCreatedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for when the task was created (the task entered the PENDING state).
tContainerInstanceARN :: Lens' Task (Maybe Text) Source #
The Amazon Resource Name (ARN) of the container instances that host the task.
tStartedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for when the task was started (the task transitioned from the PENDING state to the RUNNING state).
tVersion :: Lens' Task (Maybe Integer) Source #
The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch events for the task (inside the detail object) to verify that the version in your event stream is current.
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.
tTaskDefinitionARN :: Lens' Task (Maybe Text) Source #
The Amazon Resource Name (ARN) of the task definition that creates the task.
TaskDefinition
data TaskDefinition Source #
Details of a task definition.
See: taskDefinition smart constructor.
taskDefinition :: TaskDefinition Source #
Creates a value of TaskDefinition with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tdStatus- The status of the task definition.tdFamily- The family of your task definition, used as the definition name.tdContainerDefinitions- A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide .tdTaskRoleARN- The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.tdPlacementConstraints- An array of placement constraint objects to use for tasks.tdNetworkMode- The Docker networking mode to use for the containers in the task. The valid values arenone,bridge, andhost. If the network mode isnone, the containers do not have external connectivity. The default Docker network mode isbridge. Thehostnetwork mode offers the highest networking performance for containers because it uses the host network stack instead of the virtualized network stack provided by thebridgemode. For more information, see Network settings in the Docker run reference .tdTaskDefinitionARN- The full Amazon Resource Name (ARN) of the task definition.tdRevision- The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is1; each time you register a new revision of a task definition in the same family, the revision value always increases by one (even if you have deregistered previous revisions in this family).tdVolumes- The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide .tdRequiresAttributes- The container instance attributes required by your task.
tdStatus :: Lens' TaskDefinition (Maybe TaskDefinitionStatus) Source #
The status of the task definition.
tdFamily :: Lens' TaskDefinition (Maybe Text) Source #
The family of your task definition, used as the definition name.
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 about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide .
tdTaskRoleARN :: Lens' TaskDefinition (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
tdPlacementConstraints :: Lens' TaskDefinition [TaskDefinitionPlacementConstraint] Source #
An array of placement constraint objects to use for tasks.
tdNetworkMode :: Lens' TaskDefinition (Maybe NetworkMode) Source #
The Docker networking mode to use for the containers in the task. The valid values are none , bridge , and host . If the network mode is none , the containers do not have external connectivity. The default Docker network mode is bridge . The host network mode offers the highest networking performance for containers because it uses the host network stack instead of the virtualized network stack provided by the bridge mode. For more information, see Network settings in the Docker run reference .
tdTaskDefinitionARN :: Lens' TaskDefinition (Maybe Text) Source #
The full Amazon Resource Name (ARN) of the task definition.
tdRevision :: Lens' TaskDefinition (Maybe Int) Source #
The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1 ; each time you register a new revision of a task definition in the same family, the revision value always increases by one (even if you have deregistered previous revisions in this family).
tdVolumes :: Lens' TaskDefinition [Volume] Source #
The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide .
tdRequiresAttributes :: Lens' TaskDefinition [Attribute] Source #
The container instance attributes required by your task.
TaskDefinitionPlacementConstraint
data TaskDefinitionPlacementConstraint Source #
An object representing a constraint on task placement in the task definition. For more information, see Task Placement Constraints in the Amazon EC2 Container Service Developer Guide .
See: taskDefinitionPlacementConstraint smart constructor.
Instances
taskDefinitionPlacementConstraint :: TaskDefinitionPlacementConstraint Source #
Creates a value of TaskDefinitionPlacementConstraint with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tdpcExpression- A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide .tdpcType- The type of constraint. TheDistinctInstanceconstraint ensures that each task in a particular group is running on a different container instance. TheMemberOfconstraint restricts selection to be from a group of valid candidates.
tdpcExpression :: Lens' TaskDefinitionPlacementConstraint (Maybe Text) Source #
A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide .
tdpcType :: Lens' TaskDefinitionPlacementConstraint (Maybe TaskDefinitionPlacementConstraintType) Source #
The type of constraint. The DistinctInstance constraint ensures that each task in a particular group is running on a different container instance. The MemberOf constraint restricts selection to be from a group of valid candidates.
TaskOverride
data TaskOverride Source #
The overrides associated with a task.
See: taskOverride smart constructor.
taskOverride :: TaskOverride Source #
Creates a value of TaskOverride with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
toContainerOverrides- One or more container overrides sent to a task.toTaskRoleARN- The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
toContainerOverrides :: Lens' TaskOverride [ContainerOverride] Source #
One or more container overrides sent to a task.
toTaskRoleARN :: Lens' TaskOverride (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
Ulimit
The ulimit settings to pass to the container.
See: ulimit smart constructor.
Arguments
| :: UlimitName | |
| -> Int | |
| -> Int | |
| -> Ulimit |
Creates a value of Ulimit with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uName- Thetypeof theulimit.uSoftLimit- The soft limit for the ulimit type.uHardLimit- The hard limit for the ulimit type.
VersionInfo
data VersionInfo Source #
The Docker and Amazon ECS container agent version information about a container instance.
See: versionInfo smart constructor.
versionInfo :: VersionInfo Source #
Creates a value of VersionInfo with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
viAgentHash- The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.viAgentVersion- The version number of the Amazon ECS container agent.viDockerVersion- The Docker version running on the container instance.
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.
Volume
A data volume used in a task definition.
See: volume smart constructor.
Creates a value of Volume with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vName- The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in thesourceVolumeparameter of container definitionmountPoints.vHost- The contents of thehostparameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.
vName :: Lens' Volume (Maybe Text) Source #
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints .
vHost :: Lens' Volume (Maybe HostVolumeProperties) Source #
The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.
VolumeFrom
data VolumeFrom Source #
Details on a data volume from another container in the same task definition.
See: volumeFrom smart constructor.
volumeFrom :: VolumeFrom Source #
Creates a value of VolumeFrom with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vfSourceContainer- The name of another container within the same task definition to mount volumes from.vfReadOnly- If this value istrue, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse.
vfSourceContainer :: Lens' VolumeFrom (Maybe Text) Source #
The name of another container within the same task definition to mount volumes from.
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 .