| Copyright | (c) 2013-2018 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.Types
Contents
- Service Configuration
- Errors
- AgentUpdateStatus
- AssignPublicIP
- ClusterField
- Compatibility
- Connectivity
- ContainerInstanceStatus
- DesiredStatus
- DeviceCgroupPermission
- HealthStatus
- LaunchType
- LogDriver
- NetworkMode
- PlacementConstraintType
- PlacementStrategyType
- SortOrder
- TargetType
- TaskDefinitionFamilyStatus
- TaskDefinitionPlacementConstraintType
- TaskDefinitionStatus
- TransportProtocol
- UlimitName
- AWSVPCConfiguration
- Attachment
- AttachmentStateChange
- Attribute
- Cluster
- Container
- ContainerDefinition
- ContainerInstance
- ContainerOverride
- ContainerService
- ContainerStateChange
- Deployment
- DeploymentConfiguration
- Device
- Failure
- HealthCheck
- HostEntry
- HostVolumeProperties
- KernelCapabilities
- KeyValuePair
- LinuxParameters
- LoadBalancer
- LogConfiguration
- MountPoint
- NetworkBinding
- NetworkConfiguration
- NetworkInterface
- PlacementConstraint
- PlacementStrategy
- PortMapping
- Resource
- ServiceEvent
- ServiceRegistry
- Task
- TaskDefinition
- TaskDefinitionPlacementConstraint
- TaskOverride
- Tmpfs
- Ulimit
- VersionInfo
- Volume
- VolumeFrom
Description
- ecs :: Service
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ClusterContainsTasksException :: AsError a => Getting (First ServiceError) a ServiceError
- _PlatformUnknownException :: 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
- _UnsupportedFeatureException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _PlatformTaskDefinitionIncompatibilityException :: AsError a => Getting (First ServiceError) a ServiceError
- _MissingVersionException :: AsError a => Getting (First ServiceError) a ServiceError
- _UpdateInProgressException :: AsError a => Getting (First ServiceError) a ServiceError
- _BlockedException :: 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
- data AgentUpdateStatus
- data AssignPublicIP
- data ClusterField = Statistics
- data Compatibility
- data Connectivity
- data ContainerInstanceStatus
- data DesiredStatus
- data DeviceCgroupPermission
- data HealthStatus
- data LaunchType
- 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 AWSVPCConfiguration
- awsVPCConfiguration :: AWSVPCConfiguration
- avcSecurityGroups :: Lens' AWSVPCConfiguration [Text]
- avcAssignPublicIP :: Lens' AWSVPCConfiguration (Maybe AssignPublicIP)
- avcSubnets :: Lens' AWSVPCConfiguration [Text]
- data Attachment
- attachment :: Attachment
- aStatus :: Lens' Attachment (Maybe Text)
- aDetails :: Lens' Attachment [KeyValuePair]
- aId :: Lens' Attachment (Maybe Text)
- aType :: Lens' Attachment (Maybe Text)
- data AttachmentStateChange
- attachmentStateChange :: Text -> Text -> AttachmentStateChange
- ascAttachmentARN :: Lens' AttachmentStateChange Text
- ascStatus :: Lens' AttachmentStateChange Text
- 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)
- cStatistics :: Lens' Cluster [KeyValuePair]
- cActiveServicesCount :: Lens' Cluster (Maybe Int)
- data Container
- container :: Container
- cNetworkBindings :: Lens' Container [NetworkBinding]
- cContainerARN :: Lens' Container (Maybe Text)
- cNetworkInterfaces :: Lens' Container [NetworkInterface]
- 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)
- cHealthStatus :: Lens' Container (Maybe HealthStatus)
- data ContainerDefinition
- containerDefinition :: ContainerDefinition
- cdImage :: Lens' ContainerDefinition (Maybe Text)
- cdCommand :: Lens' ContainerDefinition [Text]
- cdHostname :: Lens' ContainerDefinition (Maybe Text)
- cdDockerSecurityOptions :: Lens' ContainerDefinition [Text]
- cdHealthCheck :: Lens' ContainerDefinition (Maybe HealthCheck)
- 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)
- ciAttachments :: Lens' ContainerInstance [Attachment]
- 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)
- csPlatformVersion :: Lens' ContainerService (Maybe Text)
- 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)
- csLaunchType :: Lens' ContainerService (Maybe LaunchType)
- csServiceARN :: Lens' ContainerService (Maybe Text)
- csTaskDefinition :: Lens' ContainerService (Maybe Text)
- csHealthCheckGracePeriodSeconds :: Lens' ContainerService (Maybe Int)
- csNetworkConfiguration :: Lens' ContainerService (Maybe NetworkConfiguration)
- csServiceRegistries :: Lens' ContainerService [ServiceRegistry]
- csRoleARN :: Lens' ContainerService (Maybe Text)
- csDeploymentConfiguration :: Lens' ContainerService (Maybe DeploymentConfiguration)
- data ContainerStateChange
- containerStateChange :: ContainerStateChange
- cscNetworkBindings :: Lens' ContainerStateChange [NetworkBinding]
- cscStatus :: Lens' ContainerStateChange (Maybe Text)
- cscContainerName :: Lens' ContainerStateChange (Maybe Text)
- cscReason :: Lens' ContainerStateChange (Maybe Text)
- cscExitCode :: Lens' ContainerStateChange (Maybe Int)
- data Deployment
- deployment :: Deployment
- dRunningCount :: Lens' Deployment (Maybe Int)
- dStatus :: Lens' Deployment (Maybe Text)
- dCreatedAt :: Lens' Deployment (Maybe UTCTime)
- dPlatformVersion :: Lens' Deployment (Maybe Text)
- dDesiredCount :: Lens' Deployment (Maybe Int)
- dPendingCount :: Lens' Deployment (Maybe Int)
- dId :: Lens' Deployment (Maybe Text)
- dLaunchType :: Lens' Deployment (Maybe LaunchType)
- dUpdatedAt :: Lens' Deployment (Maybe UTCTime)
- dTaskDefinition :: Lens' Deployment (Maybe Text)
- dNetworkConfiguration :: Lens' Deployment (Maybe NetworkConfiguration)
- 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 HealthCheck
- healthCheck :: HealthCheck
- hcStartPeriod :: Lens' HealthCheck (Maybe Int)
- hcRetries :: Lens' HealthCheck (Maybe Int)
- hcInterval :: Lens' HealthCheck (Maybe Int)
- hcTimeout :: Lens' HealthCheck (Maybe Int)
- hcCommand :: Lens' HealthCheck [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
- lpSharedMemorySize :: Lens' LinuxParameters (Maybe Int)
- lpInitProcessEnabled :: Lens' LinuxParameters (Maybe Bool)
- lpTmpfs :: Lens' LinuxParameters [Tmpfs]
- 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 NetworkConfiguration
- networkConfiguration :: NetworkConfiguration
- ncAwsvpcConfiguration :: Lens' NetworkConfiguration (Maybe AWSVPCConfiguration)
- data NetworkInterface
- networkInterface :: NetworkInterface
- niIpv6Address :: Lens' NetworkInterface (Maybe Text)
- niPrivateIPv4Address :: Lens' NetworkInterface (Maybe Text)
- niAttachmentId :: Lens' NetworkInterface (Maybe Text)
- 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 ServiceRegistry
- serviceRegistry :: ServiceRegistry
- srRegistryARN :: Lens' ServiceRegistry (Maybe Text)
- srPort :: Lens' ServiceRegistry (Maybe Int)
- 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)
- tAttachments :: Lens' Task [Attachment]
- tCreatedAt :: Lens' Task (Maybe UTCTime)
- tPlatformVersion :: Lens' Task (Maybe Text)
- tTaskARN :: Lens' Task (Maybe Text)
- tContainerInstanceARN :: Lens' Task (Maybe Text)
- tExecutionStoppedAt :: Lens' Task (Maybe UTCTime)
- tLastStatus :: Lens' Task (Maybe Text)
- tMemory :: Lens' Task (Maybe Text)
- tPullStoppedAt :: Lens' Task (Maybe UTCTime)
- tContainers :: Lens' Task [Container]
- tStartedAt :: Lens' Task (Maybe UTCTime)
- tVersion :: Lens' Task (Maybe Integer)
- tStartedBy :: Lens' Task (Maybe Text)
- tStoppedReason :: Lens' Task (Maybe Text)
- tConnectivity :: Lens' Task (Maybe Connectivity)
- tStoppingAt :: Lens' Task (Maybe UTCTime)
- tLaunchType :: Lens' Task (Maybe LaunchType)
- tTaskDefinitionARN :: Lens' Task (Maybe Text)
- tHealthStatus :: Lens' Task (Maybe HealthStatus)
- tConnectivityAt :: Lens' Task (Maybe UTCTime)
- tCpu :: Lens' Task (Maybe Text)
- tPullStartedAt :: Lens' Task (Maybe UTCTime)
- data TaskDefinition
- taskDefinition :: TaskDefinition
- tdStatus :: Lens' TaskDefinition (Maybe TaskDefinitionStatus)
- tdExecutionRoleARN :: Lens' TaskDefinition (Maybe Text)
- tdRequiresCompatibilities :: Lens' TaskDefinition [Compatibility]
- tdFamily :: Lens' TaskDefinition (Maybe Text)
- tdContainerDefinitions :: Lens' TaskDefinition [ContainerDefinition]
- tdMemory :: Lens' TaskDefinition (Maybe Text)
- tdTaskRoleARN :: Lens' TaskDefinition (Maybe Text)
- tdPlacementConstraints :: Lens' TaskDefinition [TaskDefinitionPlacementConstraint]
- tdNetworkMode :: Lens' TaskDefinition (Maybe NetworkMode)
- tdTaskDefinitionARN :: Lens' TaskDefinition (Maybe Text)
- tdCompatibilities :: Lens' TaskDefinition [Compatibility]
- tdRevision :: Lens' TaskDefinition (Maybe Int)
- tdVolumes :: Lens' TaskDefinition [Volume]
- tdCpu :: Lens' TaskDefinition (Maybe Text)
- 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]
- toExecutionRoleARN :: Lens' TaskOverride (Maybe Text)
- toTaskRoleARN :: Lens' TaskOverride (Maybe Text)
- data Tmpfs
- tmpfs :: Text -> Int -> Tmpfs
- tMountOptions :: Lens' Tmpfs [Text]
- tContainerPath :: Lens' Tmpfs Text
- tSize :: Lens' Tmpfs Int
- 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
Errors
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError #
You do not have authorization to perform the requested action.
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified parameter is invalid. Review the available parameters for the API request.
_ServerException :: AsError a => Getting (First ServiceError) a ServiceError #
These errors are usually caused by a server issue.
_ClusterContainsTasksException :: AsError a => Getting (First ServiceError) a ServiceError #
You cannot delete a cluster that has active tasks.
_PlatformUnknownException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified platform version does not exist.
_ClusterContainsServicesException :: AsError a => Getting (First ServiceError) a ServiceError #
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 :: AsError a => Getting (First ServiceError) a ServiceError #
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 :: AsError a => Getting (First ServiceError) a ServiceError #
The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService .
_ClusterNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified cluster could not be found. You can view your available clusters with ListClusters . Amazon ECS clusters are region-specific.
_NoUpdateAvailableException :: AsError a => Getting (First ServiceError) a ServiceError #
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.
_UnsupportedFeatureException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified task is not supported in this region.
_ServiceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified service could not be found. You can view your available services with ListServices . Amazon ECS services are cluster-specific and region-specific.
_PlatformTaskDefinitionIncompatibilityException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified platform version does not satisfy the task definition’s required capabilities.
_MissingVersionException :: AsError a => Getting (First ServiceError) a ServiceError #
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 :: AsError a => Getting (First ServiceError) a ServiceError #
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.
_BlockedException :: AsError a => Getting (First ServiceError) a ServiceError #
Your AWS account has been blocked. Contact AWS Support for more information.
_TargetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
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 :: AsError a => Getting (First ServiceError) a ServiceError #
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 :: AsError a => Getting (First ServiceError) a ServiceError #
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 permissions to use the action or resource, or specifying an identifier that is not valid.
AgentUpdateStatus
data AgentUpdateStatus #
Constructors
| AUSFailed | |
| AUSPending | |
| AUSStaged | |
| AUSStaging | |
| AUSUpdated | |
| AUSUpdating |
Instances
AssignPublicIP
data AssignPublicIP #
Instances
ClusterField
data ClusterField #
Constructors
| Statistics |
Instances
Compatibility
data Compatibility #
Instances
Connectivity
data Connectivity #
Constructors
| Connected | |
| Disconnected |
Instances
ContainerInstanceStatus
data ContainerInstanceStatus #
Instances
DesiredStatus
data DesiredStatus #
Instances
DeviceCgroupPermission
data DeviceCgroupPermission #
Instances
HealthStatus
data HealthStatus #
Instances
LaunchType
data LaunchType #
Instances
LogDriver
Instances
NetworkMode
data NetworkMode #
Instances
PlacementConstraintType
data PlacementConstraintType #
Constructors
| PCTDistinctInstance | |
| PCTMemberOf |
Instances
PlacementStrategyType
data PlacementStrategyType #
Instances
SortOrder
Instances
TargetType
data TargetType #
Constructors
| ContainerInstance |
Instances
TaskDefinitionFamilyStatus
data TaskDefinitionFamilyStatus #
Constructors
| TDFSActive | |
| TDFSAll | |
| TDFSInactive |
Instances
TaskDefinitionPlacementConstraintType
data TaskDefinitionPlacementConstraintType #
Constructors
| MemberOf |
Instances
TaskDefinitionStatus
data TaskDefinitionStatus #
Constructors
| TDSActive | |
| TDSInactive |
Instances
TransportProtocol
data TransportProtocol #
Instances
UlimitName
data UlimitName #
Constructors
| CPU | |
| Core | |
| Data | |
| Fsize | |
| Locks | |
| Memlock | |
| Msgqueue | |
| Nice | |
| Nofile | |
| Nproc | |
| Rss | |
| Rtprio | |
| Rttime | |
| Sigpending | |
| Stack |
Instances
AWSVPCConfiguration
data AWSVPCConfiguration #
An object representing the networking details for a task or service.
See: awsVPCConfiguration smart constructor.
awsVPCConfiguration :: AWSVPCConfiguration #
Creates a value of AWSVPCConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
avcSecurityGroups- The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups able to be specified per AwsVpcConfiguration.avcAssignPublicIP- Whether the task's elastic network interface receives a public IP address.avcSubnets- The subnets associated with the task or service. There is a limit of 10 subnets able to be specified per AwsVpcConfiguration.
avcSecurityGroups :: Lens' AWSVPCConfiguration [Text] #
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups able to be specified per AwsVpcConfiguration.
avcAssignPublicIP :: Lens' AWSVPCConfiguration (Maybe AssignPublicIP) #
Whether the task's elastic network interface receives a public IP address.
avcSubnets :: Lens' AWSVPCConfiguration [Text] #
The subnets associated with the task or service. There is a limit of 10 subnets able to be specified per AwsVpcConfiguration.
Attachment
data Attachment #
An object representing a container instance or task attachment.
See: attachment smart constructor.
Instances
Creates a value of Attachment with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aStatus- The status of the attachment. Valid values arePRECREATED,CREATED,ATTACHING,ATTACHED,DETACHING,DETACHED, andDELETED.aDetails- Details of the attachment. For Elastic Network Interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.aId- The unique identifier for the attachment.aType- The type of the attachment, such asElasticNetworkInterface.
aStatus :: Lens' Attachment (Maybe Text) #
The status of the attachment. Valid values are PRECREATED , CREATED , ATTACHING , ATTACHED , DETACHING , DETACHED , and DELETED .
aDetails :: Lens' Attachment [KeyValuePair] #
Details of the attachment. For Elastic Network Interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
aType :: Lens' Attachment (Maybe Text) #
The type of the attachment, such as ElasticNetworkInterface .
AttachmentStateChange
data AttachmentStateChange #
An object representing a change in state for a task attachment.
See: attachmentStateChange smart constructor.
Arguments
| :: Text | |
| -> Text | |
| -> AttachmentStateChange |
Creates a value of AttachmentStateChange with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ascAttachmentARN- The Amazon Resource Name (ARN) of the attachment.ascStatus- The status of the attachment.
ascAttachmentARN :: Lens' AttachmentStateChange Text #
The Amazon Resource Name (ARN) of the attachment.
ascStatus :: Lens' AttachmentStateChange Text #
The status of the attachment.
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 Elastic 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 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) #
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) #
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) #
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 ARN.
aName :: Lens' Attribute Text #
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.cStatistics- Additional information about your clusters that are separated by launch type, including: * runningEC2TasksCount * RunningFargateTasksCount * pendingEC2TasksCount * pendingFargateTasksCount * activeEC2ServiceCount * activeFargateServiceCount * drainingEC2ServiceCount * drainingFargateServiceCountcActiveServicesCount- The number of services that are running on the cluster in anACTIVEstate. You can view these services withListServices.
cStatus :: Lens' Cluster (Maybe Text) #
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) #
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) #
The number of tasks in the cluster that are in the RUNNING state.
cRegisteredContainerInstancesCount :: Lens' Cluster (Maybe Int) #
The number of container instances registered into the cluster.
cPendingTasksCount :: Lens' Cluster (Maybe Int) #
The number of tasks in the cluster that are in the PENDING state.
cClusterName :: Lens' Cluster (Maybe Text) #
A user-generated string that you use to identify your cluster.
cStatistics :: Lens' Cluster [KeyValuePair] #
Additional information about your clusters that are separated by launch type, including: * runningEC2TasksCount * RunningFargateTasksCount * pendingEC2TasksCount * pendingFargateTasksCount * activeEC2ServiceCount * activeFargateServiceCount * drainingEC2ServiceCount * drainingFargateServiceCount
cActiveServicesCount :: Lens' Cluster (Maybe Int) #
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.
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.cNetworkInterfaces- The network interfaces associated with the container.cTaskARN- The 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.cHealthStatus- The health status of the container. If health checks are not configured for this container in its task definition, then it reports health status asUNKNOWN.
cNetworkBindings :: Lens' Container [NetworkBinding] #
The network bindings associated with the container.
cNetworkInterfaces :: Lens' Container [NetworkInterface] #
The network interfaces associated with the container.
cReason :: Lens' Container (Maybe Text) #
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
cHealthStatus :: Lens' Container (Maybe HealthStatus) #
The health status of the container. If health checks are not configured for this container in its task definition, then it reports health status as UNKNOWN .
ContainerDefinition
data ContainerDefinition #
Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
See: containerDefinition smart constructor.
containerDefinition :: ContainerDefinition #
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 . * When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks. * 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 field is not valid for containers in tasks using the Fargate launch type. This parameter maps toSecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run .cdHealthCheck- The health check command and associated configuration parameters for the container. This parameter maps toHealthCheckin the Create a container section of the Docker Remote API and theHEALTHCHECKparameter of 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 plaintext 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 in to 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. For task definitions that use theawsvpcnetwork mode, you should only specify thecontainerPort. ThehostPortcan be left blank or it must be the same value as thecontainerPort. Port mappings on Windows use theNetNATgateway address rather thanlocalhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. 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 can't 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 in to 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. If using the Fargate launch type, this may be used to list non-Fargate hosts you want the container to talk to. 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 . If your containers are part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of memory reserved for all containers within a task be lower than the taskmemoryvalue. For containers that are part of a task using the EC2 launch type, 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. If using the Fargate launch type, the only supported value isawslogs. 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 in to 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 . Windows containers can mount whole directories on the same drive as> env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.cdLinks- Thelinkparameter allows containers to communicate with each other without the need for port mappings. Only supported if the network mode of a task definition is set tobridge. Thename:internalNameconstruct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. For more information about linking Docker containers, go to 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 Elastic Container Service Developer Guide .cdCpu- The number ofcpuunits reserved for the container. This parameter maps toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption to docker run . This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-levelcpuvalue. 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. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. 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. On Linux container instances, 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. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.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. 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.
cdImage :: Lens' ContainerDefinition (Maybe Text) #
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 . * When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks. * 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] #
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) #
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] #
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type. This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run .
cdHealthCheck :: Lens' ContainerDefinition (Maybe HealthCheck) #
The health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run .
cdDisableNetworking :: Lens' ContainerDefinition (Maybe Bool) #
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] #
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] #
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 plaintext environment variables for sensitive information, such as credential data.
cdEntryPoint :: Lens' ContainerDefinition [Text] #
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) #
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] #
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 in to your container instance and run the following command: sudo docker version | grep "Server API version"
cdPrivileged :: Lens' ContainerDefinition (Maybe Bool) #
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] #
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. For task definitions that use the awsvpc network mode, you should only specify the containerPort . The hostPort can be left blank or it must be the same value as the containerPort . Port mappings on Windows use the NetNAT gateway address rather than localhost . There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. 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 can't 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) #
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 in to your container instance and run the following command: sudo docker version | grep "Server API version"
cdExtraHosts :: Lens' ContainerDefinition [HostEntry] #
A list of hostnames and IP address mappings to append to the etchosts file on the container. If using the Fargate launch type, this may be used to list non-Fargate hosts you want the container to talk to. 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) #
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 . If your containers are part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of memory reserved for all containers within a task be lower than the task memory value. For containers that are part of a task using the EC2 launch type, 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) #
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] #
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) #
The log configuration specification for the container. If using the Fargate launch type, the only supported value is awslogs . 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 in to your container instance and run the following command: sudo docker version | grep "Server API version"
cdLinuxParameters :: Lens' ContainerDefinition (Maybe LinuxParameters) #
Linux-specific modifications that are applied to the container, such as Linux KernelCapabilities .
cdName :: Lens' ContainerDefinition (Maybe Text) #
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] #
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] #
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 . Windows containers can mount whole directories on the same drive as > env:ProgramData . Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.
cdLinks :: Lens' ContainerDefinition [Text] #
The link parameter allows containers to communicate with each other without the need for port mappings. Only supported if the network mode of a task definition is set to bridge . The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. For more information about linking Docker containers, go to 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) #
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) #
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 Elastic Container Service Developer Guide .
cdCpu :: Lens' ContainerDefinition (Maybe Int) #
The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run . This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value. 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. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. 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. On Linux container instances, 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. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.
cdMemoryReservation :: Lens' ContainerDefinition (Maybe Int) #
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. 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.
ContainerInstance
data ContainerInstance #
An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
See: containerInstance smart constructor.
containerInstance :: ContainerInstance #
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 Elastic Container Service Developer Guide .ciAttachments- The Elastic Network Interfaces associated with the container instance.ciRunningTasksCount- The number of tasks on the container instance that are in theRUNNINGstatus.ciRemainingResources- For CPU and memory resource types, this parameter describes the remaining CPU and memory on the that has not already been allocated to tasks (and is therefore available for new tasks). For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with thehostorbridgenetwork mode). 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 connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped returnfalse. Instances without a connected agent can't 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 time stamp for when the container instance was registered.ciRegisteredResources- For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS; this value represents the total amount of CPU and memory that can be allocated on this container instance to 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) #
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 Elastic Container Service Developer Guide .
ciAttachments :: Lens' ContainerInstance [Attachment] #
The Elastic Network Interfaces associated with the container instance.
ciRunningTasksCount :: Lens' ContainerInstance (Maybe Int) #
The number of tasks on the container instance that are in the RUNNING status.
ciRemainingResources :: Lens' ContainerInstance [Resource] #
For CPU and memory resource types, this parameter describes the remaining CPU and memory on the that has not already been allocated to tasks (and is therefore available for new tasks). For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that is not specified here is available for new tasks.
ciEc2InstanceId :: Lens' ContainerInstance (Maybe Text) #
The EC2 instance ID of the container instance.
ciContainerInstanceARN :: Lens' ContainerInstance (Maybe Text) #
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) #
This parameter returns true if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false . Instances without a connected agent can't accept placement requests.
ciVersionInfo :: Lens' ContainerInstance (Maybe VersionInfo) #
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
ciAgentUpdateStatus :: Lens' ContainerInstance (Maybe AgentUpdateStatus) #
The status of the most recent agent update. If an update has never been requested, this value is NULL .
ciAttributes :: Lens' ContainerInstance [Attribute] #
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) #
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) #
The number of tasks on the container instance that are in the PENDING status.
ciRegisteredAt :: Lens' ContainerInstance (Maybe UTCTime) #
The Unix time stamp for when the container instance was registered.
ciRegisteredResources :: Lens' ContainerInstance [Resource] #
For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS; this value represents the total amount of CPU and memory that can be allocated on this container instance to 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 #
The overrides that should be sent to a container.
See: containerOverride smart constructor.
containerOverride :: ContainerOverride #
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] #
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] #
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) #
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) #
The name of the container that receives the override. This parameter is required if any override is specified.
coCpu :: Lens' ContainerOverride (Maybe Int) #
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) #
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 #
Details on a service within a cluster
See: containerService smart constructor.
containerService :: ContainerService #
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 time stamp for when the service was created.csPlatformVersion- The platform version on which your task is running. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .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.csLaunchType- The launch type on which your service is running.csServiceARN- The 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.csHealthCheckGracePeriodSeconds- The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.csNetworkConfiguration- The VPC subnet and security group configuration for tasks that receive their own Elastic Network Interface by using theawsvpcnetworking mode.csServiceRegistries-csRoleARN- The 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) #
The number of tasks in the cluster that are in the RUNNING state.
csStatus :: Lens' ContainerService (Maybe Text) #
The status of the service. The valid values are ACTIVE , DRAINING , or INACTIVE .
csClusterARN :: Lens' ContainerService (Maybe Text) #
The Amazon Resource Name (ARN) of the cluster that hosts the service.
csCreatedAt :: Lens' ContainerService (Maybe UTCTime) #
The Unix time stamp for when the service was created.
csPlatformVersion :: Lens' ContainerService (Maybe Text) #
The platform version on which your task is running. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
csDesiredCount :: Lens' ContainerService (Maybe Int) #
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] #
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) #
The number of tasks in the cluster that are in the PENDING state.
csPlacementConstraints :: Lens' ContainerService [PlacementConstraint] #
The placement constraints for the tasks in the service.
csEvents :: Lens' ContainerService [ServiceEvent] #
The event stream for your service. A maximum of 100 of the latest events are displayed.
csPlacementStrategy :: Lens' ContainerService [PlacementStrategy] #
The placement strategy that determines how tasks for the service are placed.
csDeployments :: Lens' ContainerService [Deployment] #
The current state of deployments for the service.
csServiceName :: Lens' ContainerService (Maybe Text) #
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.
csLaunchType :: Lens' ContainerService (Maybe LaunchType) #
The launch type on which your service is running.
csServiceARN :: Lens' ContainerService (Maybe Text) #
The 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) #
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 .
csHealthCheckGracePeriodSeconds :: Lens' ContainerService (Maybe Int) #
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
csNetworkConfiguration :: Lens' ContainerService (Maybe NetworkConfiguration) #
The VPC subnet and security group configuration for tasks that receive their own Elastic Network Interface by using the awsvpc networking mode.
csRoleARN :: Lens' ContainerService (Maybe Text) #
The 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) #
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
ContainerStateChange
data ContainerStateChange #
An object representing a change in state for a container.
See: containerStateChange smart constructor.
containerStateChange :: ContainerStateChange #
Creates a value of ContainerStateChange with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cscNetworkBindings- Any network bindings associated with the container.cscStatus- The status of the container.cscContainerName- The name of the container.cscReason- The reason for the state change.cscExitCode- The exit code for the container, if the state change is a result of the container exiting.
cscNetworkBindings :: Lens' ContainerStateChange [NetworkBinding] #
Any network bindings associated with the container.
cscContainerName :: Lens' ContainerStateChange (Maybe Text) #
The name of the container.
cscExitCode :: Lens' ContainerStateChange (Maybe Int) #
The exit code for the container, if the state change is a result of the container exiting.
Deployment
data Deployment #
The details of an Amazon ECS service deployment.
See: deployment smart constructor.
Instances
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 time stamp for when the service was created.dPlatformVersion- The platform version on which your service is running.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.dLaunchType- The launch type on which your service is running.dUpdatedAt- The Unix time stamp for when the service was last updated.dTaskDefinition- The most recent task definition that was specified for the service to use.dNetworkConfiguration- The VPC subnet and security group configuration for tasks that receive their own Elastic Network Interface by using theawsvpcnetworking mode.
dRunningCount :: Lens' Deployment (Maybe Int) #
The number of tasks in the deployment that are in the RUNNING status.
dStatus :: Lens' Deployment (Maybe Text) #
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) #
The Unix time stamp for when the service was created.
dPlatformVersion :: Lens' Deployment (Maybe Text) #
The platform version on which your service is running.
dDesiredCount :: Lens' Deployment (Maybe Int) #
The most recent desired count of tasks that was specified for the service to deploy or maintain.
dPendingCount :: Lens' Deployment (Maybe Int) #
The number of tasks in the deployment that are in the PENDING status.
dLaunchType :: Lens' Deployment (Maybe LaunchType) #
The launch type on which your service is running.
dUpdatedAt :: Lens' Deployment (Maybe UTCTime) #
The Unix time stamp for when the service was last updated.
dTaskDefinition :: Lens' Deployment (Maybe Text) #
The most recent task definition that was specified for the service to use.
dNetworkConfiguration :: Lens' Deployment (Maybe NetworkConfiguration) #
The VPC subnet and security group configuration for tasks that receive their own Elastic Network Interface by using the awsvpc networking mode.
DeploymentConfiguration
data DeploymentConfiguration #
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 #
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 number of 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) #
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 number of healthy tasks during a deployment is the desiredCount multiplied by minimumHealthyPercent /100, rounded up to the nearest integer value.
dcMaximumPercent :: Lens' DeploymentConfiguration (Maybe Int) #
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 has permissions forread,write, andmknodfor the device.dHostPath- The path for the device on the host container instance.
dContainerPath :: Lens' Device (Maybe Text) #
The path inside the container at which to expose the host device.
dPermissions :: Lens' Device [DeviceCgroupPermission] #
The explicit permissions to provide to the container for the device. By default, the container has permissions for read , write , and mknod for the device.
Failure
A failed resource.
See: failure smart constructor.
HealthCheck
data HealthCheck #
An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).
See: healthCheck smart constructor.
Instances
Creates a value of HealthCheck with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hcStartPeriod- The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. ThestartPeriodis disabled by default.hcRetries- The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3 retries.hcInterval- The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.hcTimeout- The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5 seconds.hcCommand- A string array representing the command that the container runs to determine if it is healthy. The string array must start withCMDto execute the command arguments directly, orCMD-SHELLto run the command with the container's default shell. For example:[ CMD-SHELL, "curl -f http://localhost/ || exit 1" ]An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, seeHealthCheckin the Create a container section of the Docker Remote API .
hcStartPeriod :: Lens' HealthCheck (Maybe Int) #
The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default.
hcRetries :: Lens' HealthCheck (Maybe Int) #
The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3 retries.
hcInterval :: Lens' HealthCheck (Maybe Int) #
The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
hcTimeout :: Lens' HealthCheck (Maybe Int) #
The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5 seconds.
hcCommand :: Lens' HealthCheck [Text] #
A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute the command arguments directly, or CMD-SHELL to run the command with the container's default shell. For example: [ CMD-SHELL, "curl -f http://localhost/ || exit 1" ] An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API .
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.
heHostname :: Lens' HostEntry Text #
The hostname to use in the etchosts entry.
heIpAddress :: Lens' HostEntry Text #
The IP address to use in the etchosts entry.
HostVolumeProperties
data HostVolumeProperties #
Details on a container instance host volume.
See: hostVolumeProperties smart constructor.
Instances
hostVolumeProperties :: HostVolumeProperties #
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. If you are using the Fargate launch type, thesourcePathparameter is not supported.
hvpSourcePath :: Lens' HostVolumeProperties (Maybe Text) #
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. If you are using the Fargate launch type, the sourcePath parameter is not supported.
KernelCapabilities
data KernelCapabilities #
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.
kernelCapabilities :: KernelCapabilities #
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] #
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] #
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 #
A key and value pair object.
See: keyValuePair smart constructor.
keyValuePair :: KeyValuePair #
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) #
The value of the key value pair. For environment variables, this is the value of the environment variable.
kvpName :: Lens' KeyValuePair (Maybe Text) #
The name of the key value pair. For environment variables, this is the name of the environment variable.
LinuxParameters
data LinuxParameters #
Linux-specific options that are applied to the container, such as Linux KernelCapabilities .
See: linuxParameters smart constructor.
linuxParameters :: LinuxParameters #
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:
lpSharedMemorySize- The value for the size of thedevshmvolume. This parameter maps to the--shm-sizeoption to docker run .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 in to your container instance and run the following command:sudo docker version | grep "Server API version"lpTmpfs- The container path, mount options, and size of the tmpfs mount. This parameter maps to the--tmpfsoption to docker run .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.
lpSharedMemorySize :: Lens' LinuxParameters (Maybe Int) #
The value for the size of the devshm volume. This parameter maps to the --shm-size option to docker run .
lpInitProcessEnabled :: Lens' LinuxParameters (Maybe Bool) #
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 in to your container instance and run the following command: sudo docker version | grep "Server API version"
lpTmpfs :: Lens' LinuxParameters [Tmpfs] #
The container path, mount options, and size of the tmpfs mount. This parameter maps to the --tmpfs option to docker run .
lpDevices :: Lens' LinuxParameters [Device] #
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) #
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
LoadBalancer
data LoadBalancer #
Details on a load balancer that is used with a service.
See: loadBalancer smart constructor.
loadBalancer :: LoadBalancer #
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) #
The name of a load balancer.
lbContainerName :: Lens' LoadBalancer (Maybe Text) #
The name of the container (as it appears in a container definition) to associate with the load balancer.
lbTargetGroupARN :: Lens' LoadBalancer (Maybe Text) #
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.
lbContainerPort :: Lens' LoadBalancer (Maybe Int) #
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 #
Log configuration options to send to a custom log driver for the container.
See: logConfiguration smart constructor.
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 in to 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. If using the Fargate launch type, the only supported value isawslogs. For more information about using theawslogsdriver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide . 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 in to your container instance and run the following command:sudo docker version | grep "Server API version"
lcOptions :: Lens' LogConfiguration (HashMap Text Text) #
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 in to your container instance and run the following command: sudo docker version | grep "Server API version"
lcLogDriver :: Lens' LogConfiguration LogDriver #
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. If using the Fargate launch type, the only supported value is awslogs . For more information about using the awslogs driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide . 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 in to your container instance and run the following command: sudo docker version | grep "Server API version"
MountPoint
data MountPoint #
Details on a volume mount point that is used in a container definition.
See: mountPoint smart constructor.
Instances
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) #
The path on the container to mount the host volume at.
mpSourceVolume :: Lens' MountPoint (Maybe Text) #
The name of the volume to mount.
mpReadOnly :: Lens' MountPoint (Maybe Bool) #
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 #
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.
networkBinding :: NetworkBinding #
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 used with the network binding.
nbBindIP :: Lens' NetworkBinding (Maybe Text) #
The IP address that the container is bound to on the container instance.
nbProtocol :: Lens' NetworkBinding (Maybe TransportProtocol) #
The protocol used for the network binding.
nbHostPort :: Lens' NetworkBinding (Maybe Int) #
The port number on the host that is used with the network binding.
nbContainerPort :: Lens' NetworkBinding (Maybe Int) #
The port number on the container that is used with the network binding.
NetworkConfiguration
data NetworkConfiguration #
An object representing the network configuration for a task or service.
See: networkConfiguration smart constructor.
Instances
networkConfiguration :: NetworkConfiguration #
Creates a value of NetworkConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ncAwsvpcConfiguration- The VPC subnets and security groups associated with a task.
ncAwsvpcConfiguration :: Lens' NetworkConfiguration (Maybe AWSVPCConfiguration) #
The VPC subnets and security groups associated with a task.
NetworkInterface
data NetworkInterface #
An object representing the Elastic Network Interface for tasks that use the awsvpc network mode.
See: networkInterface smart constructor.
networkInterface :: NetworkInterface #
Creates a value of NetworkInterface with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
niIpv6Address- The private IPv6 address for the network interface.niPrivateIPv4Address- The private IPv4 address for the network interface.niAttachmentId- The attachment ID for the network interface.
niIpv6Address :: Lens' NetworkInterface (Maybe Text) #
The private IPv6 address for the network interface.
niPrivateIPv4Address :: Lens' NetworkInterface (Maybe Text) #
The private IPv4 address for the network interface.
niAttachmentId :: Lens' NetworkInterface (Maybe Text) #
The attachment ID for the network interface.
PlacementConstraint
data PlacementConstraint #
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide .
See: placementConstraint smart constructor.
placementConstraint :: PlacementConstraint #
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 Elastic 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 the selection to a group of valid candidates. The valuedistinctInstanceis not supported in task definitions.
pcExpression :: Lens' PlacementConstraint (Maybe Text) #
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 Elastic Container Service Developer Guide .
pcType :: Lens' PlacementConstraint (Maybe PlacementConstraintType) #
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 the selection to a group of valid candidates. The value distinctInstance is not supported in task definitions.
PlacementStrategy
data PlacementStrategy #
The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide .
See: placementStrategy smart constructor.
placementStrategy :: PlacementStrategy #
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) #
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) #
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 #
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.
If using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort . The hostPort can be left blank or it must be the same value as the containerPort .
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.
Instances
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. If using containers in a task with theawsvpcorhostnetwork mode, thehostPortcan either be left blank or set to the same value as thecontainerPort. If using containers in a task with thebridgenetwork mode, 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 from 49153 through 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 using containers in a task with theawsvpcorhostnetwork mode, exposed ports should be specified usingcontainerPort. If using containers in a task with thebridgenetwork mode and 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) #
The protocol used for the port mapping. Valid values are tcp and udp . The default is tcp .
pmHostPort :: Lens' PortMapping (Maybe Int) #
The port number on the container instance to reserve for your container. If using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort . If using containers in a task with the bridge network mode, 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 from 49153 through 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) #
The port number on the container that is bound to the user-specified or automatically assigned host port. If using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort . If using containers in a task with the bridge network mode and 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] #
When the stringSetValue type is set, the value of the resource must be a string type.
rIntegerValue :: Lens' Resource (Maybe Int) #
When the integerValue type is set, the value of the resource must be an integer.
rDoubleValue :: Lens' Resource (Maybe Double) #
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
rLongValue :: Lens' Resource (Maybe Integer) #
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
rName :: Lens' Resource (Maybe Text) #
The name of the resource, such as cpu , memory , ports , or a user-defined resource.
rType :: Lens' Resource (Maybe Text) #
The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .
ServiceEvent
data ServiceEvent #
Details on an event associated with a service.
See: serviceEvent smart constructor.
Instances
serviceEvent :: ServiceEvent #
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 time stamp for when the event was triggered.seId- The ID string of the event.seMessage- The event message.
seCreatedAt :: Lens' ServiceEvent (Maybe UTCTime) #
The Unix time stamp for when the event was triggered.
ServiceRegistry
data ServiceRegistry #
Details of the service registry.
See: serviceRegistry smart constructor.
serviceRegistry :: ServiceRegistry #
Creates a value of ServiceRegistry with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srRegistryARN- The Amazon Resource Name (ARN) of the Service Registry. The currently supported service registry is Amazon Route 53 Auto Naming Service. For more information, see Service .srPort- The port value used if your Service Discovery service specified an SRV record.
srRegistryARN :: Lens' ServiceRegistry (Maybe Text) #
The Amazon Resource Name (ARN) of the Service Registry. The currently supported service registry is Amazon Route 53 Auto Naming Service. For more information, see Service .
srPort :: Lens' ServiceRegistry (Maybe Int) #
The port value used if your Service Discovery service specified an SRV record.
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 time stamp 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 ARN of the cluster that hosts the task.tGroup- The name of the task group associated with the task.tAttachments- The Elastic Network Adapter associated with the task if the task uses theawsvpcnetwork mode.tCreatedAt- The Unix time stamp for when the task was created (the task entered thePENDINGstate).tPlatformVersion- The platform version on which your task is running. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .tTaskARN- The Amazon Resource Name (ARN) of the task.tContainerInstanceARN- The ARN of the container instances that host the task.tExecutionStoppedAt- The Unix time stamp for when the task execution stopped.tLastStatus- The last known status of the task.tMemory- The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example1024, or as a string using GB, for example1GBor1 GB, in a task definition but is converted to an integer indicating the MiB when the task definition is registered. If using the EC2 launch type, this field is optional. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for thecpuparameter: * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Availablecpuvalues: 256 (.25 vCPU) * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Availablecpuvalues: 512 (.5 vCPU) * 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Availablecpuvalues: 1024 (1 vCPU) * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 2048 (2 vCPU) * Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 4096 (4 vCPU)tPullStoppedAt- The Unix time stamp for when the container image pull completed.tContainers- The containers associated with the task.tStartedAt- The Unix time stamp for when the task 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.tConnectivity- The connectivity status of a task.tStoppingAt- The Unix time stamp for when the task will stop (transitions from theRUNNINGstate toSTOPPED).tLaunchType- The launch type on which your task is running.tTaskDefinitionARN- The ARN of the task definition that creates the task.tHealthStatus- The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting asHEALTHY, then the task status also reports asHEALTHY. If any essential containers in the task are reporting asUNHEALTHYorUNKNOWN, then the task status also reports asUNHEALTHYorUNKNOWN, accordingly.tConnectivityAt- The Unix time stamp for when the task last went intoCONNECTEDstatus.tCpu- The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example1024, or as a string using vCPUs, for example1 vCPUor1 vcpu, in a task definition but is converted to an integer indicating the CPU units when the task definition is registered. If using the EC2 launch type, this field is optional. Supported values are between128CPU units (0.125vCPUs) and10240CPU units (10vCPUs). If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for thememoryparameter: * 256 (.25 vCPU) - Availablememoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) * 512 (.5 vCPU) - Availablememoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) * 1024 (1 vCPU) - Availablememoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) * 2048 (2 vCPU) - Availablememoryvalues: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) * 4096 (4 vCPU) - Availablememoryvalues: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)tPullStartedAt- The Unix time stamp for when the container image pull began.
tStoppedAt :: Lens' Task (Maybe UTCTime) #
The Unix time stamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
tOverrides :: Lens' Task (Maybe TaskOverride) #
One or more container overrides.
tAttachments :: Lens' Task [Attachment] #
The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
tCreatedAt :: Lens' Task (Maybe UTCTime) #
The Unix time stamp for when the task was created (the task entered the PENDING state).
tPlatformVersion :: Lens' Task (Maybe Text) #
The platform version on which your task is running. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
tContainerInstanceARN :: Lens' Task (Maybe Text) #
The ARN of the container instances that host the task.
tExecutionStoppedAt :: Lens' Task (Maybe UTCTime) #
The Unix time stamp for when the task execution stopped.
tMemory :: Lens' Task (Maybe Text) #
The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example 1024 , or as a string using GB, for example 1GB or 1 GB , in a task definition but is converted to an integer indicating the MiB when the task definition is registered. If using the EC2 launch type, this field is optional. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter: * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU) * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU) * 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU) * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU) * Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
tPullStoppedAt :: Lens' Task (Maybe UTCTime) #
The Unix time stamp for when the container image pull completed.
tContainers :: Lens' Task [Container] #
The containers associated with the task.
tStartedAt :: Lens' Task (Maybe UTCTime) #
The Unix time stamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
tVersion :: Lens' Task (Maybe Integer) #
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) #
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.
tConnectivity :: Lens' Task (Maybe Connectivity) #
The connectivity status of a task.
tStoppingAt :: Lens' Task (Maybe UTCTime) #
The Unix time stamp for when the task will stop (transitions from the RUNNING state to STOPPED ).
tLaunchType :: Lens' Task (Maybe LaunchType) #
The launch type on which your task is running.
tTaskDefinitionARN :: Lens' Task (Maybe Text) #
The ARN of the task definition that creates the task.
tHealthStatus :: Lens' Task (Maybe HealthStatus) #
The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY , then the task status also reports as HEALTHY . If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN , then the task status also reports as UNHEALTHY or UNKNOWN , accordingly.
tConnectivityAt :: Lens' Task (Maybe UTCTime) #
The Unix time stamp for when the task last went into CONNECTED status.
tCpu :: Lens' Task (Maybe Text) #
The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example 1024 , or as a string using vCPUs, for example 1 vCPU or 1 vcpu , in a task definition but is converted to an integer indicating the CPU units when the task definition is registered. If using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter: * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) * 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) * 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) * 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) * 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
tPullStartedAt :: Lens' Task (Maybe UTCTime) #
The Unix time stamp for when the container image pull began.
TaskDefinition
data TaskDefinition #
Details of a task definition.
See: taskDefinition smart constructor.
taskDefinition :: TaskDefinition #
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.tdExecutionRoleARN- The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.tdRequiresCompatibilities- The launch type the task is using.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 Elastic Container Service Developer Guide .tdMemory- The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for thecpuparameter: * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Availablecpuvalues: 256 (.25 vCPU) * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Availablecpuvalues: 512 (.5 vCPU) * 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Availablecpuvalues: 1024 (1 vCPU) * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 2048 (2 vCPU) * Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 4096 (4 vCPU)tdTaskRoleARN- The 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. IAM roles for tasks on Windows require that the-EnableTaskIAMRoleoption is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide .tdPlacementConstraints- An array of placement constraint objects to use for tasks. This field is not valid if using the Fargate launch type for your task.tdNetworkMode- The Docker networking mode to use for the containers in the task. The valid values arenone,bridge,awsvpc, andhost. The default Docker network mode isbridge. If using the Fargate launch type, theawsvpcnetwork mode is required. If using the EC2 launch type, any network mode can be used. If the network mode is set tonone, you can't specify port mappings in your container definitions, and the task's containers do not have external connectivity. Thehostandawsvpcnetwork modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by thebridgemode. With thehostandawsvpcnetwork modes, exposed container ports are mapped directly to the corresponding host port (for thehostnetwork mode) or the attached elastic network interface port (for theawsvpcnetwork mode), so you cannot take advantage of dynamic host port mappings. If the network mode isawsvpc, the task is allocated an Elastic Network Interface, and you must specify aNetworkConfigurationwhen you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide . If the network mode ishost, you can't run multiple instantiations of the same task on a single container instance when port mappings are used. Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose thedefaultnetwork mode object. For more information, see Network settings in the Docker run reference .tdTaskDefinitionARN- The full Amazon Resource Name (ARN) of the task definition.tdCompatibilities- The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .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. If you are using the Fargate launch type, thehostandsourcePathparameters are not supported. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide .tdCpu- The number ofcpuunits used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for thememoryparameter: * 256 (.25 vCPU) - Availablememoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) * 512 (.5 vCPU) - Availablememoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) * 1024 (1 vCPU) - Availablememoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) * 2048 (2 vCPU) - Availablememoryvalues: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) * 4096 (4 vCPU) - Availablememoryvalues: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)tdRequiresAttributes- The container instance attributes required by your task. This field is not valid if using the Fargate launch type for your task.
tdStatus :: Lens' TaskDefinition (Maybe TaskDefinitionStatus) #
The status of the task definition.
tdExecutionRoleARN :: Lens' TaskDefinition (Maybe Text) #
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
tdRequiresCompatibilities :: Lens' TaskDefinition [Compatibility] #
The launch type the task is using.
tdFamily :: Lens' TaskDefinition (Maybe Text) #
The family of your task definition, used as the definition name.
tdContainerDefinitions :: Lens' TaskDefinition [ContainerDefinition] #
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 Elastic Container Service Developer Guide .
tdMemory :: Lens' TaskDefinition (Maybe Text) #
The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter: * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU) * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU) * 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU) * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU) * Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
tdTaskRoleARN :: Lens' TaskDefinition (Maybe Text) #
The 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. IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide .
tdPlacementConstraints :: Lens' TaskDefinition [TaskDefinitionPlacementConstraint] #
An array of placement constraint objects to use for tasks. This field is not valid if using the Fargate launch type for your task.
tdNetworkMode :: Lens' TaskDefinition (Maybe NetworkMode) #
The Docker networking mode to use for the containers in the task. The valid values are none , bridge , awsvpc , and host . The default Docker network mode is bridge . If using the Fargate launch type, the awsvpc network mode is required. If using the EC2 launch type, any network mode can be used. If the network mode is set to none , you can't specify port mappings in your container definitions, and the task's containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode. With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings. If the network mode is awsvpc , the task is allocated an Elastic Network Interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide . If the network mode is host , you can't run multiple instantiations of the same task on a single container instance when port mappings are used. Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the default network mode object. For more information, see Network settings in the Docker run reference .
tdTaskDefinitionARN :: Lens' TaskDefinition (Maybe Text) #
The full Amazon Resource Name (ARN) of the task definition.
tdCompatibilities :: Lens' TaskDefinition [Compatibility] #
The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
tdRevision :: Lens' TaskDefinition (Maybe Int) #
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] #
The list of volumes in a task. If you are using the Fargate launch type, the host and sourcePath parameters are not supported. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide .
tdCpu :: Lens' TaskDefinition (Maybe Text) #
The number of cpu units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter: * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) * 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) * 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) * 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) * 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
tdRequiresAttributes :: Lens' TaskDefinition [Attribute] #
The container instance attributes required by your task. This field is not valid if using the Fargate launch type for your task.
TaskDefinitionPlacementConstraint
data TaskDefinitionPlacementConstraint #
An object representing a constraint on task placement in the task definition.
If you are using the Fargate launch type, task placement constraints are not supported.
For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide .
See: taskDefinitionPlacementConstraint smart constructor.
Instances
taskDefinitionPlacementConstraint :: TaskDefinitionPlacementConstraint #
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 Elastic 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) #
A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide .
tdpcType :: Lens' TaskDefinitionPlacementConstraint (Maybe TaskDefinitionPlacementConstraintType) #
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 #
The overrides associated with a task.
See: taskOverride smart constructor.
taskOverride :: TaskOverride #
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.toExecutionRoleARN- The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.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] #
One or more container overrides sent to a task.
toExecutionRoleARN :: Lens' TaskOverride (Maybe Text) #
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
toTaskRoleARN :: Lens' TaskOverride (Maybe Text) #
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.
Tmpfs
The container path, mount options, and size of the tmpfs mount.
See: tmpfs smart constructor.
Creates a value of Tmpfs with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tMountOptions- The list of tmpfs volume mount options. Valid values:"defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime"tContainerPath- The absolute file path where the tmpfs volume will be mounted.tSize- The size of the tmpfs volume.
tMountOptions :: Lens' Tmpfs [Text] #
The list of tmpfs volume mount options. Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime"
tContainerPath :: Lens' Tmpfs Text #
The absolute file path where the tmpfs volume will be mounted.
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.
uName :: Lens' Ulimit UlimitName #
The type of the ulimit .
uSoftLimit :: Lens' Ulimit Int #
The soft limit for the ulimit type.
uHardLimit :: Lens' Ulimit Int #
The hard limit for the ulimit type.
VersionInfo
data VersionInfo #
The Docker and Amazon ECS container agent version information about a container instance.
See: versionInfo smart constructor.
Instances
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) #
The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
viAgentVersion :: Lens' VersionInfo (Maybe Text) #
The version number of the Amazon ECS container agent.
viDockerVersion :: Lens' VersionInfo (Maybe Text) #
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. Windows containers can mount whole directories on the same drive as> env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mountC:mypath:C:mypathandD::D:@ , but notD:mypath:C:mypathorD::C:mypath@ .
vName :: Lens' Volume (Maybe Text) #
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) #
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. Windows containers can mount whole directories on the same drive as > env:ProgramData . Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:mypath:C:mypath and D::D:@ , but not D:mypath:C:mypath or D::C:mypath@ .
VolumeFrom
data VolumeFrom #
Details on a data volume from another container in the same task definition.
See: volumeFrom smart constructor.
Instances
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) #
The name of another container within the same task definition to mount volumes from.
vfReadOnly :: Lens' VolumeFrom (Maybe Bool) #
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 .