| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.ECS.Types
Contents
- Service Configuration
- Errors
- AgentUpdateStatus
- ApplicationProtocol
- AssignPublicIp
- CPUArchitecture
- CapacityProviderField
- CapacityProviderStatus
- CapacityProviderUpdateStatus
- ClusterField
- ClusterSettingName
- Compatibility
- Connectivity
- ContainerCondition
- ContainerInstanceField
- ContainerInstanceStatus
- DeploymentControllerType
- DeploymentRolloutState
- DesiredStatus
- DeviceCgroupPermission
- EFSAuthorizationConfigIAM
- EFSTransitEncryption
- EnvironmentFileType
- ExecuteCommandLogging
- FirelensConfigurationType
- HealthStatus
- InstanceHealthCheckState
- InstanceHealthCheckType
- IpcMode
- LaunchType
- LogDriver
- ManagedAgentName
- ManagedScalingStatus
- ManagedTerminationProtection
- NetworkMode
- OSFamily
- PidMode
- PlacementConstraintType
- PlacementStrategyType
- PlatformDeviceType
- PropagateTags
- ProxyConfigurationType
- ResourceType
- ScaleUnit
- SchedulingStrategy
- Scope
- ServiceField
- SettingName
- SortOrder
- StabilityStatus
- TargetType
- TaskDefinitionFamilyStatus
- TaskDefinitionField
- TaskDefinitionPlacementConstraintType
- TaskDefinitionStatus
- TaskField
- TaskSetField
- TaskStopCode
- TransportProtocol
- UlimitName
- Attachment
- AttachmentStateChange
- Attribute
- AutoScalingGroupProvider
- AutoScalingGroupProviderUpdate
- AwsVpcConfiguration
- CapacityProvider
- CapacityProviderStrategyItem
- Cluster
- ClusterConfiguration
- ClusterServiceConnectDefaults
- ClusterServiceConnectDefaultsRequest
- ClusterSetting
- Container
- ContainerDefinition
- ContainerDependency
- ContainerInstance
- ContainerInstanceHealthStatus
- ContainerOverride
- ContainerService
- ContainerStateChange
- Deployment
- DeploymentAlarms
- DeploymentCircuitBreaker
- DeploymentConfiguration
- DeploymentController
- Device
- DockerVolumeConfiguration
- EFSAuthorizationConfig
- EFSVolumeConfiguration
- EnvironmentFile
- EphemeralStorage
- ExecuteCommandConfiguration
- ExecuteCommandLogConfiguration
- FSxWindowsFileServerAuthorizationConfig
- FSxWindowsFileServerVolumeConfiguration
- Failure
- FirelensConfiguration
- HealthCheck
- HostEntry
- HostVolumeProperties
- InferenceAccelerator
- InferenceAcceleratorOverride
- InstanceHealthCheckResult
- KernelCapabilities
- KeyValuePair
- LinuxParameters
- LoadBalancer
- LogConfiguration
- ManagedAgent
- ManagedAgentStateChange
- ManagedScaling
- MountPoint
- NetworkBinding
- NetworkConfiguration
- NetworkInterface
- PlacementConstraint
- PlacementStrategy
- PlatformDevice
- PortMapping
- ProtectedTask
- ProxyConfiguration
- RepositoryCredentials
- Resource
- ResourceRequirement
- RuntimePlatform
- Scale
- Secret
- ServiceConnectClientAlias
- ServiceConnectConfiguration
- ServiceConnectService
- ServiceConnectServiceResource
- ServiceEvent
- ServiceRegistry
- Session
- Setting
- SystemControl
- Tag
- Task
- TaskDefinition
- TaskDefinitionPlacementConstraint
- TaskOverride
- TaskSet
- Tmpfs
- Ulimit
- VersionInfo
- Volume
- VolumeFrom
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _AttributeLimitExceededException :: AsError a => Fold a ServiceError
- _BlockedException :: AsError a => Fold a ServiceError
- _ClientException :: AsError a => Fold a ServiceError
- _ClusterContainsContainerInstancesException :: AsError a => Fold a ServiceError
- _ClusterContainsServicesException :: AsError a => Fold a ServiceError
- _ClusterContainsTasksException :: AsError a => Fold a ServiceError
- _ClusterNotFoundException :: AsError a => Fold a ServiceError
- _InvalidParameterException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _MissingVersionException :: AsError a => Fold a ServiceError
- _NamespaceNotFoundException :: AsError a => Fold a ServiceError
- _NoUpdateAvailableException :: AsError a => Fold a ServiceError
- _PlatformTaskDefinitionIncompatibilityException :: AsError a => Fold a ServiceError
- _PlatformUnknownException :: AsError a => Fold a ServiceError
- _ResourceInUseException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServerException :: AsError a => Fold a ServiceError
- _ServiceNotActiveException :: AsError a => Fold a ServiceError
- _ServiceNotFoundException :: AsError a => Fold a ServiceError
- _TargetNotConnectedException :: AsError a => Fold a ServiceError
- _TargetNotFoundException :: AsError a => Fold a ServiceError
- _TaskSetNotFoundException :: AsError a => Fold a ServiceError
- _UnsupportedFeatureException :: AsError a => Fold a ServiceError
- _UpdateInProgressException :: AsError a => Fold a ServiceError
- newtype AgentUpdateStatus where
- AgentUpdateStatus' { }
- pattern AgentUpdateStatus_FAILED :: AgentUpdateStatus
- pattern AgentUpdateStatus_PENDING :: AgentUpdateStatus
- pattern AgentUpdateStatus_STAGED :: AgentUpdateStatus
- pattern AgentUpdateStatus_STAGING :: AgentUpdateStatus
- pattern AgentUpdateStatus_UPDATED :: AgentUpdateStatus
- pattern AgentUpdateStatus_UPDATING :: AgentUpdateStatus
- newtype ApplicationProtocol where
- ApplicationProtocol' { }
- pattern ApplicationProtocol_Grpc :: ApplicationProtocol
- pattern ApplicationProtocol_Http :: ApplicationProtocol
- pattern ApplicationProtocol_Http2 :: ApplicationProtocol
- newtype AssignPublicIp where
- AssignPublicIp' { }
- pattern AssignPublicIp_DISABLED :: AssignPublicIp
- pattern AssignPublicIp_ENABLED :: AssignPublicIp
- newtype CPUArchitecture where
- CPUArchitecture' { }
- pattern CPUArchitecture_ARM64 :: CPUArchitecture
- pattern CPUArchitecture_X86_64 :: CPUArchitecture
- newtype CapacityProviderField where
- newtype CapacityProviderStatus where
- newtype CapacityProviderUpdateStatus where
- CapacityProviderUpdateStatus' { }
- pattern CapacityProviderUpdateStatus_DELETE_COMPLETE :: CapacityProviderUpdateStatus
- pattern CapacityProviderUpdateStatus_DELETE_FAILED :: CapacityProviderUpdateStatus
- pattern CapacityProviderUpdateStatus_DELETE_IN_PROGRESS :: CapacityProviderUpdateStatus
- pattern CapacityProviderUpdateStatus_UPDATE_COMPLETE :: CapacityProviderUpdateStatus
- pattern CapacityProviderUpdateStatus_UPDATE_FAILED :: CapacityProviderUpdateStatus
- pattern CapacityProviderUpdateStatus_UPDATE_IN_PROGRESS :: CapacityProviderUpdateStatus
- newtype ClusterField where
- ClusterField' { }
- pattern ClusterField_ATTACHMENTS :: ClusterField
- pattern ClusterField_CONFIGURATIONS :: ClusterField
- pattern ClusterField_SETTINGS :: ClusterField
- pattern ClusterField_STATISTICS :: ClusterField
- pattern ClusterField_TAGS :: ClusterField
- newtype ClusterSettingName where
- newtype Compatibility where
- Compatibility' { }
- pattern Compatibility_EC2 :: Compatibility
- pattern Compatibility_EXTERNAL :: Compatibility
- pattern Compatibility_FARGATE :: Compatibility
- newtype Connectivity where
- Connectivity' { }
- pattern Connectivity_CONNECTED :: Connectivity
- pattern Connectivity_DISCONNECTED :: Connectivity
- newtype ContainerCondition where
- ContainerCondition' { }
- pattern ContainerCondition_COMPLETE :: ContainerCondition
- pattern ContainerCondition_HEALTHY :: ContainerCondition
- pattern ContainerCondition_START :: ContainerCondition
- pattern ContainerCondition_SUCCESS :: ContainerCondition
- newtype ContainerInstanceField where
- newtype ContainerInstanceStatus where
- ContainerInstanceStatus' { }
- pattern ContainerInstanceStatus_ACTIVE :: ContainerInstanceStatus
- pattern ContainerInstanceStatus_DEREGISTERING :: ContainerInstanceStatus
- pattern ContainerInstanceStatus_DRAINING :: ContainerInstanceStatus
- pattern ContainerInstanceStatus_REGISTERING :: ContainerInstanceStatus
- pattern ContainerInstanceStatus_REGISTRATION_FAILED :: ContainerInstanceStatus
- newtype DeploymentControllerType where
- newtype DeploymentRolloutState where
- newtype DesiredStatus where
- DesiredStatus' { }
- pattern DesiredStatus_PENDING :: DesiredStatus
- pattern DesiredStatus_RUNNING :: DesiredStatus
- pattern DesiredStatus_STOPPED :: DesiredStatus
- newtype DeviceCgroupPermission where
- newtype EFSAuthorizationConfigIAM where
- newtype EFSTransitEncryption where
- newtype EnvironmentFileType where
- newtype ExecuteCommandLogging where
- newtype FirelensConfigurationType where
- newtype HealthStatus where
- HealthStatus' { }
- pattern HealthStatus_HEALTHY :: HealthStatus
- pattern HealthStatus_UNHEALTHY :: HealthStatus
- pattern HealthStatus_UNKNOWN :: HealthStatus
- newtype InstanceHealthCheckState where
- InstanceHealthCheckState' { }
- pattern InstanceHealthCheckState_IMPAIRED :: InstanceHealthCheckState
- pattern InstanceHealthCheckState_INITIALIZING :: InstanceHealthCheckState
- pattern InstanceHealthCheckState_INSUFFICIENT_DATA :: InstanceHealthCheckState
- pattern InstanceHealthCheckState_OK :: InstanceHealthCheckState
- newtype InstanceHealthCheckType where
- newtype IpcMode where
- IpcMode' {
- fromIpcMode :: Text
- pattern IpcMode_Host :: IpcMode
- pattern IpcMode_None :: IpcMode
- pattern IpcMode_Task :: IpcMode
- IpcMode' {
- newtype LaunchType where
- LaunchType' { }
- pattern LaunchType_EC2 :: LaunchType
- pattern LaunchType_EXTERNAL :: LaunchType
- pattern LaunchType_FARGATE :: LaunchType
- newtype LogDriver where
- LogDriver' { }
- pattern LogDriver_Awsfirelens :: LogDriver
- pattern LogDriver_Awslogs :: LogDriver
- pattern LogDriver_Fluentd :: LogDriver
- pattern LogDriver_Gelf :: LogDriver
- pattern LogDriver_Journald :: LogDriver
- pattern LogDriver_Json_file :: LogDriver
- pattern LogDriver_Splunk :: LogDriver
- pattern LogDriver_Syslog :: LogDriver
- newtype ManagedAgentName where
- newtype ManagedScalingStatus where
- newtype ManagedTerminationProtection where
- newtype NetworkMode where
- NetworkMode' { }
- pattern NetworkMode_Awsvpc :: NetworkMode
- pattern NetworkMode_Bridge :: NetworkMode
- pattern NetworkMode_Host :: NetworkMode
- pattern NetworkMode_None :: NetworkMode
- newtype OSFamily where
- OSFamily' {
- fromOSFamily :: Text
- pattern OSFamily_LINUX :: OSFamily
- pattern OSFamily_WINDOWS_SERVER_2004_CORE :: OSFamily
- pattern OSFamily_WINDOWS_SERVER_2016_FULL :: OSFamily
- pattern OSFamily_WINDOWS_SERVER_2019_CORE :: OSFamily
- pattern OSFamily_WINDOWS_SERVER_2019_FULL :: OSFamily
- pattern OSFamily_WINDOWS_SERVER_2022_CORE :: OSFamily
- pattern OSFamily_WINDOWS_SERVER_2022_FULL :: OSFamily
- pattern OSFamily_WINDOWS_SERVER_20H2_CORE :: OSFamily
- OSFamily' {
- newtype PidMode where
- PidMode' {
- fromPidMode :: Text
- pattern PidMode_Host :: PidMode
- pattern PidMode_Task :: PidMode
- PidMode' {
- newtype PlacementConstraintType where
- newtype PlacementStrategyType where
- newtype PlatformDeviceType where
- newtype PropagateTags where
- PropagateTags' { }
- pattern PropagateTags_NONE :: PropagateTags
- pattern PropagateTags_SERVICE :: PropagateTags
- pattern PropagateTags_TASK_DEFINITION :: PropagateTags
- newtype ProxyConfigurationType where
- newtype ResourceType where
- ResourceType' { }
- pattern ResourceType_GPU :: ResourceType
- pattern ResourceType_InferenceAccelerator :: ResourceType
- newtype ScaleUnit where
- ScaleUnit' { }
- pattern ScaleUnit_PERCENT :: ScaleUnit
- newtype SchedulingStrategy where
- SchedulingStrategy' { }
- pattern SchedulingStrategy_DAEMON :: SchedulingStrategy
- pattern SchedulingStrategy_REPLICA :: SchedulingStrategy
- newtype Scope where
- Scope' { }
- pattern Scope_Shared :: Scope
- pattern Scope_Task :: Scope
- newtype ServiceField where
- ServiceField' { }
- pattern ServiceField_TAGS :: ServiceField
- newtype SettingName where
- SettingName' { }
- pattern SettingName_AwsvpcTrunking :: SettingName
- pattern SettingName_ContainerInsights :: SettingName
- pattern SettingName_ContainerInstanceLongArnFormat :: SettingName
- pattern SettingName_ServiceLongArnFormat :: SettingName
- pattern SettingName_TaskLongArnFormat :: SettingName
- newtype SortOrder where
- SortOrder' { }
- pattern SortOrder_ASC :: SortOrder
- pattern SortOrder_DESC :: SortOrder
- newtype StabilityStatus where
- StabilityStatus' { }
- pattern StabilityStatus_STABILIZING :: StabilityStatus
- pattern StabilityStatus_STEADY_STATE :: StabilityStatus
- newtype TargetType where
- TargetType' { }
- pattern TargetType_Container_instance :: TargetType
- newtype TaskDefinitionFamilyStatus where
- newtype TaskDefinitionField where
- newtype TaskDefinitionPlacementConstraintType where
- newtype TaskDefinitionStatus where
- newtype TaskField where
- TaskField' { }
- pattern TaskField_TAGS :: TaskField
- newtype TaskSetField where
- TaskSetField' { }
- pattern TaskSetField_TAGS :: TaskSetField
- newtype TaskStopCode where
- TaskStopCode' { }
- pattern TaskStopCode_EssentialContainerExited :: TaskStopCode
- pattern TaskStopCode_ServiceSchedulerInitiated :: TaskStopCode
- pattern TaskStopCode_SpotInterruption :: TaskStopCode
- pattern TaskStopCode_TaskFailedToStart :: TaskStopCode
- pattern TaskStopCode_TerminationNotice :: TaskStopCode
- pattern TaskStopCode_UserInitiated :: TaskStopCode
- newtype TransportProtocol where
- TransportProtocol' { }
- pattern TransportProtocol_Tcp :: TransportProtocol
- pattern TransportProtocol_Udp :: TransportProtocol
- newtype UlimitName where
- UlimitName' { }
- pattern UlimitName_Core :: UlimitName
- pattern UlimitName_Cpu :: UlimitName
- pattern UlimitName_Data :: UlimitName
- pattern UlimitName_Fsize :: UlimitName
- pattern UlimitName_Locks :: UlimitName
- pattern UlimitName_Memlock :: UlimitName
- pattern UlimitName_Msgqueue :: UlimitName
- pattern UlimitName_Nice :: UlimitName
- pattern UlimitName_Nofile :: UlimitName
- pattern UlimitName_Nproc :: UlimitName
- pattern UlimitName_Rss :: UlimitName
- pattern UlimitName_Rtprio :: UlimitName
- pattern UlimitName_Rttime :: UlimitName
- pattern UlimitName_Sigpending :: UlimitName
- pattern UlimitName_Stack :: UlimitName
- data Attachment = Attachment' {}
- newAttachment :: Attachment
- attachment_details :: Lens' Attachment (Maybe [KeyValuePair])
- attachment_id :: Lens' Attachment (Maybe Text)
- attachment_status :: Lens' Attachment (Maybe Text)
- attachment_type :: Lens' Attachment (Maybe Text)
- data AttachmentStateChange = AttachmentStateChange' {
- attachmentArn :: Text
- status :: Text
- newAttachmentStateChange :: Text -> Text -> AttachmentStateChange
- attachmentStateChange_attachmentArn :: Lens' AttachmentStateChange Text
- attachmentStateChange_status :: Lens' AttachmentStateChange Text
- data Attribute = Attribute' {}
- newAttribute :: Text -> Attribute
- attribute_targetId :: Lens' Attribute (Maybe Text)
- attribute_targetType :: Lens' Attribute (Maybe TargetType)
- attribute_value :: Lens' Attribute (Maybe Text)
- attribute_name :: Lens' Attribute Text
- data AutoScalingGroupProvider = AutoScalingGroupProvider' {}
- newAutoScalingGroupProvider :: Text -> AutoScalingGroupProvider
- autoScalingGroupProvider_managedScaling :: Lens' AutoScalingGroupProvider (Maybe ManagedScaling)
- autoScalingGroupProvider_managedTerminationProtection :: Lens' AutoScalingGroupProvider (Maybe ManagedTerminationProtection)
- autoScalingGroupProvider_autoScalingGroupArn :: Lens' AutoScalingGroupProvider Text
- data AutoScalingGroupProviderUpdate = AutoScalingGroupProviderUpdate' {}
- newAutoScalingGroupProviderUpdate :: AutoScalingGroupProviderUpdate
- autoScalingGroupProviderUpdate_managedScaling :: Lens' AutoScalingGroupProviderUpdate (Maybe ManagedScaling)
- autoScalingGroupProviderUpdate_managedTerminationProtection :: Lens' AutoScalingGroupProviderUpdate (Maybe ManagedTerminationProtection)
- data AwsVpcConfiguration = AwsVpcConfiguration' {
- assignPublicIp :: Maybe AssignPublicIp
- securityGroups :: Maybe [Text]
- subnets :: [Text]
- newAwsVpcConfiguration :: AwsVpcConfiguration
- awsVpcConfiguration_assignPublicIp :: Lens' AwsVpcConfiguration (Maybe AssignPublicIp)
- awsVpcConfiguration_securityGroups :: Lens' AwsVpcConfiguration (Maybe [Text])
- awsVpcConfiguration_subnets :: Lens' AwsVpcConfiguration [Text]
- data CapacityProvider = CapacityProvider' {}
- newCapacityProvider :: CapacityProvider
- capacityProvider_autoScalingGroupProvider :: Lens' CapacityProvider (Maybe AutoScalingGroupProvider)
- capacityProvider_capacityProviderArn :: Lens' CapacityProvider (Maybe Text)
- capacityProvider_name :: Lens' CapacityProvider (Maybe Text)
- capacityProvider_status :: Lens' CapacityProvider (Maybe CapacityProviderStatus)
- capacityProvider_tags :: Lens' CapacityProvider (Maybe [Tag])
- capacityProvider_updateStatus :: Lens' CapacityProvider (Maybe CapacityProviderUpdateStatus)
- capacityProvider_updateStatusReason :: Lens' CapacityProvider (Maybe Text)
- data CapacityProviderStrategyItem = CapacityProviderStrategyItem' {}
- newCapacityProviderStrategyItem :: Text -> CapacityProviderStrategyItem
- capacityProviderStrategyItem_base :: Lens' CapacityProviderStrategyItem (Maybe Natural)
- capacityProviderStrategyItem_weight :: Lens' CapacityProviderStrategyItem (Maybe Natural)
- capacityProviderStrategyItem_capacityProvider :: Lens' CapacityProviderStrategyItem Text
- data Cluster = Cluster' {
- activeServicesCount :: Maybe Int
- attachments :: Maybe [Attachment]
- attachmentsStatus :: Maybe Text
- capacityProviders :: Maybe [Text]
- clusterArn :: Maybe Text
- clusterName :: Maybe Text
- configuration :: Maybe ClusterConfiguration
- defaultCapacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]
- pendingTasksCount :: Maybe Int
- registeredContainerInstancesCount :: Maybe Int
- runningTasksCount :: Maybe Int
- serviceConnectDefaults :: Maybe ClusterServiceConnectDefaults
- settings :: Maybe [ClusterSetting]
- statistics :: Maybe [KeyValuePair]
- status :: Maybe Text
- tags :: Maybe [Tag]
- newCluster :: Cluster
- cluster_activeServicesCount :: Lens' Cluster (Maybe Int)
- cluster_attachments :: Lens' Cluster (Maybe [Attachment])
- cluster_attachmentsStatus :: Lens' Cluster (Maybe Text)
- cluster_capacityProviders :: Lens' Cluster (Maybe [Text])
- cluster_clusterArn :: Lens' Cluster (Maybe Text)
- cluster_clusterName :: Lens' Cluster (Maybe Text)
- cluster_configuration :: Lens' Cluster (Maybe ClusterConfiguration)
- cluster_defaultCapacityProviderStrategy :: Lens' Cluster (Maybe [CapacityProviderStrategyItem])
- cluster_pendingTasksCount :: Lens' Cluster (Maybe Int)
- cluster_registeredContainerInstancesCount :: Lens' Cluster (Maybe Int)
- cluster_runningTasksCount :: Lens' Cluster (Maybe Int)
- cluster_serviceConnectDefaults :: Lens' Cluster (Maybe ClusterServiceConnectDefaults)
- cluster_settings :: Lens' Cluster (Maybe [ClusterSetting])
- cluster_statistics :: Lens' Cluster (Maybe [KeyValuePair])
- cluster_status :: Lens' Cluster (Maybe Text)
- cluster_tags :: Lens' Cluster (Maybe [Tag])
- data ClusterConfiguration = ClusterConfiguration' {}
- newClusterConfiguration :: ClusterConfiguration
- clusterConfiguration_executeCommandConfiguration :: Lens' ClusterConfiguration (Maybe ExecuteCommandConfiguration)
- data ClusterServiceConnectDefaults = ClusterServiceConnectDefaults' {}
- newClusterServiceConnectDefaults :: ClusterServiceConnectDefaults
- clusterServiceConnectDefaults_namespace :: Lens' ClusterServiceConnectDefaults (Maybe Text)
- data ClusterServiceConnectDefaultsRequest = ClusterServiceConnectDefaultsRequest' {}
- newClusterServiceConnectDefaultsRequest :: Text -> ClusterServiceConnectDefaultsRequest
- clusterServiceConnectDefaultsRequest_namespace :: Lens' ClusterServiceConnectDefaultsRequest Text
- data ClusterSetting = ClusterSetting' {}
- newClusterSetting :: ClusterSetting
- clusterSetting_name :: Lens' ClusterSetting (Maybe ClusterSettingName)
- clusterSetting_value :: Lens' ClusterSetting (Maybe Text)
- data Container = Container' {
- containerArn :: Maybe Text
- cpu :: Maybe Text
- exitCode :: Maybe Int
- gpuIds :: Maybe [Text]
- healthStatus :: Maybe HealthStatus
- image :: Maybe Text
- imageDigest :: Maybe Text
- lastStatus :: Maybe Text
- managedAgents :: Maybe [ManagedAgent]
- memory :: Maybe Text
- memoryReservation :: Maybe Text
- name :: Maybe Text
- networkBindings :: Maybe [NetworkBinding]
- networkInterfaces :: Maybe [NetworkInterface]
- reason :: Maybe Text
- runtimeId :: Maybe Text
- taskArn :: Maybe Text
- newContainer :: Container
- container_containerArn :: Lens' Container (Maybe Text)
- container_cpu :: Lens' Container (Maybe Text)
- container_exitCode :: Lens' Container (Maybe Int)
- container_gpuIds :: Lens' Container (Maybe [Text])
- container_healthStatus :: Lens' Container (Maybe HealthStatus)
- container_image :: Lens' Container (Maybe Text)
- container_imageDigest :: Lens' Container (Maybe Text)
- container_lastStatus :: Lens' Container (Maybe Text)
- container_managedAgents :: Lens' Container (Maybe [ManagedAgent])
- container_memory :: Lens' Container (Maybe Text)
- container_memoryReservation :: Lens' Container (Maybe Text)
- container_name :: Lens' Container (Maybe Text)
- container_networkBindings :: Lens' Container (Maybe [NetworkBinding])
- container_networkInterfaces :: Lens' Container (Maybe [NetworkInterface])
- container_reason :: Lens' Container (Maybe Text)
- container_runtimeId :: Lens' Container (Maybe Text)
- container_taskArn :: Lens' Container (Maybe Text)
- data ContainerDefinition = ContainerDefinition' {
- command :: Maybe [Text]
- cpu :: Maybe Int
- dependsOn :: Maybe [ContainerDependency]
- disableNetworking :: Maybe Bool
- dnsSearchDomains :: Maybe [Text]
- dnsServers :: Maybe [Text]
- dockerLabels :: Maybe (HashMap Text Text)
- dockerSecurityOptions :: Maybe [Text]
- entryPoint :: Maybe [Text]
- environment :: Maybe [KeyValuePair]
- environmentFiles :: Maybe [EnvironmentFile]
- essential :: Maybe Bool
- extraHosts :: Maybe [HostEntry]
- firelensConfiguration :: Maybe FirelensConfiguration
- healthCheck :: Maybe HealthCheck
- hostname :: Maybe Text
- image :: Maybe Text
- interactive :: Maybe Bool
- links :: Maybe [Text]
- linuxParameters :: Maybe LinuxParameters
- logConfiguration :: Maybe LogConfiguration
- memory :: Maybe Int
- memoryReservation :: Maybe Int
- mountPoints :: Maybe [MountPoint]
- name :: Maybe Text
- portMappings :: Maybe [PortMapping]
- privileged :: Maybe Bool
- pseudoTerminal :: Maybe Bool
- readonlyRootFilesystem :: Maybe Bool
- repositoryCredentials :: Maybe RepositoryCredentials
- resourceRequirements :: Maybe [ResourceRequirement]
- secrets :: Maybe [Secret]
- startTimeout :: Maybe Int
- stopTimeout :: Maybe Int
- systemControls :: Maybe [SystemControl]
- ulimits :: Maybe [Ulimit]
- user :: Maybe Text
- volumesFrom :: Maybe [VolumeFrom]
- workingDirectory :: Maybe Text
- newContainerDefinition :: ContainerDefinition
- containerDefinition_command :: Lens' ContainerDefinition (Maybe [Text])
- containerDefinition_cpu :: Lens' ContainerDefinition (Maybe Int)
- containerDefinition_dependsOn :: Lens' ContainerDefinition (Maybe [ContainerDependency])
- containerDefinition_disableNetworking :: Lens' ContainerDefinition (Maybe Bool)
- containerDefinition_dnsSearchDomains :: Lens' ContainerDefinition (Maybe [Text])
- containerDefinition_dnsServers :: Lens' ContainerDefinition (Maybe [Text])
- containerDefinition_dockerLabels :: Lens' ContainerDefinition (Maybe (HashMap Text Text))
- containerDefinition_dockerSecurityOptions :: Lens' ContainerDefinition (Maybe [Text])
- containerDefinition_entryPoint :: Lens' ContainerDefinition (Maybe [Text])
- containerDefinition_environment :: Lens' ContainerDefinition (Maybe [KeyValuePair])
- containerDefinition_environmentFiles :: Lens' ContainerDefinition (Maybe [EnvironmentFile])
- containerDefinition_essential :: Lens' ContainerDefinition (Maybe Bool)
- containerDefinition_extraHosts :: Lens' ContainerDefinition (Maybe [HostEntry])
- containerDefinition_firelensConfiguration :: Lens' ContainerDefinition (Maybe FirelensConfiguration)
- containerDefinition_healthCheck :: Lens' ContainerDefinition (Maybe HealthCheck)
- containerDefinition_hostname :: Lens' ContainerDefinition (Maybe Text)
- containerDefinition_image :: Lens' ContainerDefinition (Maybe Text)
- containerDefinition_interactive :: Lens' ContainerDefinition (Maybe Bool)
- containerDefinition_links :: Lens' ContainerDefinition (Maybe [Text])
- containerDefinition_linuxParameters :: Lens' ContainerDefinition (Maybe LinuxParameters)
- containerDefinition_logConfiguration :: Lens' ContainerDefinition (Maybe LogConfiguration)
- containerDefinition_memory :: Lens' ContainerDefinition (Maybe Int)
- containerDefinition_memoryReservation :: Lens' ContainerDefinition (Maybe Int)
- containerDefinition_mountPoints :: Lens' ContainerDefinition (Maybe [MountPoint])
- containerDefinition_name :: Lens' ContainerDefinition (Maybe Text)
- containerDefinition_portMappings :: Lens' ContainerDefinition (Maybe [PortMapping])
- containerDefinition_privileged :: Lens' ContainerDefinition (Maybe Bool)
- containerDefinition_pseudoTerminal :: Lens' ContainerDefinition (Maybe Bool)
- containerDefinition_readonlyRootFilesystem :: Lens' ContainerDefinition (Maybe Bool)
- containerDefinition_repositoryCredentials :: Lens' ContainerDefinition (Maybe RepositoryCredentials)
- containerDefinition_resourceRequirements :: Lens' ContainerDefinition (Maybe [ResourceRequirement])
- containerDefinition_secrets :: Lens' ContainerDefinition (Maybe [Secret])
- containerDefinition_startTimeout :: Lens' ContainerDefinition (Maybe Int)
- containerDefinition_stopTimeout :: Lens' ContainerDefinition (Maybe Int)
- containerDefinition_systemControls :: Lens' ContainerDefinition (Maybe [SystemControl])
- containerDefinition_ulimits :: Lens' ContainerDefinition (Maybe [Ulimit])
- containerDefinition_user :: Lens' ContainerDefinition (Maybe Text)
- containerDefinition_volumesFrom :: Lens' ContainerDefinition (Maybe [VolumeFrom])
- containerDefinition_workingDirectory :: Lens' ContainerDefinition (Maybe Text)
- data ContainerDependency = ContainerDependency' {}
- newContainerDependency :: Text -> ContainerCondition -> ContainerDependency
- containerDependency_containerName :: Lens' ContainerDependency Text
- containerDependency_condition :: Lens' ContainerDependency ContainerCondition
- data ContainerInstance = ContainerInstance' {
- agentConnected :: Maybe Bool
- agentUpdateStatus :: Maybe AgentUpdateStatus
- attachments :: Maybe [Attachment]
- attributes :: Maybe [Attribute]
- capacityProviderName :: Maybe Text
- containerInstanceArn :: Maybe Text
- ec2InstanceId :: Maybe Text
- healthStatus :: Maybe ContainerInstanceHealthStatus
- pendingTasksCount :: Maybe Int
- registeredAt :: Maybe POSIX
- registeredResources :: Maybe [Resource]
- remainingResources :: Maybe [Resource]
- runningTasksCount :: Maybe Int
- status :: Maybe Text
- statusReason :: Maybe Text
- tags :: Maybe [Tag]
- version :: Maybe Integer
- versionInfo :: Maybe VersionInfo
- newContainerInstance :: ContainerInstance
- containerInstance_agentConnected :: Lens' ContainerInstance (Maybe Bool)
- containerInstance_agentUpdateStatus :: Lens' ContainerInstance (Maybe AgentUpdateStatus)
- containerInstance_attachments :: Lens' ContainerInstance (Maybe [Attachment])
- containerInstance_attributes :: Lens' ContainerInstance (Maybe [Attribute])
- containerInstance_capacityProviderName :: Lens' ContainerInstance (Maybe Text)
- containerInstance_containerInstanceArn :: Lens' ContainerInstance (Maybe Text)
- containerInstance_ec2InstanceId :: Lens' ContainerInstance (Maybe Text)
- containerInstance_healthStatus :: Lens' ContainerInstance (Maybe ContainerInstanceHealthStatus)
- containerInstance_pendingTasksCount :: Lens' ContainerInstance (Maybe Int)
- containerInstance_registeredAt :: Lens' ContainerInstance (Maybe UTCTime)
- containerInstance_registeredResources :: Lens' ContainerInstance (Maybe [Resource])
- containerInstance_remainingResources :: Lens' ContainerInstance (Maybe [Resource])
- containerInstance_runningTasksCount :: Lens' ContainerInstance (Maybe Int)
- containerInstance_status :: Lens' ContainerInstance (Maybe Text)
- containerInstance_statusReason :: Lens' ContainerInstance (Maybe Text)
- containerInstance_tags :: Lens' ContainerInstance (Maybe [Tag])
- containerInstance_version :: Lens' ContainerInstance (Maybe Integer)
- containerInstance_versionInfo :: Lens' ContainerInstance (Maybe VersionInfo)
- data ContainerInstanceHealthStatus = ContainerInstanceHealthStatus' {}
- newContainerInstanceHealthStatus :: ContainerInstanceHealthStatus
- containerInstanceHealthStatus_details :: Lens' ContainerInstanceHealthStatus (Maybe [InstanceHealthCheckResult])
- containerInstanceHealthStatus_overallStatus :: Lens' ContainerInstanceHealthStatus (Maybe InstanceHealthCheckState)
- data ContainerOverride = ContainerOverride' {
- command :: Maybe [Text]
- cpu :: Maybe Int
- environment :: Maybe [KeyValuePair]
- environmentFiles :: Maybe [EnvironmentFile]
- memory :: Maybe Int
- memoryReservation :: Maybe Int
- name :: Maybe Text
- resourceRequirements :: Maybe [ResourceRequirement]
- newContainerOverride :: ContainerOverride
- containerOverride_command :: Lens' ContainerOverride (Maybe [Text])
- containerOverride_cpu :: Lens' ContainerOverride (Maybe Int)
- containerOverride_environment :: Lens' ContainerOverride (Maybe [KeyValuePair])
- containerOverride_environmentFiles :: Lens' ContainerOverride (Maybe [EnvironmentFile])
- containerOverride_memory :: Lens' ContainerOverride (Maybe Int)
- containerOverride_memoryReservation :: Lens' ContainerOverride (Maybe Int)
- containerOverride_name :: Lens' ContainerOverride (Maybe Text)
- containerOverride_resourceRequirements :: Lens' ContainerOverride (Maybe [ResourceRequirement])
- data ContainerService = ContainerService' {
- capacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]
- clusterArn :: Maybe Text
- createdAt :: Maybe POSIX
- createdBy :: Maybe Text
- deploymentConfiguration :: Maybe DeploymentConfiguration
- deploymentController :: Maybe DeploymentController
- deployments :: Maybe [Deployment]
- desiredCount :: Maybe Int
- enableECSManagedTags :: Maybe Bool
- enableExecuteCommand :: Maybe Bool
- events :: Maybe [ServiceEvent]
- healthCheckGracePeriodSeconds :: Maybe Int
- launchType :: Maybe LaunchType
- loadBalancers :: Maybe [LoadBalancer]
- networkConfiguration :: Maybe NetworkConfiguration
- pendingCount :: Maybe Int
- placementConstraints :: Maybe [PlacementConstraint]
- placementStrategy :: Maybe [PlacementStrategy]
- platformFamily :: Maybe Text
- platformVersion :: Maybe Text
- propagateTags :: Maybe PropagateTags
- roleArn :: Maybe Text
- runningCount :: Maybe Int
- schedulingStrategy :: Maybe SchedulingStrategy
- serviceArn :: Maybe Text
- serviceName :: Maybe Text
- serviceRegistries :: Maybe [ServiceRegistry]
- status :: Maybe Text
- tags :: Maybe [Tag]
- taskDefinition :: Maybe Text
- taskSets :: Maybe [TaskSet]
- newContainerService :: ContainerService
- containerService_capacityProviderStrategy :: Lens' ContainerService (Maybe [CapacityProviderStrategyItem])
- containerService_clusterArn :: Lens' ContainerService (Maybe Text)
- containerService_createdAt :: Lens' ContainerService (Maybe UTCTime)
- containerService_createdBy :: Lens' ContainerService (Maybe Text)
- containerService_deploymentConfiguration :: Lens' ContainerService (Maybe DeploymentConfiguration)
- containerService_deploymentController :: Lens' ContainerService (Maybe DeploymentController)
- containerService_deployments :: Lens' ContainerService (Maybe [Deployment])
- containerService_desiredCount :: Lens' ContainerService (Maybe Int)
- containerService_enableECSManagedTags :: Lens' ContainerService (Maybe Bool)
- containerService_enableExecuteCommand :: Lens' ContainerService (Maybe Bool)
- containerService_events :: Lens' ContainerService (Maybe [ServiceEvent])
- containerService_healthCheckGracePeriodSeconds :: Lens' ContainerService (Maybe Int)
- containerService_launchType :: Lens' ContainerService (Maybe LaunchType)
- containerService_loadBalancers :: Lens' ContainerService (Maybe [LoadBalancer])
- containerService_networkConfiguration :: Lens' ContainerService (Maybe NetworkConfiguration)
- containerService_pendingCount :: Lens' ContainerService (Maybe Int)
- containerService_placementConstraints :: Lens' ContainerService (Maybe [PlacementConstraint])
- containerService_placementStrategy :: Lens' ContainerService (Maybe [PlacementStrategy])
- containerService_platformFamily :: Lens' ContainerService (Maybe Text)
- containerService_platformVersion :: Lens' ContainerService (Maybe Text)
- containerService_propagateTags :: Lens' ContainerService (Maybe PropagateTags)
- containerService_roleArn :: Lens' ContainerService (Maybe Text)
- containerService_runningCount :: Lens' ContainerService (Maybe Int)
- containerService_schedulingStrategy :: Lens' ContainerService (Maybe SchedulingStrategy)
- containerService_serviceArn :: Lens' ContainerService (Maybe Text)
- containerService_serviceName :: Lens' ContainerService (Maybe Text)
- containerService_serviceRegistries :: Lens' ContainerService (Maybe [ServiceRegistry])
- containerService_status :: Lens' ContainerService (Maybe Text)
- containerService_tags :: Lens' ContainerService (Maybe [Tag])
- containerService_taskDefinition :: Lens' ContainerService (Maybe Text)
- containerService_taskSets :: Lens' ContainerService (Maybe [TaskSet])
- data ContainerStateChange = ContainerStateChange' {}
- newContainerStateChange :: ContainerStateChange
- containerStateChange_containerName :: Lens' ContainerStateChange (Maybe Text)
- containerStateChange_exitCode :: Lens' ContainerStateChange (Maybe Int)
- containerStateChange_imageDigest :: Lens' ContainerStateChange (Maybe Text)
- containerStateChange_networkBindings :: Lens' ContainerStateChange (Maybe [NetworkBinding])
- containerStateChange_reason :: Lens' ContainerStateChange (Maybe Text)
- containerStateChange_runtimeId :: Lens' ContainerStateChange (Maybe Text)
- containerStateChange_status :: Lens' ContainerStateChange (Maybe Text)
- data Deployment = Deployment' {
- capacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]
- createdAt :: Maybe POSIX
- desiredCount :: Maybe Int
- failedTasks :: Maybe Int
- id :: Maybe Text
- launchType :: Maybe LaunchType
- networkConfiguration :: Maybe NetworkConfiguration
- pendingCount :: Maybe Int
- platformFamily :: Maybe Text
- platformVersion :: Maybe Text
- rolloutState :: Maybe DeploymentRolloutState
- rolloutStateReason :: Maybe Text
- runningCount :: Maybe Int
- serviceConnectConfiguration :: Maybe ServiceConnectConfiguration
- serviceConnectResources :: Maybe [ServiceConnectServiceResource]
- status :: Maybe Text
- taskDefinition :: Maybe Text
- updatedAt :: Maybe POSIX
- newDeployment :: Deployment
- deployment_capacityProviderStrategy :: Lens' Deployment (Maybe [CapacityProviderStrategyItem])
- deployment_createdAt :: Lens' Deployment (Maybe UTCTime)
- deployment_desiredCount :: Lens' Deployment (Maybe Int)
- deployment_failedTasks :: Lens' Deployment (Maybe Int)
- deployment_id :: Lens' Deployment (Maybe Text)
- deployment_launchType :: Lens' Deployment (Maybe LaunchType)
- deployment_networkConfiguration :: Lens' Deployment (Maybe NetworkConfiguration)
- deployment_pendingCount :: Lens' Deployment (Maybe Int)
- deployment_platformFamily :: Lens' Deployment (Maybe Text)
- deployment_platformVersion :: Lens' Deployment (Maybe Text)
- deployment_rolloutState :: Lens' Deployment (Maybe DeploymentRolloutState)
- deployment_rolloutStateReason :: Lens' Deployment (Maybe Text)
- deployment_runningCount :: Lens' Deployment (Maybe Int)
- deployment_serviceConnectConfiguration :: Lens' Deployment (Maybe ServiceConnectConfiguration)
- deployment_serviceConnectResources :: Lens' Deployment (Maybe [ServiceConnectServiceResource])
- deployment_status :: Lens' Deployment (Maybe Text)
- deployment_taskDefinition :: Lens' Deployment (Maybe Text)
- deployment_updatedAt :: Lens' Deployment (Maybe UTCTime)
- data DeploymentAlarms = DeploymentAlarms' {}
- newDeploymentAlarms :: Bool -> Bool -> DeploymentAlarms
- deploymentAlarms_alarmNames :: Lens' DeploymentAlarms [Text]
- deploymentAlarms_enable :: Lens' DeploymentAlarms Bool
- deploymentAlarms_rollback :: Lens' DeploymentAlarms Bool
- data DeploymentCircuitBreaker = DeploymentCircuitBreaker' {}
- newDeploymentCircuitBreaker :: Bool -> Bool -> DeploymentCircuitBreaker
- deploymentCircuitBreaker_enable :: Lens' DeploymentCircuitBreaker Bool
- deploymentCircuitBreaker_rollback :: Lens' DeploymentCircuitBreaker Bool
- data DeploymentConfiguration = DeploymentConfiguration' {}
- newDeploymentConfiguration :: DeploymentConfiguration
- deploymentConfiguration_alarms :: Lens' DeploymentConfiguration (Maybe DeploymentAlarms)
- deploymentConfiguration_deploymentCircuitBreaker :: Lens' DeploymentConfiguration (Maybe DeploymentCircuitBreaker)
- deploymentConfiguration_maximumPercent :: Lens' DeploymentConfiguration (Maybe Int)
- deploymentConfiguration_minimumHealthyPercent :: Lens' DeploymentConfiguration (Maybe Int)
- data DeploymentController = DeploymentController' {}
- newDeploymentController :: DeploymentControllerType -> DeploymentController
- deploymentController_type :: Lens' DeploymentController DeploymentControllerType
- data Device = Device' {}
- newDevice :: Text -> Device
- device_containerPath :: Lens' Device (Maybe Text)
- device_permissions :: Lens' Device (Maybe [DeviceCgroupPermission])
- device_hostPath :: Lens' Device Text
- data DockerVolumeConfiguration = DockerVolumeConfiguration' {}
- newDockerVolumeConfiguration :: DockerVolumeConfiguration
- dockerVolumeConfiguration_autoprovision :: Lens' DockerVolumeConfiguration (Maybe Bool)
- dockerVolumeConfiguration_driver :: Lens' DockerVolumeConfiguration (Maybe Text)
- dockerVolumeConfiguration_driverOpts :: Lens' DockerVolumeConfiguration (Maybe (HashMap Text Text))
- dockerVolumeConfiguration_labels :: Lens' DockerVolumeConfiguration (Maybe (HashMap Text Text))
- dockerVolumeConfiguration_scope :: Lens' DockerVolumeConfiguration (Maybe Scope)
- data EFSAuthorizationConfig = EFSAuthorizationConfig' {}
- newEFSAuthorizationConfig :: EFSAuthorizationConfig
- eFSAuthorizationConfig_accessPointId :: Lens' EFSAuthorizationConfig (Maybe Text)
- eFSAuthorizationConfig_iam :: Lens' EFSAuthorizationConfig (Maybe EFSAuthorizationConfigIAM)
- data EFSVolumeConfiguration = EFSVolumeConfiguration' {}
- newEFSVolumeConfiguration :: Text -> EFSVolumeConfiguration
- eFSVolumeConfiguration_authorizationConfig :: Lens' EFSVolumeConfiguration (Maybe EFSAuthorizationConfig)
- eFSVolumeConfiguration_rootDirectory :: Lens' EFSVolumeConfiguration (Maybe Text)
- eFSVolumeConfiguration_transitEncryption :: Lens' EFSVolumeConfiguration (Maybe EFSTransitEncryption)
- eFSVolumeConfiguration_transitEncryptionPort :: Lens' EFSVolumeConfiguration (Maybe Int)
- eFSVolumeConfiguration_fileSystemId :: Lens' EFSVolumeConfiguration Text
- data EnvironmentFile = EnvironmentFile' {}
- newEnvironmentFile :: Text -> EnvironmentFileType -> EnvironmentFile
- environmentFile_value :: Lens' EnvironmentFile Text
- environmentFile_type :: Lens' EnvironmentFile EnvironmentFileType
- data EphemeralStorage = EphemeralStorage' {}
- newEphemeralStorage :: Int -> EphemeralStorage
- ephemeralStorage_sizeInGiB :: Lens' EphemeralStorage Int
- data ExecuteCommandConfiguration = ExecuteCommandConfiguration' {}
- newExecuteCommandConfiguration :: ExecuteCommandConfiguration
- executeCommandConfiguration_kmsKeyId :: Lens' ExecuteCommandConfiguration (Maybe Text)
- executeCommandConfiguration_logConfiguration :: Lens' ExecuteCommandConfiguration (Maybe ExecuteCommandLogConfiguration)
- executeCommandConfiguration_logging :: Lens' ExecuteCommandConfiguration (Maybe ExecuteCommandLogging)
- data ExecuteCommandLogConfiguration = ExecuteCommandLogConfiguration' {}
- newExecuteCommandLogConfiguration :: ExecuteCommandLogConfiguration
- executeCommandLogConfiguration_cloudWatchEncryptionEnabled :: Lens' ExecuteCommandLogConfiguration (Maybe Bool)
- executeCommandLogConfiguration_cloudWatchLogGroupName :: Lens' ExecuteCommandLogConfiguration (Maybe Text)
- executeCommandLogConfiguration_s3BucketName :: Lens' ExecuteCommandLogConfiguration (Maybe Text)
- executeCommandLogConfiguration_s3EncryptionEnabled :: Lens' ExecuteCommandLogConfiguration (Maybe Bool)
- executeCommandLogConfiguration_s3KeyPrefix :: Lens' ExecuteCommandLogConfiguration (Maybe Text)
- data FSxWindowsFileServerAuthorizationConfig = FSxWindowsFileServerAuthorizationConfig' {}
- newFSxWindowsFileServerAuthorizationConfig :: Text -> Text -> FSxWindowsFileServerAuthorizationConfig
- fSxWindowsFileServerAuthorizationConfig_credentialsParameter :: Lens' FSxWindowsFileServerAuthorizationConfig Text
- fSxWindowsFileServerAuthorizationConfig_domain :: Lens' FSxWindowsFileServerAuthorizationConfig Text
- data FSxWindowsFileServerVolumeConfiguration = FSxWindowsFileServerVolumeConfiguration' {}
- newFSxWindowsFileServerVolumeConfiguration :: Text -> Text -> FSxWindowsFileServerAuthorizationConfig -> FSxWindowsFileServerVolumeConfiguration
- fSxWindowsFileServerVolumeConfiguration_fileSystemId :: Lens' FSxWindowsFileServerVolumeConfiguration Text
- fSxWindowsFileServerVolumeConfiguration_rootDirectory :: Lens' FSxWindowsFileServerVolumeConfiguration Text
- fSxWindowsFileServerVolumeConfiguration_authorizationConfig :: Lens' FSxWindowsFileServerVolumeConfiguration FSxWindowsFileServerAuthorizationConfig
- data Failure = Failure' {}
- newFailure :: Failure
- failure_arn :: Lens' Failure (Maybe Text)
- failure_detail :: Lens' Failure (Maybe Text)
- failure_reason :: Lens' Failure (Maybe Text)
- data FirelensConfiguration = FirelensConfiguration' {}
- newFirelensConfiguration :: FirelensConfigurationType -> FirelensConfiguration
- firelensConfiguration_options :: Lens' FirelensConfiguration (Maybe (HashMap Text Text))
- firelensConfiguration_type :: Lens' FirelensConfiguration FirelensConfigurationType
- data HealthCheck = HealthCheck' {}
- newHealthCheck :: HealthCheck
- healthCheck_interval :: Lens' HealthCheck (Maybe Int)
- healthCheck_retries :: Lens' HealthCheck (Maybe Int)
- healthCheck_startPeriod :: Lens' HealthCheck (Maybe Int)
- healthCheck_timeout :: Lens' HealthCheck (Maybe Int)
- healthCheck_command :: Lens' HealthCheck [Text]
- data HostEntry = HostEntry' {}
- newHostEntry :: Text -> Text -> HostEntry
- hostEntry_hostname :: Lens' HostEntry Text
- hostEntry_ipAddress :: Lens' HostEntry Text
- data HostVolumeProperties = HostVolumeProperties' {
- sourcePath :: Maybe Text
- newHostVolumeProperties :: HostVolumeProperties
- hostVolumeProperties_sourcePath :: Lens' HostVolumeProperties (Maybe Text)
- data InferenceAccelerator = InferenceAccelerator' {
- deviceName :: Text
- deviceType :: Text
- newInferenceAccelerator :: Text -> Text -> InferenceAccelerator
- inferenceAccelerator_deviceName :: Lens' InferenceAccelerator Text
- inferenceAccelerator_deviceType :: Lens' InferenceAccelerator Text
- data InferenceAcceleratorOverride = InferenceAcceleratorOverride' {
- deviceName :: Maybe Text
- deviceType :: Maybe Text
- newInferenceAcceleratorOverride :: InferenceAcceleratorOverride
- inferenceAcceleratorOverride_deviceName :: Lens' InferenceAcceleratorOverride (Maybe Text)
- inferenceAcceleratorOverride_deviceType :: Lens' InferenceAcceleratorOverride (Maybe Text)
- data InstanceHealthCheckResult = InstanceHealthCheckResult' {}
- newInstanceHealthCheckResult :: InstanceHealthCheckResult
- instanceHealthCheckResult_lastStatusChange :: Lens' InstanceHealthCheckResult (Maybe UTCTime)
- instanceHealthCheckResult_lastUpdated :: Lens' InstanceHealthCheckResult (Maybe UTCTime)
- instanceHealthCheckResult_status :: Lens' InstanceHealthCheckResult (Maybe InstanceHealthCheckState)
- instanceHealthCheckResult_type :: Lens' InstanceHealthCheckResult (Maybe InstanceHealthCheckType)
- data KernelCapabilities = KernelCapabilities' {}
- newKernelCapabilities :: KernelCapabilities
- kernelCapabilities_add :: Lens' KernelCapabilities (Maybe [Text])
- kernelCapabilities_drop :: Lens' KernelCapabilities (Maybe [Text])
- data KeyValuePair = KeyValuePair' {}
- newKeyValuePair :: KeyValuePair
- keyValuePair_name :: Lens' KeyValuePair (Maybe Text)
- keyValuePair_value :: Lens' KeyValuePair (Maybe Text)
- data LinuxParameters = LinuxParameters' {
- capabilities :: Maybe KernelCapabilities
- devices :: Maybe [Device]
- initProcessEnabled :: Maybe Bool
- maxSwap :: Maybe Int
- sharedMemorySize :: Maybe Int
- swappiness :: Maybe Int
- tmpfs :: Maybe [Tmpfs]
- newLinuxParameters :: LinuxParameters
- linuxParameters_capabilities :: Lens' LinuxParameters (Maybe KernelCapabilities)
- linuxParameters_devices :: Lens' LinuxParameters (Maybe [Device])
- linuxParameters_initProcessEnabled :: Lens' LinuxParameters (Maybe Bool)
- linuxParameters_maxSwap :: Lens' LinuxParameters (Maybe Int)
- linuxParameters_sharedMemorySize :: Lens' LinuxParameters (Maybe Int)
- linuxParameters_swappiness :: Lens' LinuxParameters (Maybe Int)
- linuxParameters_tmpfs :: Lens' LinuxParameters (Maybe [Tmpfs])
- data LoadBalancer = LoadBalancer' {}
- newLoadBalancer :: LoadBalancer
- loadBalancer_containerName :: Lens' LoadBalancer (Maybe Text)
- loadBalancer_containerPort :: Lens' LoadBalancer (Maybe Int)
- loadBalancer_loadBalancerName :: Lens' LoadBalancer (Maybe Text)
- loadBalancer_targetGroupArn :: Lens' LoadBalancer (Maybe Text)
- data LogConfiguration = LogConfiguration' {}
- newLogConfiguration :: LogDriver -> LogConfiguration
- logConfiguration_options :: Lens' LogConfiguration (Maybe (HashMap Text Text))
- logConfiguration_secretOptions :: Lens' LogConfiguration (Maybe [Secret])
- logConfiguration_logDriver :: Lens' LogConfiguration LogDriver
- data ManagedAgent = ManagedAgent' {}
- newManagedAgent :: ManagedAgent
- managedAgent_lastStartedAt :: Lens' ManagedAgent (Maybe UTCTime)
- managedAgent_lastStatus :: Lens' ManagedAgent (Maybe Text)
- managedAgent_name :: Lens' ManagedAgent (Maybe ManagedAgentName)
- managedAgent_reason :: Lens' ManagedAgent (Maybe Text)
- data ManagedAgentStateChange = ManagedAgentStateChange' {}
- newManagedAgentStateChange :: Text -> ManagedAgentName -> Text -> ManagedAgentStateChange
- managedAgentStateChange_reason :: Lens' ManagedAgentStateChange (Maybe Text)
- managedAgentStateChange_containerName :: Lens' ManagedAgentStateChange Text
- managedAgentStateChange_managedAgentName :: Lens' ManagedAgentStateChange ManagedAgentName
- managedAgentStateChange_status :: Lens' ManagedAgentStateChange Text
- data ManagedScaling = ManagedScaling' {}
- newManagedScaling :: ManagedScaling
- managedScaling_instanceWarmupPeriod :: Lens' ManagedScaling (Maybe Natural)
- managedScaling_maximumScalingStepSize :: Lens' ManagedScaling (Maybe Natural)
- managedScaling_minimumScalingStepSize :: Lens' ManagedScaling (Maybe Natural)
- managedScaling_status :: Lens' ManagedScaling (Maybe ManagedScalingStatus)
- managedScaling_targetCapacity :: Lens' ManagedScaling (Maybe Natural)
- data MountPoint = MountPoint' {
- containerPath :: Maybe Text
- readOnly :: Maybe Bool
- sourceVolume :: Maybe Text
- newMountPoint :: MountPoint
- mountPoint_containerPath :: Lens' MountPoint (Maybe Text)
- mountPoint_readOnly :: Lens' MountPoint (Maybe Bool)
- mountPoint_sourceVolume :: Lens' MountPoint (Maybe Text)
- data NetworkBinding = NetworkBinding' {}
- newNetworkBinding :: NetworkBinding
- networkBinding_bindIP :: Lens' NetworkBinding (Maybe Text)
- networkBinding_containerPort :: Lens' NetworkBinding (Maybe Int)
- networkBinding_containerPortRange :: Lens' NetworkBinding (Maybe Text)
- networkBinding_hostPort :: Lens' NetworkBinding (Maybe Int)
- networkBinding_hostPortRange :: Lens' NetworkBinding (Maybe Text)
- networkBinding_protocol :: Lens' NetworkBinding (Maybe TransportProtocol)
- data NetworkConfiguration = NetworkConfiguration' {}
- newNetworkConfiguration :: NetworkConfiguration
- networkConfiguration_awsvpcConfiguration :: Lens' NetworkConfiguration (Maybe AwsVpcConfiguration)
- data NetworkInterface = NetworkInterface' {}
- newNetworkInterface :: NetworkInterface
- networkInterface_attachmentId :: Lens' NetworkInterface (Maybe Text)
- networkInterface_ipv6Address :: Lens' NetworkInterface (Maybe Text)
- networkInterface_privateIpv4Address :: Lens' NetworkInterface (Maybe Text)
- data PlacementConstraint = PlacementConstraint' {}
- newPlacementConstraint :: PlacementConstraint
- placementConstraint_expression :: Lens' PlacementConstraint (Maybe Text)
- placementConstraint_type :: Lens' PlacementConstraint (Maybe PlacementConstraintType)
- data PlacementStrategy = PlacementStrategy' {}
- newPlacementStrategy :: PlacementStrategy
- placementStrategy_field :: Lens' PlacementStrategy (Maybe Text)
- placementStrategy_type :: Lens' PlacementStrategy (Maybe PlacementStrategyType)
- data PlatformDevice = PlatformDevice' {
- id :: Text
- type' :: PlatformDeviceType
- newPlatformDevice :: Text -> PlatformDeviceType -> PlatformDevice
- platformDevice_id :: Lens' PlatformDevice Text
- platformDevice_type :: Lens' PlatformDevice PlatformDeviceType
- data PortMapping = PortMapping' {}
- newPortMapping :: PortMapping
- portMapping_appProtocol :: Lens' PortMapping (Maybe ApplicationProtocol)
- portMapping_containerPort :: Lens' PortMapping (Maybe Int)
- portMapping_containerPortRange :: Lens' PortMapping (Maybe Text)
- portMapping_hostPort :: Lens' PortMapping (Maybe Int)
- portMapping_name :: Lens' PortMapping (Maybe Text)
- portMapping_protocol :: Lens' PortMapping (Maybe TransportProtocol)
- data ProtectedTask = ProtectedTask' {}
- newProtectedTask :: ProtectedTask
- protectedTask_expirationDate :: Lens' ProtectedTask (Maybe UTCTime)
- protectedTask_protectionEnabled :: Lens' ProtectedTask (Maybe Bool)
- protectedTask_taskArn :: Lens' ProtectedTask (Maybe Text)
- data ProxyConfiguration = ProxyConfiguration' {}
- newProxyConfiguration :: Text -> ProxyConfiguration
- proxyConfiguration_properties :: Lens' ProxyConfiguration (Maybe [KeyValuePair])
- proxyConfiguration_type :: Lens' ProxyConfiguration (Maybe ProxyConfigurationType)
- proxyConfiguration_containerName :: Lens' ProxyConfiguration Text
- data RepositoryCredentials = RepositoryCredentials' {}
- newRepositoryCredentials :: Text -> RepositoryCredentials
- repositoryCredentials_credentialsParameter :: Lens' RepositoryCredentials Text
- data Resource = Resource' {}
- newResource :: Resource
- resource_doubleValue :: Lens' Resource (Maybe Double)
- resource_integerValue :: Lens' Resource (Maybe Int)
- resource_longValue :: Lens' Resource (Maybe Integer)
- resource_name :: Lens' Resource (Maybe Text)
- resource_stringSetValue :: Lens' Resource (Maybe [Text])
- resource_type :: Lens' Resource (Maybe Text)
- data ResourceRequirement = ResourceRequirement' {
- value :: Text
- type' :: ResourceType
- newResourceRequirement :: Text -> ResourceType -> ResourceRequirement
- resourceRequirement_value :: Lens' ResourceRequirement Text
- resourceRequirement_type :: Lens' ResourceRequirement ResourceType
- data RuntimePlatform = RuntimePlatform' {}
- newRuntimePlatform :: RuntimePlatform
- runtimePlatform_cpuArchitecture :: Lens' RuntimePlatform (Maybe CPUArchitecture)
- runtimePlatform_operatingSystemFamily :: Lens' RuntimePlatform (Maybe OSFamily)
- data Scale = Scale' {}
- newScale :: Scale
- scale_unit :: Lens' Scale (Maybe ScaleUnit)
- scale_value :: Lens' Scale (Maybe Double)
- data Secret = Secret' {}
- newSecret :: Text -> Text -> Secret
- secret_name :: Lens' Secret Text
- secret_valueFrom :: Lens' Secret Text
- data ServiceConnectClientAlias = ServiceConnectClientAlias' {}
- newServiceConnectClientAlias :: Natural -> ServiceConnectClientAlias
- serviceConnectClientAlias_dnsName :: Lens' ServiceConnectClientAlias (Maybe Text)
- serviceConnectClientAlias_port :: Lens' ServiceConnectClientAlias Natural
- data ServiceConnectConfiguration = ServiceConnectConfiguration' {}
- newServiceConnectConfiguration :: Bool -> ServiceConnectConfiguration
- serviceConnectConfiguration_logConfiguration :: Lens' ServiceConnectConfiguration (Maybe LogConfiguration)
- serviceConnectConfiguration_namespace :: Lens' ServiceConnectConfiguration (Maybe Text)
- serviceConnectConfiguration_services :: Lens' ServiceConnectConfiguration (Maybe [ServiceConnectService])
- serviceConnectConfiguration_enabled :: Lens' ServiceConnectConfiguration Bool
- data ServiceConnectService = ServiceConnectService' {}
- newServiceConnectService :: Text -> ServiceConnectService
- serviceConnectService_clientAliases :: Lens' ServiceConnectService (Maybe [ServiceConnectClientAlias])
- serviceConnectService_discoveryName :: Lens' ServiceConnectService (Maybe Text)
- serviceConnectService_ingressPortOverride :: Lens' ServiceConnectService (Maybe Natural)
- serviceConnectService_portName :: Lens' ServiceConnectService Text
- data ServiceConnectServiceResource = ServiceConnectServiceResource' {}
- newServiceConnectServiceResource :: ServiceConnectServiceResource
- serviceConnectServiceResource_discoveryArn :: Lens' ServiceConnectServiceResource (Maybe Text)
- serviceConnectServiceResource_discoveryName :: Lens' ServiceConnectServiceResource (Maybe Text)
- data ServiceEvent = ServiceEvent' {}
- newServiceEvent :: ServiceEvent
- serviceEvent_createdAt :: Lens' ServiceEvent (Maybe UTCTime)
- serviceEvent_id :: Lens' ServiceEvent (Maybe Text)
- serviceEvent_message :: Lens' ServiceEvent (Maybe Text)
- data ServiceRegistry = ServiceRegistry' {
- containerName :: Maybe Text
- containerPort :: Maybe Int
- port :: Maybe Int
- registryArn :: Maybe Text
- newServiceRegistry :: ServiceRegistry
- serviceRegistry_containerName :: Lens' ServiceRegistry (Maybe Text)
- serviceRegistry_containerPort :: Lens' ServiceRegistry (Maybe Int)
- serviceRegistry_port :: Lens' ServiceRegistry (Maybe Int)
- serviceRegistry_registryArn :: Lens' ServiceRegistry (Maybe Text)
- data Session = Session' {}
- newSession :: Session
- session_sessionId :: Lens' Session (Maybe Text)
- session_streamUrl :: Lens' Session (Maybe Text)
- session_tokenValue :: Lens' Session (Maybe Text)
- data Setting = Setting' {
- name :: Maybe SettingName
- principalArn :: Maybe Text
- value :: Maybe Text
- newSetting :: Setting
- setting_name :: Lens' Setting (Maybe SettingName)
- setting_principalArn :: Lens' Setting (Maybe Text)
- setting_value :: Lens' Setting (Maybe Text)
- data SystemControl = SystemControl' {}
- newSystemControl :: SystemControl
- systemControl_namespace :: Lens' SystemControl (Maybe Text)
- systemControl_value :: Lens' SystemControl (Maybe Text)
- data Tag = Tag' {}
- newTag :: Tag
- tag_key :: Lens' Tag (Maybe Text)
- tag_value :: Lens' Tag (Maybe Text)
- data Task = Task' {
- attachments :: Maybe [Attachment]
- attributes :: Maybe [Attribute]
- availabilityZone :: Maybe Text
- capacityProviderName :: Maybe Text
- clusterArn :: Maybe Text
- connectivity :: Maybe Connectivity
- connectivityAt :: Maybe POSIX
- containerInstanceArn :: Maybe Text
- containers :: Maybe [Container]
- cpu :: Maybe Text
- createdAt :: Maybe POSIX
- desiredStatus :: Maybe Text
- enableExecuteCommand :: Maybe Bool
- ephemeralStorage :: Maybe EphemeralStorage
- executionStoppedAt :: Maybe POSIX
- group' :: Maybe Text
- healthStatus :: Maybe HealthStatus
- inferenceAccelerators :: Maybe [InferenceAccelerator]
- lastStatus :: Maybe Text
- launchType :: Maybe LaunchType
- memory :: Maybe Text
- overrides :: Maybe TaskOverride
- platformFamily :: Maybe Text
- platformVersion :: Maybe Text
- pullStartedAt :: Maybe POSIX
- pullStoppedAt :: Maybe POSIX
- startedAt :: Maybe POSIX
- startedBy :: Maybe Text
- stopCode :: Maybe TaskStopCode
- stoppedAt :: Maybe POSIX
- stoppedReason :: Maybe Text
- stoppingAt :: Maybe POSIX
- tags :: Maybe [Tag]
- taskArn :: Maybe Text
- taskDefinitionArn :: Maybe Text
- version :: Maybe Integer
- newTask :: Task
- task_attachments :: Lens' Task (Maybe [Attachment])
- task_attributes :: Lens' Task (Maybe [Attribute])
- task_availabilityZone :: Lens' Task (Maybe Text)
- task_capacityProviderName :: Lens' Task (Maybe Text)
- task_clusterArn :: Lens' Task (Maybe Text)
- task_connectivity :: Lens' Task (Maybe Connectivity)
- task_connectivityAt :: Lens' Task (Maybe UTCTime)
- task_containerInstanceArn :: Lens' Task (Maybe Text)
- task_containers :: Lens' Task (Maybe [Container])
- task_cpu :: Lens' Task (Maybe Text)
- task_createdAt :: Lens' Task (Maybe UTCTime)
- task_desiredStatus :: Lens' Task (Maybe Text)
- task_enableExecuteCommand :: Lens' Task (Maybe Bool)
- task_ephemeralStorage :: Lens' Task (Maybe EphemeralStorage)
- task_executionStoppedAt :: Lens' Task (Maybe UTCTime)
- task_group :: Lens' Task (Maybe Text)
- task_healthStatus :: Lens' Task (Maybe HealthStatus)
- task_inferenceAccelerators :: Lens' Task (Maybe [InferenceAccelerator])
- task_lastStatus :: Lens' Task (Maybe Text)
- task_launchType :: Lens' Task (Maybe LaunchType)
- task_memory :: Lens' Task (Maybe Text)
- task_overrides :: Lens' Task (Maybe TaskOverride)
- task_platformFamily :: Lens' Task (Maybe Text)
- task_platformVersion :: Lens' Task (Maybe Text)
- task_pullStartedAt :: Lens' Task (Maybe UTCTime)
- task_pullStoppedAt :: Lens' Task (Maybe UTCTime)
- task_startedAt :: Lens' Task (Maybe UTCTime)
- task_startedBy :: Lens' Task (Maybe Text)
- task_stopCode :: Lens' Task (Maybe TaskStopCode)
- task_stoppedAt :: Lens' Task (Maybe UTCTime)
- task_stoppedReason :: Lens' Task (Maybe Text)
- task_stoppingAt :: Lens' Task (Maybe UTCTime)
- task_tags :: Lens' Task (Maybe [Tag])
- task_taskArn :: Lens' Task (Maybe Text)
- task_taskDefinitionArn :: Lens' Task (Maybe Text)
- task_version :: Lens' Task (Maybe Integer)
- data TaskDefinition = TaskDefinition' {
- compatibilities :: Maybe [Compatibility]
- containerDefinitions :: Maybe [ContainerDefinition]
- cpu :: Maybe Text
- deregisteredAt :: Maybe POSIX
- ephemeralStorage :: Maybe EphemeralStorage
- executionRoleArn :: Maybe Text
- family :: Maybe Text
- inferenceAccelerators :: Maybe [InferenceAccelerator]
- ipcMode :: Maybe IpcMode
- memory :: Maybe Text
- networkMode :: Maybe NetworkMode
- pidMode :: Maybe PidMode
- placementConstraints :: Maybe [TaskDefinitionPlacementConstraint]
- proxyConfiguration :: Maybe ProxyConfiguration
- registeredAt :: Maybe POSIX
- registeredBy :: Maybe Text
- requiresAttributes :: Maybe [Attribute]
- requiresCompatibilities :: Maybe [Compatibility]
- revision :: Maybe Int
- runtimePlatform :: Maybe RuntimePlatform
- status :: Maybe TaskDefinitionStatus
- taskDefinitionArn :: Maybe Text
- taskRoleArn :: Maybe Text
- volumes :: Maybe [Volume]
- newTaskDefinition :: TaskDefinition
- taskDefinition_compatibilities :: Lens' TaskDefinition (Maybe [Compatibility])
- taskDefinition_containerDefinitions :: Lens' TaskDefinition (Maybe [ContainerDefinition])
- taskDefinition_cpu :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_deregisteredAt :: Lens' TaskDefinition (Maybe UTCTime)
- taskDefinition_ephemeralStorage :: Lens' TaskDefinition (Maybe EphemeralStorage)
- taskDefinition_executionRoleArn :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_family :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_inferenceAccelerators :: Lens' TaskDefinition (Maybe [InferenceAccelerator])
- taskDefinition_ipcMode :: Lens' TaskDefinition (Maybe IpcMode)
- taskDefinition_memory :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_networkMode :: Lens' TaskDefinition (Maybe NetworkMode)
- taskDefinition_pidMode :: Lens' TaskDefinition (Maybe PidMode)
- taskDefinition_placementConstraints :: Lens' TaskDefinition (Maybe [TaskDefinitionPlacementConstraint])
- taskDefinition_proxyConfiguration :: Lens' TaskDefinition (Maybe ProxyConfiguration)
- taskDefinition_registeredAt :: Lens' TaskDefinition (Maybe UTCTime)
- taskDefinition_registeredBy :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_requiresAttributes :: Lens' TaskDefinition (Maybe [Attribute])
- taskDefinition_requiresCompatibilities :: Lens' TaskDefinition (Maybe [Compatibility])
- taskDefinition_revision :: Lens' TaskDefinition (Maybe Int)
- taskDefinition_runtimePlatform :: Lens' TaskDefinition (Maybe RuntimePlatform)
- taskDefinition_status :: Lens' TaskDefinition (Maybe TaskDefinitionStatus)
- taskDefinition_taskDefinitionArn :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_taskRoleArn :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_volumes :: Lens' TaskDefinition (Maybe [Volume])
- data TaskDefinitionPlacementConstraint = TaskDefinitionPlacementConstraint' {}
- newTaskDefinitionPlacementConstraint :: TaskDefinitionPlacementConstraint
- taskDefinitionPlacementConstraint_expression :: Lens' TaskDefinitionPlacementConstraint (Maybe Text)
- taskDefinitionPlacementConstraint_type :: Lens' TaskDefinitionPlacementConstraint (Maybe TaskDefinitionPlacementConstraintType)
- data TaskOverride = TaskOverride' {}
- newTaskOverride :: TaskOverride
- taskOverride_containerOverrides :: Lens' TaskOverride (Maybe [ContainerOverride])
- taskOverride_cpu :: Lens' TaskOverride (Maybe Text)
- taskOverride_ephemeralStorage :: Lens' TaskOverride (Maybe EphemeralStorage)
- taskOverride_executionRoleArn :: Lens' TaskOverride (Maybe Text)
- taskOverride_inferenceAcceleratorOverrides :: Lens' TaskOverride (Maybe [InferenceAcceleratorOverride])
- taskOverride_memory :: Lens' TaskOverride (Maybe Text)
- taskOverride_taskRoleArn :: Lens' TaskOverride (Maybe Text)
- data TaskSet = TaskSet' {
- capacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]
- clusterArn :: Maybe Text
- computedDesiredCount :: Maybe Int
- createdAt :: Maybe POSIX
- externalId :: Maybe Text
- id :: Maybe Text
- launchType :: Maybe LaunchType
- loadBalancers :: Maybe [LoadBalancer]
- networkConfiguration :: Maybe NetworkConfiguration
- pendingCount :: Maybe Int
- platformFamily :: Maybe Text
- platformVersion :: Maybe Text
- runningCount :: Maybe Int
- scale :: Maybe Scale
- serviceArn :: Maybe Text
- serviceRegistries :: Maybe [ServiceRegistry]
- stabilityStatus :: Maybe StabilityStatus
- stabilityStatusAt :: Maybe POSIX
- startedBy :: Maybe Text
- status :: Maybe Text
- tags :: Maybe [Tag]
- taskDefinition :: Maybe Text
- taskSetArn :: Maybe Text
- updatedAt :: Maybe POSIX
- newTaskSet :: TaskSet
- taskSet_capacityProviderStrategy :: Lens' TaskSet (Maybe [CapacityProviderStrategyItem])
- taskSet_clusterArn :: Lens' TaskSet (Maybe Text)
- taskSet_computedDesiredCount :: Lens' TaskSet (Maybe Int)
- taskSet_createdAt :: Lens' TaskSet (Maybe UTCTime)
- taskSet_externalId :: Lens' TaskSet (Maybe Text)
- taskSet_id :: Lens' TaskSet (Maybe Text)
- taskSet_launchType :: Lens' TaskSet (Maybe LaunchType)
- taskSet_loadBalancers :: Lens' TaskSet (Maybe [LoadBalancer])
- taskSet_networkConfiguration :: Lens' TaskSet (Maybe NetworkConfiguration)
- taskSet_pendingCount :: Lens' TaskSet (Maybe Int)
- taskSet_platformFamily :: Lens' TaskSet (Maybe Text)
- taskSet_platformVersion :: Lens' TaskSet (Maybe Text)
- taskSet_runningCount :: Lens' TaskSet (Maybe Int)
- taskSet_scale :: Lens' TaskSet (Maybe Scale)
- taskSet_serviceArn :: Lens' TaskSet (Maybe Text)
- taskSet_serviceRegistries :: Lens' TaskSet (Maybe [ServiceRegistry])
- taskSet_stabilityStatus :: Lens' TaskSet (Maybe StabilityStatus)
- taskSet_stabilityStatusAt :: Lens' TaskSet (Maybe UTCTime)
- taskSet_startedBy :: Lens' TaskSet (Maybe Text)
- taskSet_status :: Lens' TaskSet (Maybe Text)
- taskSet_tags :: Lens' TaskSet (Maybe [Tag])
- taskSet_taskDefinition :: Lens' TaskSet (Maybe Text)
- taskSet_taskSetArn :: Lens' TaskSet (Maybe Text)
- taskSet_updatedAt :: Lens' TaskSet (Maybe UTCTime)
- data Tmpfs = Tmpfs' {
- mountOptions :: Maybe [Text]
- containerPath :: Text
- size :: Int
- newTmpfs :: Text -> Int -> Tmpfs
- tmpfs_mountOptions :: Lens' Tmpfs (Maybe [Text])
- tmpfs_containerPath :: Lens' Tmpfs Text
- tmpfs_size :: Lens' Tmpfs Int
- data Ulimit = Ulimit' {}
- newUlimit :: UlimitName -> Int -> Int -> Ulimit
- ulimit_name :: Lens' Ulimit UlimitName
- ulimit_softLimit :: Lens' Ulimit Int
- ulimit_hardLimit :: Lens' Ulimit Int
- data VersionInfo = VersionInfo' {}
- newVersionInfo :: VersionInfo
- versionInfo_agentHash :: Lens' VersionInfo (Maybe Text)
- versionInfo_agentVersion :: Lens' VersionInfo (Maybe Text)
- versionInfo_dockerVersion :: Lens' VersionInfo (Maybe Text)
- data Volume = Volume' {}
- newVolume :: Volume
- volume_dockerVolumeConfiguration :: Lens' Volume (Maybe DockerVolumeConfiguration)
- volume_efsVolumeConfiguration :: Lens' Volume (Maybe EFSVolumeConfiguration)
- volume_fsxWindowsFileServerVolumeConfiguration :: Lens' Volume (Maybe FSxWindowsFileServerVolumeConfiguration)
- volume_host :: Lens' Volume (Maybe HostVolumeProperties)
- volume_name :: Lens' Volume (Maybe Text)
- data VolumeFrom = VolumeFrom' {}
- newVolumeFrom :: VolumeFrom
- volumeFrom_readOnly :: Lens' VolumeFrom (Maybe Bool)
- volumeFrom_sourceContainer :: Lens' VolumeFrom (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2014-11-13 of the Amazon EC2 Container Service SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You don't have authorization to perform the requested action.
_AttributeLimitExceededException :: AsError a => Fold a ServiceError Source #
You can apply up to 10 custom attributes for each resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.
_BlockedException :: AsError a => Fold a ServiceError Source #
Your Amazon Web Services account was blocked. For more information, contact Amazon Web Services Support.
_ClientException :: AsError a => Fold a ServiceError Source #
These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource,. Or, it might be specifying an identifier that isn't valid.
_ClusterContainsContainerInstancesException :: AsError a => Fold a ServiceError Source #
You can't delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.
_ClusterContainsServicesException :: AsError a => Fold a ServiceError Source #
You can't delete a cluster that contains services. First, update the service to reduce its desired task count to 0, and then delete the service. For more information, see UpdateService and DeleteService.
_ClusterContainsTasksException :: AsError a => Fold a ServiceError Source #
You can't delete a cluster that has active tasks.
_ClusterNotFoundException :: AsError a => Fold a ServiceError Source #
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
_InvalidParameterException :: AsError a => Fold a ServiceError Source #
The specified parameter isn't valid. Review the available parameters for the API request.
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The limit for the resource was exceeded.
_MissingVersionException :: AsError a => Fold a ServiceError Source #
Amazon ECS can't determine the current version of the Amazon ECS container agent on the container instance and doesn't have enough information to proceed with an update. This could be because the agent running on the container instance is a previous or custom version that doesn't use our version information.
_NamespaceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified namespace wasn't found.
_NoUpdateAvailableException :: AsError a => Fold a ServiceError Source #
There's no update available for this Amazon ECS container agent. This might be because the agent is already running the latest version or because it's so old that there's no update path to the current version.
_PlatformTaskDefinitionIncompatibilityException :: AsError a => Fold a ServiceError Source #
The specified platform version doesn't satisfy the required capabilities of the task definition.
_PlatformUnknownException :: AsError a => Fold a ServiceError Source #
The specified platform version doesn't exist.
_ResourceInUseException :: AsError a => Fold a ServiceError Source #
The specified resource is in-use and can't be removed.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource wasn't found.
_ServerException :: AsError a => Fold a ServiceError Source #
These errors are usually caused by a server issue.
_ServiceNotActiveException :: AsError a => Fold a ServiceError Source #
The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.
_ServiceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
_TargetNotConnectedException :: AsError a => Fold a ServiceError Source #
The execute command cannot run. This error can be caused by any of the following configuration issues:
- Incorrect IAM permissions
- The SSM agent is not installed or is not running
- There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for for Systems Manager Session Manager
For information about how to troubleshoot the issues, see Troubleshooting issues with ECS Exec in the Amazon Elastic Container Service Developer Guide.
_TargetNotFoundException :: AsError a => Fold a ServiceError Source #
The specified target wasn't found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.
_TaskSetNotFoundException :: AsError a => Fold a ServiceError Source #
The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.
_UnsupportedFeatureException :: AsError a => Fold a ServiceError Source #
The specified task isn't supported in this Region.
_UpdateInProgressException :: AsError a => Fold a ServiceError Source #
There's already a current Amazon ECS container agent update in progress
on the container instance that's specified. If the container agent
becomes disconnected while it's 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.
AgentUpdateStatus
newtype AgentUpdateStatus Source #
Constructors
| AgentUpdateStatus' | |
Fields | |
Bundled Patterns
| pattern AgentUpdateStatus_FAILED :: AgentUpdateStatus | |
| pattern AgentUpdateStatus_PENDING :: AgentUpdateStatus | |
| pattern AgentUpdateStatus_STAGED :: AgentUpdateStatus | |
| pattern AgentUpdateStatus_STAGING :: AgentUpdateStatus | |
| pattern AgentUpdateStatus_UPDATED :: AgentUpdateStatus | |
| pattern AgentUpdateStatus_UPDATING :: AgentUpdateStatus |
Instances
ApplicationProtocol
newtype ApplicationProtocol Source #
Constructors
| ApplicationProtocol' | |
Fields | |
Bundled Patterns
| pattern ApplicationProtocol_Grpc :: ApplicationProtocol | |
| pattern ApplicationProtocol_Http :: ApplicationProtocol | |
| pattern ApplicationProtocol_Http2 :: ApplicationProtocol |
Instances
AssignPublicIp
newtype AssignPublicIp Source #
Constructors
| AssignPublicIp' | |
Fields | |
Bundled Patterns
| pattern AssignPublicIp_DISABLED :: AssignPublicIp | |
| pattern AssignPublicIp_ENABLED :: AssignPublicIp |
Instances
CPUArchitecture
newtype CPUArchitecture Source #
Constructors
| CPUArchitecture' | |
Fields | |
Bundled Patterns
| pattern CPUArchitecture_ARM64 :: CPUArchitecture | |
| pattern CPUArchitecture_X86_64 :: CPUArchitecture |
Instances
CapacityProviderField
newtype CapacityProviderField Source #
Constructors
| CapacityProviderField' | |
Fields | |
Bundled Patterns
| pattern CapacityProviderField_TAGS :: CapacityProviderField |
Instances
CapacityProviderStatus
newtype CapacityProviderStatus Source #
Constructors
| CapacityProviderStatus' | |
Fields | |
Bundled Patterns
| pattern CapacityProviderStatus_ACTIVE :: CapacityProviderStatus | |
| pattern CapacityProviderStatus_INACTIVE :: CapacityProviderStatus |
Instances
CapacityProviderUpdateStatus
newtype CapacityProviderUpdateStatus Source #
Constructors
| CapacityProviderUpdateStatus' | |
Fields | |
Bundled Patterns
Instances
ClusterField
newtype ClusterField Source #
Constructors
| ClusterField' | |
Fields | |
Bundled Patterns
| pattern ClusterField_ATTACHMENTS :: ClusterField | |
| pattern ClusterField_CONFIGURATIONS :: ClusterField | |
| pattern ClusterField_SETTINGS :: ClusterField | |
| pattern ClusterField_STATISTICS :: ClusterField | |
| pattern ClusterField_TAGS :: ClusterField |
Instances
ClusterSettingName
newtype ClusterSettingName Source #
Constructors
| ClusterSettingName' | |
Fields | |
Bundled Patterns
| pattern ClusterSettingName_ContainerInsights :: ClusterSettingName |
Instances
Compatibility
newtype Compatibility Source #
Constructors
| Compatibility' | |
Fields | |
Bundled Patterns
| pattern Compatibility_EC2 :: Compatibility | |
| pattern Compatibility_EXTERNAL :: Compatibility | |
| pattern Compatibility_FARGATE :: Compatibility |
Instances
Connectivity
newtype Connectivity Source #
Constructors
| Connectivity' | |
Fields | |
Bundled Patterns
| pattern Connectivity_CONNECTED :: Connectivity | |
| pattern Connectivity_DISCONNECTED :: Connectivity |
Instances
ContainerCondition
newtype ContainerCondition Source #
Constructors
| ContainerCondition' | |
Fields | |
Bundled Patterns
| pattern ContainerCondition_COMPLETE :: ContainerCondition | |
| pattern ContainerCondition_HEALTHY :: ContainerCondition | |
| pattern ContainerCondition_START :: ContainerCondition | |
| pattern ContainerCondition_SUCCESS :: ContainerCondition |
Instances
ContainerInstanceField
newtype ContainerInstanceField Source #
Constructors
| ContainerInstanceField' | |
Fields | |
Bundled Patterns
| pattern ContainerInstanceField_CONTAINER_INSTANCE_HEALTH :: ContainerInstanceField | |
| pattern ContainerInstanceField_TAGS :: ContainerInstanceField |
Instances
ContainerInstanceStatus
newtype ContainerInstanceStatus Source #
Constructors
| ContainerInstanceStatus' | |
Fields | |
Bundled Patterns
Instances
DeploymentControllerType
newtype DeploymentControllerType Source #
Constructors
| DeploymentControllerType' | |
Fields | |
Bundled Patterns
Instances
DeploymentRolloutState
newtype DeploymentRolloutState Source #
Constructors
| DeploymentRolloutState' | |
Fields | |
Bundled Patterns
| pattern DeploymentRolloutState_COMPLETED :: DeploymentRolloutState | |
| pattern DeploymentRolloutState_FAILED :: DeploymentRolloutState | |
| pattern DeploymentRolloutState_IN_PROGRESS :: DeploymentRolloutState |
Instances
DesiredStatus
newtype DesiredStatus Source #
Constructors
| DesiredStatus' | |
Fields | |
Bundled Patterns
| pattern DesiredStatus_PENDING :: DesiredStatus | |
| pattern DesiredStatus_RUNNING :: DesiredStatus | |
| pattern DesiredStatus_STOPPED :: DesiredStatus |
Instances
DeviceCgroupPermission
newtype DeviceCgroupPermission Source #
Constructors
| DeviceCgroupPermission' | |
Fields | |
Bundled Patterns
| pattern DeviceCgroupPermission_Mknod :: DeviceCgroupPermission | |
| pattern DeviceCgroupPermission_Read :: DeviceCgroupPermission | |
| pattern DeviceCgroupPermission_Write :: DeviceCgroupPermission |
Instances
EFSAuthorizationConfigIAM
newtype EFSAuthorizationConfigIAM Source #
Constructors
| EFSAuthorizationConfigIAM' | |
Fields | |
Bundled Patterns
| pattern EFSAuthorizationConfigIAM_DISABLED :: EFSAuthorizationConfigIAM | |
| pattern EFSAuthorizationConfigIAM_ENABLED :: EFSAuthorizationConfigIAM |
Instances
EFSTransitEncryption
newtype EFSTransitEncryption Source #
Constructors
| EFSTransitEncryption' | |
Fields | |
Bundled Patterns
| pattern EFSTransitEncryption_DISABLED :: EFSTransitEncryption | |
| pattern EFSTransitEncryption_ENABLED :: EFSTransitEncryption |
Instances
EnvironmentFileType
newtype EnvironmentFileType Source #
Constructors
| EnvironmentFileType' | |
Fields | |
Bundled Patterns
| pattern EnvironmentFileType_S3 :: EnvironmentFileType |
Instances
ExecuteCommandLogging
newtype ExecuteCommandLogging Source #
Constructors
| ExecuteCommandLogging' | |
Fields | |
Bundled Patterns
| pattern ExecuteCommandLogging_DEFAULT :: ExecuteCommandLogging | |
| pattern ExecuteCommandLogging_NONE :: ExecuteCommandLogging | |
| pattern ExecuteCommandLogging_OVERRIDE :: ExecuteCommandLogging |
Instances
FirelensConfigurationType
newtype FirelensConfigurationType Source #
Constructors
| FirelensConfigurationType' | |
Fields | |
Bundled Patterns
| pattern FirelensConfigurationType_Fluentbit :: FirelensConfigurationType | |
| pattern FirelensConfigurationType_Fluentd :: FirelensConfigurationType |
Instances
HealthStatus
newtype HealthStatus Source #
Constructors
| HealthStatus' | |
Fields | |
Bundled Patterns
| pattern HealthStatus_HEALTHY :: HealthStatus | |
| pattern HealthStatus_UNHEALTHY :: HealthStatus | |
| pattern HealthStatus_UNKNOWN :: HealthStatus |
Instances
InstanceHealthCheckState
newtype InstanceHealthCheckState Source #
Constructors
| InstanceHealthCheckState' | |
Fields | |
Bundled Patterns
Instances
InstanceHealthCheckType
newtype InstanceHealthCheckType Source #
Constructors
| InstanceHealthCheckType' | |
Fields | |
Bundled Patterns
| pattern InstanceHealthCheckType_CONTAINER_RUNTIME :: InstanceHealthCheckType |
Instances
IpcMode
Constructors
| IpcMode' | |
Fields
| |
Bundled Patterns
| pattern IpcMode_Host :: IpcMode | |
| pattern IpcMode_None :: IpcMode | |
| pattern IpcMode_Task :: IpcMode |
Instances
LaunchType
newtype LaunchType Source #
Constructors
| LaunchType' | |
Fields | |
Bundled Patterns
| pattern LaunchType_EC2 :: LaunchType | |
| pattern LaunchType_EXTERNAL :: LaunchType | |
| pattern LaunchType_FARGATE :: LaunchType |
Instances
LogDriver
Constructors
| LogDriver' | |
Fields | |
Bundled Patterns
| pattern LogDriver_Awsfirelens :: LogDriver | |
| pattern LogDriver_Awslogs :: LogDriver | |
| pattern LogDriver_Fluentd :: LogDriver | |
| pattern LogDriver_Gelf :: LogDriver | |
| pattern LogDriver_Journald :: LogDriver | |
| pattern LogDriver_Json_file :: LogDriver | |
| pattern LogDriver_Splunk :: LogDriver | |
| pattern LogDriver_Syslog :: LogDriver |
Instances
ManagedAgentName
newtype ManagedAgentName Source #
Constructors
| ManagedAgentName' | |
Fields | |
Bundled Patterns
| pattern ManagedAgentName_ExecuteCommandAgent :: ManagedAgentName |
Instances
ManagedScalingStatus
newtype ManagedScalingStatus Source #
Constructors
| ManagedScalingStatus' | |
Fields | |
Bundled Patterns
| pattern ManagedScalingStatus_DISABLED :: ManagedScalingStatus | |
| pattern ManagedScalingStatus_ENABLED :: ManagedScalingStatus |
Instances
ManagedTerminationProtection
newtype ManagedTerminationProtection Source #
Constructors
| ManagedTerminationProtection' | |
Fields | |
Bundled Patterns
| pattern ManagedTerminationProtection_DISABLED :: ManagedTerminationProtection | |
| pattern ManagedTerminationProtection_ENABLED :: ManagedTerminationProtection |
Instances
NetworkMode
newtype NetworkMode Source #
Constructors
| NetworkMode' | |
Fields | |
Bundled Patterns
| pattern NetworkMode_Awsvpc :: NetworkMode | |
| pattern NetworkMode_Bridge :: NetworkMode | |
| pattern NetworkMode_Host :: NetworkMode | |
| pattern NetworkMode_None :: NetworkMode |
Instances
OSFamily
Constructors
| OSFamily' | |
Fields
| |
Bundled Patterns
| pattern OSFamily_LINUX :: OSFamily | |
| pattern OSFamily_WINDOWS_SERVER_2004_CORE :: OSFamily | |
| pattern OSFamily_WINDOWS_SERVER_2016_FULL :: OSFamily | |
| pattern OSFamily_WINDOWS_SERVER_2019_CORE :: OSFamily | |
| pattern OSFamily_WINDOWS_SERVER_2019_FULL :: OSFamily | |
| pattern OSFamily_WINDOWS_SERVER_2022_CORE :: OSFamily | |
| pattern OSFamily_WINDOWS_SERVER_2022_FULL :: OSFamily | |
| pattern OSFamily_WINDOWS_SERVER_20H2_CORE :: OSFamily |
Instances
PidMode
Constructors
| PidMode' | |
Fields
| |
Bundled Patterns
| pattern PidMode_Host :: PidMode | |
| pattern PidMode_Task :: PidMode |
Instances
PlacementConstraintType
newtype PlacementConstraintType Source #
Constructors
| PlacementConstraintType' | |
Fields | |
Bundled Patterns
| pattern PlacementConstraintType_DistinctInstance :: PlacementConstraintType | |
| pattern PlacementConstraintType_MemberOf :: PlacementConstraintType |
Instances
PlacementStrategyType
newtype PlacementStrategyType Source #
Constructors
| PlacementStrategyType' | |
Fields | |
Bundled Patterns
| pattern PlacementStrategyType_Binpack :: PlacementStrategyType | |
| pattern PlacementStrategyType_Random :: PlacementStrategyType | |
| pattern PlacementStrategyType_Spread :: PlacementStrategyType |
Instances
PlatformDeviceType
newtype PlatformDeviceType Source #
Constructors
| PlatformDeviceType' | |
Fields | |
Bundled Patterns
| pattern PlatformDeviceType_GPU :: PlatformDeviceType |
Instances
PropagateTags
newtype PropagateTags Source #
Constructors
| PropagateTags' | |
Fields | |
Bundled Patterns
| pattern PropagateTags_NONE :: PropagateTags | |
| pattern PropagateTags_SERVICE :: PropagateTags | |
| pattern PropagateTags_TASK_DEFINITION :: PropagateTags |
Instances
ProxyConfigurationType
newtype ProxyConfigurationType Source #
Constructors
| ProxyConfigurationType' | |
Fields | |
Bundled Patterns
| pattern ProxyConfigurationType_APPMESH :: ProxyConfigurationType |
Instances
ResourceType
newtype ResourceType Source #
Constructors
| ResourceType' | |
Fields | |
Bundled Patterns
| pattern ResourceType_GPU :: ResourceType | |
| pattern ResourceType_InferenceAccelerator :: ResourceType |
Instances
ScaleUnit
Constructors
| ScaleUnit' | |
Fields | |
Bundled Patterns
| pattern ScaleUnit_PERCENT :: ScaleUnit |
Instances
SchedulingStrategy
newtype SchedulingStrategy Source #
Constructors
| SchedulingStrategy' | |
Fields | |
Bundled Patterns
| pattern SchedulingStrategy_DAEMON :: SchedulingStrategy | |
| pattern SchedulingStrategy_REPLICA :: SchedulingStrategy |
Instances
Scope
Bundled Patterns
| pattern Scope_Shared :: Scope | |
| pattern Scope_Task :: Scope |
Instances
ServiceField
newtype ServiceField Source #
Constructors
| ServiceField' | |
Fields | |
Bundled Patterns
| pattern ServiceField_TAGS :: ServiceField |
Instances
SettingName
newtype SettingName Source #
Constructors
| SettingName' | |
Fields | |
Bundled Patterns
| pattern SettingName_AwsvpcTrunking :: SettingName | |
| pattern SettingName_ContainerInsights :: SettingName | |
| pattern SettingName_ContainerInstanceLongArnFormat :: SettingName | |
| pattern SettingName_ServiceLongArnFormat :: SettingName | |
| pattern SettingName_TaskLongArnFormat :: SettingName |
Instances
SortOrder
Constructors
| SortOrder' | |
Fields | |
Bundled Patterns
| pattern SortOrder_ASC :: SortOrder | |
| pattern SortOrder_DESC :: SortOrder |
Instances
StabilityStatus
newtype StabilityStatus Source #
Constructors
| StabilityStatus' | |
Fields | |
Bundled Patterns
| pattern StabilityStatus_STABILIZING :: StabilityStatus | |
| pattern StabilityStatus_STEADY_STATE :: StabilityStatus |
Instances
TargetType
newtype TargetType Source #
Constructors
| TargetType' | |
Fields | |
Bundled Patterns
| pattern TargetType_Container_instance :: TargetType |
Instances
TaskDefinitionFamilyStatus
newtype TaskDefinitionFamilyStatus Source #
Constructors
| TaskDefinitionFamilyStatus' | |
Fields | |
Bundled Patterns
Instances
TaskDefinitionField
newtype TaskDefinitionField Source #
Constructors
| TaskDefinitionField' | |
Fields | |
Bundled Patterns
| pattern TaskDefinitionField_TAGS :: TaskDefinitionField |
Instances
TaskDefinitionPlacementConstraintType
newtype TaskDefinitionPlacementConstraintType Source #
Constructors
| TaskDefinitionPlacementConstraintType' | |
Bundled Patterns
| pattern TaskDefinitionPlacementConstraintType_MemberOf :: TaskDefinitionPlacementConstraintType |
Instances
TaskDefinitionStatus
newtype TaskDefinitionStatus Source #
Constructors
| TaskDefinitionStatus' | |
Fields | |
Bundled Patterns
| pattern TaskDefinitionStatus_ACTIVE :: TaskDefinitionStatus | |
| pattern TaskDefinitionStatus_INACTIVE :: TaskDefinitionStatus |
Instances
TaskField
Constructors
| TaskField' | |
Fields | |
Bundled Patterns
| pattern TaskField_TAGS :: TaskField |
Instances
TaskSetField
newtype TaskSetField Source #
Constructors
| TaskSetField' | |
Fields | |
Bundled Patterns
| pattern TaskSetField_TAGS :: TaskSetField |
Instances
TaskStopCode
newtype TaskStopCode Source #
Constructors
| TaskStopCode' | |
Fields | |
Bundled Patterns
| pattern TaskStopCode_EssentialContainerExited :: TaskStopCode | |
| pattern TaskStopCode_ServiceSchedulerInitiated :: TaskStopCode | |
| pattern TaskStopCode_SpotInterruption :: TaskStopCode | |
| pattern TaskStopCode_TaskFailedToStart :: TaskStopCode | |
| pattern TaskStopCode_TerminationNotice :: TaskStopCode | |
| pattern TaskStopCode_UserInitiated :: TaskStopCode |
Instances
TransportProtocol
newtype TransportProtocol Source #
Constructors
| TransportProtocol' | |
Fields | |
Bundled Patterns
| pattern TransportProtocol_Tcp :: TransportProtocol | |
| pattern TransportProtocol_Udp :: TransportProtocol |
Instances
UlimitName
newtype UlimitName Source #
Constructors
| UlimitName' | |
Fields | |
Bundled Patterns
| pattern UlimitName_Core :: UlimitName | |
| pattern UlimitName_Cpu :: UlimitName | |
| pattern UlimitName_Data :: UlimitName | |
| pattern UlimitName_Fsize :: UlimitName | |
| pattern UlimitName_Locks :: UlimitName | |
| pattern UlimitName_Memlock :: UlimitName | |
| pattern UlimitName_Msgqueue :: UlimitName | |
| pattern UlimitName_Nice :: UlimitName | |
| pattern UlimitName_Nofile :: UlimitName | |
| pattern UlimitName_Nproc :: UlimitName | |
| pattern UlimitName_Rss :: UlimitName | |
| pattern UlimitName_Rtprio :: UlimitName | |
| pattern UlimitName_Rttime :: UlimitName | |
| pattern UlimitName_Sigpending :: UlimitName | |
| pattern UlimitName_Stack :: UlimitName |
Instances
Attachment
data Attachment Source #
An object representing a container instance or task attachment.
See: newAttachment smart constructor.
Constructors
| Attachment' | |
Fields
| |
Instances
newAttachment :: Attachment Source #
Create a value of Attachment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:details:Attachment', attachment_details - 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.
$sel:id:Attachment', attachment_id - The unique identifier for the attachment.
$sel:status:Attachment', attachment_status - The status of the attachment. Valid values are PRECREATED, CREATED,
ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED, and
FAILED.
$sel:type':Attachment', attachment_type - The type of the attachment, such as ElasticNetworkInterface.
attachment_details :: Lens' Attachment (Maybe [KeyValuePair]) Source #
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.
attachment_id :: Lens' Attachment (Maybe Text) Source #
The unique identifier for the attachment.
attachment_status :: Lens' Attachment (Maybe Text) Source #
The status of the attachment. Valid values are PRECREATED, CREATED,
ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED, and
FAILED.
attachment_type :: Lens' Attachment (Maybe Text) Source #
The type of the attachment, such as ElasticNetworkInterface.
AttachmentStateChange
data AttachmentStateChange Source #
An object representing a change in state for a task attachment.
See: newAttachmentStateChange smart constructor.
Constructors
| AttachmentStateChange' | |
Fields
| |
Instances
newAttachmentStateChange Source #
Arguments
| :: Text | |
| -> Text | |
| -> AttachmentStateChange |
Create a value of AttachmentStateChange with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attachmentArn:AttachmentStateChange', attachmentStateChange_attachmentArn - The Amazon Resource Name (ARN) of the attachment.
$sel:status:AttachmentStateChange', attachmentStateChange_status - The status of the attachment.
attachmentStateChange_attachmentArn :: Lens' AttachmentStateChange Text Source #
The Amazon Resource Name (ARN) of the attachment.
attachmentStateChange_status :: Lens' AttachmentStateChange Text Source #
The status of the attachment.
Attribute
An attribute is a name-value pair that's associated with an Amazon ECS object. Use attributes 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: newAttribute smart constructor.
Constructors
| Attribute' | |
Fields
| |
Instances
Create a value of Attribute with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetId:Attribute', attribute_targetId - The ID of the target. You can specify the short form ID for a resource
or the full Amazon Resource Name (ARN).
$sel:targetType:Attribute', attribute_targetType - The type of the target to attach the attribute with. This parameter is
required if you use the short form ID for a resource instead of the full
ARN.
$sel:value:Attribute', attribute_value - The value of the attribute. The value must contain between 1 and 128
characters. It can contain letters (uppercase and lowercase), numbers,
hyphens (-), underscores (_), periods (.), at signs (@), forward
slashes (/), back slashes (\), colons (:), or spaces. The value can't
start or end with a space.
$sel:name:Attribute', attribute_name - The name of the attribute. The name must contain between 1 and 128
characters. The name may contain letters (uppercase and lowercase),
numbers, hyphens (-), underscores (_), forward slashes (/), back
slashes (\), or periods (.).
attribute_targetId :: Lens' Attribute (Maybe Text) Source #
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
attribute_targetType :: Lens' Attribute (Maybe TargetType) Source #
The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.
attribute_value :: Lens' Attribute (Maybe Text) Source #
The value of the attribute. The value must contain between 1 and 128
characters. It can contain letters (uppercase and lowercase), numbers,
hyphens (-), underscores (_), periods (.), at signs (@), forward
slashes (/), back slashes (\), colons (:), or spaces. The value can't
start or end with a space.
attribute_name :: Lens' Attribute Text Source #
The name of the attribute. The name must contain between 1 and 128
characters. The name may contain letters (uppercase and lowercase),
numbers, hyphens (-), underscores (_), forward slashes (/), back
slashes (\), or periods (.).
AutoScalingGroupProvider
data AutoScalingGroupProvider Source #
The details of the Auto Scaling group for the capacity provider.
See: newAutoScalingGroupProvider smart constructor.
Constructors
| AutoScalingGroupProvider' | |
Fields
| |
Instances
newAutoScalingGroupProvider Source #
Create a value of AutoScalingGroupProvider with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:managedScaling:AutoScalingGroupProvider', autoScalingGroupProvider_managedScaling - The managed scaling settings for the Auto Scaling group capacity
provider.
$sel:managedTerminationProtection:AutoScalingGroupProvider', autoScalingGroupProvider_managedTerminationProtection - The managed termination protection setting to use for the Auto Scaling
group capacity provider. This determines whether the Auto Scaling group
has managed termination protection. The default is disabled.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.
When managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.
$sel:autoScalingGroupArn:AutoScalingGroupProvider', autoScalingGroupProvider_autoScalingGroupArn - The Amazon Resource Name (ARN) that identifies the Auto Scaling group.
autoScalingGroupProvider_managedScaling :: Lens' AutoScalingGroupProvider (Maybe ManagedScaling) Source #
The managed scaling settings for the Auto Scaling group capacity provider.
autoScalingGroupProvider_managedTerminationProtection :: Lens' AutoScalingGroupProvider (Maybe ManagedTerminationProtection) Source #
The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is disabled.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.
When managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.
autoScalingGroupProvider_autoScalingGroupArn :: Lens' AutoScalingGroupProvider Text Source #
The Amazon Resource Name (ARN) that identifies the Auto Scaling group.
AutoScalingGroupProviderUpdate
data AutoScalingGroupProviderUpdate Source #
The details of the Auto Scaling group capacity provider to update.
See: newAutoScalingGroupProviderUpdate smart constructor.
Constructors
| AutoScalingGroupProviderUpdate' | |
Fields
| |
Instances
newAutoScalingGroupProviderUpdate :: AutoScalingGroupProviderUpdate Source #
Create a value of AutoScalingGroupProviderUpdate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:managedScaling:AutoScalingGroupProviderUpdate', autoScalingGroupProviderUpdate_managedScaling - The managed scaling settings for the Auto Scaling group capacity
provider.
$sel:managedTerminationProtection:AutoScalingGroupProviderUpdate', autoScalingGroupProviderUpdate_managedTerminationProtection - The managed termination protection setting to use for the Auto Scaling
group capacity provider. This determines whether the Auto Scaling group
has managed termination protection.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled. For more information, see Instance Protection in the Auto Scaling User Guide.
When managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.
autoScalingGroupProviderUpdate_managedScaling :: Lens' AutoScalingGroupProviderUpdate (Maybe ManagedScaling) Source #
The managed scaling settings for the Auto Scaling group capacity provider.
autoScalingGroupProviderUpdate_managedTerminationProtection :: Lens' AutoScalingGroupProviderUpdate (Maybe ManagedTerminationProtection) Source #
The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled. For more information, see Instance Protection in the Auto Scaling User Guide.
When managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.
AwsVpcConfiguration
data AwsVpcConfiguration Source #
An object representing the networking details for a task or service.
See: newAwsVpcConfiguration smart constructor.
Constructors
| AwsVpcConfiguration' | |
Fields
| |
Instances
newAwsVpcConfiguration :: AwsVpcConfiguration Source #
Create a value of AwsVpcConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assignPublicIp:AwsVpcConfiguration', awsVpcConfiguration_assignPublicIp - Whether the task's elastic network interface receives a public IP
address. The default value is DISABLED.
$sel:securityGroups:AwsVpcConfiguration', awsVpcConfiguration_securityGroups - The IDs of the security groups associated with the task or service. If
you don't specify a security group, the default security group for the
VPC is used. There's a limit of 5 security groups that can be specified
per AwsVpcConfiguration.
All specified security groups must be from the same VPC.
$sel:subnets:AwsVpcConfiguration', awsVpcConfiguration_subnets - The IDs of the subnets associated with the task or service. There's a
limit of 16 subnets that can be specified per AwsVpcConfiguration.
All specified subnets must be from the same VPC.
awsVpcConfiguration_assignPublicIp :: Lens' AwsVpcConfiguration (Maybe AssignPublicIp) Source #
Whether the task's elastic network interface receives a public IP
address. The default value is DISABLED.
awsVpcConfiguration_securityGroups :: Lens' AwsVpcConfiguration (Maybe [Text]) Source #
The IDs of the security groups associated with the task or service. If
you don't specify a security group, the default security group for the
VPC is used. There's a limit of 5 security groups that can be specified
per AwsVpcConfiguration.
All specified security groups must be from the same VPC.
awsVpcConfiguration_subnets :: Lens' AwsVpcConfiguration [Text] Source #
The IDs of the subnets associated with the task or service. There's a
limit of 16 subnets that can be specified per AwsVpcConfiguration.
All specified subnets must be from the same VPC.
CapacityProvider
data CapacityProvider Source #
The details for a capacity provider.
See: newCapacityProvider smart constructor.
Constructors
| CapacityProvider' | |
Fields
| |
Instances
newCapacityProvider :: CapacityProvider Source #
Create a value of CapacityProvider with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoScalingGroupProvider:CapacityProvider', capacityProvider_autoScalingGroupProvider - The Auto Scaling group settings for the capacity provider.
$sel:capacityProviderArn:CapacityProvider', capacityProvider_capacityProviderArn - The Amazon Resource Name (ARN) that identifies the capacity provider.
$sel:name:CapacityProvider', capacityProvider_name - The name of the capacity provider.
$sel:status:CapacityProvider', capacityProvider_status - The current status of the capacity provider. Only capacity providers in
an ACTIVE state can be used in a cluster. When a capacity provider is
successfully deleted, it has an INACTIVE status.
$sel:tags:CapacityProvider', capacityProvider_tags - The metadata that you apply to the capacity provider to help you
categorize and organize it. Each tag consists of a key and an optional
value. You define both.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
$sel:updateStatus:CapacityProvider', capacityProvider_updateStatus - The update status of the capacity provider. The following are the
possible states that is returned.
- DELETE_IN_PROGRESS
- The capacity provider is in the process of being deleted.
- DELETE_COMPLETE
- The capacity provider was successfully deleted and has an
INACTIVEstatus. - DELETE_FAILED
- The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.
$sel:updateStatusReason:CapacityProvider', capacityProvider_updateStatusReason - The update status reason. This provides further details about the update
status for the capacity provider.
capacityProvider_autoScalingGroupProvider :: Lens' CapacityProvider (Maybe AutoScalingGroupProvider) Source #
The Auto Scaling group settings for the capacity provider.
capacityProvider_capacityProviderArn :: Lens' CapacityProvider (Maybe Text) Source #
The Amazon Resource Name (ARN) that identifies the capacity provider.
capacityProvider_name :: Lens' CapacityProvider (Maybe Text) Source #
The name of the capacity provider.
capacityProvider_status :: Lens' CapacityProvider (Maybe CapacityProviderStatus) Source #
The current status of the capacity provider. Only capacity providers in
an ACTIVE state can be used in a cluster. When a capacity provider is
successfully deleted, it has an INACTIVE status.
capacityProvider_tags :: Lens' CapacityProvider (Maybe [Tag]) Source #
The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
capacityProvider_updateStatus :: Lens' CapacityProvider (Maybe CapacityProviderUpdateStatus) Source #
The update status of the capacity provider. The following are the possible states that is returned.
- DELETE_IN_PROGRESS
- The capacity provider is in the process of being deleted.
- DELETE_COMPLETE
- The capacity provider was successfully deleted and has an
INACTIVEstatus. - DELETE_FAILED
- The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.
capacityProvider_updateStatusReason :: Lens' CapacityProvider (Maybe Text) Source #
The update status reason. This provides further details about the update status for the capacity provider.
CapacityProviderStrategyItem
data CapacityProviderStrategyItem Source #
The details of a capacity provider strategy. A capacity provider strategy can be set when using the RunTask or CreateCluster APIs or as the default capacity provider strategy for a cluster with the CreateCluster API.
Only capacity providers that are already associated with a cluster and
have an ACTIVE or UPDATING status can be used in a capacity provider
strategy. The PutClusterCapacityProviders API is used to associate a
capacity provider with a cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.
To use a Fargate capacity provider, specify either the FARGATE or
FARGATE_SPOT capacity providers. The Fargate capacity providers are
available to all accounts and only need to be associated with a cluster
to be used in a capacity provider strategy.
A capacity provider strategy may contain a maximum of 6 capacity providers.
See: newCapacityProviderStrategyItem smart constructor.
Constructors
| CapacityProviderStrategyItem' | |
Fields
| |
Instances
newCapacityProviderStrategyItem Source #
Create a value of CapacityProviderStrategyItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:base:CapacityProviderStrategyItem', capacityProviderStrategyItem_base - The base value designates how many tasks, at a minimum, to run on the
specified capacity provider. Only one capacity provider in a capacity
provider strategy can have a base defined. If no value is specified,
the default value of 0 is used.
$sel:weight:CapacityProviderStrategyItem', capacityProviderStrategyItem_weight - The weight value designates the relative percentage of the total
number of tasks launched that should use the specified capacity
provider. The weight value is taken into consideration after the
base value, if defined, is satisfied.
If no weight value is specified, the default value of 0 is used.
When multiple capacity providers are specified within a capacity
provider strategy, at least one of the capacity providers must have a
weight value greater than zero and any capacity providers with a weight
of 0 can't be used to place tasks. If you specify multiple capacity
providers in a strategy that all have a weight of 0, any RunTask or
CreateService actions using the capacity provider strategy will fail.
An example scenario for using weights is defining a strategy that
contains two capacity providers and both have a weight of 1, then when
the base is satisfied, the tasks will be split evenly across the two
capacity providers. Using that same logic, if you specify a weight of
1 for capacityProviderA and a weight of 4 for capacityProviderB,
then for every one task that's run using capacityProviderA, four
tasks would use capacityProviderB.
$sel:capacityProvider:CapacityProviderStrategyItem', capacityProviderStrategyItem_capacityProvider - The short name of the capacity provider.
capacityProviderStrategyItem_base :: Lens' CapacityProviderStrategyItem (Maybe Natural) Source #
The base value designates how many tasks, at a minimum, to run on the
specified capacity provider. Only one capacity provider in a capacity
provider strategy can have a base defined. If no value is specified,
the default value of 0 is used.
capacityProviderStrategyItem_weight :: Lens' CapacityProviderStrategyItem (Maybe Natural) Source #
The weight value designates the relative percentage of the total
number of tasks launched that should use the specified capacity
provider. The weight value is taken into consideration after the
base value, if defined, is satisfied.
If no weight value is specified, the default value of 0 is used.
When multiple capacity providers are specified within a capacity
provider strategy, at least one of the capacity providers must have a
weight value greater than zero and any capacity providers with a weight
of 0 can't be used to place tasks. If you specify multiple capacity
providers in a strategy that all have a weight of 0, any RunTask or
CreateService actions using the capacity provider strategy will fail.
An example scenario for using weights is defining a strategy that
contains two capacity providers and both have a weight of 1, then when
the base is satisfied, the tasks will be split evenly across the two
capacity providers. Using that same logic, if you specify a weight of
1 for capacityProviderA and a weight of 4 for capacityProviderB,
then for every one task that's run using capacityProviderA, four
tasks would use capacityProviderB.
capacityProviderStrategyItem_capacityProvider :: Lens' CapacityProviderStrategyItem Text Source #
The short name of the capacity provider.
Cluster
A regional grouping of one or more container instances where 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: newCluster smart constructor.
Constructors
| Cluster' | |
Fields
| |
Instances
newCluster :: Cluster Source #
Create a value of Cluster with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:activeServicesCount:Cluster', cluster_activeServicesCount - The number of services that are running on the cluster in an ACTIVE
state. You can view these services with ListServices.
$sel:attachments:Cluster', cluster_attachments - The resources attached to a cluster. When using a capacity provider with
a cluster, the capacity provider and associated resources are returned
as cluster attachments.
$sel:attachmentsStatus:Cluster', cluster_attachmentsStatus - The status of the capacity providers associated with the cluster. The
following are the states that are returned.
- UPDATE_IN_PROGRESS
- The available capacity providers for the cluster are updating.
- UPDATE_COMPLETE
- The capacity providers have successfully updated.
- UPDATE_FAILED
- The capacity provider updates failed.
$sel:capacityProviders:Cluster', cluster_capacityProviders - The capacity providers associated with the cluster.
$sel:clusterArn:Cluster', cluster_clusterArn - The Amazon Resource Name (ARN) that identifies the cluster. For more
information about the ARN format, see
Amazon Resource Name (ARN)
in the Amazon ECS Developer Guide.
$sel:clusterName:Cluster', cluster_clusterName - A user-generated string that you use to identify your cluster.
$sel:configuration:Cluster', cluster_configuration - The execute command configuration for the cluster.
$sel:defaultCapacityProviderStrategy:Cluster', cluster_defaultCapacityProviderStrategy - The default capacity provider strategy for the cluster. When services or
tasks are run in the cluster with no launch type or capacity provider
strategy specified, the default capacity provider strategy is used.
$sel:pendingTasksCount:Cluster', cluster_pendingTasksCount - The number of tasks in the cluster that are in the PENDING state.
$sel:registeredContainerInstancesCount:Cluster', cluster_registeredContainerInstancesCount - The number of container instances registered into the cluster. This
includes container instances in both ACTIVE and DRAINING status.
$sel:runningTasksCount:Cluster', cluster_runningTasksCount - The number of tasks in the cluster that are in the RUNNING state.
$sel:serviceConnectDefaults:Cluster', cluster_serviceConnectDefaults - Use this parameter to set a default Service Connect namespace. After you
set a default Service Connect namespace, any new services with Service
Connect turned on that are created in the cluster are added as client
services in the namespace. This setting only applies to new services
that set the enabled parameter to true in the
ServiceConnectConfiguration. You can set the namespace of each service
individually in the ServiceConnectConfiguration to override this
default parameter.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
$sel:settings:Cluster', cluster_settings - The settings for the cluster. This parameter indicates whether
CloudWatch Container Insights is enabled or disabled for a cluster.
$sel:statistics:Cluster', cluster_statistics - Additional information about your clusters that are separated by launch
type. They include the following:
- runningEC2TasksCount
- RunningFargateTasksCount
- pendingEC2TasksCount
- pendingFargateTasksCount
- activeEC2ServiceCount
- activeFargateServiceCount
- drainingEC2ServiceCount
- drainingFargateServiceCount
Cluster, cluster_status - The status of the cluster. The following are the possible states that
are returned.
- ACTIVE
- The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
- PROVISIONING
- The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.
- DEPROVISIONING
- The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.
- FAILED
- The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.
- INACTIVE
- The cluster has been deleted. Clusters with an
INACTIVEstatus may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely onINACTIVEclusters persisting.
$sel:tags:Cluster', cluster_tags - The metadata that you apply to the cluster to help you categorize and
organize them. Each tag consists of a key and an optional value. You
define both.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
cluster_activeServicesCount :: Lens' Cluster (Maybe Int) Source #
The number of services that are running on the cluster in an ACTIVE
state. You can view these services with ListServices.
cluster_attachments :: Lens' Cluster (Maybe [Attachment]) Source #
The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.
cluster_attachmentsStatus :: Lens' Cluster (Maybe Text) Source #
The status of the capacity providers associated with the cluster. The following are the states that are returned.
- UPDATE_IN_PROGRESS
- The available capacity providers for the cluster are updating.
- UPDATE_COMPLETE
- The capacity providers have successfully updated.
- UPDATE_FAILED
- The capacity provider updates failed.
cluster_capacityProviders :: Lens' Cluster (Maybe [Text]) Source #
The capacity providers associated with the cluster.
cluster_clusterArn :: Lens' Cluster (Maybe Text) Source #
The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
cluster_clusterName :: Lens' Cluster (Maybe Text) Source #
A user-generated string that you use to identify your cluster.
cluster_configuration :: Lens' Cluster (Maybe ClusterConfiguration) Source #
The execute command configuration for the cluster.
cluster_defaultCapacityProviderStrategy :: Lens' Cluster (Maybe [CapacityProviderStrategyItem]) Source #
The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
cluster_pendingTasksCount :: Lens' Cluster (Maybe Int) Source #
The number of tasks in the cluster that are in the PENDING state.
cluster_registeredContainerInstancesCount :: Lens' Cluster (Maybe Int) Source #
The number of container instances registered into the cluster. This
includes container instances in both ACTIVE and DRAINING status.
cluster_runningTasksCount :: Lens' Cluster (Maybe Int) Source #
The number of tasks in the cluster that are in the RUNNING state.
cluster_serviceConnectDefaults :: Lens' Cluster (Maybe ClusterServiceConnectDefaults) Source #
Use this parameter to set a default Service Connect namespace. After you
set a default Service Connect namespace, any new services with Service
Connect turned on that are created in the cluster are added as client
services in the namespace. This setting only applies to new services
that set the enabled parameter to true in the
ServiceConnectConfiguration. You can set the namespace of each service
individually in the ServiceConnectConfiguration to override this
default parameter.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
cluster_settings :: Lens' Cluster (Maybe [ClusterSetting]) Source #
The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
cluster_statistics :: Lens' Cluster (Maybe [KeyValuePair]) Source #
Additional information about your clusters that are separated by launch type. They include the following:
- runningEC2TasksCount
- RunningFargateTasksCount
- pendingEC2TasksCount
- pendingFargateTasksCount
- activeEC2ServiceCount
- activeFargateServiceCount
- drainingEC2ServiceCount
- drainingFargateServiceCount
cluster_status :: Lens' Cluster (Maybe Text) Source #
The status of the cluster. The following are the possible states that are returned.
- ACTIVE
- The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
- PROVISIONING
- The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.
- DEPROVISIONING
- The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.
- FAILED
- The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.
- INACTIVE
- The cluster has been deleted. Clusters with an
INACTIVEstatus may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely onINACTIVEclusters persisting.
cluster_tags :: Lens' Cluster (Maybe [Tag]) Source #
The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
ClusterConfiguration
data ClusterConfiguration Source #
The execute command configuration for the cluster.
See: newClusterConfiguration smart constructor.
Constructors
| ClusterConfiguration' | |
Fields
| |
Instances
newClusterConfiguration :: ClusterConfiguration Source #
Create a value of ClusterConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:executeCommandConfiguration:ClusterConfiguration', clusterConfiguration_executeCommandConfiguration - The details of the execute command configuration.
clusterConfiguration_executeCommandConfiguration :: Lens' ClusterConfiguration (Maybe ExecuteCommandConfiguration) Source #
The details of the execute command configuration.
ClusterServiceConnectDefaults
data ClusterServiceConnectDefaults Source #
Use this parameter to set a default Service Connect namespace. After you
set a default Service Connect namespace, any new services with Service
Connect turned on that are created in the cluster are added as client
services in the namespace. This setting only applies to new services
that set the enabled parameter to true in the
ServiceConnectConfiguration. You can set the namespace of each service
individually in the ServiceConnectConfiguration to override this
default parameter.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
See: newClusterServiceConnectDefaults smart constructor.
Constructors
| ClusterServiceConnectDefaults' | |
Instances
newClusterServiceConnectDefaults :: ClusterServiceConnectDefaults Source #
Create a value of ClusterServiceConnectDefaults with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:namespace:ClusterServiceConnectDefaults', clusterServiceConnectDefaults_namespace - The namespace name or full Amazon Resource Name (ARN) of the Cloud Map
namespace. When you create a service and don't specify a Service
Connect configuration, this namespace is used.
clusterServiceConnectDefaults_namespace :: Lens' ClusterServiceConnectDefaults (Maybe Text) Source #
The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a Service Connect configuration, this namespace is used.
ClusterServiceConnectDefaultsRequest
data ClusterServiceConnectDefaultsRequest Source #
Use this parameter to set a default Service Connect namespace. After you
set a default Service Connect namespace, any new services with Service
Connect turned on that are created in the cluster are added as client
services in the namespace. This setting only applies to new services
that set the enabled parameter to true in the
ServiceConnectConfiguration. You can set the namespace of each service
individually in the ServiceConnectConfiguration to override this
default parameter.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
See: newClusterServiceConnectDefaultsRequest smart constructor.
Constructors
| ClusterServiceConnectDefaultsRequest' | |
Fields
| |
Instances
newClusterServiceConnectDefaultsRequest Source #
Arguments
| :: Text | |
| -> ClusterServiceConnectDefaultsRequest |
Create a value of ClusterServiceConnectDefaultsRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:namespace:ClusterServiceConnectDefaultsRequest', clusterServiceConnectDefaultsRequest_namespace - The namespace name or full Amazon Resource Name (ARN) of the Cloud Map
namespace that's used when you create a service and don't specify a
Service Connect configuration. The namespace name can include up to 1024
characters. The name is case-sensitive. The name can't include hyphens
(-), tilde (~), greater than (>), less than (<), or slash (/).
If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this Amazon Web Services Region.
If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a Cloud Map namespace with the "API calls" method of instance discovery only. This instance discovery method is the "HTTP" namespace type in the Command Line Interface. Other types of instance discovery aren't used by Service Connect.
If you update the service with an empty string "" for the namespace
name, the cluster configuration for Service Connect is removed. Note
that the namespace will remain in Cloud Map and must be deleted
separately.
For more information about Cloud Map, see Working with Services in the /Cloud Map Developer Guide/.
clusterServiceConnectDefaultsRequest_namespace :: Lens' ClusterServiceConnectDefaultsRequest Text Source #
The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/).
If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this Amazon Web Services Region.
If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a Cloud Map namespace with the "API calls" method of instance discovery only. This instance discovery method is the "HTTP" namespace type in the Command Line Interface. Other types of instance discovery aren't used by Service Connect.
If you update the service with an empty string "" for the namespace
name, the cluster configuration for Service Connect is removed. Note
that the namespace will remain in Cloud Map and must be deleted
separately.
For more information about Cloud Map, see Working with Services in the /Cloud Map Developer Guide/.
ClusterSetting
data ClusterSetting Source #
The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.
See: newClusterSetting smart constructor.
Constructors
| ClusterSetting' | |
Fields
| |
Instances
newClusterSetting :: ClusterSetting Source #
Create a value of ClusterSetting with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:ClusterSetting', clusterSetting_name - The name of the cluster setting. The only supported value is
containerInsights.
$sel:value:ClusterSetting', clusterSetting_value - The value to set for the cluster setting. The supported values are
enabled and disabled. If enabled is specified, CloudWatch
Container Insights will be enabled for the cluster, otherwise it will be
disabled unless the containerInsights account setting is enabled. If a
cluster value is specified, it will override the containerInsights
value set with PutAccountSetting or PutAccountSettingDefault.
clusterSetting_name :: Lens' ClusterSetting (Maybe ClusterSettingName) Source #
The name of the cluster setting. The only supported value is
containerInsights.
clusterSetting_value :: Lens' ClusterSetting (Maybe Text) Source #
The value to set for the cluster setting. The supported values are
enabled and disabled. If enabled is specified, CloudWatch
Container Insights will be enabled for the cluster, otherwise it will be
disabled unless the containerInsights account setting is enabled. If a
cluster value is specified, it will override the containerInsights
value set with PutAccountSetting or PutAccountSettingDefault.
Container
A Docker container that's part of a task.
See: newContainer smart constructor.
Constructors
| Container' | |
Fields
| |
Instances
newContainer :: Container Source #
Create a value of Container with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containerArn:Container', container_containerArn - The Amazon Resource Name (ARN) of the container.
$sel:cpu:Container', container_cpu - The number of CPU units set for the container. The value is 0 if no
value was specified in the container definition when the task definition
was registered.
$sel:exitCode:Container', container_exitCode - The exit code returned from the container.
$sel:gpuIds:Container', container_gpuIds - The IDs of each GPU assigned to the container.
$sel:healthStatus:Container', container_healthStatus - The health status of the container. If health checks aren't configured
for this container in its task definition, then it reports the health
status as UNKNOWN.
$sel:image:Container', container_image - The image used for the container.
$sel:imageDigest:Container', container_imageDigest - The container image manifest digest.
The imageDigest is only returned if the container is using an image
hosted in Amazon ECR, otherwise it is omitted.
Container, container_lastStatus - The last known status of the container.
$sel:managedAgents:Container', container_managedAgents - The details of any Amazon ECS managed agents associated with the
container.
$sel:memory:Container', container_memory - The hard limit (in MiB) of memory set for the container.
$sel:memoryReservation:Container', container_memoryReservation - The soft limit (in MiB) of memory set for the container.
Container, container_name - The name of the container.
$sel:networkBindings:Container', container_networkBindings - The network bindings associated with the container.
$sel:networkInterfaces:Container', container_networkInterfaces - The network interfaces associated with the container.
Container, container_reason - A short (255 max characters) human-readable string to provide additional
details about a running or stopped container.
$sel:runtimeId:Container', container_runtimeId - The ID of the Docker container.
$sel:taskArn:Container', container_taskArn - The ARN of the task.
container_containerArn :: Lens' Container (Maybe Text) Source #
The Amazon Resource Name (ARN) of the container.
container_cpu :: Lens' Container (Maybe Text) Source #
The number of CPU units set for the container. The value is 0 if no
value was specified in the container definition when the task definition
was registered.
container_exitCode :: Lens' Container (Maybe Int) Source #
The exit code returned from the container.
container_gpuIds :: Lens' Container (Maybe [Text]) Source #
The IDs of each GPU assigned to the container.
container_healthStatus :: Lens' Container (Maybe HealthStatus) Source #
The health status of the container. If health checks aren't configured
for this container in its task definition, then it reports the health
status as UNKNOWN.
container_imageDigest :: Lens' Container (Maybe Text) Source #
The container image manifest digest.
The imageDigest is only returned if the container is using an image
hosted in Amazon ECR, otherwise it is omitted.
container_lastStatus :: Lens' Container (Maybe Text) Source #
The last known status of the container.
container_managedAgents :: Lens' Container (Maybe [ManagedAgent]) Source #
The details of any Amazon ECS managed agents associated with the container.
container_memory :: Lens' Container (Maybe Text) Source #
The hard limit (in MiB) of memory set for the container.
container_memoryReservation :: Lens' Container (Maybe Text) Source #
The soft limit (in MiB) of memory set for the container.
container_networkBindings :: Lens' Container (Maybe [NetworkBinding]) Source #
The network bindings associated with the container.
container_networkInterfaces :: Lens' Container (Maybe [NetworkInterface]) Source #
The network interfaces associated with the container.
container_reason :: Lens' Container (Maybe Text) Source #
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
ContainerDefinition
data ContainerDefinition Source #
Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
See: newContainerDefinition smart constructor.
Constructors
| ContainerDefinition' | |
Fields
| |
Instances
newContainerDefinition :: ContainerDefinition Source #
Create a value of ContainerDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ContainerDefinition, containerDefinition_command - The command that's 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. If there are
multiple arguments, each argument is a separated string in the array.
$sel:cpu:ContainerDefinition', containerDefinition_cpu - 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.
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
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's 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 is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. 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 isn't 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 two 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's described in the task definition. A null or zero
CPU value is passed to Docker as 0, which Windows interprets as 1% of
one CPU.
$sel:dependsOn:ContainerDefinition', containerDefinition_dependsOn - The dependencies defined for container startup and shutdown. A container
can contain multiple dependencies on other containers in a task
definition. When a dependency is defined for container startup, for
container shutdown it is reversed.
For tasks using the EC2 launch type, the container instances require at
least version 1.26.0 of the container agent to turn on container
dependencies. However, we recommend using the latest container agent
version. For information about checking your agent version and updating
to the latest version, see
Updating the Amazon ECS Container Agent
in the Amazon Elastic Container Service Developer Guide. If you're
using an Amazon ECS-optimized Linux AMI, your instance needs at least
version 1.26.0-1 of the ecs-init package. If your container instances
are launched from version 20190301 or later, then they contain the
required versions of the container agent and ecs-init. For more
information, see
Amazon ECS-optimized Linux AMI
in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires the following platforms:
- Linux platform version
1.3.0or later. - Windows platform version
1.0.0or later.
$sel:disableNetworking:ContainerDefinition', containerDefinition_disableNetworking - 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.
This parameter is not supported for Windows containers.
$sel:dnsSearchDomains:ContainerDefinition', containerDefinition_dnsSearchDomains - 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.
This parameter is not supported for Windows containers.
$sel:dnsServers:ContainerDefinition', containerDefinition_dnsServers - 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.
This parameter is not supported for Windows containers.
$sel:dockerLabels:ContainerDefinition', containerDefinition_dockerLabels - A key/value map of labels to add to the container. This parameter maps
to Labels in the
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 --format '{{.Server.APIVersion}}'
$sel:dockerSecurityOptions:ContainerDefinition', containerDefinition_dockerSecurityOptions - A list of strings to provide custom labels for SELinux and AppArmor
multi-level security systems. This field isn't valid for containers in
tasks using the Fargate launch type.
With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.
This parameter maps to SecurityOpt in the
Create a container
section of the
Docker Remote API and the
--security-opt option to
docker run.
The Amazon ECS container agent running on a container instance must
register with the ECS_SELINUX_CAPABLE=true or
ECS_APPARMOR_CAPABLE=true environment variables before containers
placed on that instance can use these security options. For more
information, see
Amazon ECS Container Agent Configuration
in the Amazon Elastic Container Service Developer Guide.
For more information about valid values, see Docker Run Security Configuration.
Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"
$sel:entryPoint:ContainerDefinition', containerDefinition_entryPoint - Early versions of the Amazon ECS container agent don't 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's 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.
$sel:environment:ContainerDefinition', containerDefinition_environment - 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.
We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.
$sel:environmentFiles:ContainerDefinition', containerDefinition_environmentFiles - A list of files containing the environment variables to pass to a
container. This parameter maps to the --env-file option to
docker run.
You can specify up to ten environment files. The file must have a .env
file extension. Each line in an environment file contains an environment
variable in VARIABLE=VALUE format. Lines beginning with # are
treated as comments and are ignored. For more information about the
environment variable file syntax, see
Declare default environment variables in file.
If there are environment variables specified using the environment
parameter in a container definition, they take precedence over the
variables contained within an environment file. If multiple environment
files are specified that contain the same variable, they're processed
from the top down. We recommend that you use unique variable names. For
more information, see
Specifying Environment Variables
in the Amazon Elastic Container Service Developer Guide.
$sel:essential:ContainerDefinition', containerDefinition_essential - 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, its failure doesn't 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's composed of multiple containers, 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.
$sel:extraHosts:ContainerDefinition', containerDefinition_extraHosts - A list of hostnames and IP address mappings to append to the
/etc/hosts file on the container. This parameter maps to
ExtraHosts in the
Create a container
section of the
Docker Remote API and the
--add-host option to
docker run.
This parameter isn't supported for Windows containers or tasks that use
the awsvpc network mode.
$sel:firelensConfiguration:ContainerDefinition', containerDefinition_firelensConfiguration - The FireLens configuration for the container. This is used to specify
and configure a log router for container logs. For more information, see
Custom Log Routing
in the Amazon Elastic Container Service Developer Guide.
$sel:healthCheck:ContainerDefinition', containerDefinition_healthCheck - The container 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.
ContainerDefinition, containerDefinition_hostname - 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.
The hostname parameter is not supported if you're using the awsvpc
network mode.
$sel:image:ContainerDefinition', containerDefinition_image - The image used to start a container. This string is passed directly to
the Docker daemon. By default, images in the Docker Hub registry are
available. 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 aren't propagated to already running tasks.
- Images in Amazon ECR repositories can be specified by either using
the full
registry/repository:tagorregistry/repository@digest. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latestor012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256: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,
amazon/amazon-ecs-agent). - Images in other online repositories are qualified further by a
domain name (for example,
quay.io/assemblyline/ubuntu).
$sel:interactive:ContainerDefinition', containerDefinition_interactive - When this parameter is true, you can deploy containerized applications
that require stdin or a tty to be allocated. This parameter maps to
OpenStdin in the
Create a container
section of the
Docker Remote API and the
--interactive option to
docker run.
$sel:links:ContainerDefinition', containerDefinition_links - The links parameter allows containers to communicate with each other
without the need for port mappings. This parameter is only supported if
the network mode of a task definition is bridge. The
name:internalName construct is analogous to name:alias in Docker
links. Up to 255 letters (uppercase and lowercase), numbers,
underscores, and hyphens are allowed. For more information about linking
Docker containers, go to
Legacy container links in the
Docker documentation. This parameter maps to Links in the
Create a container
section of the
Docker Remote API and the
--link option to
docker run.
This parameter is not supported for Windows containers.
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.
$sel:linuxParameters:ContainerDefinition', containerDefinition_linuxParameters - Linux-specific modifications that are applied to the container, such as
Linux kernel capabilities. For more information see KernelCapabilities.
This parameter is not supported for Windows containers.
$sel:logConfiguration:ContainerDefinition', containerDefinition_logConfiguration - The log configuration specification for the container.
This parameter maps to LogConfig in the
Create a container
section of the
Docker Remote API and the
--log-driver option to
docker run.
By default, containers use the same logging driver that the Docker
daemon uses. However the container can 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 about the options for different supported log drivers,
see
Configure logging drivers
in the Docker documentation.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
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 --format '{{.Server.APIVersion}}'
The Amazon ECS container agent running on a container instance must
register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers
placed on that instance can use these log configuration options. For
more information, see
Amazon ECS Container Agent Configuration
in the Amazon Elastic Container Service Developer Guide.
$sel:memory:ContainerDefinition', containerDefinition_memory - The amount (in MiB) of memory to present to the container. If your
container attempts to exceed the memory specified here, the container is
killed. The total amount of memory reserved for all containers within a
task must be lower than the task memory value, if one is specified.
This parameter maps to Memory in the
Create a container
section of the
Docker Remote API and the
--memory option to
docker run.
If using the Fargate launch type, this parameter is optional.
If using the EC2 launch type, you must specify either a task-level
memory value or a container-level memory value. If you specify both a
container-level memory and memoryReservation value, memory must be
greater than memoryReservation. If you specify memoryReservation,
then that value is subtracted from the available memory resources for
the container instance where the container is placed. Otherwise, the
value of memory is used.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
$sel:memoryReservation:ContainerDefinition', containerDefinition_memoryReservation - 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.
If a task-level memory value is not specified, you must specify a
non-zero integer for one or both of memory or memoryReservation in a
container definition. 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 where 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 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
$sel:mountPoints:ContainerDefinition', containerDefinition_mountPoints - 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 can't mount directories on a
different drive, and mount point can't be across drives.
ContainerDefinition, containerDefinition_name - The name of a container. If you're 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, underscores, and hyphens 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.
$sel:portMappings:ContainerDefinition', containerDefinition_portMappings - 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, 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's no loopback for port mappings on Windows, so you
can't 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.
After a task reaches the RUNNING status, manual and automatic host and
container port assignments are visible in the Network Bindings
section of a container description for a selected task in the Amazon ECS
console. The assignments are also visible in the networkBindings
section DescribeTasks responses.
$sel:privileged:ContainerDefinition', containerDefinition_privileged - 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.
This parameter is not supported for Windows containers or tasks run on Fargate.
$sel:pseudoTerminal:ContainerDefinition', containerDefinition_pseudoTerminal - When this parameter is true, a TTY is allocated. This parameter maps
to Tty in the
Create a container
section of the
Docker Remote API and the
--tty option to
docker run.
$sel:readonlyRootFilesystem:ContainerDefinition', containerDefinition_readonlyRootFilesystem - 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.
This parameter is not supported for Windows containers.
$sel:repositoryCredentials:ContainerDefinition', containerDefinition_repositoryCredentials - The private repository authentication credentials to use.
$sel:resourceRequirements:ContainerDefinition', containerDefinition_resourceRequirements - The type and amount of a resource to assign to a container. The only
supported resource is a GPU.
$sel:secrets:ContainerDefinition', containerDefinition_secrets - The secrets to pass to the container. For more information, see
Specifying Sensitive Data
in the Amazon Elastic Container Service Developer Guide.
$sel:startTimeout:ContainerDefinition', containerDefinition_startTimeout - Time duration (in seconds) to wait before giving up on resolving
dependencies for a container. For example, you specify two containers in
a task definition with containerA having a dependency on containerB
reaching a COMPLETE, SUCCESS, or HEALTHY status. If a
startTimeout value is specified for containerB and it doesn't reach
the desired status within that time then containerA gives up and not
start. This results in the task transitioning to a STOPPED state.
When the ECS_CONTAINER_START_TIMEOUT container agent configuration
variable is used, it's enforced independently from this start timeout
value.
For tasks using the Fargate launch type, the task or service requires the following platforms:
- Linux platform version
1.3.0or later. - Windows platform version
1.0.0or later.
For tasks using the EC2 launch type, your container instances require at
least version 1.26.0 of the container agent to use a container start
timeout value. However, we recommend using the latest container agent
version. For information about checking your agent version and updating
to the latest version, see
Updating the Amazon ECS Container Agent
in the Amazon Elastic Container Service Developer Guide. If you're
using an Amazon ECS-optimized Linux AMI, your instance needs at least
version 1.26.0-1 of the ecs-init package. If your container
instances are launched from version 20190301 or later, then they
contain the required versions of the container agent and ecs-init. For
more information, see
Amazon ECS-optimized Linux AMI
in the Amazon Elastic Container Service Developer Guide.
$sel:stopTimeout:ContainerDefinition', containerDefinition_stopTimeout - Time duration (in seconds) to wait before the container is forcefully
killed if it doesn't exit normally on its own.
For tasks using the Fargate launch type, the task or service requires the following platforms:
- Linux platform version
1.3.0or later. - Windows platform version
1.0.0or later.
The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.
For tasks that use the EC2 launch type, if the stopTimeout parameter
isn't specified, the value set for the Amazon ECS container agent
configuration variable ECS_CONTAINER_STOP_TIMEOUT is used. If neither
the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT agent
configuration variable are set, then the default values of 30 seconds
for Linux containers and 30 seconds on Windows containers are used. Your
container instances require at least version 1.26.0 of the container
agent to use a container stop timeout value. However, we recommend using
the latest container agent version. For information about checking your
agent version and updating to the latest version, see
Updating the Amazon ECS Container Agent
in the Amazon Elastic Container Service Developer Guide. If you're
using an Amazon ECS-optimized Linux AMI, your instance needs at least
version 1.26.0-1 of the ecs-init package. If your container instances
are launched from version 20190301 or later, then they contain the
required versions of the container agent and ecs-init. For more
information, see
Amazon ECS-optimized Linux AMI
in the Amazon Elastic Container Service Developer Guide.
$sel:systemControls:ContainerDefinition', containerDefinition_systemControls - A list of namespaced kernel parameters to set in the container. This
parameter maps to Sysctls in the
Create a container
section of the
Docker Remote API and the
--sysctl option to
docker run.
We don't recommended that you specify network-related systemControls
parameters for multiple containers in a single task that also uses
either the awsvpc or host network modes. For tasks that use the
awsvpc network mode, the container that's started last determines
which systemControls parameters take effect. For tasks that use the
host network mode, it changes the container instance's namespaced
kernel parameters as well as the containers.
$sel:ulimits:ContainerDefinition', containerDefinition_ulimits - A list of ulimits to set in the container. If a ulimit value is
specified in a task definition, it overrides the default values set by
Docker. 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.
Amazon ECS tasks hosted on Fargate use the default resource limit values
set by the operating system with the exception of the nofile resource
limit parameter which Fargate overrides. The nofile resource limit
sets a restriction on the number of open files that a container can use.
The default nofile soft limit is 1024 and hard limit is 4096.
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 --format '{{.Server.APIVersion}}'
This parameter is not supported for Windows containers.
$sel:user:ContainerDefinition', containerDefinition_user - The user 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.
When running tasks using the host network mode, don't run containers
using the root user (UID 0). We recommend using a non-root user for
better security.
You can specify the user using the following formats. If specifying a
UID or GID, you must specify it as a positive integer.
user
user:group
uid
uid:gid
user:gid
uid:group
This parameter is not supported for Windows containers.
$sel:volumesFrom:ContainerDefinition', containerDefinition_volumesFrom - 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.
$sel:workingDirectory:ContainerDefinition', containerDefinition_workingDirectory - The working directory to run commands inside the container in. This
parameter maps to WorkingDir in the
Create a container
section of the
Docker Remote API and the
--workdir option to
docker run.
containerDefinition_command :: Lens' ContainerDefinition (Maybe [Text]) Source #
The command that's 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. If there are
multiple arguments, each argument is a separated string in the array.
containerDefinition_cpu :: Lens' ContainerDefinition (Maybe Int) Source #
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.
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
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's 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 is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. 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 isn't 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 two 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's described in the task definition. A null or zero
CPU value is passed to Docker as 0, which Windows interprets as 1% of
one CPU.
containerDefinition_dependsOn :: Lens' ContainerDefinition (Maybe [ContainerDependency]) Source #
The dependencies defined for container startup and shutdown. A container can contain multiple dependencies on other containers in a task definition. When a dependency is defined for container startup, for container shutdown it is reversed.
For tasks using the EC2 launch type, the container instances require at
least version 1.26.0 of the container agent to turn on container
dependencies. However, we recommend using the latest container agent
version. For information about checking your agent version and updating
to the latest version, see
Updating the Amazon ECS Container Agent
in the Amazon Elastic Container Service Developer Guide. If you're
using an Amazon ECS-optimized Linux AMI, your instance needs at least
version 1.26.0-1 of the ecs-init package. If your container instances
are launched from version 20190301 or later, then they contain the
required versions of the container agent and ecs-init. For more
information, see
Amazon ECS-optimized Linux AMI
in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires the following platforms:
- Linux platform version
1.3.0or later. - Windows platform version
1.0.0or later.
containerDefinition_disableNetworking :: Lens' ContainerDefinition (Maybe Bool) Source #
When this parameter is true, networking is disabled within the
container. This parameter maps to NetworkDisabled in the
Create a container
section of the
Docker Remote API.
This parameter is not supported for Windows containers.
containerDefinition_dnsSearchDomains :: Lens' ContainerDefinition (Maybe [Text]) Source #
A list of DNS search domains that are presented to the container. This
parameter maps to DnsSearch in the
Create a container
section of the
Docker Remote API and the
--dns-search option to
docker run.
This parameter is not supported for Windows containers.
containerDefinition_dnsServers :: Lens' ContainerDefinition (Maybe [Text]) Source #
A list of DNS servers that are presented to the container. This
parameter maps to Dns in the
Create a container
section of the
Docker Remote API and the
--dns option to
docker run.
This parameter is not supported for Windows containers.
containerDefinition_dockerLabels :: Lens' ContainerDefinition (Maybe (HashMap Text Text)) Source #
A key/value map of labels to add to the container. This parameter maps
to Labels in the
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 --format '{{.Server.APIVersion}}'
containerDefinition_dockerSecurityOptions :: Lens' ContainerDefinition (Maybe [Text]) Source #
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field isn't valid for containers in tasks using the Fargate launch type.
With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.
This parameter maps to SecurityOpt in the
Create a container
section of the
Docker Remote API and the
--security-opt option to
docker run.
The Amazon ECS container agent running on a container instance must
register with the ECS_SELINUX_CAPABLE=true or
ECS_APPARMOR_CAPABLE=true environment variables before containers
placed on that instance can use these security options. For more
information, see
Amazon ECS Container Agent Configuration
in the Amazon Elastic Container Service Developer Guide.
For more information about valid values, see Docker Run Security Configuration.
Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"
containerDefinition_entryPoint :: Lens' ContainerDefinition (Maybe [Text]) Source #
Early versions of the Amazon ECS container agent don't 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's 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.
containerDefinition_environment :: Lens' ContainerDefinition (Maybe [KeyValuePair]) Source #
The environment variables to pass to a container. This parameter maps to
Env in the
Create a container
section of the
Docker Remote API and the
--env option to
docker run.
We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.
containerDefinition_environmentFiles :: Lens' ContainerDefinition (Maybe [EnvironmentFile]) Source #
A list of files containing the environment variables to pass to a
container. This parameter maps to the --env-file option to
docker run.
You can specify up to ten environment files. The file must have a .env
file extension. Each line in an environment file contains an environment
variable in VARIABLE=VALUE format. Lines beginning with # are
treated as comments and are ignored. For more information about the
environment variable file syntax, see
Declare default environment variables in file.
If there are environment variables specified using the environment
parameter in a container definition, they take precedence over the
variables contained within an environment file. If multiple environment
files are specified that contain the same variable, they're processed
from the top down. We recommend that you use unique variable names. For
more information, see
Specifying Environment Variables
in the Amazon Elastic Container Service Developer Guide.
containerDefinition_essential :: Lens' ContainerDefinition (Maybe Bool) Source #
If the essential parameter of a container is marked as true, and
that container fails or stops for any reason, all other containers that
are part of the task are stopped. If the essential parameter of a
container is marked as false, its failure doesn't 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's composed of multiple containers, 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.
containerDefinition_extraHosts :: Lens' ContainerDefinition (Maybe [HostEntry]) Source #
A list of hostnames and IP address mappings to append to the
/etc/hosts file on the container. This parameter maps to
ExtraHosts in the
Create a container
section of the
Docker Remote API and the
--add-host option to
docker run.
This parameter isn't supported for Windows containers or tasks that use
the awsvpc network mode.
containerDefinition_firelensConfiguration :: Lens' ContainerDefinition (Maybe FirelensConfiguration) Source #
The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.
containerDefinition_healthCheck :: Lens' ContainerDefinition (Maybe HealthCheck) Source #
The container 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.
containerDefinition_hostname :: Lens' ContainerDefinition (Maybe Text) Source #
The hostname to use for your container. This parameter maps to
Hostname in the
Create a container
section of the
Docker Remote API and the
--hostname option to
docker run.
The hostname parameter is not supported if you're using the awsvpc
network mode.
containerDefinition_image :: Lens' ContainerDefinition (Maybe Text) Source #
The image used to start a container. This string is passed directly to
the Docker daemon. By default, images in the Docker Hub registry are
available. 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 aren't propagated to already running tasks.
- Images in Amazon ECR repositories can be specified by either using
the full
registry/repository:tagorregistry/repository@digest. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latestor012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256: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,
amazon/amazon-ecs-agent). - Images in other online repositories are qualified further by a
domain name (for example,
quay.io/assemblyline/ubuntu).
containerDefinition_interactive :: Lens' ContainerDefinition (Maybe Bool) Source #
When this parameter is true, you can deploy containerized applications
that require stdin or a tty to be allocated. This parameter maps to
OpenStdin in the
Create a container
section of the
Docker Remote API and the
--interactive option to
docker run.
containerDefinition_links :: Lens' ContainerDefinition (Maybe [Text]) Source #
The links parameter allows containers to communicate with each other
without the need for port mappings. This parameter is only supported if
the network mode of a task definition is bridge. The
name:internalName construct is analogous to name:alias in Docker
links. Up to 255 letters (uppercase and lowercase), numbers,
underscores, and hyphens are allowed. For more information about linking
Docker containers, go to
Legacy container links in the
Docker documentation. This parameter maps to Links in the
Create a container
section of the
Docker Remote API and the
--link option to
docker run.
This parameter is not supported for Windows containers.
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.
containerDefinition_linuxParameters :: Lens' ContainerDefinition (Maybe LinuxParameters) Source #
Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.
This parameter is not supported for Windows containers.
containerDefinition_logConfiguration :: Lens' ContainerDefinition (Maybe LogConfiguration) Source #
The log configuration specification for the container.
This parameter maps to LogConfig in the
Create a container
section of the
Docker Remote API and the
--log-driver option to
docker run.
By default, containers use the same logging driver that the Docker
daemon uses. However the container can 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 about the options for different supported log drivers,
see
Configure logging drivers
in the Docker documentation.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
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 --format '{{.Server.APIVersion}}'
The Amazon ECS container agent running on a container instance must
register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers
placed on that instance can use these log configuration options. For
more information, see
Amazon ECS Container Agent Configuration
in the Amazon Elastic Container Service Developer Guide.
containerDefinition_memory :: Lens' ContainerDefinition (Maybe Int) Source #
The amount (in MiB) of memory to present to the container. If your
container attempts to exceed the memory specified here, the container is
killed. The total amount of memory reserved for all containers within a
task must be lower than the task memory value, if one is specified.
This parameter maps to Memory in the
Create a container
section of the
Docker Remote API and the
--memory option to
docker run.
If using the Fargate launch type, this parameter is optional.
If using the EC2 launch type, you must specify either a task-level
memory value or a container-level memory value. If you specify both a
container-level memory and memoryReservation value, memory must be
greater than memoryReservation. If you specify memoryReservation,
then that value is subtracted from the available memory resources for
the container instance where the container is placed. Otherwise, the
value of memory is used.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
containerDefinition_memoryReservation :: Lens' ContainerDefinition (Maybe Int) Source #
The soft limit (in MiB) of memory to reserve for the container. When
system memory is under heavy contention, Docker attempts to keep the
container memory to this soft limit. However, your container can consume
more memory when it needs to, up to either the hard limit specified with
the memory parameter (if applicable), or all of the available memory
on the container instance, whichever comes first. This parameter maps to
MemoryReservation in the
Create a container
section of the
Docker Remote API and the
--memory-reservation option to
docker run.
If a task-level memory value is not specified, you must specify a
non-zero integer for one or both of memory or memoryReservation in a
container definition. 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 where 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 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
containerDefinition_mountPoints :: Lens' ContainerDefinition (Maybe [MountPoint]) Source #
The mount points for data volumes in your container.
This parameter maps to Volumes in the
Create a container
section of the
Docker Remote API and the
--volume option to
docker run.
Windows containers can mount whole directories on the same drive as
$env:ProgramData. Windows containers can't mount directories on a
different drive, and mount point can't be across drives.
containerDefinition_name :: Lens' ContainerDefinition (Maybe Text) Source #
The name of a container. If you're 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, underscores, and hyphens 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.
containerDefinition_portMappings :: Lens' ContainerDefinition (Maybe [PortMapping]) Source #
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.
For task definitions that use the awsvpc network mode, 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's no loopback for port mappings on Windows, so you
can't 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.
After a task reaches the RUNNING status, manual and automatic host and
container port assignments are visible in the Network Bindings
section of a container description for a selected task in the Amazon ECS
console. The assignments are also visible in the networkBindings
section DescribeTasks responses.
containerDefinition_privileged :: Lens' ContainerDefinition (Maybe Bool) Source #
When this parameter is true, the container is given elevated privileges
on the host container instance (similar to the root user). This
parameter maps to Privileged in the
Create a container
section of the
Docker Remote API and the
--privileged option to
docker run.
This parameter is not supported for Windows containers or tasks run on Fargate.
containerDefinition_pseudoTerminal :: Lens' ContainerDefinition (Maybe Bool) Source #
When this parameter is true, a TTY is allocated. This parameter maps
to Tty in the
Create a container
section of the
Docker Remote API and the
--tty option to
docker run.
containerDefinition_readonlyRootFilesystem :: Lens' ContainerDefinition (Maybe Bool) Source #
When this parameter is true, the container is given read-only access to
its root file system. This parameter maps to ReadonlyRootfs in the
Create a container
section of the
Docker Remote API and the
--read-only option to
docker run.
This parameter is not supported for Windows containers.
containerDefinition_repositoryCredentials :: Lens' ContainerDefinition (Maybe RepositoryCredentials) Source #
The private repository authentication credentials to use.
containerDefinition_resourceRequirements :: Lens' ContainerDefinition (Maybe [ResourceRequirement]) Source #
The type and amount of a resource to assign to a container. The only supported resource is a GPU.
containerDefinition_secrets :: Lens' ContainerDefinition (Maybe [Secret]) Source #
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
containerDefinition_startTimeout :: Lens' ContainerDefinition (Maybe Int) Source #
Time duration (in seconds) to wait before giving up on resolving
dependencies for a container. For example, you specify two containers in
a task definition with containerA having a dependency on containerB
reaching a COMPLETE, SUCCESS, or HEALTHY status. If a
startTimeout value is specified for containerB and it doesn't reach
the desired status within that time then containerA gives up and not
start. This results in the task transitioning to a STOPPED state.
When the ECS_CONTAINER_START_TIMEOUT container agent configuration
variable is used, it's enforced independently from this start timeout
value.
For tasks using the Fargate launch type, the task or service requires the following platforms:
- Linux platform version
1.3.0or later. - Windows platform version
1.0.0or later.
For tasks using the EC2 launch type, your container instances require at
least version 1.26.0 of the container agent to use a container start
timeout value. However, we recommend using the latest container agent
version. For information about checking your agent version and updating
to the latest version, see
Updating the Amazon ECS Container Agent
in the Amazon Elastic Container Service Developer Guide. If you're
using an Amazon ECS-optimized Linux AMI, your instance needs at least
version 1.26.0-1 of the ecs-init package. If your container
instances are launched from version 20190301 or later, then they
contain the required versions of the container agent and ecs-init. For
more information, see
Amazon ECS-optimized Linux AMI
in the Amazon Elastic Container Service Developer Guide.
containerDefinition_stopTimeout :: Lens' ContainerDefinition (Maybe Int) Source #
Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.
For tasks using the Fargate launch type, the task or service requires the following platforms:
- Linux platform version
1.3.0or later. - Windows platform version
1.0.0or later.
The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.
For tasks that use the EC2 launch type, if the stopTimeout parameter
isn't specified, the value set for the Amazon ECS container agent
configuration variable ECS_CONTAINER_STOP_TIMEOUT is used. If neither
the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT agent
configuration variable are set, then the default values of 30 seconds
for Linux containers and 30 seconds on Windows containers are used. Your
container instances require at least version 1.26.0 of the container
agent to use a container stop timeout value. However, we recommend using
the latest container agent version. For information about checking your
agent version and updating to the latest version, see
Updating the Amazon ECS Container Agent
in the Amazon Elastic Container Service Developer Guide. If you're
using an Amazon ECS-optimized Linux AMI, your instance needs at least
version 1.26.0-1 of the ecs-init package. If your container instances
are launched from version 20190301 or later, then they contain the
required versions of the container agent and ecs-init. For more
information, see
Amazon ECS-optimized Linux AMI
in the Amazon Elastic Container Service Developer Guide.
containerDefinition_systemControls :: Lens' ContainerDefinition (Maybe [SystemControl]) Source #
A list of namespaced kernel parameters to set in the container. This
parameter maps to Sysctls in the
Create a container
section of the
Docker Remote API and the
--sysctl option to
docker run.
We don't recommended that you specify network-related systemControls
parameters for multiple containers in a single task that also uses
either the awsvpc or host network modes. For tasks that use the
awsvpc network mode, the container that's started last determines
which systemControls parameters take effect. For tasks that use the
host network mode, it changes the container instance's namespaced
kernel parameters as well as the containers.
containerDefinition_ulimits :: Lens' ContainerDefinition (Maybe [Ulimit]) Source #
A list of ulimits to set in the container. If a ulimit value is
specified in a task definition, it overrides the default values set by
Docker. 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.
Amazon ECS tasks hosted on Fargate use the default resource limit values
set by the operating system with the exception of the nofile resource
limit parameter which Fargate overrides. The nofile resource limit
sets a restriction on the number of open files that a container can use.
The default nofile soft limit is 1024 and hard limit is 4096.
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 --format '{{.Server.APIVersion}}'
This parameter is not supported for Windows containers.
containerDefinition_user :: Lens' ContainerDefinition (Maybe Text) Source #
The user 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.
When running tasks using the host network mode, don't run containers
using the root user (UID 0). We recommend using a non-root user for
better security.
You can specify the user using the following formats. If specifying a
UID or GID, you must specify it as a positive integer.
user
user:group
uid
uid:gid
user:gid
uid:group
This parameter is not supported for Windows containers.
containerDefinition_volumesFrom :: Lens' ContainerDefinition (Maybe [VolumeFrom]) Source #
Data volumes to mount from another container. This parameter maps to
VolumesFrom in the
Create a container
section of the
Docker Remote API and the
--volumes-from option to
docker run.
containerDefinition_workingDirectory :: Lens' ContainerDefinition (Maybe Text) Source #
The working directory to run commands inside the container in. This
parameter maps to WorkingDir in the
Create a container
section of the
Docker Remote API and the
--workdir option to
docker run.
ContainerDependency
data ContainerDependency Source #
The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.
Your Amazon ECS container instances require at least version 1.26.0 of
the container agent to use container dependencies. However, we recommend
using the latest container agent version. For information about checking
your agent version and updating to the latest version, see
Updating the Amazon ECS Container Agent
in the Amazon Elastic Container Service Developer Guide. If you're
using an Amazon ECS-optimized Linux AMI, your instance needs at least
version 1.26.0-1 of the ecs-init package. If your container instances
are launched from version 20190301 or later, then they contain the
required versions of the container agent and ecs-init. For more
information, see
Amazon ECS-optimized Linux AMI
in the Amazon Elastic Container Service Developer Guide.
For tasks that use the Fargate launch type, the task or service requires the following platforms:
- Linux platform version
1.3.0or later. - Windows platform version
1.0.0or later.
See: newContainerDependency smart constructor.
Constructors
| ContainerDependency' | |
Fields
| |
Instances
newContainerDependency Source #
Arguments
| :: Text | |
| -> ContainerCondition | |
| -> ContainerDependency |
Create a value of ContainerDependency with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containerName:ContainerDependency', containerDependency_containerName - The name of a container.
$sel:condition:ContainerDependency', containerDependency_condition - The dependency condition of the container. The following are the
available conditions and their behavior:
START- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.COMPLETE- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.SUCCESS- This condition is the same asCOMPLETE, but it also requires that the container exits with azerostatus. This condition can't be set on an essential container.HEALTHY- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.
containerDependency_containerName :: Lens' ContainerDependency Text Source #
The name of a container.
containerDependency_condition :: Lens' ContainerDependency ContainerCondition Source #
The dependency condition of the container. The following are the available conditions and their behavior:
START- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.COMPLETE- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.SUCCESS- This condition is the same asCOMPLETE, but it also requires that the container exits with azerostatus. This condition can't be set on an essential container.HEALTHY- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.
ContainerInstance
data ContainerInstance Source #
An Amazon EC2 or External instance that's running the Amazon ECS agent and has been registered with a cluster.
See: newContainerInstance smart constructor.
Constructors
| ContainerInstance' | |
Fields
| |
Instances
newContainerInstance :: ContainerInstance Source #
Create a value of ContainerInstance with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentConnected:ContainerInstance', containerInstance_agentConnected - This parameter returns true if the agent is connected to Amazon ECS.
An instance with an agent that may be unhealthy or stopped return
false. Only instances connected to an agent can accept task placement
requests.
$sel:agentUpdateStatus:ContainerInstance', containerInstance_agentUpdateStatus - The status of the most recent agent update. If an update wasn't ever
requested, this value is NULL.
$sel:attachments:ContainerInstance', containerInstance_attachments - The resources attached to a container instance, such as an elastic
network interface.
$sel:attributes:ContainerInstance', containerInstance_attributes - The attributes set for the container instance, either by the Amazon ECS
container agent at instance registration or manually with the
PutAttributes operation.
$sel:capacityProviderName:ContainerInstance', containerInstance_capacityProviderName - The capacity provider that's associated with the container instance.
$sel:containerInstanceArn:ContainerInstance', containerInstance_containerInstanceArn - The Amazon Resource Name (ARN) of the container instance. For more
information about the ARN format, see
Amazon Resource Name (ARN)
in the Amazon ECS Developer Guide.
$sel:ec2InstanceId:ContainerInstance', containerInstance_ec2InstanceId - The ID of the container instance. For Amazon EC2 instances, this value
is the Amazon EC2 instance ID. For external instances, this value is the
Amazon Web Services Systems Manager managed instance ID.
$sel:healthStatus:ContainerInstance', containerInstance_healthStatus - An object representing the health status of the container instance.
$sel:pendingTasksCount:ContainerInstance', containerInstance_pendingTasksCount - The number of tasks on the container instance that are in the PENDING
status.
$sel:registeredAt:ContainerInstance', containerInstance_registeredAt - The Unix timestamp for the time when the container instance was
registered.
$sel:registeredResources:ContainerInstance', containerInstance_registeredResources - 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.
$sel:remainingResources:ContainerInstance', containerInstance_remainingResources - For CPU and memory resource types, this parameter describes the
remaining CPU and memory that wasn't already 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's not specified here is available
for new tasks.
$sel:runningTasksCount:ContainerInstance', containerInstance_runningTasksCount - The number of tasks on the container instance that are in the RUNNING
status.
ContainerInstance, containerInstance_status - The status of the container instance. The valid values are
REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE,
DEREGISTERING, or DRAINING.
If your account has opted in to the awsvpcTrunking account setting,
then any newly registered container instance will transition to a
REGISTERING status while the trunk elastic network interface is
provisioned for the instance. If the registration fails, the instance
will transition to a REGISTRATION_FAILED status. You can describe the
container instance and see the reason for failure in the statusReason
parameter. Once the container instance is terminated, the instance
transitions to a DEREGISTERING status while the trunk elastic network
interface is deprovisioned. The instance then transitions to an
INACTIVE status.
The ACTIVE status indicates that the container instance can accept
tasks. The DRAINING indicates that new tasks aren't 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.
$sel:statusReason:ContainerInstance', containerInstance_statusReason - The reason that the container instance reached its current status.
$sel:tags:ContainerInstance', containerInstance_tags - The metadata that you apply to the container instance to help you
categorize and organize them. Each tag consists of a key and an optional
value. You define both.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
$sel:version:ContainerInstance', containerInstance_version - 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're 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.
$sel:versionInfo:ContainerInstance', containerInstance_versionInfo - The version information for the Amazon ECS container agent and Docker
daemon running on the container instance.
containerInstance_agentConnected :: Lens' ContainerInstance (Maybe Bool) Source #
This parameter returns true if the agent is connected to Amazon ECS.
An instance with an agent that may be unhealthy or stopped return
false. Only instances connected to an agent can accept task placement
requests.
containerInstance_agentUpdateStatus :: Lens' ContainerInstance (Maybe AgentUpdateStatus) Source #
The status of the most recent agent update. If an update wasn't ever
requested, this value is NULL.
containerInstance_attachments :: Lens' ContainerInstance (Maybe [Attachment]) Source #
The resources attached to a container instance, such as an elastic network interface.
containerInstance_attributes :: Lens' ContainerInstance (Maybe [Attribute]) Source #
The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
containerInstance_capacityProviderName :: Lens' ContainerInstance (Maybe Text) Source #
The capacity provider that's associated with the container instance.
containerInstance_containerInstanceArn :: Lens' ContainerInstance (Maybe Text) Source #
The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
containerInstance_ec2InstanceId :: Lens' ContainerInstance (Maybe Text) Source #
The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.
containerInstance_healthStatus :: Lens' ContainerInstance (Maybe ContainerInstanceHealthStatus) Source #
An object representing the health status of the container instance.
containerInstance_pendingTasksCount :: Lens' ContainerInstance (Maybe Int) Source #
The number of tasks on the container instance that are in the PENDING
status.
containerInstance_registeredAt :: Lens' ContainerInstance (Maybe UTCTime) Source #
The Unix timestamp for the time when the container instance was registered.
containerInstance_registeredResources :: Lens' ContainerInstance (Maybe [Resource]) Source #
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.
containerInstance_remainingResources :: Lens' ContainerInstance (Maybe [Resource]) Source #
For CPU and memory resource types, this parameter describes the
remaining CPU and memory that wasn't already 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's not specified here is available
for new tasks.
containerInstance_runningTasksCount :: Lens' ContainerInstance (Maybe Int) Source #
The number of tasks on the container instance that are in the RUNNING
status.
containerInstance_status :: Lens' ContainerInstance (Maybe Text) Source #
The status of the container instance. The valid values are
REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE,
DEREGISTERING, or DRAINING.
If your account has opted in to the awsvpcTrunking account setting,
then any newly registered container instance will transition to a
REGISTERING status while the trunk elastic network interface is
provisioned for the instance. If the registration fails, the instance
will transition to a REGISTRATION_FAILED status. You can describe the
container instance and see the reason for failure in the statusReason
parameter. Once the container instance is terminated, the instance
transitions to a DEREGISTERING status while the trunk elastic network
interface is deprovisioned. The instance then transitions to an
INACTIVE status.
The ACTIVE status indicates that the container instance can accept
tasks. The DRAINING indicates that new tasks aren't 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.
containerInstance_statusReason :: Lens' ContainerInstance (Maybe Text) Source #
The reason that the container instance reached its current status.
containerInstance_tags :: Lens' ContainerInstance (Maybe [Tag]) Source #
The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
containerInstance_version :: Lens' ContainerInstance (Maybe Integer) Source #
The version counter for the container instance. Every time a container
instance experiences a change that triggers a CloudWatch event, the
version counter is incremented. If you're 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.
containerInstance_versionInfo :: Lens' ContainerInstance (Maybe VersionInfo) Source #
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
ContainerInstanceHealthStatus
data ContainerInstanceHealthStatus Source #
An object representing the health status of the container instance.
See: newContainerInstanceHealthStatus smart constructor.
Constructors
| ContainerInstanceHealthStatus' | |
Fields
| |
Instances
newContainerInstanceHealthStatus :: ContainerInstanceHealthStatus Source #
Create a value of ContainerInstanceHealthStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:details:ContainerInstanceHealthStatus', containerInstanceHealthStatus_details - An array of objects representing the details of the container instance
health status.
$sel:overallStatus:ContainerInstanceHealthStatus', containerInstanceHealthStatus_overallStatus - The overall health status of the container instance. This is an
aggregate status of all container instance health checks.
containerInstanceHealthStatus_details :: Lens' ContainerInstanceHealthStatus (Maybe [InstanceHealthCheckResult]) Source #
An array of objects representing the details of the container instance health status.
containerInstanceHealthStatus_overallStatus :: Lens' ContainerInstanceHealthStatus (Maybe InstanceHealthCheckState) Source #
The overall health status of the container instance. This is an aggregate status of all container instance health checks.
ContainerOverride
data ContainerOverride Source #
The overrides that are sent to a container. An empty container override
can be passed in. An example of an empty container override is
{"containerOverrides": [ ] }. If a non-empty container override is
specified, the name parameter must be included.
See: newContainerOverride smart constructor.
Constructors
| ContainerOverride' | |
Fields
| |
Instances
newContainerOverride :: ContainerOverride Source #
Create a value of ContainerOverride with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:command:ContainerOverride', containerOverride_command - 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.
$sel:cpu:ContainerOverride', containerOverride_cpu - 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.
$sel:environment:ContainerOverride', containerOverride_environment - 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.
$sel:environmentFiles:ContainerOverride', containerOverride_environmentFiles - A list of files containing the environment variables to pass to a
container, instead of the value from the container definition.
$sel:memory:ContainerOverride', containerOverride_memory - 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.
$sel:memoryReservation:ContainerOverride', containerOverride_memoryReservation - 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.
ContainerOverride, containerOverride_name - The name of the container that receives the override. This parameter is
required if any override is specified.
$sel:resourceRequirements:ContainerOverride', containerOverride_resourceRequirements - The type and amount of a resource to assign to a container, instead of
the default value from the task definition. The only supported resource
is a GPU.
containerOverride_command :: Lens' ContainerOverride (Maybe [Text]) Source #
The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
containerOverride_cpu :: Lens' ContainerOverride (Maybe Int) Source #
The number of cpu units reserved for the container, instead of the
default value from the task definition. You must also specify a
container name.
containerOverride_environment :: Lens' ContainerOverride (Maybe [KeyValuePair]) Source #
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
containerOverride_environmentFiles :: Lens' ContainerOverride (Maybe [EnvironmentFile]) Source #
A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
containerOverride_memory :: Lens' ContainerOverride (Maybe Int) Source #
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
containerOverride_memoryReservation :: Lens' ContainerOverride (Maybe Int) Source #
The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
containerOverride_name :: Lens' ContainerOverride (Maybe Text) Source #
The name of the container that receives the override. This parameter is required if any override is specified.
containerOverride_resourceRequirements :: Lens' ContainerOverride (Maybe [ResourceRequirement]) Source #
The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.
ContainerService
data ContainerService Source #
Details on a service within a cluster
See: newContainerService smart constructor.
Constructors
| ContainerService' | |
Fields
| |
Instances
newContainerService :: ContainerService Source #
Create a value of ContainerService with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ContainerService, containerService_capacityProviderStrategy - The capacity provider strategy the service uses. When using the
DescribeServices API, this field is omitted if the service was created
using a launch type.
ContainerService, containerService_clusterArn - The Amazon Resource Name (ARN) of the cluster that hosts the service.
ContainerService, containerService_createdAt - The Unix timestamp for the time when the service was created.
$sel:createdBy:ContainerService', containerService_createdBy - The principal that created the service.
$sel:deploymentConfiguration:ContainerService', containerService_deploymentConfiguration - Optional deployment parameters that control how many tasks run during
the deployment and the ordering of stopping and starting tasks.
$sel:deploymentController:ContainerService', containerService_deploymentController - The deployment controller type the service is using.
$sel:deployments:ContainerService', containerService_deployments - The current state of deployments for the service.
ContainerService, containerService_desiredCount - 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.
$sel:enableECSManagedTags:ContainerService', containerService_enableECSManagedTags - Determines whether to use Amazon ECS managed tags for the tasks in the
service. For more information, see
Tagging Your Amazon ECS Resources
in the Amazon Elastic Container Service Developer Guide.
$sel:enableExecuteCommand:ContainerService', containerService_enableExecuteCommand - Determines whether the execute command functionality is enabled for the
service. If true, the execute command functionality is enabled for all
containers in tasks as part of the service.
$sel:events:ContainerService', containerService_events - The event stream for your service. A maximum of 100 of the latest events
are displayed.
$sel:healthCheckGracePeriodSeconds:ContainerService', containerService_healthCheckGracePeriodSeconds - 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.
ContainerService, containerService_launchType - The launch type the service is using. When using the DescribeServices
API, this field is omitted if the service was created using a capacity
provider strategy.
ContainerService, containerService_loadBalancers - A list of Elastic Load Balancing load balancer objects. It contains the
load balancer name, the container name, and the container port to access
from the load balancer. The container name is as it appears in a
container definition.
ContainerService, containerService_networkConfiguration - The VPC subnet and security group configuration for tasks that receive
their own elastic network interface by using the awsvpc networking
mode.
ContainerService, containerService_pendingCount - The number of tasks in the cluster that are in the PENDING state.
$sel:placementConstraints:ContainerService', containerService_placementConstraints - The placement constraints for the tasks in the service.
$sel:placementStrategy:ContainerService', containerService_placementStrategy - The placement strategy that determines how tasks for the service are
placed.
ContainerService, containerService_platformFamily - The operating system that your tasks in the service run on. A platform
family is specified only for tasks using the Fargate launch type.
All tasks that run as part of this service must use the same
platformFamily value as the service (for example, LINUX).
ContainerService, containerService_platformVersion - The platform version to run your service on. A platform version is only
specified for tasks that are hosted on Fargate. If one isn't specified,
the LATEST platform version is used. For more information, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
$sel:propagateTags:ContainerService', containerService_propagateTags - Determines whether to propagate the tags from the task definition or the
service to the task. If no value is specified, the tags aren't
propagated.
$sel:roleArn:ContainerService', containerService_roleArn - The ARN of the IAM role that's associated with the service. It allows
the Amazon ECS container agent to register container instances with an
Elastic Load Balancing load balancer.
ContainerService, containerService_runningCount - The number of tasks in the cluster that are in the RUNNING state.
$sel:schedulingStrategy:ContainerService', containerService_schedulingStrategy - The scheduling strategy to use for the service. For more information,
see
Services.
There are two service scheduler strategies available.
REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.Fargate tasks don't support the
DAEMONscheduling strategy.
ContainerService, containerService_serviceArn - The ARN that identifies the service. For more information about the ARN
format, see
Amazon Resource Name (ARN)
in the Amazon ECS Developer Guide.
$sel:serviceName:ContainerService', containerService_serviceName - The name of your service. Up to 255 letters (uppercase and lowercase),
numbers, underscores, and hyphens are allowed. Service names must be
unique within a cluster. However, you can have similarly named services
in multiple clusters within a Region or across multiple Regions.
ContainerService, containerService_serviceRegistries - The details for the service discovery registries to assign to this
service. For more information, see
Service Discovery.
ContainerService, containerService_status - The status of the service. The valid values are ACTIVE, DRAINING, or
INACTIVE.
ContainerService, containerService_tags - The metadata that you apply to the service to help you categorize and
organize them. Each tag consists of a key and an optional value. You
define bot the key and value.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
ContainerService, containerService_taskDefinition - 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.
$sel:taskSets:ContainerService', containerService_taskSets - Information about a set of Amazon ECS tasks in either an CodeDeploy or
an EXTERNAL deployment. An Amazon ECS task set includes details such
as the desired number of tasks, how many tasks are running, and whether
the task set serves production traffic.
containerService_capacityProviderStrategy :: Lens' ContainerService (Maybe [CapacityProviderStrategyItem]) Source #
The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.
containerService_clusterArn :: Lens' ContainerService (Maybe Text) Source #
The Amazon Resource Name (ARN) of the cluster that hosts the service.
containerService_createdAt :: Lens' ContainerService (Maybe UTCTime) Source #
The Unix timestamp for the time when the service was created.
containerService_createdBy :: Lens' ContainerService (Maybe Text) Source #
The principal that created the service.
containerService_deploymentConfiguration :: Lens' ContainerService (Maybe DeploymentConfiguration) Source #
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
containerService_deploymentController :: Lens' ContainerService (Maybe DeploymentController) Source #
The deployment controller type the service is using.
containerService_deployments :: Lens' ContainerService (Maybe [Deployment]) Source #
The current state of deployments for the service.
containerService_desiredCount :: Lens' ContainerService (Maybe Int) Source #
The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
containerService_enableECSManagedTags :: Lens' ContainerService (Maybe Bool) Source #
Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
containerService_enableExecuteCommand :: Lens' ContainerService (Maybe Bool) Source #
Determines whether the execute command functionality is enabled for the
service. If true, the execute command functionality is enabled for all
containers in tasks as part of the service.
containerService_events :: Lens' ContainerService (Maybe [ServiceEvent]) Source #
The event stream for your service. A maximum of 100 of the latest events are displayed.
containerService_healthCheckGracePeriodSeconds :: Lens' ContainerService (Maybe Int) Source #
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.
containerService_launchType :: Lens' ContainerService (Maybe LaunchType) Source #
The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy.
containerService_loadBalancers :: Lens' ContainerService (Maybe [LoadBalancer]) Source #
A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.
containerService_networkConfiguration :: Lens' ContainerService (Maybe NetworkConfiguration) Source #
The VPC subnet and security group configuration for tasks that receive
their own elastic network interface by using the awsvpc networking
mode.
containerService_pendingCount :: Lens' ContainerService (Maybe Int) Source #
The number of tasks in the cluster that are in the PENDING state.
containerService_placementConstraints :: Lens' ContainerService (Maybe [PlacementConstraint]) Source #
The placement constraints for the tasks in the service.
containerService_placementStrategy :: Lens' ContainerService (Maybe [PlacementStrategy]) Source #
The placement strategy that determines how tasks for the service are placed.
containerService_platformFamily :: Lens' ContainerService (Maybe Text) Source #
The operating system that your tasks in the service run on. A platform family is specified only for tasks using the Fargate launch type.
All tasks that run as part of this service must use the same
platformFamily value as the service (for example, LINUX).
containerService_platformVersion :: Lens' ContainerService (Maybe Text) Source #
The platform version to run your service on. A platform version is only
specified for tasks that are hosted on Fargate. If one isn't specified,
the LATEST platform version is used. For more information, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
containerService_propagateTags :: Lens' ContainerService (Maybe PropagateTags) Source #
Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.
containerService_roleArn :: Lens' ContainerService (Maybe Text) Source #
The ARN of the IAM role that's associated with the service. It allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
containerService_runningCount :: Lens' ContainerService (Maybe Int) Source #
The number of tasks in the cluster that are in the RUNNING state.
containerService_schedulingStrategy :: Lens' ContainerService (Maybe SchedulingStrategy) Source #
The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available.
REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.Fargate tasks don't support the
DAEMONscheduling strategy.
containerService_serviceArn :: Lens' ContainerService (Maybe Text) Source #
The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
containerService_serviceName :: Lens' ContainerService (Maybe Text) Source #
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions.
containerService_serviceRegistries :: Lens' ContainerService (Maybe [ServiceRegistry]) Source #
The details for the service discovery registries to assign to this service. For more information, see Service Discovery.
containerService_status :: Lens' ContainerService (Maybe Text) Source #
The status of the service. The valid values are ACTIVE, DRAINING, or
INACTIVE.
containerService_tags :: Lens' ContainerService (Maybe [Tag]) Source #
The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
containerService_taskDefinition :: Lens' ContainerService (Maybe Text) Source #
The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
containerService_taskSets :: Lens' ContainerService (Maybe [TaskSet]) Source #
Information about a set of Amazon ECS tasks in either an CodeDeploy or
an EXTERNAL deployment. An Amazon ECS task set includes details such
as the desired number of tasks, how many tasks are running, and whether
the task set serves production traffic.
ContainerStateChange
data ContainerStateChange Source #
An object that represents a change in state for a container.
See: newContainerStateChange smart constructor.
Constructors
| ContainerStateChange' | |
Fields
| |
Instances
newContainerStateChange :: ContainerStateChange Source #
Create a value of ContainerStateChange with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containerName:ContainerStateChange', containerStateChange_containerName - The name of the container.
$sel:exitCode:ContainerStateChange', containerStateChange_exitCode - The exit code for the container, if the state change is a result of the
container exiting.
$sel:imageDigest:ContainerStateChange', containerStateChange_imageDigest - The container image SHA 256 digest.
$sel:networkBindings:ContainerStateChange', containerStateChange_networkBindings - Any network bindings that are associated with the container.
$sel:reason:ContainerStateChange', containerStateChange_reason - The reason for the state change.
$sel:runtimeId:ContainerStateChange', containerStateChange_runtimeId - The ID of the Docker container.
$sel:status:ContainerStateChange', containerStateChange_status - The status of the container.
containerStateChange_containerName :: Lens' ContainerStateChange (Maybe Text) Source #
The name of the container.
containerStateChange_exitCode :: Lens' ContainerStateChange (Maybe Int) Source #
The exit code for the container, if the state change is a result of the container exiting.
containerStateChange_imageDigest :: Lens' ContainerStateChange (Maybe Text) Source #
The container image SHA 256 digest.
containerStateChange_networkBindings :: Lens' ContainerStateChange (Maybe [NetworkBinding]) Source #
Any network bindings that are associated with the container.
containerStateChange_reason :: Lens' ContainerStateChange (Maybe Text) Source #
The reason for the state change.
containerStateChange_runtimeId :: Lens' ContainerStateChange (Maybe Text) Source #
The ID of the Docker container.
containerStateChange_status :: Lens' ContainerStateChange (Maybe Text) Source #
The status of the container.
Deployment
data Deployment Source #
The details of an Amazon ECS service deployment. This is used only when
a service uses the ECS deployment controller type.
See: newDeployment smart constructor.
Constructors
| Deployment' | |
Fields
| |
Instances
newDeployment :: Deployment Source #
Create a value of Deployment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:capacityProviderStrategy:Deployment', deployment_capacityProviderStrategy - The capacity provider strategy that the deployment is using.
$sel:createdAt:Deployment', deployment_createdAt - The Unix timestamp for the time when the service deployment was created.
$sel:desiredCount:Deployment', deployment_desiredCount - The most recent desired count of tasks that was specified for the
service to deploy or maintain.
$sel:failedTasks:Deployment', deployment_failedTasks - The number of consecutively failed tasks in the deployment. A task is
considered a failure if the service scheduler can't launch the task,
the task doesn't transition to a RUNNING state, or if it fails any of
its defined health checks and is stopped.
Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.
$sel:id:Deployment', deployment_id - The ID of the deployment.
$sel:launchType:Deployment', deployment_launchType - The launch type the tasks in the service are using. For more
information, see
Amazon ECS Launch Types
in the Amazon Elastic Container Service Developer Guide.
$sel:networkConfiguration:Deployment', deployment_networkConfiguration - The VPC subnet and security group configuration for tasks that receive
their own elastic network interface by using the awsvpc networking
mode.
$sel:pendingCount:Deployment', deployment_pendingCount - The number of tasks in the deployment that are in the PENDING status.
$sel:platformFamily:Deployment', deployment_platformFamily - The operating system that your tasks in the service, or tasks are
running on. A platform family is specified only for tasks using the
Fargate launch type.
All tasks that run as part of this service must use the same
platformFamily value as the service, for example, LINUX..
$sel:platformVersion:Deployment', deployment_platformVersion - The platform version that your tasks in the service run on. A platform
version is only specified for tasks using the Fargate launch type. If
one isn't specified, the LATEST platform version is used. For more
information, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
$sel:rolloutState:Deployment', deployment_rolloutState - The rolloutState of a service is only returned for services that use
the rolling update (ECS) deployment type that aren't behind a Classic
Load Balancer.
The rollout state of the deployment. When a service deployment is
started, it begins in an IN_PROGRESS state. When the service reaches a
steady state, the deployment transitions to a COMPLETED state. If the
service fails to reach a steady state and circuit breaker is enabled,
the deployment transitions to a FAILED state. A deployment in FAILED
state doesn't launch any new tasks. For more information, see
DeploymentCircuitBreaker.
$sel:rolloutStateReason:Deployment', deployment_rolloutStateReason - A description of the rollout state of a deployment.
$sel:runningCount:Deployment', deployment_runningCount - The number of tasks in the deployment that are in the RUNNING status.
$sel:serviceConnectConfiguration:Deployment', deployment_serviceConnectConfiguration - The details of the Service Connect configuration that's used by this
deployment. Compare the configuration between multiple deployments when
troubleshooting issues with new deployments.
The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
$sel:serviceConnectResources:Deployment', deployment_serviceConnectResources - The list of Service Connect resources that are associated with this
deployment. Each list entry maps a discovery name to a Cloud Map service
name.
$sel:status:Deployment', deployment_status - The status of the deployment. The following describes each state.
- PRIMARY
- The most recent deployment of a service.
- ACTIVE
- A service deployment that still has running tasks, but are in the
process of being replaced with a new
PRIMARYdeployment. - INACTIVE
- A deployment that has been completely replaced.
$sel:taskDefinition:Deployment', deployment_taskDefinition - The most recent task definition that was specified for the tasks in the
service to use.
$sel:updatedAt:Deployment', deployment_updatedAt - The Unix timestamp for the time when the service deployment was last
updated.
deployment_capacityProviderStrategy :: Lens' Deployment (Maybe [CapacityProviderStrategyItem]) Source #
The capacity provider strategy that the deployment is using.
deployment_createdAt :: Lens' Deployment (Maybe UTCTime) Source #
The Unix timestamp for the time when the service deployment was created.
deployment_desiredCount :: Lens' Deployment (Maybe Int) Source #
The most recent desired count of tasks that was specified for the service to deploy or maintain.
deployment_failedTasks :: Lens' Deployment (Maybe Int) Source #
The number of consecutively failed tasks in the deployment. A task is
considered a failure if the service scheduler can't launch the task,
the task doesn't transition to a RUNNING state, or if it fails any of
its defined health checks and is stopped.
Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.
deployment_id :: Lens' Deployment (Maybe Text) Source #
The ID of the deployment.
deployment_launchType :: Lens' Deployment (Maybe LaunchType) Source #
The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
deployment_networkConfiguration :: Lens' Deployment (Maybe NetworkConfiguration) Source #
The VPC subnet and security group configuration for tasks that receive
their own elastic network interface by using the awsvpc networking
mode.
deployment_pendingCount :: Lens' Deployment (Maybe Int) Source #
The number of tasks in the deployment that are in the PENDING status.
deployment_platformFamily :: Lens' Deployment (Maybe Text) Source #
The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.
All tasks that run as part of this service must use the same
platformFamily value as the service, for example, LINUX..
deployment_platformVersion :: Lens' Deployment (Maybe Text) Source #
The platform version that your tasks in the service run on. A platform
version is only specified for tasks using the Fargate launch type. If
one isn't specified, the LATEST platform version is used. For more
information, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
deployment_rolloutState :: Lens' Deployment (Maybe DeploymentRolloutState) Source #
The rolloutState of a service is only returned for services that use
the rolling update (ECS) deployment type that aren't behind a Classic
Load Balancer.
The rollout state of the deployment. When a service deployment is
started, it begins in an IN_PROGRESS state. When the service reaches a
steady state, the deployment transitions to a COMPLETED state. If the
service fails to reach a steady state and circuit breaker is enabled,
the deployment transitions to a FAILED state. A deployment in FAILED
state doesn't launch any new tasks. For more information, see
DeploymentCircuitBreaker.
deployment_rolloutStateReason :: Lens' Deployment (Maybe Text) Source #
A description of the rollout state of a deployment.
deployment_runningCount :: Lens' Deployment (Maybe Int) Source #
The number of tasks in the deployment that are in the RUNNING status.
deployment_serviceConnectConfiguration :: Lens' Deployment (Maybe ServiceConnectConfiguration) Source #
The details of the Service Connect configuration that's used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.
The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
deployment_serviceConnectResources :: Lens' Deployment (Maybe [ServiceConnectServiceResource]) Source #
The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.
deployment_status :: Lens' Deployment (Maybe Text) Source #
The status of the deployment. The following describes each state.
- PRIMARY
- The most recent deployment of a service.
- ACTIVE
- A service deployment that still has running tasks, but are in the
process of being replaced with a new
PRIMARYdeployment. - INACTIVE
- A deployment that has been completely replaced.
deployment_taskDefinition :: Lens' Deployment (Maybe Text) Source #
The most recent task definition that was specified for the tasks in the service to use.
deployment_updatedAt :: Lens' Deployment (Maybe UTCTime) Source #
The Unix timestamp for the time when the service deployment was last updated.
DeploymentAlarms
data DeploymentAlarms Source #
One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment.
When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure.
You can only use the DeploymentAlarms method to detect failures when
the DeploymentController is set to ECS (rolling update).
For more information, see Rolling update in the /Amazon Elastic Container Service Developer Guide/ .
See: newDeploymentAlarms smart constructor.
Constructors
| DeploymentAlarms' | |
Fields
| |
Instances
Arguments
| :: Bool | |
| -> Bool | |
| -> DeploymentAlarms |
Create a value of DeploymentAlarms with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:alarmNames:DeploymentAlarms', deploymentAlarms_alarmNames - One or more CloudWatch alarm names. Use a "," to separate the alarms.
$sel:enable:DeploymentAlarms', deploymentAlarms_enable - Determines whether to use the CloudWatch alarm option in the service
deployment process.
$sel:rollback:DeploymentAlarms', deploymentAlarms_rollback - Determines whether to configure Amazon ECS to roll back the service if a
service deployment fails. If rollback is used, when a service deployment
fails, the service is rolled back to the last deployment that completed
successfully.
deploymentAlarms_alarmNames :: Lens' DeploymentAlarms [Text] Source #
One or more CloudWatch alarm names. Use a "," to separate the alarms.
deploymentAlarms_enable :: Lens' DeploymentAlarms Bool Source #
Determines whether to use the CloudWatch alarm option in the service deployment process.
deploymentAlarms_rollback :: Lens' DeploymentAlarms Bool Source #
Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
DeploymentCircuitBreaker
data DeploymentCircuitBreaker Source #
The deployment circuit breaker can only be used for services using the
rolling update (ECS) deployment type that aren't behind a Classic
Load Balancer.
The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If enabled, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide.
See: newDeploymentCircuitBreaker smart constructor.
Constructors
| DeploymentCircuitBreaker' | |
Fields
| |
Instances
newDeploymentCircuitBreaker Source #
Arguments
| :: Bool | |
| -> Bool | |
| -> DeploymentCircuitBreaker |
Create a value of DeploymentCircuitBreaker with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enable:DeploymentCircuitBreaker', deploymentCircuitBreaker_enable - Determines whether to use the deployment circuit breaker logic for the
service.
$sel:rollback:DeploymentCircuitBreaker', deploymentCircuitBreaker_rollback - Determines whether to configure Amazon ECS to roll back the service if a
service deployment fails. If rollback is on, when a service deployment
fails, the service is rolled back to the last deployment that completed
successfully.
deploymentCircuitBreaker_enable :: Lens' DeploymentCircuitBreaker Bool Source #
Determines whether to use the deployment circuit breaker logic for the service.
deploymentCircuitBreaker_rollback :: Lens' DeploymentCircuitBreaker Bool Source #
Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
DeploymentConfiguration
data DeploymentConfiguration Source #
Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.
See: newDeploymentConfiguration smart constructor.
Constructors
| DeploymentConfiguration' | |
Fields
| |
Instances
newDeploymentConfiguration :: DeploymentConfiguration Source #
Create a value of DeploymentConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:alarms:DeploymentConfiguration', deploymentConfiguration_alarms - Information about the CloudWatch alarms.
$sel:deploymentCircuitBreaker:DeploymentConfiguration', deploymentConfiguration_deploymentCircuitBreaker - The deployment circuit breaker can only be used for services using the
rolling update (ECS) deployment type.
The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If deployment circuit breaker is enabled, a service deployment will transition to a failed state and stop launching new tasks. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
$sel:maximumPercent:DeploymentConfiguration', deploymentConfiguration_maximumPercent - If a service is using the rolling update (ECS) deployment type, the
maximumPercent parameter represents an upper limit on the number of
your service's tasks that are allowed in the RUNNING or PENDING
state during a deployment, as a percentage of the desiredCount
(rounded down to the nearest integer). This parameter enables you to
define the deployment batch size. For example, if your service is using
the REPLICA service scheduler and has a desiredCount of four tasks
and a maximumPercent value of 200%, the scheduler may start four new
tasks before stopping the four older tasks (provided that the cluster
resources required to do this are available). The default
maximumPercent value for a service using the REPLICA service
scheduler is 200%.
If a service is using either the blue/green (CODE_DEPLOY) or
EXTERNAL deployment types and tasks that use the EC2 launch type, the
maximum percent value is set to the default value and is used to
define the upper limit on the number of the tasks in the service that
remain in the RUNNING state while the container instances are in the
DRAINING state. If the tasks in the service use the Fargate launch
type, the maximum percent value is not used, although it is returned
when describing your service.
$sel:minimumHealthyPercent:DeploymentConfiguration', deploymentConfiguration_minimumHealthyPercent - If a service is using the rolling update (ECS) deployment type, the
minimumHealthyPercent represents a lower limit on the number of your
service's tasks that must remain in the RUNNING state during a
deployment, as a percentage of the desiredCount (rounded up to the
nearest integer). This parameter enables you to deploy without using
additional cluster capacity. For example, if your service has a
desiredCount of four tasks and a minimumHealthyPercent of 50%, the
service scheduler may stop two existing tasks to free up cluster
capacity before starting two new tasks.
For services that do not use a load balancer, the following should be noted:
- A service is considered healthy if all essential containers within the tasks in the service pass their health checks.
- If a task has no essential containers with a health check defined,
the service scheduler will wait for 40 seconds after a task reaches
a
RUNNINGstate before the task is counted towards the minimum healthy percent total. - If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.
For services are that do use a load balancer, the following should be noted:
- If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
- If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
If a service is using either the blue/green (CODE_DEPLOY) or
EXTERNAL deployment types and is running tasks that use the EC2 launch
type, the minimum healthy percent value is set to the default value
and is used to define the lower limit on the number of the tasks in the
service that remain in the RUNNING state while the container instances
are in the DRAINING state. If a service is using either the
blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is
running tasks that use the Fargate launch type, the minimum healthy
percent value is not used, although it is returned when describing your
service.
deploymentConfiguration_alarms :: Lens' DeploymentConfiguration (Maybe DeploymentAlarms) Source #
Information about the CloudWatch alarms.
deploymentConfiguration_deploymentCircuitBreaker :: Lens' DeploymentConfiguration (Maybe DeploymentCircuitBreaker) Source #
The deployment circuit breaker can only be used for services using the
rolling update (ECS) deployment type.
The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If deployment circuit breaker is enabled, a service deployment will transition to a failed state and stop launching new tasks. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
deploymentConfiguration_maximumPercent :: Lens' DeploymentConfiguration (Maybe Int) Source #
If a service is using the rolling update (ECS) deployment type, the
maximumPercent parameter represents an upper limit on the number of
your service's tasks that are allowed in the RUNNING or PENDING
state during a deployment, as a percentage of the desiredCount
(rounded down to the nearest integer). This parameter enables you to
define the deployment batch size. For example, if your service is using
the REPLICA service scheduler and has a desiredCount of four tasks
and a maximumPercent value of 200%, the scheduler may start four new
tasks before stopping the four older tasks (provided that the cluster
resources required to do this are available). The default
maximumPercent value for a service using the REPLICA service
scheduler is 200%.
If a service is using either the blue/green (CODE_DEPLOY) or
EXTERNAL deployment types and tasks that use the EC2 launch type, the
maximum percent value is set to the default value and is used to
define the upper limit on the number of the tasks in the service that
remain in the RUNNING state while the container instances are in the
DRAINING state. If the tasks in the service use the Fargate launch
type, the maximum percent value is not used, although it is returned
when describing your service.
deploymentConfiguration_minimumHealthyPercent :: Lens' DeploymentConfiguration (Maybe Int) Source #
If a service is using the rolling update (ECS) deployment type, the
minimumHealthyPercent represents a lower limit on the number of your
service's tasks that must remain in the RUNNING state during a
deployment, as a percentage of the desiredCount (rounded up to the
nearest integer). This parameter enables you to deploy without using
additional cluster capacity. For example, if your service has a
desiredCount of four tasks and a minimumHealthyPercent of 50%, the
service scheduler may stop two existing tasks to free up cluster
capacity before starting two new tasks.
For services that do not use a load balancer, the following should be noted:
- A service is considered healthy if all essential containers within the tasks in the service pass their health checks.
- If a task has no essential containers with a health check defined,
the service scheduler will wait for 40 seconds after a task reaches
a
RUNNINGstate before the task is counted towards the minimum healthy percent total. - If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.
For services are that do use a load balancer, the following should be noted:
- If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
- If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
If a service is using either the blue/green (CODE_DEPLOY) or
EXTERNAL deployment types and is running tasks that use the EC2 launch
type, the minimum healthy percent value is set to the default value
and is used to define the lower limit on the number of the tasks in the
service that remain in the RUNNING state while the container instances
are in the DRAINING state. If a service is using either the
blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is
running tasks that use the Fargate launch type, the minimum healthy
percent value is not used, although it is returned when describing your
service.
DeploymentController
data DeploymentController Source #
The deployment controller to use for the service. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
See: newDeploymentController smart constructor.
Constructors
| DeploymentController' | |
Fields
| |
Instances
newDeploymentController Source #
Create a value of DeploymentController with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':DeploymentController', deploymentController_type - The deployment controller type to use.
There are three deployment controller types available:
- ECS
- The rolling update (
ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. - CODE_DEPLOY
- The blue/green (
CODE_DEPLOY) deployment type uses the blue/green deployment model powered by CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. - EXTERNAL
- The external (
EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.
deploymentController_type :: Lens' DeploymentController DeploymentControllerType Source #
The deployment controller type to use.
There are three deployment controller types available:
- ECS
- The rolling update (
ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. - CODE_DEPLOY
- The blue/green (
CODE_DEPLOY) deployment type uses the blue/green deployment model powered by CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. - EXTERNAL
- The external (
EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.
Device
An object representing a container instance host device.
See: newDevice smart constructor.
Constructors
| Device' | |
Fields
| |
Instances
| FromJSON Device Source # | |
| ToJSON Device Source # | |
Defined in Amazonka.ECS.Types.Device | |
| Generic Device Source # | |
| Read Device Source # | |
| Show Device Source # | |
| NFData Device Source # | |
Defined in Amazonka.ECS.Types.Device | |
| Eq Device Source # | |
| Hashable Device Source # | |
Defined in Amazonka.ECS.Types.Device | |
| type Rep Device Source # | |
Defined in Amazonka.ECS.Types.Device type Rep Device = D1 ('MetaData "Device" "Amazonka.ECS.Types.Device" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Device'" 'PrefixI 'True) (S1 ('MetaSel ('Just "containerPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DeviceCgroupPermission])) :*: S1 ('MetaSel ('Just "hostPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Create a value of Device with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containerPath:Device', device_containerPath - The path inside the container at which to expose the host device.
$sel:permissions:Device', device_permissions - 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.
$sel:hostPath:Device', device_hostPath - The path for the device on the host container instance.
device_containerPath :: Lens' Device (Maybe Text) Source #
The path inside the container at which to expose the host device.
device_permissions :: Lens' Device (Maybe [DeviceCgroupPermission]) Source #
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.
device_hostPath :: Lens' Device Text Source #
The path for the device on the host container instance.
DockerVolumeConfiguration
data DockerVolumeConfiguration Source #
This parameter is specified when you're using Docker volumes. Docker
volumes are only supported when you're using the EC2 launch type.
Windows containers only support the use of the local driver. To use
bind mounts, specify a host instead.
See: newDockerVolumeConfiguration smart constructor.
Constructors
| DockerVolumeConfiguration' | |
Fields
| |
Instances
newDockerVolumeConfiguration :: DockerVolumeConfiguration Source #
Create a value of DockerVolumeConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoprovision:DockerVolumeConfiguration', dockerVolumeConfiguration_autoprovision - If this value is true, the Docker volume is created if it doesn't
already exist.
This field is only used if the scope is shared.
$sel:driver:DockerVolumeConfiguration', dockerVolumeConfiguration_driver - The Docker volume driver to use. The driver value must match the driver
name provided by Docker because it is used for task placement. If the
driver was installed using the Docker plugin CLI, use docker plugin ls
to retrieve the driver name from your container instance. If the driver
was installed using another method, use Docker plugin discovery to
retrieve the driver name. For more information, see
Docker plugin discovery.
This parameter maps to Driver in the
Create a volume
section of the
Docker Remote API and the
xxdriver option to
docker volume create.
$sel:driverOpts:DockerVolumeConfiguration', dockerVolumeConfiguration_driverOpts - A map of Docker driver-specific options passed through. This parameter
maps to DriverOpts in the
Create a volume
section of the
Docker Remote API and the
xxopt option to
docker volume create.
$sel:labels:DockerVolumeConfiguration', dockerVolumeConfiguration_labels - Custom metadata to add to your Docker volume. This parameter maps to
Labels in the
Create a volume
section of the
Docker Remote API and the
xxlabel option to
docker volume create.
$sel:scope:DockerVolumeConfiguration', dockerVolumeConfiguration_scope - The scope for the Docker volume that determines its lifecycle. Docker
volumes that are scoped to a task are automatically provisioned when
the task starts and destroyed when the task stops. Docker volumes that
are scoped as shared persist after the task stops.
dockerVolumeConfiguration_autoprovision :: Lens' DockerVolumeConfiguration (Maybe Bool) Source #
If this value is true, the Docker volume is created if it doesn't
already exist.
This field is only used if the scope is shared.
dockerVolumeConfiguration_driver :: Lens' DockerVolumeConfiguration (Maybe Text) Source #
The Docker volume driver to use. The driver value must match the driver
name provided by Docker because it is used for task placement. If the
driver was installed using the Docker plugin CLI, use docker plugin ls
to retrieve the driver name from your container instance. If the driver
was installed using another method, use Docker plugin discovery to
retrieve the driver name. For more information, see
Docker plugin discovery.
This parameter maps to Driver in the
Create a volume
section of the
Docker Remote API and the
xxdriver option to
docker volume create.
dockerVolumeConfiguration_driverOpts :: Lens' DockerVolumeConfiguration (Maybe (HashMap Text Text)) Source #
A map of Docker driver-specific options passed through. This parameter
maps to DriverOpts in the
Create a volume
section of the
Docker Remote API and the
xxopt option to
docker volume create.
dockerVolumeConfiguration_labels :: Lens' DockerVolumeConfiguration (Maybe (HashMap Text Text)) Source #
Custom metadata to add to your Docker volume. This parameter maps to
Labels in the
Create a volume
section of the
Docker Remote API and the
xxlabel option to
docker volume create.
dockerVolumeConfiguration_scope :: Lens' DockerVolumeConfiguration (Maybe Scope) Source #
The scope for the Docker volume that determines its lifecycle. Docker
volumes that are scoped to a task are automatically provisioned when
the task starts and destroyed when the task stops. Docker volumes that
are scoped as shared persist after the task stops.
EFSAuthorizationConfig
data EFSAuthorizationConfig Source #
The authorization configuration details for the Amazon EFS file system.
See: newEFSAuthorizationConfig smart constructor.
Constructors
| EFSAuthorizationConfig' | |
Fields
| |
Instances
newEFSAuthorizationConfig :: EFSAuthorizationConfig Source #
Create a value of EFSAuthorizationConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessPointId:EFSAuthorizationConfig', eFSAuthorizationConfig_accessPointId - The Amazon EFS access point ID to use. If an access point is specified,
the root directory value specified in the EFSVolumeConfiguration must
either be omitted or set to / which will enforce the path set on the
EFS access point. If an access point is used, transit encryption must be
enabled in the EFSVolumeConfiguration. For more information, see
Working with Amazon EFS access points
in the Amazon Elastic File System User Guide.
$sel:iam:EFSAuthorizationConfig', eFSAuthorizationConfig_iam - Determines whether to use the Amazon ECS task IAM role defined in a task
definition when mounting the Amazon EFS file system. If enabled, transit
encryption must be enabled in the EFSVolumeConfiguration. If this
parameter is omitted, the default value of DISABLED is used. For more
information, see
Using Amazon EFS access points
in the Amazon Elastic Container Service Developer Guide.
eFSAuthorizationConfig_accessPointId :: Lens' EFSAuthorizationConfig (Maybe Text) Source #
The Amazon EFS access point ID to use. If an access point is specified,
the root directory value specified in the EFSVolumeConfiguration must
either be omitted or set to / which will enforce the path set on the
EFS access point. If an access point is used, transit encryption must be
enabled in the EFSVolumeConfiguration. For more information, see
Working with Amazon EFS access points
in the Amazon Elastic File System User Guide.
eFSAuthorizationConfig_iam :: Lens' EFSAuthorizationConfig (Maybe EFSAuthorizationConfigIAM) Source #
Determines whether to use the Amazon ECS task IAM role defined in a task
definition when mounting the Amazon EFS file system. If enabled, transit
encryption must be enabled in the EFSVolumeConfiguration. If this
parameter is omitted, the default value of DISABLED is used. For more
information, see
Using Amazon EFS access points
in the Amazon Elastic Container Service Developer Guide.
EFSVolumeConfiguration
data EFSVolumeConfiguration Source #
This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.
See: newEFSVolumeConfiguration smart constructor.
Constructors
| EFSVolumeConfiguration' | |
Fields
| |
Instances
newEFSVolumeConfiguration Source #
Create a value of EFSVolumeConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:authorizationConfig:EFSVolumeConfiguration', eFSVolumeConfiguration_authorizationConfig - The authorization configuration details for the Amazon EFS file system.
$sel:rootDirectory:EFSVolumeConfiguration', eFSVolumeConfiguration_rootDirectory - The directory within the Amazon EFS file system to mount as the root
directory inside the host. If this parameter is omitted, the root of the
Amazon EFS volume will be used. Specifying / will have the same
effect as omitting this parameter.
If an EFS access point is specified in the authorizationConfig, the
root directory parameter must either be omitted or set to / which
will enforce the path set on the EFS access point.
$sel:transitEncryption:EFSVolumeConfiguration', eFSVolumeConfiguration_transitEncryption - Determines whether to use encryption for Amazon EFS data in transit
between the Amazon ECS host and the Amazon EFS server. Transit
encryption must be enabled if Amazon EFS IAM authorization is used. If
this parameter is omitted, the default value of DISABLED is used. For
more information, see
Encrypting data in transit
in the Amazon Elastic File System User Guide.
$sel:transitEncryptionPort:EFSVolumeConfiguration', eFSVolumeConfiguration_transitEncryptionPort - The port to use when sending encrypted data between the Amazon ECS host
and the Amazon EFS server. If you do not specify a transit encryption
port, it will use the port selection strategy that the Amazon EFS mount
helper uses. For more information, see
EFS mount helper
in the Amazon Elastic File System User Guide.
$sel:fileSystemId:EFSVolumeConfiguration', eFSVolumeConfiguration_fileSystemId - The Amazon EFS file system ID to use.
eFSVolumeConfiguration_authorizationConfig :: Lens' EFSVolumeConfiguration (Maybe EFSAuthorizationConfig) Source #
The authorization configuration details for the Amazon EFS file system.
eFSVolumeConfiguration_rootDirectory :: Lens' EFSVolumeConfiguration (Maybe Text) Source #
The directory within the Amazon EFS file system to mount as the root
directory inside the host. If this parameter is omitted, the root of the
Amazon EFS volume will be used. Specifying / will have the same
effect as omitting this parameter.
If an EFS access point is specified in the authorizationConfig, the
root directory parameter must either be omitted or set to / which
will enforce the path set on the EFS access point.
eFSVolumeConfiguration_transitEncryption :: Lens' EFSVolumeConfiguration (Maybe EFSTransitEncryption) Source #
Determines whether to use encryption for Amazon EFS data in transit
between the Amazon ECS host and the Amazon EFS server. Transit
encryption must be enabled if Amazon EFS IAM authorization is used. If
this parameter is omitted, the default value of DISABLED is used. For
more information, see
Encrypting data in transit
in the Amazon Elastic File System User Guide.
eFSVolumeConfiguration_transitEncryptionPort :: Lens' EFSVolumeConfiguration (Maybe Int) Source #
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
eFSVolumeConfiguration_fileSystemId :: Lens' EFSVolumeConfiguration Text Source #
The Amazon EFS file system ID to use.
EnvironmentFile
data EnvironmentFile Source #
A list of files containing the environment variables to pass to a
container. You can specify up to ten environment files. The file must
have a .env file extension. Each line in an environment file should
contain an environment variable in VARIABLE=VALUE format. Lines
beginning with # are treated as comments and are ignored. For more
information about the environment variable file syntax, see
Declare default environment variables in file.
If there are environment variables specified using the environment
parameter in a container definition, they take precedence over the
variables contained within an environment file. If multiple environment
files are specified that contain the same variable, they're processed
from the top down. We recommend that you use unique variable names. For
more information, see
Specifying environment variables
in the Amazon Elastic Container Service Developer Guide.
This parameter is only supported for tasks hosted on Fargate using the following platform versions:
- Linux platform version
1.4.0or later. - Windows platform version
1.0.0or later.
See: newEnvironmentFile smart constructor.
Constructors
| EnvironmentFile' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> EnvironmentFileType | |
| -> EnvironmentFile |
Create a value of EnvironmentFile with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:EnvironmentFile', environmentFile_value - The Amazon Resource Name (ARN) of the Amazon S3 object containing the
environment variable file.
$sel:type':EnvironmentFile', environmentFile_type - The file type to use. The only supported value is s3.
environmentFile_value :: Lens' EnvironmentFile Text Source #
The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
environmentFile_type :: Lens' EnvironmentFile EnvironmentFileType Source #
The file type to use. The only supported value is s3.
EphemeralStorage
data EphemeralStorage Source #
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage in the Amazon ECS User Guide for Fargate.
This parameter is only supported for tasks hosted on Fargate using Linux
platform version 1.4.0 or later. This parameter is not supported for
Windows containers on Fargate.
See: newEphemeralStorage smart constructor.
Constructors
| EphemeralStorage' | |
Instances
Arguments
| :: Int | |
| -> EphemeralStorage |
Create a value of EphemeralStorage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sizeInGiB:EphemeralStorage', ephemeralStorage_sizeInGiB - The total amount, in GiB, of ephemeral storage to set for the task. The
minimum supported value is 21 GiB and the maximum supported value is
200 GiB.
ephemeralStorage_sizeInGiB :: Lens' EphemeralStorage Int Source #
The total amount, in GiB, of ephemeral storage to set for the task. The
minimum supported value is 21 GiB and the maximum supported value is
200 GiB.
ExecuteCommandConfiguration
data ExecuteCommandConfiguration Source #
The details of the execute command configuration.
See: newExecuteCommandConfiguration smart constructor.
Constructors
| ExecuteCommandConfiguration' | |
Fields
| |
Instances
newExecuteCommandConfiguration :: ExecuteCommandConfiguration Source #
Create a value of ExecuteCommandConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKeyId:ExecuteCommandConfiguration', executeCommandConfiguration_kmsKeyId - Specify an Key Management Service key ID to encrypt the data between the
local client and the container.
$sel:logConfiguration:ExecuteCommandConfiguration', executeCommandConfiguration_logConfiguration - The log configuration for the results of the execute command actions.
The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When
logging=OVERRIDE is specified, a logConfiguration must be provided.
$sel:logging:ExecuteCommandConfiguration', executeCommandConfiguration_logging - The log setting to use for redirecting logs for your execute command
results. The following log settings are available.
NONE: The execute command session is not logged.DEFAULT: Theawslogsconfiguration in the task definition is used. If no logging parameter is specified, it defaults to this value. If noawslogslog driver is configured in the task definition, the output won't be logged.OVERRIDE: Specify the logging details as a part oflogConfiguration. If theOVERRIDElogging option is specified, thelogConfigurationis required.
executeCommandConfiguration_kmsKeyId :: Lens' ExecuteCommandConfiguration (Maybe Text) Source #
Specify an Key Management Service key ID to encrypt the data between the local client and the container.
executeCommandConfiguration_logConfiguration :: Lens' ExecuteCommandConfiguration (Maybe ExecuteCommandLogConfiguration) Source #
The log configuration for the results of the execute command actions.
The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When
logging=OVERRIDE is specified, a logConfiguration must be provided.
executeCommandConfiguration_logging :: Lens' ExecuteCommandConfiguration (Maybe ExecuteCommandLogging) Source #
The log setting to use for redirecting logs for your execute command results. The following log settings are available.
NONE: The execute command session is not logged.DEFAULT: Theawslogsconfiguration in the task definition is used. If no logging parameter is specified, it defaults to this value. If noawslogslog driver is configured in the task definition, the output won't be logged.OVERRIDE: Specify the logging details as a part oflogConfiguration. If theOVERRIDElogging option is specified, thelogConfigurationis required.
ExecuteCommandLogConfiguration
data ExecuteCommandLogConfiguration Source #
The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.
See: newExecuteCommandLogConfiguration smart constructor.
Constructors
| ExecuteCommandLogConfiguration' | |
Fields
| |
Instances
newExecuteCommandLogConfiguration :: ExecuteCommandLogConfiguration Source #
Create a value of ExecuteCommandLogConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cloudWatchEncryptionEnabled:ExecuteCommandLogConfiguration', executeCommandLogConfiguration_cloudWatchEncryptionEnabled - Determines whether to use encryption on the CloudWatch logs. If not
specified, encryption will be disabled.
$sel:cloudWatchLogGroupName:ExecuteCommandLogConfiguration', executeCommandLogConfiguration_cloudWatchLogGroupName - The name of the CloudWatch log group to send logs to.
The CloudWatch log group must already be created.
$sel:s3BucketName:ExecuteCommandLogConfiguration', executeCommandLogConfiguration_s3BucketName - The name of the S3 bucket to send logs to.
The S3 bucket must already be created.
$sel:s3EncryptionEnabled:ExecuteCommandLogConfiguration', executeCommandLogConfiguration_s3EncryptionEnabled - Determines whether to use encryption on the S3 logs. If not specified,
encryption is not used.
$sel:s3KeyPrefix:ExecuteCommandLogConfiguration', executeCommandLogConfiguration_s3KeyPrefix - An optional folder in the S3 bucket to place logs in.
executeCommandLogConfiguration_cloudWatchEncryptionEnabled :: Lens' ExecuteCommandLogConfiguration (Maybe Bool) Source #
Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be disabled.
executeCommandLogConfiguration_cloudWatchLogGroupName :: Lens' ExecuteCommandLogConfiguration (Maybe Text) Source #
The name of the CloudWatch log group to send logs to.
The CloudWatch log group must already be created.
executeCommandLogConfiguration_s3BucketName :: Lens' ExecuteCommandLogConfiguration (Maybe Text) Source #
The name of the S3 bucket to send logs to.
The S3 bucket must already be created.
executeCommandLogConfiguration_s3EncryptionEnabled :: Lens' ExecuteCommandLogConfiguration (Maybe Bool) Source #
Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.
executeCommandLogConfiguration_s3KeyPrefix :: Lens' ExecuteCommandLogConfiguration (Maybe Text) Source #
An optional folder in the S3 bucket to place logs in.
FSxWindowsFileServerAuthorizationConfig
data FSxWindowsFileServerAuthorizationConfig Source #
The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon ECS API Reference.
For more information and the input format, see Amazon FSx for Windows File Server Volumes in the Amazon Elastic Container Service Developer Guide.
See: newFSxWindowsFileServerAuthorizationConfig smart constructor.
Constructors
| FSxWindowsFileServerAuthorizationConfig' | |
Fields
| |
Instances
newFSxWindowsFileServerAuthorizationConfig Source #
Arguments
| :: Text |
|
| -> Text | |
| -> FSxWindowsFileServerAuthorizationConfig |
Create a value of FSxWindowsFileServerAuthorizationConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:credentialsParameter:FSxWindowsFileServerAuthorizationConfig', fSxWindowsFileServerAuthorizationConfig_credentialsParameter - The authorization credential option to use. The authorization credential
options can be provided using either the Amazon Resource Name (ARN) of
an Secrets Manager secret or SSM Parameter Store parameter. The ARN
refers to the stored credentials.
$sel:domain:FSxWindowsFileServerAuthorizationConfig', fSxWindowsFileServerAuthorizationConfig_domain - A fully qualified domain name hosted by an
Directory Service
Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.
fSxWindowsFileServerAuthorizationConfig_credentialsParameter :: Lens' FSxWindowsFileServerAuthorizationConfig Text Source #
The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store parameter. The ARN refers to the stored credentials.
fSxWindowsFileServerAuthorizationConfig_domain :: Lens' FSxWindowsFileServerAuthorizationConfig Text Source #
A fully qualified domain name hosted by an Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.
FSxWindowsFileServerVolumeConfiguration
data FSxWindowsFileServerVolumeConfiguration Source #
This parameter is specified when you're using Amazon FSx for Windows File Server file system for task storage.
For more information and the input format, see Amazon FSx for Windows File Server volumes in the Amazon Elastic Container Service Developer Guide.
See: newFSxWindowsFileServerVolumeConfiguration smart constructor.
Constructors
| FSxWindowsFileServerVolumeConfiguration' | |
Fields
| |
Instances
newFSxWindowsFileServerVolumeConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> FSxWindowsFileServerAuthorizationConfig |
|
| -> FSxWindowsFileServerVolumeConfiguration |
Create a value of FSxWindowsFileServerVolumeConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileSystemId:FSxWindowsFileServerVolumeConfiguration', fSxWindowsFileServerVolumeConfiguration_fileSystemId - The Amazon FSx for Windows File Server file system ID to use.
$sel:rootDirectory:FSxWindowsFileServerVolumeConfiguration', fSxWindowsFileServerVolumeConfiguration_rootDirectory - The directory within the Amazon FSx for Windows File Server file system
to mount as the root directory inside the host.
$sel:authorizationConfig:FSxWindowsFileServerVolumeConfiguration', fSxWindowsFileServerVolumeConfiguration_authorizationConfig - The authorization configuration details for the Amazon FSx for Windows
File Server file system.
fSxWindowsFileServerVolumeConfiguration_fileSystemId :: Lens' FSxWindowsFileServerVolumeConfiguration Text Source #
The Amazon FSx for Windows File Server file system ID to use.
fSxWindowsFileServerVolumeConfiguration_rootDirectory :: Lens' FSxWindowsFileServerVolumeConfiguration Text Source #
The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
fSxWindowsFileServerVolumeConfiguration_authorizationConfig :: Lens' FSxWindowsFileServerVolumeConfiguration FSxWindowsFileServerAuthorizationConfig Source #
The authorization configuration details for the Amazon FSx for Windows File Server file system.
Failure
A failed resource. For a list of common causes, see API failure reasons in the Amazon Elastic Container Service Developer Guide.
See: newFailure smart constructor.
Constructors
| Failure' | |
Instances
| FromJSON Failure Source # | |
| Generic Failure Source # | |
| Read Failure Source # | |
| Show Failure Source # | |
| NFData Failure Source # | |
Defined in Amazonka.ECS.Types.Failure | |
| Eq Failure Source # | |
| Hashable Failure Source # | |
Defined in Amazonka.ECS.Types.Failure | |
| type Rep Failure Source # | |
Defined in Amazonka.ECS.Types.Failure type Rep Failure = D1 ('MetaData "Failure" "Amazonka.ECS.Types.Failure" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Failure'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "detail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
newFailure :: Failure Source #
Create a value of Failure with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Failure', failure_arn - The Amazon Resource Name (ARN) of the failed resource.
$sel:detail:Failure', failure_detail - The details of the failure.
$sel:reason:Failure', failure_reason - The reason for the failure.
failure_arn :: Lens' Failure (Maybe Text) Source #
The Amazon Resource Name (ARN) of the failed resource.
FirelensConfiguration
data FirelensConfiguration Source #
The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.
See: newFirelensConfiguration smart constructor.
Constructors
| FirelensConfiguration' | |
Fields
| |
Instances
newFirelensConfiguration Source #
Create a value of FirelensConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:FirelensConfiguration', firelensConfiguration_options - The options to use when configuring the log router. This field is
optional and can be used to specify a custom configuration file or to
add additional metadata, such as the task, task definition, cluster, and
container instance details to the log event. If specified, the syntax to
use is
"options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}.
For more information, see
Creating a task definition that uses a FireLens configuration
in the Amazon Elastic Container Service Developer Guide.
Tasks hosted on Fargate only support the file configuration file type.
$sel:type':FirelensConfiguration', firelensConfiguration_type - The log router to use. The valid values are fluentd or fluentbit.
firelensConfiguration_options :: Lens' FirelensConfiguration (Maybe (HashMap Text Text)) Source #
The options to use when configuring the log router. This field is
optional and can be used to specify a custom configuration file or to
add additional metadata, such as the task, task definition, cluster, and
container instance details to the log event. If specified, the syntax to
use is
"options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}.
For more information, see
Creating a task definition that uses a FireLens configuration
in the Amazon Elastic Container Service Developer Guide.
Tasks hosted on Fargate only support the file configuration file type.
firelensConfiguration_type :: Lens' FirelensConfiguration FirelensConfigurationType Source #
The log router to use. The valid values are fluentd or fluentbit.
HealthCheck
data HealthCheck Source #
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).
The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console.
The following describes the possible healthStatus values for a
container:
HEALTHY-The container health check has passed successfully.UNHEALTHY-The container health check has failed.UNKNOWN-The container health check is being evaluated or there's no container health check defined.
The following describes the possible healthStatus values for a task.
The container health check status of nonessential containers only
affects the health status of a task if no essential containers have
health checks defined.
HEALTHY-All essential containers within the task have passed their health checks.UNHEALTHY-One or more essential containers have failed their health check.UNKNOWN-The essential containers within the task are still having their health checks evaluated or there are only nonessential containers with health checks defined.
If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.
For tasks that are a part of a service and the service uses the ECS
rolling deployment type, the deployment is paused while the new tasks
have the UNKNOWN task health check status. For example, tasks that
define health checks for nonessential containers when no essential
containers have health checks will have the UNKNOWN health check
status indefinitely which prevents the deployment from completing.
The following are notes about container health check support:
- Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS container agent.
- Container health checks are supported for Fargate tasks if you're
using platform version
1.1.0or greater. For more information, see Fargate platform versions. - Container health checks aren't supported for tasks that are part of a service that's configured to use a Classic Load Balancer.
See: newHealthCheck smart constructor.
Constructors
| HealthCheck' | |
Fields
| |
Instances
newHealthCheck :: HealthCheck Source #
Create a value of HealthCheck with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:interval:HealthCheck', healthCheck_interval - The time period in seconds between each health check execution. You may
specify between 5 and 300 seconds. The default value is 30 seconds.
$sel:retries:HealthCheck', healthCheck_retries - 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.
$sel:startPeriod:HealthCheck', healthCheck_startPeriod - The optional grace period to provide containers time to bootstrap before
failed health checks count towards the maximum number of retries. You
can specify between 0 and 300 seconds. By default, the startPeriod is
disabled.
If a health check succeeds within the startPeriod, then the container
is considered healthy and any subsequent failures count toward the
maximum number of retries.
$sel:timeout:HealthCheck', healthCheck_timeout - 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.
$sel:command:HealthCheck', healthCheck_command - A string array representing the command that the container runs to
determine if it is healthy. The string array must start with CMD to
run the command arguments directly, or CMD-SHELL to run the command
with the container's default shell.
When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in brackets.
[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
You don't need to include the brackets when you use the Amazon Web Services Management Console.
"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.
healthCheck_interval :: Lens' HealthCheck (Maybe Int) Source #
The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
healthCheck_retries :: Lens' HealthCheck (Maybe Int) Source #
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.
healthCheck_startPeriod :: Lens' HealthCheck (Maybe Int) Source #
The optional grace period to provide containers time to bootstrap before
failed health checks count towards the maximum number of retries. You
can specify between 0 and 300 seconds. By default, the startPeriod is
disabled.
If a health check succeeds within the startPeriod, then the container
is considered healthy and any subsequent failures count toward the
maximum number of retries.
healthCheck_timeout :: Lens' HealthCheck (Maybe Int) Source #
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.
healthCheck_command :: Lens' HealthCheck [Text] Source #
A string array representing the command that the container runs to
determine if it is healthy. The string array must start with CMD to
run the command arguments directly, or CMD-SHELL to run the command
with the container's default shell.
When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in brackets.
[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
You don't need to include the brackets when you use the Amazon Web Services Management Console.
"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 /etc/hosts
file of a container via the extraHosts parameter of its
ContainerDefinition.
See: newHostEntry smart constructor.
Constructors
| HostEntry' | |
Instances
| FromJSON HostEntry Source # | |
| ToJSON HostEntry Source # | |
Defined in Amazonka.ECS.Types.HostEntry | |
| Generic HostEntry Source # | |
| Read HostEntry Source # | |
| Show HostEntry Source # | |
| NFData HostEntry Source # | |
Defined in Amazonka.ECS.Types.HostEntry | |
| Eq HostEntry Source # | |
| Hashable HostEntry Source # | |
Defined in Amazonka.ECS.Types.HostEntry | |
| type Rep HostEntry Source # | |
Defined in Amazonka.ECS.Types.HostEntry type Rep HostEntry = D1 ('MetaData "HostEntry" "Amazonka.ECS.Types.HostEntry" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "HostEntry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hostname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "ipAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of HostEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hostname:HostEntry', hostEntry_hostname - The hostname to use in the /etc/hosts entry.
$sel:ipAddress:HostEntry', hostEntry_ipAddress - The IP address to use in the /etc/hosts entry.
HostVolumeProperties
data HostVolumeProperties Source #
Details on a container instance bind mount host volume.
See: newHostVolumeProperties smart constructor.
Constructors
| HostVolumeProperties' | |
Fields
| |
Instances
newHostVolumeProperties :: HostVolumeProperties Source #
Create a value of HostVolumeProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourcePath:HostVolumeProperties', hostVolumeProperties_sourcePath - When the host parameter is used, specify a sourcePath to declare the
path on the host container instance that's 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 doesn't 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're using the Fargate launch type, the sourcePath parameter is
not supported.
hostVolumeProperties_sourcePath :: Lens' HostVolumeProperties (Maybe Text) Source #
When the host parameter is used, specify a sourcePath to declare the
path on the host container instance that's 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 doesn't 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're using the Fargate launch type, the sourcePath parameter is
not supported.
InferenceAccelerator
data InferenceAccelerator Source #
Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
See: newInferenceAccelerator smart constructor.
Constructors
| InferenceAccelerator' | |
Fields
| |
Instances
newInferenceAccelerator Source #
Arguments
| :: Text | |
| -> Text | |
| -> InferenceAccelerator |
Create a value of InferenceAccelerator with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceName:InferenceAccelerator', inferenceAccelerator_deviceName - The Elastic Inference accelerator device name. The deviceName must
also be referenced in a container definition as a ResourceRequirement.
$sel:deviceType:InferenceAccelerator', inferenceAccelerator_deviceType - The Elastic Inference accelerator type to use.
inferenceAccelerator_deviceName :: Lens' InferenceAccelerator Text Source #
The Elastic Inference accelerator device name. The deviceName must
also be referenced in a container definition as a ResourceRequirement.
inferenceAccelerator_deviceType :: Lens' InferenceAccelerator Text Source #
The Elastic Inference accelerator type to use.
InferenceAcceleratorOverride
data InferenceAcceleratorOverride Source #
Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
See: newInferenceAcceleratorOverride smart constructor.
Constructors
| InferenceAcceleratorOverride' | |
Fields
| |
Instances
newInferenceAcceleratorOverride :: InferenceAcceleratorOverride Source #
Create a value of InferenceAcceleratorOverride with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceName:InferenceAcceleratorOverride', inferenceAcceleratorOverride_deviceName - The Elastic Inference accelerator device name to override for the task.
This parameter must match a deviceName specified in the task
definition.
$sel:deviceType:InferenceAcceleratorOverride', inferenceAcceleratorOverride_deviceType - The Elastic Inference accelerator type to use.
inferenceAcceleratorOverride_deviceName :: Lens' InferenceAcceleratorOverride (Maybe Text) Source #
The Elastic Inference accelerator device name to override for the task.
This parameter must match a deviceName specified in the task
definition.
inferenceAcceleratorOverride_deviceType :: Lens' InferenceAcceleratorOverride (Maybe Text) Source #
The Elastic Inference accelerator type to use.
InstanceHealthCheckResult
data InstanceHealthCheckResult Source #
An object representing the result of a container instance health status check.
See: newInstanceHealthCheckResult smart constructor.
Constructors
| InstanceHealthCheckResult' | |
Fields
| |
Instances
newInstanceHealthCheckResult :: InstanceHealthCheckResult Source #
Create a value of InstanceHealthCheckResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastStatusChange:InstanceHealthCheckResult', instanceHealthCheckResult_lastStatusChange - The Unix timestamp for when the container instance health status last
changed.
$sel:lastUpdated:InstanceHealthCheckResult', instanceHealthCheckResult_lastUpdated - The Unix timestamp for when the container instance health status was
last updated.
$sel:status:InstanceHealthCheckResult', instanceHealthCheckResult_status - The container instance health status.
$sel:type':InstanceHealthCheckResult', instanceHealthCheckResult_type - The type of container instance health status that was verified.
instanceHealthCheckResult_lastStatusChange :: Lens' InstanceHealthCheckResult (Maybe UTCTime) Source #
The Unix timestamp for when the container instance health status last changed.
instanceHealthCheckResult_lastUpdated :: Lens' InstanceHealthCheckResult (Maybe UTCTime) Source #
The Unix timestamp for when the container instance health status was last updated.
instanceHealthCheckResult_status :: Lens' InstanceHealthCheckResult (Maybe InstanceHealthCheckState) Source #
The container instance health status.
instanceHealthCheckResult_type :: Lens' InstanceHealthCheckResult (Maybe InstanceHealthCheckType) Source #
The type of container instance health status that was verified.
KernelCapabilities
data KernelCapabilities Source #
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page.
See: newKernelCapabilities smart constructor.
Constructors
| KernelCapabilities' | |
Fields
| |
Instances
newKernelCapabilities :: KernelCapabilities Source #
Create a value of KernelCapabilities with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:add:KernelCapabilities', kernelCapabilities_add - 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.
Tasks launched on Fargate only support adding the SYS_PTRACE kernel
capability.
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"
$sel:drop:KernelCapabilities', kernelCapabilities_drop - 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"
kernelCapabilities_add :: Lens' KernelCapabilities (Maybe [Text]) Source #
The Linux capabilities for the container that have been added to the
default configuration provided by Docker. This parameter maps to
CapAdd in the
Create a container
section of the
Docker Remote API and the
--cap-add option to
docker run.
Tasks launched on Fargate only support adding the SYS_PTRACE kernel
capability.
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"
kernelCapabilities_drop :: Lens' KernelCapabilities (Maybe [Text]) Source #
The Linux capabilities for the container that have been removed from the
default configuration provided by Docker. This parameter maps to
CapDrop in the
Create a container
section of the
Docker Remote API and the
--cap-drop option to
docker run.
Valid values:
"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
KeyValuePair
data KeyValuePair Source #
A key-value pair object.
See: newKeyValuePair smart constructor.
Constructors
| KeyValuePair' | |
Instances
newKeyValuePair :: KeyValuePair Source #
Create a value of KeyValuePair with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:KeyValuePair', keyValuePair_name - The name of the key-value pair. For environment variables, this is the
name of the environment variable.
$sel:value:KeyValuePair', keyValuePair_value - The value of the key-value pair. For environment variables, this is the
value of the environment variable.
keyValuePair_name :: Lens' KeyValuePair (Maybe Text) Source #
The name of the key-value pair. For environment variables, this is the name of the environment variable.
keyValuePair_value :: Lens' KeyValuePair (Maybe Text) Source #
The value of the key-value pair. For environment variables, this is the value of the environment variable.
LinuxParameters
data LinuxParameters Source #
Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
See: newLinuxParameters smart constructor.
Constructors
| LinuxParameters' | |
Fields
| |
Instances
newLinuxParameters :: LinuxParameters Source #
Create a value of LinuxParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:capabilities:LinuxParameters', linuxParameters_capabilities - The Linux capabilities for the container that are added to or dropped
from the default configuration provided by Docker.
For tasks that use the Fargate launch type, capabilities is supported
for all platform versions but the add parameter is only supported if
using platform version 1.4.0 or later.
$sel:devices:LinuxParameters', linuxParameters_devices - 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.
If you're using tasks that use the Fargate launch type, the devices
parameter isn't supported.
$sel:initProcessEnabled:LinuxParameters', linuxParameters_initProcessEnabled - 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 --format '{{.Server.APIVersion}}'
$sel:maxSwap:LinuxParameters', linuxParameters_maxSwap - The total amount of swap memory (in MiB) a container can use. This
parameter will be translated to the --memory-swap option to
docker run
where the value would be the sum of the container memory plus the
maxSwap value.
If a maxSwap value of 0 is specified, the container will not use
swap. Accepted values are 0 or any positive integer. If the maxSwap
parameter is omitted, the container will use the swap configuration for
the container instance it is running on. A maxSwap value must be set
for the swappiness parameter to be used.
If you're using tasks that use the Fargate launch type, the maxSwap
parameter isn't supported.
$sel:sharedMemorySize:LinuxParameters', linuxParameters_sharedMemorySize - The value for the size (in MiB) of the /dev/shm volume. This
parameter maps to the --shm-size option to
docker run.
If you are using tasks that use the Fargate launch type, the
sharedMemorySize parameter is not supported.
$sel:swappiness:LinuxParameters', linuxParameters_swappiness - This allows you to tune a container's memory swappiness behavior. A
swappiness value of 0 will cause swapping to not happen unless
absolutely necessary. A swappiness value of 100 will cause pages to
be swapped very aggressively. Accepted values are whole numbers between
0 and 100. If the swappiness parameter is not specified, a default
value of 60 is used. If a value is not specified for maxSwap then
this parameter is ignored. This parameter maps to the
--memory-swappiness option to
docker run.
If you're using tasks that use the Fargate launch type, the
swappiness parameter isn't supported.
$sel:tmpfs:LinuxParameters', linuxParameters_tmpfs - The container path, mount options, and size (in MiB) of the tmpfs mount.
This parameter maps to the --tmpfs option to
docker run.
If you're using tasks that use the Fargate launch type, the tmpfs
parameter isn't supported.
linuxParameters_capabilities :: Lens' LinuxParameters (Maybe KernelCapabilities) Source #
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
For tasks that use the Fargate launch type, capabilities is supported
for all platform versions but the add parameter is only supported if
using platform version 1.4.0 or later.
linuxParameters_devices :: Lens' LinuxParameters (Maybe [Device]) Source #
Any host devices to expose to the container. This parameter maps to
Devices in the
Create a container
section of the
Docker Remote API and the
--device option to
docker run.
If you're using tasks that use the Fargate launch type, the devices
parameter isn't supported.
linuxParameters_initProcessEnabled :: Lens' LinuxParameters (Maybe Bool) Source #
Run an init process inside the container that forwards signals and
reaps processes. This parameter maps to the --init option to
docker run.
This parameter requires version 1.25 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log in to your container instance and run the
following command:
sudo docker version --format '{{.Server.APIVersion}}'
linuxParameters_maxSwap :: Lens' LinuxParameters (Maybe Int) Source #
The total amount of swap memory (in MiB) a container can use. This
parameter will be translated to the --memory-swap option to
docker run
where the value would be the sum of the container memory plus the
maxSwap value.
If a maxSwap value of 0 is specified, the container will not use
swap. Accepted values are 0 or any positive integer. If the maxSwap
parameter is omitted, the container will use the swap configuration for
the container instance it is running on. A maxSwap value must be set
for the swappiness parameter to be used.
If you're using tasks that use the Fargate launch type, the maxSwap
parameter isn't supported.
linuxParameters_sharedMemorySize :: Lens' LinuxParameters (Maybe Int) Source #
The value for the size (in MiB) of the /dev/shm volume. This
parameter maps to the --shm-size option to
docker run.
If you are using tasks that use the Fargate launch type, the
sharedMemorySize parameter is not supported.
linuxParameters_swappiness :: Lens' LinuxParameters (Maybe Int) Source #
This allows you to tune a container's memory swappiness behavior. A
swappiness value of 0 will cause swapping to not happen unless
absolutely necessary. A swappiness value of 100 will cause pages to
be swapped very aggressively. Accepted values are whole numbers between
0 and 100. If the swappiness parameter is not specified, a default
value of 60 is used. If a value is not specified for maxSwap then
this parameter is ignored. This parameter maps to the
--memory-swappiness option to
docker run.
If you're using tasks that use the Fargate launch type, the
swappiness parameter isn't supported.
linuxParameters_tmpfs :: Lens' LinuxParameters (Maybe [Tmpfs]) Source #
The container path, mount options, and size (in MiB) of the tmpfs mount.
This parameter maps to the --tmpfs option to
docker run.
If you're using tasks that use the Fargate launch type, the tmpfs
parameter isn't supported.
LoadBalancer
data LoadBalancer Source #
The load balancer configuration to use with a service or task set.
For specific notes and restrictions regarding the use of load balancers with services and task sets, see the CreateService and CreateTaskSet actions.
When you add, update, or remove a load balancer configuration, Amazon ECS starts a new deployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and deregister from load balancers.
We recommend that you verify this on a test environment before you update the Elastic Load Balancing configuration.
A service-linked role is required for services that use multiple target groups. For more information, see Using service-linked roles in the Amazon Elastic Container Service Developer Guide.
See: newLoadBalancer smart constructor.
Constructors
| LoadBalancer' | |
Fields
| |
Instances
newLoadBalancer :: LoadBalancer Source #
Create a value of LoadBalancer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containerName:LoadBalancer', loadBalancer_containerName - The name of the container (as it appears in a container definition) to
associate with the load balancer.
$sel:containerPort:LoadBalancer', loadBalancer_containerPort - The port on the container to associate with the load balancer. This port
must correspond to a containerPort in the task definition the tasks in
the service are using. For tasks that use the EC2 launch type, the
container instance they're launched on must allow ingress traffic on
the hostPort of the port mapping.
$sel:loadBalancerName:LoadBalancer', loadBalancer_loadBalancerName - The name of the load balancer to associate with the Amazon ECS service
or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
$sel:targetGroupArn:LoadBalancer', loadBalancer_targetGroupArn - The full Amazon Resource Name (ARN) of the Elastic Load Balancing target
group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you're using a Classic Load Balancer, omit the target group ARN.
For services using the ECS deployment controller, you can specify one
or multiple target groups. For more information, see
Registering multiple target groups with a service
in the Amazon Elastic Container Service Developer Guide.
For services using the CODE_DEPLOY deployment controller, you're
required to define two target groups for the load balancer. For more
information, see
Blue/green deployment with CodeDeploy
in the Amazon Elastic Container Service Developer Guide.
If your service's task definition uses the awsvpc network mode, you
must choose ip as the target type, not instance. Do this when
creating your target groups because tasks that use the awsvpc network
mode are associated with an elastic network interface, not an Amazon EC2
instance. This network mode is required for the Fargate launch type.
loadBalancer_containerName :: Lens' LoadBalancer (Maybe Text) Source #
The name of the container (as it appears in a container definition) to associate with the load balancer.
loadBalancer_containerPort :: Lens' LoadBalancer (Maybe Int) Source #
The port on the container to associate with the load balancer. This port
must correspond to a containerPort in the task definition the tasks in
the service are using. For tasks that use the EC2 launch type, the
container instance they're launched on must allow ingress traffic on
the hostPort of the port mapping.
loadBalancer_loadBalancerName :: Lens' LoadBalancer (Maybe Text) Source #
The name of the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
loadBalancer_targetGroupArn :: Lens' LoadBalancer (Maybe Text) Source #
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you're using a Classic Load Balancer, omit the target group ARN.
For services using the ECS deployment controller, you can specify one
or multiple target groups. For more information, see
Registering multiple target groups with a service
in the Amazon Elastic Container Service Developer Guide.
For services using the CODE_DEPLOY deployment controller, you're
required to define two target groups for the load balancer. For more
information, see
Blue/green deployment with CodeDeploy
in the Amazon Elastic Container Service Developer Guide.
If your service's task definition uses the awsvpc network mode, you
must choose ip as the target type, not instance. Do this when
creating your target groups because tasks that use the awsvpc network
mode are associated with an elastic network interface, not an Amazon EC2
instance. This network mode is required for the Fargate launch type.
LogConfiguration
data LogConfiguration Source #
The log configuration for the container. This parameter maps to
LogConfig in the
Create a container
section of the
Docker Remote API and the
--log-driver option to
docker run .
By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
Understand the following when specifying a log configuration for your containers.
- Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the valid values below). Additional log drivers may be available in future releases of the Amazon ECS container agent.
- This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
- For tasks that are hosted on Amazon EC2 instances, the Amazon ECS
container agent must register the available logging drivers with the
ECS_AVAILABLE_LOGGING_DRIVERSenvironment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide. - For tasks that are on Fargate, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.
See: newLogConfiguration smart constructor.
Constructors
| LogConfiguration' | |
Fields
| |
Instances
Arguments
| :: LogDriver | |
| -> LogConfiguration |
Create a value of LogConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:LogConfiguration', logConfiguration_options - 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 --format '{{.Server.APIVersion}}'
$sel:secretOptions:LogConfiguration', logConfiguration_secretOptions - The secrets to pass to the log configuration. For more information, see
Specifying sensitive data
in the Amazon Elastic Container Service Developer Guide.
$sel:logDriver:LogConfiguration', logConfiguration_logDriver - The log driver to use for the container.
For tasks on Fargate, the supported log drivers are awslogs, splunk,
and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs, fluentd, gelf, json-file, journald,
logentries,syslog, splunk, and awsfirelens.
For more information about using the awslogs log driver, see
Using the awslogs log driver
in the Amazon Elastic Container Service Developer Guide.
For more information about using the awsfirelens log driver, see
Custom log routing
in the Amazon Elastic Container Service Developer Guide.
If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.
logConfiguration_options :: Lens' LogConfiguration (Maybe (HashMap Text Text)) Source #
The configuration options to send to the log driver. This parameter
requires version 1.19 of the Docker Remote API or greater on your
container instance. To check the Docker Remote API version on your
container instance, log in to your container instance and run the
following command:
sudo docker version --format '{{.Server.APIVersion}}'
logConfiguration_secretOptions :: Lens' LogConfiguration (Maybe [Secret]) Source #
The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
logConfiguration_logDriver :: Lens' LogConfiguration LogDriver Source #
The log driver to use for the container.
For tasks on Fargate, the supported log drivers are awslogs, splunk,
and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs, fluentd, gelf, json-file, journald,
logentries,syslog, splunk, and awsfirelens.
For more information about using the awslogs log driver, see
Using the awslogs log driver
in the Amazon Elastic Container Service Developer Guide.
For more information about using the awsfirelens log driver, see
Custom log routing
in the Amazon Elastic Container Service Developer Guide.
If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.
ManagedAgent
data ManagedAgent Source #
Details about the managed agent status for the container.
See: newManagedAgent smart constructor.
Constructors
| ManagedAgent' | |
Fields
| |
Instances
newManagedAgent :: ManagedAgent Source #
Create a value of ManagedAgent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastStartedAt:ManagedAgent', managedAgent_lastStartedAt - The Unix timestamp for the time when the managed agent was last started.
$sel:lastStatus:ManagedAgent', managedAgent_lastStatus - The last known status of the managed agent.
$sel:name:ManagedAgent', managedAgent_name - The name of the managed agent. When the execute command feature is
enabled, the managed agent name is ExecuteCommandAgent.
$sel:reason:ManagedAgent', managedAgent_reason - The reason for why the managed agent is in the state it is in.
managedAgent_lastStartedAt :: Lens' ManagedAgent (Maybe UTCTime) Source #
The Unix timestamp for the time when the managed agent was last started.
managedAgent_lastStatus :: Lens' ManagedAgent (Maybe Text) Source #
The last known status of the managed agent.
managedAgent_name :: Lens' ManagedAgent (Maybe ManagedAgentName) Source #
The name of the managed agent. When the execute command feature is
enabled, the managed agent name is ExecuteCommandAgent.
managedAgent_reason :: Lens' ManagedAgent (Maybe Text) Source #
The reason for why the managed agent is in the state it is in.
ManagedAgentStateChange
data ManagedAgentStateChange Source #
An object representing a change in state for a managed agent.
See: newManagedAgentStateChange smart constructor.
Constructors
| ManagedAgentStateChange' | |
Fields
| |
Instances
newManagedAgentStateChange Source #
Arguments
| :: Text | |
| -> ManagedAgentName | |
| -> Text | |
| -> ManagedAgentStateChange |
Create a value of ManagedAgentStateChange with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:reason:ManagedAgentStateChange', managedAgentStateChange_reason - The reason for the status of the managed agent.
$sel:containerName:ManagedAgentStateChange', managedAgentStateChange_containerName - The name of the container that's associated with the managed agent.
$sel:managedAgentName:ManagedAgentStateChange', managedAgentStateChange_managedAgentName - The name of the managed agent.
$sel:status:ManagedAgentStateChange', managedAgentStateChange_status - The status of the managed agent.
managedAgentStateChange_reason :: Lens' ManagedAgentStateChange (Maybe Text) Source #
The reason for the status of the managed agent.
managedAgentStateChange_containerName :: Lens' ManagedAgentStateChange Text Source #
The name of the container that's associated with the managed agent.
managedAgentStateChange_managedAgentName :: Lens' ManagedAgentStateChange ManagedAgentName Source #
The name of the managed agent.
managedAgentStateChange_status :: Lens' ManagedAgentStateChange Text Source #
The status of the managed agent.
ManagedScaling
data ManagedScaling Source #
The managed scaling settings for the Auto Scaling group capacity provider.
When managed scaling is enabled, Amazon ECS manages the scale-in and
scale-out actions of the Auto Scaling group. Amazon ECS manages a target
tracking scaling policy using an Amazon ECS managed CloudWatch metric
with the specified targetCapacity value as the target value for the
metric. For more information, see
Using managed scaling
in the Amazon Elastic Container Service Developer Guide.
If managed scaling is disabled, the user must manage the scaling of the Auto Scaling group.
See: newManagedScaling smart constructor.
Constructors
| ManagedScaling' | |
Fields
| |
Instances
newManagedScaling :: ManagedScaling Source #
Create a value of ManagedScaling with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:instanceWarmupPeriod:ManagedScaling', managedScaling_instanceWarmupPeriod - The period of time, in seconds, after a newly launched Amazon EC2
instance can contribute to CloudWatch metrics for Auto Scaling group. If
this parameter is omitted, the default value of 300 seconds is used.
$sel:maximumScalingStepSize:ManagedScaling', managedScaling_maximumScalingStepSize - The maximum number of Amazon EC2 instances that Amazon ECS will scale
out at one time. The scale in process is not affected by this parameter.
If this parameter is omitted, the default value of 1 is used.
$sel:minimumScalingStepSize:ManagedScaling', managedScaling_minimumScalingStepSize - The minimum number of Amazon EC2 instances that Amazon ECS will scale
out at one time. The scale in process is not affected by this parameter
If this parameter is omitted, the default value of 1 is used.
When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.
If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.
$sel:status:ManagedScaling', managedScaling_status - Determines whether to use managed scaling for the capacity provider.
$sel:targetCapacity:ManagedScaling', managedScaling_targetCapacity - The target capacity value for the capacity provider. The specified value
must be greater than 0 and less than or equal to 100. A value of
100 results in the Amazon EC2 instances in your Auto Scaling group
being completely used.
managedScaling_instanceWarmupPeriod :: Lens' ManagedScaling (Maybe Natural) Source #
The period of time, in seconds, after a newly launched Amazon EC2
instance can contribute to CloudWatch metrics for Auto Scaling group. If
this parameter is omitted, the default value of 300 seconds is used.
managedScaling_maximumScalingStepSize :: Lens' ManagedScaling (Maybe Natural) Source #
The maximum number of Amazon EC2 instances that Amazon ECS will scale
out at one time. The scale in process is not affected by this parameter.
If this parameter is omitted, the default value of 1 is used.
managedScaling_minimumScalingStepSize :: Lens' ManagedScaling (Maybe Natural) Source #
The minimum number of Amazon EC2 instances that Amazon ECS will scale
out at one time. The scale in process is not affected by this parameter
If this parameter is omitted, the default value of 1 is used.
When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.
If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.
managedScaling_status :: Lens' ManagedScaling (Maybe ManagedScalingStatus) Source #
Determines whether to use managed scaling for the capacity provider.
managedScaling_targetCapacity :: Lens' ManagedScaling (Maybe Natural) Source #
The target capacity value for the capacity provider. The specified value
must be greater than 0 and less than or equal to 100. A value of
100 results in the Amazon EC2 instances in your Auto Scaling group
being completely used.
MountPoint
data MountPoint Source #
Details for a volume mount point that's used in a container definition.
See: newMountPoint smart constructor.
Constructors
| MountPoint' | |
Fields
| |
Instances
newMountPoint :: MountPoint Source #
Create a value of MountPoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containerPath:MountPoint', mountPoint_containerPath - The path on the container to mount the host volume at.
$sel:readOnly:MountPoint', mountPoint_readOnly - 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.
$sel:sourceVolume:MountPoint', mountPoint_sourceVolume - The name of the volume to mount. Must be a volume name referenced in the
name parameter of task definition volume.
mountPoint_containerPath :: Lens' MountPoint (Maybe Text) Source #
The path on the container to mount the host volume at.
mountPoint_readOnly :: Lens' MountPoint (Maybe Bool) Source #
If this value is true, the container has read-only access to the
volume. If this value is false, then the container can write to the
volume. The default value is false.
mountPoint_sourceVolume :: Lens' MountPoint (Maybe Text) Source #
The name of the volume to mount. Must be a volume name referenced in the
name parameter of task definition volume.
NetworkBinding
data NetworkBinding Source #
Details on the network bindings between a container and its host
container instance. After a task reaches the RUNNING status, manual
and automatic host and container port assignments are visible in the
networkBindings section of DescribeTasks API responses.
See: newNetworkBinding smart constructor.
Constructors
| NetworkBinding' | |
Fields
| |
Instances
newNetworkBinding :: NetworkBinding Source #
Create a value of NetworkBinding with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bindIP:NetworkBinding', networkBinding_bindIP - The IP address that the container is bound to on the container instance.
$sel:containerPort:NetworkBinding', networkBinding_containerPort - The port number on the container that's used with the network binding.
$sel:containerPortRange:NetworkBinding', networkBinding_containerPortRange - The port number range on the container that's bound to the dynamically
mapped host port range.
The following rules apply when you specify a containerPortRange:
- You must use either the
bridgenetwork mode or theawsvpcnetwork mode. - This parameter is available for both the EC2 and Fargate launch types.
- This parameter is available for both the Linux and Windows operating systems.
- The container instance must have at least version 1.67.0 of the
container agent and at least version 1.67.0-1 of the
ecs-initpackage - You can specify a maximum of 100 port ranges per container.
You do not specify a
hostPortRange. The value of thehostPortRangeis set as follows:- For containers in a task with the
awsvpcnetwork mode, thehostPortis set to the same value as thecontainerPort. This is a static mapping strategy. - For containers in a task with the
bridgenetwork mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
- For containers in a task with the
- The
containerPortRangevalid values are between 1 and 65535. - A port can only be included in one port mapping per container.
- You cannot specify overlapping port ranges.
- The first port in the range must be less than last port in the range.
Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
For more information, see Issue #11185 on the Github website.
For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
You can call
DescribeTasks
to view the hostPortRange which are the host ports that are bound to
the container ports.
$sel:hostPort:NetworkBinding', networkBinding_hostPort - The port number on the host that's used with the network binding.
$sel:hostPortRange:NetworkBinding', networkBinding_hostPortRange - The port number range on the host that's used with the network binding.
This is assigned is assigned by Docker and delivered by the Amazon ECS
agent.
$sel:protocol:NetworkBinding', networkBinding_protocol - The protocol used for the network binding.
networkBinding_bindIP :: Lens' NetworkBinding (Maybe Text) Source #
The IP address that the container is bound to on the container instance.
networkBinding_containerPort :: Lens' NetworkBinding (Maybe Int) Source #
The port number on the container that's used with the network binding.
networkBinding_containerPortRange :: Lens' NetworkBinding (Maybe Text) Source #
The port number range on the container that's bound to the dynamically mapped host port range.
The following rules apply when you specify a containerPortRange:
- You must use either the
bridgenetwork mode or theawsvpcnetwork mode. - This parameter is available for both the EC2 and Fargate launch types.
- This parameter is available for both the Linux and Windows operating systems.
- The container instance must have at least version 1.67.0 of the
container agent and at least version 1.67.0-1 of the
ecs-initpackage - You can specify a maximum of 100 port ranges per container.
You do not specify a
hostPortRange. The value of thehostPortRangeis set as follows:- For containers in a task with the
awsvpcnetwork mode, thehostPortis set to the same value as thecontainerPort. This is a static mapping strategy. - For containers in a task with the
bridgenetwork mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
- For containers in a task with the
- The
containerPortRangevalid values are between 1 and 65535. - A port can only be included in one port mapping per container.
- You cannot specify overlapping port ranges.
- The first port in the range must be less than last port in the range.
Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
For more information, see Issue #11185 on the Github website.
For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
You can call
DescribeTasks
to view the hostPortRange which are the host ports that are bound to
the container ports.
networkBinding_hostPort :: Lens' NetworkBinding (Maybe Int) Source #
The port number on the host that's used with the network binding.
networkBinding_hostPortRange :: Lens' NetworkBinding (Maybe Text) Source #
The port number range on the host that's used with the network binding. This is assigned is assigned by Docker and delivered by the Amazon ECS agent.
networkBinding_protocol :: Lens' NetworkBinding (Maybe TransportProtocol) Source #
The protocol used for the network binding.
NetworkConfiguration
data NetworkConfiguration Source #
An object representing the network configuration for a task or service.
See: newNetworkConfiguration smart constructor.
Constructors
| NetworkConfiguration' | |
Fields
| |
Instances
newNetworkConfiguration :: NetworkConfiguration Source #
Create a value of NetworkConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:awsvpcConfiguration:NetworkConfiguration', networkConfiguration_awsvpcConfiguration - The VPC subnets and security groups that are associated with a task.
All specified subnets and security groups must be from the same VPC.
networkConfiguration_awsvpcConfiguration :: Lens' NetworkConfiguration (Maybe AwsVpcConfiguration) Source #
The VPC subnets and security groups that are associated with a task.
All specified subnets and security groups must be from the same VPC.
NetworkInterface
data NetworkInterface Source #
An object representing the elastic network interface for tasks that use
the awsvpc network mode.
See: newNetworkInterface smart constructor.
Constructors
| NetworkInterface' | |
Fields
| |
Instances
newNetworkInterface :: NetworkInterface Source #
Create a value of NetworkInterface with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attachmentId:NetworkInterface', networkInterface_attachmentId - The attachment ID for the network interface.
$sel:ipv6Address:NetworkInterface', networkInterface_ipv6Address - The private IPv6 address for the network interface.
$sel:privateIpv4Address:NetworkInterface', networkInterface_privateIpv4Address - The private IPv4 address for the network interface.
networkInterface_attachmentId :: Lens' NetworkInterface (Maybe Text) Source #
The attachment ID for the network interface.
networkInterface_ipv6Address :: Lens' NetworkInterface (Maybe Text) Source #
The private IPv6 address for the network interface.
networkInterface_privateIpv4Address :: Lens' NetworkInterface (Maybe Text) Source #
The private IPv4 address for the network interface.
PlacementConstraint
data PlacementConstraint Source #
An object representing a constraint on task placement. For more information, see Task placement constraints in the Amazon Elastic Container Service Developer Guide.
If you're using the Fargate launch type, task placement constraints aren't supported.
See: newPlacementConstraint smart constructor.
Constructors
| PlacementConstraint' | |
Fields
| |
Instances
newPlacementConstraint :: PlacementConstraint Source #
Create a value of PlacementConstraint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expression:PlacementConstraint', placementConstraint_expression - A cluster query language expression to apply to the constraint. The
expression can have a maximum length of 2000 characters. You can't
specify an expression if the constraint type is distinctInstance. For
more information, see
Cluster query language
in the Amazon Elastic Container Service Developer Guide.
$sel:type':PlacementConstraint', placementConstraint_type - 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.
placementConstraint_expression :: Lens' PlacementConstraint (Maybe Text) Source #
A cluster query language expression to apply to the constraint. The
expression can have a maximum length of 2000 characters. You can't
specify an expression if the constraint type is distinctInstance. For
more information, see
Cluster query language
in the Amazon Elastic Container Service Developer Guide.
placementConstraint_type :: Lens' PlacementConstraint (Maybe PlacementConstraintType) Source #
The type of constraint. Use distinctInstance to ensure that each task
in a particular group is running on a different container instance. Use
memberOf to restrict the selection to a group of valid candidates.
PlacementStrategy
data PlacementStrategy Source #
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: newPlacementStrategy smart constructor.
Constructors
| PlacementStrategy' | |
Fields
| |
Instances
newPlacementStrategy :: PlacementStrategy Source #
Create a value of PlacementStrategy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:field:PlacementStrategy', placementStrategy_field - 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's 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.
$sel:type':PlacementStrategy', placementStrategy_type - 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's
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.
placementStrategy_field :: Lens' PlacementStrategy (Maybe Text) Source #
The field to apply the placement strategy against. For the spread
placement strategy, valid values are instanceId (or host, which has
the same effect), or any platform or custom attribute that's 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.
placementStrategy_type :: Lens' PlacementStrategy (Maybe PlacementStrategyType) Source #
The type of placement strategy. The random placement strategy randomly
places tasks on available candidates. The spread placement strategy
spreads placement across available candidates evenly based on the
field parameter. The binpack strategy places tasks on available
candidates that have the least available amount of the resource that's
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.
PlatformDevice
data PlatformDevice Source #
The devices that are available on the container instance. The only supported device type is a GPU.
See: newPlatformDevice smart constructor.
Constructors
| PlatformDevice' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> PlatformDeviceType | |
| -> PlatformDevice |
Create a value of PlatformDevice with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:PlatformDevice', platformDevice_id - The ID for the GPUs on the container instance. The available GPU IDs can
also be obtained on the container instance in the
/var/lib/ecs/gpu/nvidia_gpu_info.json file.
$sel:type':PlatformDevice', platformDevice_type - The type of device that's available on the container instance. The only
supported value is GPU.
platformDevice_id :: Lens' PlatformDevice Text Source #
The ID for the GPUs on the container instance. The available GPU IDs can
also be obtained on the container instance in the
/var/lib/ecs/gpu/nvidia_gpu_info.json file.
platformDevice_type :: Lens' PlatformDevice PlatformDeviceType Source #
The type of device that's available on the container instance. The only
supported value is GPU.
PortMapping
data PortMapping Source #
Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.
If you use containers in a task with the awsvpc or host network
mode, specify the exposed ports using containerPort. The hostPort
can be left blank or it must be the same value as the containerPort.
You can't expose the same container port for multiple protocols. If you attempt this, an error is returned.
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: newPortMapping smart constructor.
Constructors
| PortMapping' | |
Fields
| |
Instances
newPortMapping :: PortMapping Source #
Create a value of PortMapping with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appProtocol:PortMapping', portMapping_appProtocol - The application protocol that's used for the port mapping. This
parameter only applies to Service Connect. We recommend that you set
this parameter to be consistent with the protocol that your application
uses. If you set this parameter, Amazon ECS adds protocol-specific
connection handling to the Service Connect proxy. If you set this
parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS
console and CloudWatch.
If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
$sel:containerPort:PortMapping', portMapping_containerPort - The port number on the container that's bound to the user-specified or
automatically assigned host port.
If you use containers in a task with the awsvpc or host network
mode, specify the exposed ports using containerPort.
If you use 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.
$sel:containerPortRange:PortMapping', portMapping_containerPortRange - The port number range on the container that's bound to the dynamically
mapped host port range.
The following rules apply when you specify a containerPortRange:
- You must use either the
bridgenetwork mode or theawsvpcnetwork mode. - This parameter is available for both the EC2 and Fargate launch types.
- This parameter is available for both the Linux and Windows operating systems.
- The container instance must have at least version 1.67.0 of the
container agent and at least version 1.67.0-1 of the
ecs-initpackage - You can specify a maximum of 100 port ranges per container.
You do not specify a
hostPortRange. The value of thehostPortRangeis set as follows:- For containers in a task with the
awsvpcnetwork mode, thehostPortis set to the same value as thecontainerPort. This is a static mapping strategy. - For containers in a task with the
bridgenetwork mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
- For containers in a task with the
- The
containerPortRangevalid values are between 1 and 65535. - A port can only be included in one port mapping per container.
- You cannot specify overlapping port ranges.
- The first port in the range must be less than last port in the range.
Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
For more information, see Issue #11185 on the Github website.
For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
You can call
DescribeTasks
to view the hostPortRange which are the host ports that are bound to
the container ports.
$sel:hostPort:PortMapping', portMapping_hostPort - The port number on the container instance to reserve for your container.
If you specify a containerPortRange, leave this field empty and the
value of the hostPort is set as follows:
- For containers in a task with the
awsvpcnetwork mode, thehostPortis set to the same value as thecontainerPort. This is a static mapping strategy. - For containers in a task with the
bridgenetwork mode, the Amazon ECS agent finds open ports on the host and automaticaly binds them to the container ports. This is a dynamic mapping strategy.
If you use 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 you use 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
/proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter
is unavailable, the default ephemeral port range from 49153 through
65535 is used. Do 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-51680. Any host
port that was previously specified in a running task is also reserved
while the task is running. That is, after a task stops, the host port is
released. The current reserved ports are displayed in the
remainingResources of DescribeContainerInstances output. A container
instance can have up to 100 reserved ports at a time. This number
includes the default reserved ports. Automatically assigned ports
aren't included in the 100 reserved ports quota.
$sel:name:PortMapping', portMapping_name - The name that's used for the port mapping. This parameter only applies
to Service Connect. This parameter is the name that you use in the
serviceConnectConfiguration of a service. The name can include up to
64 characters. The characters can include lowercase letters, numbers,
underscores (_), and hyphens (-). The name can't start with a hyphen.
For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
$sel:protocol:PortMapping', portMapping_protocol - The protocol used for the port mapping. Valid values are tcp and
udp. The default is tcp.
portMapping_appProtocol :: Lens' PortMapping (Maybe ApplicationProtocol) Source #
The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.
If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
portMapping_containerPort :: Lens' PortMapping (Maybe Int) Source #
The port number on the container that's bound to the user-specified or automatically assigned host port.
If you use containers in a task with the awsvpc or host network
mode, specify the exposed ports using containerPort.
If you use 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.
portMapping_containerPortRange :: Lens' PortMapping (Maybe Text) Source #
The port number range on the container that's bound to the dynamically mapped host port range.
The following rules apply when you specify a containerPortRange:
- You must use either the
bridgenetwork mode or theawsvpcnetwork mode. - This parameter is available for both the EC2 and Fargate launch types.
- This parameter is available for both the Linux and Windows operating systems.
- The container instance must have at least version 1.67.0 of the
container agent and at least version 1.67.0-1 of the
ecs-initpackage - You can specify a maximum of 100 port ranges per container.
You do not specify a
hostPortRange. The value of thehostPortRangeis set as follows:- For containers in a task with the
awsvpcnetwork mode, thehostPortis set to the same value as thecontainerPort. This is a static mapping strategy. - For containers in a task with the
bridgenetwork mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
- For containers in a task with the
- The
containerPortRangevalid values are between 1 and 65535. - A port can only be included in one port mapping per container.
- You cannot specify overlapping port ranges.
- The first port in the range must be less than last port in the range.
Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
For more information, see Issue #11185 on the Github website.
For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
You can call
DescribeTasks
to view the hostPortRange which are the host ports that are bound to
the container ports.
portMapping_hostPort :: Lens' PortMapping (Maybe Int) Source #
The port number on the container instance to reserve for your container.
If you specify a containerPortRange, leave this field empty and the
value of the hostPort is set as follows:
- For containers in a task with the
awsvpcnetwork mode, thehostPortis set to the same value as thecontainerPort. This is a static mapping strategy. - For containers in a task with the
bridgenetwork mode, the Amazon ECS agent finds open ports on the host and automaticaly binds them to the container ports. This is a dynamic mapping strategy.
If you use 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 you use 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
/proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter
is unavailable, the default ephemeral port range from 49153 through
65535 is used. Do 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-51680. Any host
port that was previously specified in a running task is also reserved
while the task is running. That is, after a task stops, the host port is
released. The current reserved ports are displayed in the
remainingResources of DescribeContainerInstances output. A container
instance can have up to 100 reserved ports at a time. This number
includes the default reserved ports. Automatically assigned ports
aren't included in the 100 reserved ports quota.
portMapping_name :: Lens' PortMapping (Maybe Text) Source #
The name that's used for the port mapping. This parameter only applies
to Service Connect. This parameter is the name that you use in the
serviceConnectConfiguration of a service. The name can include up to
64 characters. The characters can include lowercase letters, numbers,
underscores (_), and hyphens (-). The name can't start with a hyphen.
For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
portMapping_protocol :: Lens' PortMapping (Maybe TransportProtocol) Source #
The protocol used for the port mapping. Valid values are tcp and
udp. The default is tcp.
ProtectedTask
data ProtectedTask Source #
An object representing the protection status details for a task. You can set the protection status with the UpdateTaskProtection API and get the status of tasks with the GetTaskProtection API.
See: newProtectedTask smart constructor.
Constructors
| ProtectedTask' | |
Fields
| |
Instances
newProtectedTask :: ProtectedTask Source #
Create a value of ProtectedTask with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expirationDate:ProtectedTask', protectedTask_expirationDate - The epoch time when protection for the task will expire.
$sel:protectionEnabled:ProtectedTask', protectedTask_protectionEnabled - The protection status of the task. If scale-in protection is enabled for
a task, the value is true. Otherwise, it is false.
$sel:taskArn:ProtectedTask', protectedTask_taskArn - The task ARN.
protectedTask_expirationDate :: Lens' ProtectedTask (Maybe UTCTime) Source #
The epoch time when protection for the task will expire.
protectedTask_protectionEnabled :: Lens' ProtectedTask (Maybe Bool) Source #
The protection status of the task. If scale-in protection is enabled for
a task, the value is true. Otherwise, it is false.
protectedTask_taskArn :: Lens' ProtectedTask (Maybe Text) Source #
The task ARN.
ProxyConfiguration
data ProxyConfiguration Source #
The configuration details for the App Mesh proxy.
For tasks that use the EC2 launch type, the container instances require
at least version 1.26.0 of the container agent and at least version
1.26.0-1 of the ecs-init package to use a proxy configuration. If your
container instances are launched from the Amazon ECS optimized AMI
version 20190301 or later, then they contain the required versions of
the container agent and ecs-init. For more information, see
Amazon ECS-optimized Linux AMI
See: newProxyConfiguration smart constructor.
Constructors
| ProxyConfiguration' | |
Fields
| |
Instances
newProxyConfiguration Source #
Arguments
| :: Text | |
| -> ProxyConfiguration |
Create a value of ProxyConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:properties:ProxyConfiguration', proxyConfiguration_properties - The set of network configuration parameters to provide the Container
Network Interface (CNI) plugin, specified as key-value pairs.
IgnoredUID- (Required) The user ID (UID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGIDis specified, this field can be empty.IgnoredGID- (Required) The group ID (GID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUIDis specified, this field can be empty.AppPorts- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPortandProxyEgressPort.ProxyIngressPort- (Required) Specifies the port that incoming traffic to theAppPortsis directed to.ProxyEgressPort- (Required) Specifies the port that outgoing traffic from theAppPortsis directed to.EgressIgnoredPorts- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort. It can be an empty list.EgressIgnoredIPs- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort. It can be an empty list.
$sel:type':ProxyConfiguration', proxyConfiguration_type - The proxy type. The only supported value is APPMESH.
$sel:containerName:ProxyConfiguration', proxyConfiguration_containerName - The name of the container that will serve as the App Mesh proxy.
proxyConfiguration_properties :: Lens' ProxyConfiguration (Maybe [KeyValuePair]) Source #
The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.
IgnoredUID- (Required) The user ID (UID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGIDis specified, this field can be empty.IgnoredGID- (Required) The group ID (GID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUIDis specified, this field can be empty.AppPorts- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPortandProxyEgressPort.ProxyIngressPort- (Required) Specifies the port that incoming traffic to theAppPortsis directed to.ProxyEgressPort- (Required) Specifies the port that outgoing traffic from theAppPortsis directed to.EgressIgnoredPorts- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort. It can be an empty list.EgressIgnoredIPs- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort. It can be an empty list.
proxyConfiguration_type :: Lens' ProxyConfiguration (Maybe ProxyConfigurationType) Source #
The proxy type. The only supported value is APPMESH.
proxyConfiguration_containerName :: Lens' ProxyConfiguration Text Source #
The name of the container that will serve as the App Mesh proxy.
RepositoryCredentials
data RepositoryCredentials Source #
The repository credentials for private registry authentication.
See: newRepositoryCredentials smart constructor.
Constructors
| RepositoryCredentials' | |
Fields
| |
Instances
newRepositoryCredentials Source #
Create a value of RepositoryCredentials with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:credentialsParameter:RepositoryCredentials', repositoryCredentials_credentialsParameter - The Amazon Resource Name (ARN) of the secret containing the private
repository credentials.
When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN of the secret.
repositoryCredentials_credentialsParameter :: Lens' RepositoryCredentials Text Source #
The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN of the secret.
Resource
Describes the resources available for a container instance.
See: newResource smart constructor.
Constructors
| Resource' | |
Fields
| |
Instances
newResource :: Resource Source #
Create a value of Resource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:doubleValue:Resource', resource_doubleValue - When the doubleValue type is set, the value of the resource must be a
double precision floating-point type.
$sel:integerValue:Resource', resource_integerValue - When the integerValue type is set, the value of the resource must be
an integer.
$sel:longValue:Resource', resource_longValue - When the longValue type is set, the value of the resource must be an
extended precision floating-point type.
$sel:name:Resource', resource_name - The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP,
or a user-defined resource.
$sel:stringSetValue:Resource', resource_stringSetValue - When the stringSetValue type is set, the value of the resource must be
a string type.
$sel:type':Resource', resource_type - The type of the resource. Valid values: INTEGER, DOUBLE, LONG, or
STRINGSET.
resource_doubleValue :: Lens' Resource (Maybe Double) Source #
When the doubleValue type is set, the value of the resource must be a
double precision floating-point type.
resource_integerValue :: Lens' Resource (Maybe Int) Source #
When the integerValue type is set, the value of the resource must be
an integer.
resource_longValue :: Lens' Resource (Maybe Integer) Source #
When the longValue type is set, the value of the resource must be an
extended precision floating-point type.
resource_name :: Lens' Resource (Maybe Text) Source #
The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP,
or a user-defined resource.
resource_stringSetValue :: Lens' Resource (Maybe [Text]) Source #
When the stringSetValue type is set, the value of the resource must be
a string type.
resource_type :: Lens' Resource (Maybe Text) Source #
The type of the resource. Valid values: INTEGER, DOUBLE, LONG, or
STRINGSET.
ResourceRequirement
data ResourceRequirement Source #
The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide
See: newResourceRequirement smart constructor.
Constructors
| ResourceRequirement' | |
Fields
| |
Instances
newResourceRequirement Source #
Arguments
| :: Text | |
| -> ResourceType | |
| -> ResourceRequirement |
Create a value of ResourceRequirement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:ResourceRequirement', resourceRequirement_value - The value for the specified resource type.
If the GPU type is used, the value is the number of physical GPUs
the Amazon ECS container agent reserves for the container. The number of
GPUs that's reserved for all containers in a task can't exceed the
number of available GPUs on the container instance that the task is
launched on.
If the InferenceAccelerator type is used, the value matches the
deviceName for an InferenceAccelerator specified in a task definition.
$sel:type':ResourceRequirement', resourceRequirement_type - The type of resource to assign to a container. The supported values are
GPU or InferenceAccelerator.
resourceRequirement_value :: Lens' ResourceRequirement Text Source #
The value for the specified resource type.
If the GPU type is used, the value is the number of physical GPUs
the Amazon ECS container agent reserves for the container. The number of
GPUs that's reserved for all containers in a task can't exceed the
number of available GPUs on the container instance that the task is
launched on.
If the InferenceAccelerator type is used, the value matches the
deviceName for an InferenceAccelerator specified in a task definition.
resourceRequirement_type :: Lens' ResourceRequirement ResourceType Source #
The type of resource to assign to a container. The supported values are
GPU or InferenceAccelerator.
RuntimePlatform
data RuntimePlatform Source #
Information about the platform for the Amazon ECS service or task.
For more information about RuntimePlatform, see
RuntimePlatform
in the Amazon Elastic Container Service Developer Guide.
See: newRuntimePlatform smart constructor.
Constructors
| RuntimePlatform' | |
Fields
| |
Instances
newRuntimePlatform :: RuntimePlatform Source #
Create a value of RuntimePlatform with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cpuArchitecture:RuntimePlatform', runtimePlatform_cpuArchitecture - The CPU architecture.
You can run your Linux tasks on an ARM-based platform by setting the
value to ARM64. This option is available for tasks that run on Linux
Amazon EC2 instance or Linux containers on Fargate.
$sel:operatingSystemFamily:RuntimePlatform', runtimePlatform_operatingSystemFamily - The operating system.
runtimePlatform_cpuArchitecture :: Lens' RuntimePlatform (Maybe CPUArchitecture) Source #
The CPU architecture.
You can run your Linux tasks on an ARM-based platform by setting the
value to ARM64. This option is available for tasks that run on Linux
Amazon EC2 instance or Linux containers on Fargate.
runtimePlatform_operatingSystemFamily :: Lens' RuntimePlatform (Maybe OSFamily) Source #
The operating system.
Scale
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
See: newScale smart constructor.
Constructors
| Scale' | |
Instances
| FromJSON Scale Source # | |
| ToJSON Scale Source # | |
Defined in Amazonka.ECS.Types.Scale | |
| Generic Scale Source # | |
| Read Scale Source # | |
| Show Scale Source # | |
| NFData Scale Source # | |
Defined in Amazonka.ECS.Types.Scale | |
| Eq Scale Source # | |
| Hashable Scale Source # | |
Defined in Amazonka.ECS.Types.Scale | |
| type Rep Scale Source # | |
Defined in Amazonka.ECS.Types.Scale type Rep Scale = D1 ('MetaData "Scale" "Amazonka.ECS.Types.Scale" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Scale'" 'PrefixI 'True) (S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScaleUnit)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) | |
Create a value of Scale with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:unit:Scale', scale_unit - The unit of measure for the scale value.
$sel:value:Scale', scale_value - The value, specified as a percent total of a service's desiredCount,
to scale the task set. Accepted values are numbers between 0 and 100.
scale_value :: Lens' Scale (Maybe Double) Source #
The value, specified as a percent total of a service's desiredCount,
to scale the task set. Accepted values are numbers between 0 and 100.
Secret
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
- To inject sensitive data into your containers as environment
variables, use the
secretscontainer definition parameter. - To reference sensitive information in the log configuration of a
container, use the
secretOptionscontainer definition parameter.
For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
See: newSecret smart constructor.
Constructors
| Secret' | |
Fields
| |
Instances
| FromJSON Secret Source # | |
| ToJSON Secret Source # | |
Defined in Amazonka.ECS.Types.Secret | |
| Generic Secret Source # | |
| Read Secret Source # | |
| Show Secret Source # | |
| NFData Secret Source # | |
Defined in Amazonka.ECS.Types.Secret | |
| Eq Secret Source # | |
| Hashable Secret Source # | |
Defined in Amazonka.ECS.Types.Secret | |
| type Rep Secret Source # | |
Defined in Amazonka.ECS.Types.Secret type Rep Secret = D1 ('MetaData "Secret" "Amazonka.ECS.Types.Secret" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Secret'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "valueFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Secret with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Secret', secret_name - The name of the secret.
$sel:valueFrom:Secret', secret_valueFrom - The secret to expose to the container. The supported values are either
the full ARN of the Secrets Manager secret or the full ARN of the
parameter in the SSM Parameter Store.
For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the /Amazon Elastic Container Service Developer Guide/.
If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
secret_valueFrom :: Lens' Secret Text Source #
The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.
For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the /Amazon Elastic Container Service Developer Guide/.
If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
ServiceConnectClientAlias
data ServiceConnectClientAlias Source #
Each alias ("endpoint") is a fully-qualified name and port number that other tasks ("clients") can use to connect to this service.
Each name and port mapping must be unique within the namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
See: newServiceConnectClientAlias smart constructor.
Constructors
| ServiceConnectClientAlias' | |
Fields
| |
Instances
newServiceConnectClientAlias Source #
Create a value of ServiceConnectClientAlias with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dnsName:ServiceConnectClientAlias', serviceConnectClientAlias_dnsName - The dnsName is the name that you use in the applications of client
tasks to connect to this service. The name must be a valid DNS name but
doesn't need to be fully-qualified. The name can include up to 127
characters. The name can include lowercase letters, numbers, underscores
(_), hyphens (-), and periods (.). The name can't start with a hyphen.
If this parameter isn't specified, the default value of
discoveryName.namespace is used. If the discoveryName isn't
specified, the port mapping name from the task definition is used in
portName.namespace.
To avoid changing your applications in client Amazon ECS services, set
this to the same name that the client application uses by default. For
example, a few common names are database, db, or the lowercase name
of a database, such as mysql or redis. For more information, see
Service Connect
in the Amazon Elastic Container Service Developer Guide.
$sel:port:ServiceConnectClientAlias', serviceConnectClientAlias_port - The listening port number for the Service Connect proxy. This port is
available inside of all of the tasks within the same namespace.
To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
serviceConnectClientAlias_dnsName :: Lens' ServiceConnectClientAlias (Maybe Text) Source #
The dnsName is the name that you use in the applications of client
tasks to connect to this service. The name must be a valid DNS name but
doesn't need to be fully-qualified. The name can include up to 127
characters. The name can include lowercase letters, numbers, underscores
(_), hyphens (-), and periods (.). The name can't start with a hyphen.
If this parameter isn't specified, the default value of
discoveryName.namespace is used. If the discoveryName isn't
specified, the port mapping name from the task definition is used in
portName.namespace.
To avoid changing your applications in client Amazon ECS services, set
this to the same name that the client application uses by default. For
example, a few common names are database, db, or the lowercase name
of a database, such as mysql or redis. For more information, see
Service Connect
in the Amazon Elastic Container Service Developer Guide.
serviceConnectClientAlias_port :: Lens' ServiceConnectClientAlias Natural Source #
The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.
To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
ServiceConnectConfiguration
data ServiceConnectConfiguration Source #
The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
See: newServiceConnectConfiguration smart constructor.
Constructors
| ServiceConnectConfiguration' | |
Fields
| |
Instances
newServiceConnectConfiguration Source #
Create a value of ServiceConnectConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logConfiguration:ServiceConnectConfiguration', serviceConnectConfiguration_logConfiguration - Undocumented member.
$sel:namespace:ServiceConnectConfiguration', serviceConnectConfiguration_namespace - The namespace name or full Amazon Resource Name (ARN) of the Cloud Map
namespace for use with Service Connect. The namespace must be in the
same Amazon Web Services Region as the Amazon ECS service and cluster.
The type of namespace doesn't affect Service Connect. For more
information about Cloud Map, see
Working with Services in the /Cloud Map
Developer Guide/.
$sel:services:ServiceConnectConfiguration', serviceConnectConfiguration_services - The list of Service Connect service objects. These are names and aliases
(also known as endpoints) that are used by other Amazon ECS services to
connect to this service.
This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.
An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.
$sel:enabled:ServiceConnectConfiguration', serviceConnectConfiguration_enabled - Specifies whether to use Service Connect with this service.
serviceConnectConfiguration_logConfiguration :: Lens' ServiceConnectConfiguration (Maybe LogConfiguration) Source #
Undocumented member.
serviceConnectConfiguration_namespace :: Lens' ServiceConnectConfiguration (Maybe Text) Source #
The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the /Cloud Map Developer Guide/.
serviceConnectConfiguration_services :: Lens' ServiceConnectConfiguration (Maybe [ServiceConnectService]) Source #
The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.
This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.
An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.
serviceConnectConfiguration_enabled :: Lens' ServiceConnectConfiguration Bool Source #
Specifies whether to use Service Connect with this service.
ServiceConnectService
data ServiceConnectService Source #
The Service Connect service object configuration. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
See: newServiceConnectService smart constructor.
Constructors
| ServiceConnectService' | |
Fields
| |
Instances
newServiceConnectService Source #
Create a value of ServiceConnectService with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientAliases:ServiceConnectService', serviceConnectService_clientAliases - The list of client aliases for this Service Connect service. You use
these to assign names that can be used by client applications. The
maximum number of client aliases that you can have in this list is 1.
Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.
Each name and port mapping must be unique within the namespace.
For each ServiceConnectService, you must provide at least one
clientAlias with one port.
$sel:discoveryName:ServiceConnectService', serviceConnectService_discoveryName - The discoveryName is the name of the new Cloud Map service that Amazon
ECS creates for this Amazon ECS service. This must be unique within the
Cloud Map namespace. The name can contain up to 64 characters. The name
can include lowercase letters, numbers, underscores (_), and hyphens
(-). The name can't start with a hyphen.
If this parameter isn't specified, the default value of
discoveryName.namespace is used. If the discoveryName isn't
specified, the port mapping name from the task definition is used in
portName.namespace.
$sel:ingressPortOverride:ServiceConnectService', serviceConnectService_ingressPortOverride - The port number for the Service Connect proxy to listen on.
Use the value of this field to bypass the proxy for traffic on the port
number specified in the named portMapping in the task definition of
this application, and then use it in your VPC security groups to allow
traffic into the proxy for this Amazon ECS service.
In awsvpc mode and Fargate, the default value is the container port
number. The container port number is in the portMapping in the task
definition. In bridge mode, the default value is the ephemeral port of
the Service Connect proxy.
$sel:portName:ServiceConnectService', serviceConnectService_portName - The portName must match the name of one of the portMappings from all
the containers in the task definition of this Amazon ECS service.
serviceConnectService_clientAliases :: Lens' ServiceConnectService (Maybe [ServiceConnectClientAlias]) Source #
The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.
Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.
Each name and port mapping must be unique within the namespace.
For each ServiceConnectService, you must provide at least one
clientAlias with one port.
serviceConnectService_discoveryName :: Lens' ServiceConnectService (Maybe Text) Source #
The discoveryName is the name of the new Cloud Map service that Amazon
ECS creates for this Amazon ECS service. This must be unique within the
Cloud Map namespace. The name can contain up to 64 characters. The name
can include lowercase letters, numbers, underscores (_), and hyphens
(-). The name can't start with a hyphen.
If this parameter isn't specified, the default value of
discoveryName.namespace is used. If the discoveryName isn't
specified, the port mapping name from the task definition is used in
portName.namespace.
serviceConnectService_ingressPortOverride :: Lens' ServiceConnectService (Maybe Natural) Source #
The port number for the Service Connect proxy to listen on.
Use the value of this field to bypass the proxy for traffic on the port
number specified in the named portMapping in the task definition of
this application, and then use it in your VPC security groups to allow
traffic into the proxy for this Amazon ECS service.
In awsvpc mode and Fargate, the default value is the container port
number. The container port number is in the portMapping in the task
definition. In bridge mode, the default value is the ephemeral port of
the Service Connect proxy.
serviceConnectService_portName :: Lens' ServiceConnectService Text Source #
The portName must match the name of one of the portMappings from all
the containers in the task definition of this Amazon ECS service.
ServiceConnectServiceResource
data ServiceConnectServiceResource Source #
The Service Connect resource. Each configuration maps a discovery name to a Cloud Map service name. The data is stored in Cloud Map as part of the Service Connect configuration for each discovery name of this Amazon ECS service.
A task can resolve the dnsName for each of the clientAliases of a
service. However a task can't resolve the discovery names. If you want
to connect to a service, refer to the ServiceConnectConfiguration of
that service for the list of clientAliases that you can use.
See: newServiceConnectServiceResource smart constructor.
Constructors
| ServiceConnectServiceResource' | |
Fields
| |
Instances
newServiceConnectServiceResource :: ServiceConnectServiceResource Source #
Create a value of ServiceConnectServiceResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:discoveryArn:ServiceConnectServiceResource', serviceConnectServiceResource_discoveryArn - The Amazon Resource Name (ARN) for the namespace in Cloud Map that
matches the discovery name for this Service Connect resource. You can
use this ARN in other integrations with Cloud Map. However, Service
Connect can't ensure connectivity outside of Amazon ECS.
$sel:discoveryName:ServiceConnectServiceResource', serviceConnectServiceResource_discoveryName - The discovery name of this Service Connect resource.
The discoveryName is the name of the new Cloud Map service that Amazon
ECS creates for this Amazon ECS service. This must be unique within the
Cloud Map namespace. The name can contain up to 64 characters. The name
can include lowercase letters, numbers, underscores (_), and hyphens
(-). The name can't start with a hyphen.
If this parameter isn't specified, the default value of
discoveryName.namespace is used. If the discoveryName isn't
specified, the port mapping name from the task definition is used in
portName.namespace.
serviceConnectServiceResource_discoveryArn :: Lens' ServiceConnectServiceResource (Maybe Text) Source #
The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name for this Service Connect resource. You can use this ARN in other integrations with Cloud Map. However, Service Connect can't ensure connectivity outside of Amazon ECS.
serviceConnectServiceResource_discoveryName :: Lens' ServiceConnectServiceResource (Maybe Text) Source #
The discovery name of this Service Connect resource.
The discoveryName is the name of the new Cloud Map service that Amazon
ECS creates for this Amazon ECS service. This must be unique within the
Cloud Map namespace. The name can contain up to 64 characters. The name
can include lowercase letters, numbers, underscores (_), and hyphens
(-). The name can't start with a hyphen.
If this parameter isn't specified, the default value of
discoveryName.namespace is used. If the discoveryName isn't
specified, the port mapping name from the task definition is used in
portName.namespace.
ServiceEvent
data ServiceEvent Source #
The details for an event that's associated with a service.
See: newServiceEvent smart constructor.
Constructors
| ServiceEvent' | |
Instances
newServiceEvent :: ServiceEvent Source #
Create a value of ServiceEvent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdAt:ServiceEvent', serviceEvent_createdAt - The Unix timestamp for the time when the event was triggered.
$sel:id:ServiceEvent', serviceEvent_id - The ID string for the event.
$sel:message:ServiceEvent', serviceEvent_message - The event message.
serviceEvent_createdAt :: Lens' ServiceEvent (Maybe UTCTime) Source #
The Unix timestamp for the time when the event was triggered.
serviceEvent_id :: Lens' ServiceEvent (Maybe Text) Source #
The ID string for the event.
serviceEvent_message :: Lens' ServiceEvent (Maybe Text) Source #
The event message.
ServiceRegistry
data ServiceRegistry Source #
The details for the service registry.
Each service may be associated with one service registry. Multiple service registries for each service are not supported.
When you add, update, or remove the service registries configuration, Amazon ECS starts a new deployment. New tasks are registered and deregistered to the updated service registry configuration.
See: newServiceRegistry smart constructor.
Constructors
| ServiceRegistry' | |
Fields
| |
Instances
newServiceRegistry :: ServiceRegistry Source #
Create a value of ServiceRegistry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containerName:ServiceRegistry', serviceRegistry_containerName - The container name value to be used for your service discovery service.
It's already specified in the task definition. If the task definition
that your service task specifies uses the bridge or host network
mode, you must specify a containerName and containerPort combination
from the task definition. If the task definition that your service task
specifies uses the awsvpc network mode and a type SRV DNS record is
used, you must specify either a containerName and containerPort
combination or a port value. However, you can't specify both.
$sel:containerPort:ServiceRegistry', serviceRegistry_containerPort - The port value to be used for your service discovery service. It's
already specified in the task definition. If the task definition your
service task specifies uses the bridge or host network mode, you
must specify a containerName and containerPort combination from the
task definition. If the task definition your service task specifies uses
the awsvpc network mode and a type SRV DNS record is used, you must
specify either a containerName and containerPort combination or a
port value. However, you can't specify both.
$sel:port:ServiceRegistry', serviceRegistry_port - The port value used if your service discovery service specified an SRV
record. This field might be used if both the awsvpc network mode and
SRV records are used.
$sel:registryArn:ServiceRegistry', serviceRegistry_registryArn - The Amazon Resource Name (ARN) of the service registry. The currently
supported service registry is Cloud Map. For more information, see
CreateService.
serviceRegistry_containerName :: Lens' ServiceRegistry (Maybe Text) Source #
The container name value to be used for your service discovery service.
It's already specified in the task definition. If the task definition
that your service task specifies uses the bridge or host network
mode, you must specify a containerName and containerPort combination
from the task definition. If the task definition that your service task
specifies uses the awsvpc network mode and a type SRV DNS record is
used, you must specify either a containerName and containerPort
combination or a port value. However, you can't specify both.
serviceRegistry_containerPort :: Lens' ServiceRegistry (Maybe Int) Source #
The port value to be used for your service discovery service. It's
already specified in the task definition. If the task definition your
service task specifies uses the bridge or host network mode, you
must specify a containerName and containerPort combination from the
task definition. If the task definition your service task specifies uses
the awsvpc network mode and a type SRV DNS record is used, you must
specify either a containerName and containerPort combination or a
port value. However, you can't specify both.
serviceRegistry_port :: Lens' ServiceRegistry (Maybe Int) Source #
The port value used if your service discovery service specified an SRV
record. This field might be used if both the awsvpc network mode and
SRV records are used.
serviceRegistry_registryArn :: Lens' ServiceRegistry (Maybe Text) Source #
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.
Session
The details for the execute command session.
See: newSession smart constructor.
Constructors
| Session' | |
Fields
| |
Instances
| FromJSON Session Source # | |
| Generic Session Source # | |
| Show Session Source # | |
| NFData Session Source # | |
Defined in Amazonka.ECS.Types.Session | |
| Eq Session Source # | |
| Hashable Session Source # | |
Defined in Amazonka.ECS.Types.Session | |
| type Rep Session Source # | |
Defined in Amazonka.ECS.Types.Session type Rep Session = D1 ('MetaData "Session" "Amazonka.ECS.Types.Session" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Session'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "streamUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tokenValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))) | |
newSession :: Session Source #
Create a value of Session with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sessionId:Session', session_sessionId - The ID of the execute command session.
$sel:streamUrl:Session', session_streamUrl - A URL to the managed agent on the container that the SSM Session Manager
client uses to send commands and receive output from the container.
$sel:tokenValue:Session', session_tokenValue - An encrypted token value containing session and caller information.
It's used to authenticate the connection to the container.
session_streamUrl :: Lens' Session (Maybe Text) Source #
A URL to the managed agent on the container that the SSM Session Manager client uses to send commands and receive output from the container.
session_tokenValue :: Lens' Session (Maybe Text) Source #
An encrypted token value containing session and caller information. It's used to authenticate the connection to the container.
Setting
The current account setting for a resource.
See: newSetting smart constructor.
Constructors
| Setting' | |
Fields
| |
Instances
| FromJSON Setting Source # | |
| Generic Setting Source # | |
| Read Setting Source # | |
| Show Setting Source # | |
| NFData Setting Source # | |
Defined in Amazonka.ECS.Types.Setting | |
| Eq Setting Source # | |
| Hashable Setting Source # | |
Defined in Amazonka.ECS.Types.Setting | |
| type Rep Setting Source # | |
Defined in Amazonka.ECS.Types.Setting type Rep Setting = D1 ('MetaData "Setting" "Amazonka.ECS.Types.Setting" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Setting'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SettingName)) :*: (S1 ('MetaSel ('Just "principalArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
newSetting :: Setting Source #
Create a value of Setting with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Setting', setting_name - The Amazon ECS resource name.
$sel:principalArn:Setting', setting_principalArn - The ARN of the principal. It can be an IAM user, IAM role, or the root
user. If this field is omitted, the authenticated user is assumed.
$sel:value:Setting', setting_value - Determines whether the account setting is enabled or disabled for the
specified resource.
setting_name :: Lens' Setting (Maybe SettingName) Source #
The Amazon ECS resource name.
setting_principalArn :: Lens' Setting (Maybe Text) Source #
The ARN of the principal. It can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.
setting_value :: Lens' Setting (Maybe Text) Source #
Determines whether the account setting is enabled or disabled for the specified resource.
SystemControl
data SystemControl Source #
A list of namespaced kernel parameters to set in the container. This
parameter maps to Sysctls in the
Create a container
section of the
Docker Remote API and the
--sysctl option to
docker run.
We don't recommend that you specify network-related systemControls
parameters for multiple containers in a single task. This task also uses
either the awsvpc or host network mode. It does it for the following
reasons.
- For tasks that use the
awsvpcnetwork mode, if you setsystemControlsfor any container, it applies to all containers in the task. If you set differentsystemControlsfor multiple containers in a single task, the container that's started last determines whichsystemControlstake effect. - For tasks that use the
hostnetwork mode, thesystemControlsparameter applies to the container instance's kernel parameter and that of all containers of any tasks running on that container instance.
See: newSystemControl smart constructor.
Constructors
| SystemControl' | |
Instances
newSystemControl :: SystemControl Source #
Create a value of SystemControl with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:namespace:SystemControl', systemControl_namespace - The namespaced kernel parameter to set a value for.
$sel:value:SystemControl', systemControl_value - The value for the namespaced kernel parameter that's specified in
namespace.
systemControl_namespace :: Lens' SystemControl (Maybe Text) Source #
The namespaced kernel parameter to set a value for.
systemControl_value :: Lens' SystemControl (Maybe Text) Source #
The value for the namespaced kernel parameter that's specified in
namespace.
Tag
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
See: newTag smart constructor.
Constructors
| Tag' | |
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.ECS.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.ECS.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.ECS.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.ECS.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.ECS.Types.Tag" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - One part of a key-value pair that make up a tag. A key is a general
label that acts like a category for more specific tag values.
$sel:value:Tag', tag_value - The optional part of a key-value pair that make up a tag. A value acts
as a descriptor within a tag category (key).
tag_key :: Lens' Tag (Maybe Text) Source #
One part of a key-value pair that make up a tag. A key is a general
label that acts like a category for more specific tag values.
tag_value :: Lens' Tag (Maybe Text) Source #
The optional part of a key-value pair that make up a tag. A value acts
as a descriptor within a tag category (key).
Task
Details on a task in a cluster.
See: newTask smart constructor.
Constructors
| Task' | |
Fields
| |
Instances
Create a value of Task with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attachments:Task', task_attachments - The Elastic Network Adapter that's associated with the task if the task
uses the awsvpc network mode.
$sel:attributes:Task', task_attributes - The attributes of the task
$sel:availabilityZone:Task', task_availabilityZone - The Availability Zone for the task.
$sel:capacityProviderName:Task', task_capacityProviderName - The capacity provider that's associated with the task.
$sel:clusterArn:Task', task_clusterArn - The ARN of the cluster that hosts the task.
$sel:connectivity:Task', task_connectivity - The connectivity status of a task.
$sel:connectivityAt:Task', task_connectivityAt - The Unix timestamp for the time when the task last went into CONNECTED
status.
$sel:containerInstanceArn:Task', task_containerInstanceArn - The ARN of the container instances that host the task.
$sel:containers:Task', task_containers - The containers that's associated with the task.
Task, task_cpu - The number of CPU units used by the task as expressed in a task
definition. It can be expressed as an integer using CPU units (for
example, 1024). It can also be expressed as a string using vCPUs (for
example, 1 vCPU or 1 vcpu). String values are converted to an
integer that indicates the CPU units when the task definition is
registered.
If you use 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 you use the Fargate launch type, this field is required. You must use
one of the following values. These values determine the range of
supported values for the memory parameter:
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
- 256 (.25 vCPU) - Available
memoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - 512 (.5 vCPU) - Available
memoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - 1024 (1 vCPU) - Available
memoryvalues: 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
memoryvalues: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - 4096 (4 vCPU) - Available
memoryvalues: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) 8192 (8 vCPU) - Available
memoryvalues: 16 GB and 60 GB in 4 GB incrementsThis option requires Linux platform
1.4.0or later.16384 (16vCPU) - Available
memoryvalues: 32GB and 120 GB in 8 GB incrementsThis option requires Linux platform
1.4.0or later.
$sel:createdAt:Task', task_createdAt - The Unix timestamp for the time when the task was created. More
specifically, it's for the time when the task entered the PENDING
state.
$sel:desiredStatus:Task', task_desiredStatus - The desired status of the task. For more information, see
Task Lifecycle.
$sel:enableExecuteCommand:Task', task_enableExecuteCommand - Determines whether execute command functionality is enabled for this
task. If true, execute command functionality is enabled on all the
containers in the task.
Task, task_ephemeralStorage - The ephemeral storage settings for the task.
$sel:executionStoppedAt:Task', task_executionStoppedAt - The Unix timestamp for the time when the task execution stopped.
$sel:group':Task', task_group - The name of the task group that's associated with the task.
Task, task_healthStatus - The health status for the task. It's determined by the health of the
essential containers in the task. If all essential containers in the
task are reporting as HEALTHY, the task status also reports as
HEALTHY. If any essential containers in the task are reporting as
UNHEALTHY or UNKNOWN, the task status also reports as UNHEALTHY or
UNKNOWN.
The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.
$sel:inferenceAccelerators:Task', task_inferenceAccelerators - The Elastic Inference accelerator that's associated with the task.
Task, task_lastStatus - The last known status for the task. For more information, see
Task Lifecycle.
$sel:launchType:Task', task_launchType - The infrastructure where your task runs on. For more information, see
Amazon ECS launch types
in the Amazon Elastic Container Service Developer Guide.
Task, task_memory - The amount of memory (in MiB) that the task uses as expressed in a task
definition. It can be expressed as an integer using MiB (for example,
1024). If it's expressed as a string using GB (for example, 1GB or
1 GB), it's converted to an integer indicating the MiB when the task
definition is registered.
If you use the EC2 launch type, this field is optional.
If you use the Fargate launch type, this field is required. You must use
one of the following values. The value that you choose determines the
range of supported values for the cpu parameter.
- 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
cpuvalues: 256 (.25 vCPU) - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available
cpuvalues: 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
cpuvalues: 1024 (1 vCPU) - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
Available
cpuvalues: 2048 (2 vCPU) - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
Available
cpuvalues: 4096 (4 vCPU) Between 16 GB and 60 GB in 4 GB increments - Available
cpuvalues: 8192 (8 vCPU)This option requires Linux platform
1.4.0or later.Between 32GB and 120 GB in 8 GB increments - Available
cpuvalues: 16384 (16 vCPU)This option requires Linux platform
1.4.0or later.
$sel:overrides:Task', task_overrides - One or more container overrides.
$sel:platformFamily:Task', task_platformFamily - The operating system that your tasks are running on. A platform family
is specified only for tasks that use the Fargate launch type.
All tasks that run as part of this service must use the same
platformFamily value as the service (for example, LINUX.).
$sel:platformVersion:Task', task_platformVersion - The platform version where your task runs on. A platform version is only
specified for tasks that use the Fargate launch type. If you didn't
specify one, the LATEST platform version is used. For more
information, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
$sel:pullStartedAt:Task', task_pullStartedAt - The Unix timestamp for the time when the container image pull began.
$sel:pullStoppedAt:Task', task_pullStoppedAt - The Unix timestamp for the time when the container image pull completed.
$sel:startedAt:Task', task_startedAt - The Unix timestamp for the time when the task started. More
specifically, it's for the time when the task transitioned from the
PENDING state to the RUNNING state.
$sel:startedBy:Task', task_startedBy - The tag specified when a task is started. If an Amazon ECS service
started the task, the startedBy parameter contains the deployment ID
of that service.
$sel:stopCode:Task', task_stopCode - The stop code indicating why a task was stopped. The stoppedReason
might contain additional details.
The following are valid values:
TaskFailedToStart
EssentialContainerExited
UserInitiated
TerminationNotice
ServiceSchedulerInitiated
SpotInterruption
$sel:stoppedAt:Task', task_stoppedAt - The Unix timestamp for the time when the task was stopped. More
specifically, it's for the time when the task transitioned from the
RUNNING state to the STOPPED state.
$sel:stoppedReason:Task', task_stoppedReason - The reason that the task was stopped.
$sel:stoppingAt:Task', task_stoppingAt - The Unix timestamp for the time when the task stops. More specifically,
it's for the time when the task transitions from the RUNNING state to
STOPPED.
$sel:tags:Task', task_tags - The metadata that you apply to the task to help you categorize and
organize the task. Each tag consists of a key and an optional value. You
define both the key and value.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
Task, task_taskArn - The Amazon Resource Name (ARN) of the task.
$sel:taskDefinitionArn:Task', task_taskDefinitionArn - The ARN of the task definition that creates the task.
$sel:version:Task', task_version - The version counter for the task. Every time a task experiences a change
that starts a CloudWatch event, the version counter is incremented. If
you replicate your Amazon ECS task state with CloudWatch Events, you can
compare the version of a task reported by the Amazon ECS API actions
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.
task_attachments :: Lens' Task (Maybe [Attachment]) Source #
The Elastic Network Adapter that's associated with the task if the task
uses the awsvpc network mode.
task_capacityProviderName :: Lens' Task (Maybe Text) Source #
The capacity provider that's associated with the task.
task_connectivity :: Lens' Task (Maybe Connectivity) Source #
The connectivity status of a task.
task_connectivityAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for the time when the task last went into CONNECTED
status.
task_containerInstanceArn :: Lens' Task (Maybe Text) Source #
The ARN of the container instances that host the task.
task_containers :: Lens' Task (Maybe [Container]) Source #
The containers that's associated with the task.
task_cpu :: Lens' Task (Maybe Text) Source #
The number of CPU units used by the task as expressed in a task
definition. It can be expressed as an integer using CPU units (for
example, 1024). It can also be expressed as a string using vCPUs (for
example, 1 vCPU or 1 vcpu). String values are converted to an
integer that indicates the CPU units when the task definition is
registered.
If you use 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 you use the Fargate launch type, this field is required. You must use
one of the following values. These values determine the range of
supported values for the memory parameter:
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
- 256 (.25 vCPU) - Available
memoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - 512 (.5 vCPU) - Available
memoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - 1024 (1 vCPU) - Available
memoryvalues: 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
memoryvalues: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - 4096 (4 vCPU) - Available
memoryvalues: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) 8192 (8 vCPU) - Available
memoryvalues: 16 GB and 60 GB in 4 GB incrementsThis option requires Linux platform
1.4.0or later.16384 (16vCPU) - Available
memoryvalues: 32GB and 120 GB in 8 GB incrementsThis option requires Linux platform
1.4.0or later.
task_createdAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for the time when the task was created. More
specifically, it's for the time when the task entered the PENDING
state.
task_desiredStatus :: Lens' Task (Maybe Text) Source #
The desired status of the task. For more information, see Task Lifecycle.
task_enableExecuteCommand :: Lens' Task (Maybe Bool) Source #
Determines whether execute command functionality is enabled for this
task. If true, execute command functionality is enabled on all the
containers in the task.
task_ephemeralStorage :: Lens' Task (Maybe EphemeralStorage) Source #
The ephemeral storage settings for the task.
task_executionStoppedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for the time when the task execution stopped.
task_group :: Lens' Task (Maybe Text) Source #
The name of the task group that's associated with the task.
task_healthStatus :: Lens' Task (Maybe HealthStatus) Source #
The health status for the task. It's determined by the health of the
essential containers in the task. If all essential containers in the
task are reporting as HEALTHY, the task status also reports as
HEALTHY. If any essential containers in the task are reporting as
UNHEALTHY or UNKNOWN, the task status also reports as UNHEALTHY or
UNKNOWN.
The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.
task_inferenceAccelerators :: Lens' Task (Maybe [InferenceAccelerator]) Source #
The Elastic Inference accelerator that's associated with the task.
task_lastStatus :: Lens' Task (Maybe Text) Source #
The last known status for the task. For more information, see Task Lifecycle.
task_launchType :: Lens' Task (Maybe LaunchType) Source #
The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
task_memory :: Lens' Task (Maybe Text) Source #
The amount of memory (in MiB) that the task uses as expressed in a task
definition. It can be expressed as an integer using MiB (for example,
1024). If it's expressed as a string using GB (for example, 1GB or
1 GB), it's converted to an integer indicating the MiB when the task
definition is registered.
If you use the EC2 launch type, this field is optional.
If you use the Fargate launch type, this field is required. You must use
one of the following values. The value that you choose determines the
range of supported values for the cpu parameter.
- 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
cpuvalues: 256 (.25 vCPU) - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available
cpuvalues: 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
cpuvalues: 1024 (1 vCPU) - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
Available
cpuvalues: 2048 (2 vCPU) - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
Available
cpuvalues: 4096 (4 vCPU) Between 16 GB and 60 GB in 4 GB increments - Available
cpuvalues: 8192 (8 vCPU)This option requires Linux platform
1.4.0or later.Between 32GB and 120 GB in 8 GB increments - Available
cpuvalues: 16384 (16 vCPU)This option requires Linux platform
1.4.0or later.
task_overrides :: Lens' Task (Maybe TaskOverride) Source #
One or more container overrides.
task_platformFamily :: Lens' Task (Maybe Text) Source #
The operating system that your tasks are running on. A platform family is specified only for tasks that use the Fargate launch type.
All tasks that run as part of this service must use the same
platformFamily value as the service (for example, LINUX.).
task_platformVersion :: Lens' Task (Maybe Text) Source #
The platform version where your task runs on. A platform version is only
specified for tasks that use the Fargate launch type. If you didn't
specify one, the LATEST platform version is used. For more
information, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
task_pullStartedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for the time when the container image pull began.
task_pullStoppedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for the time when the container image pull completed.
task_startedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for the time when the task started. More
specifically, it's for the time when the task transitioned from the
PENDING state to the RUNNING state.
task_startedBy :: Lens' Task (Maybe Text) Source #
The tag specified when a task is started. If an Amazon ECS service
started the task, the startedBy parameter contains the deployment ID
of that service.
task_stopCode :: Lens' Task (Maybe TaskStopCode) Source #
The stop code indicating why a task was stopped. The stoppedReason
might contain additional details.
The following are valid values:
TaskFailedToStart
EssentialContainerExited
UserInitiated
TerminationNotice
ServiceSchedulerInitiated
SpotInterruption
task_stoppedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for the time when the task was stopped. More
specifically, it's for the time when the task transitioned from the
RUNNING state to the STOPPED state.
task_stoppingAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for the time when the task stops. More specifically,
it's for the time when the task transitions from the RUNNING state to
STOPPED.
task_tags :: Lens' Task (Maybe [Tag]) Source #
The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
task_taskDefinitionArn :: Lens' Task (Maybe Text) Source #
The ARN of the task definition that creates the task.
task_version :: Lens' Task (Maybe Integer) Source #
The version counter for the task. Every time a task experiences a change
that starts a CloudWatch event, the version counter is incremented. If
you replicate your Amazon ECS task state with CloudWatch Events, you can
compare the version of a task reported by the Amazon ECS API actions
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.
TaskDefinition
data TaskDefinition Source #
The details of a task definition which describes the container and volume definitions of an Amazon Elastic Container Service task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.
See: newTaskDefinition smart constructor.
Constructors
| TaskDefinition' | |
Fields
| |
Instances
newTaskDefinition :: TaskDefinition Source #
Create a value of TaskDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:compatibilities:TaskDefinition', taskDefinition_compatibilities - The task launch types the task definition validated against during task
definition registration. For more information, see
Amazon ECS launch types
in the Amazon Elastic Container Service Developer Guide.
$sel:containerDefinitions:TaskDefinition', taskDefinition_containerDefinitions - 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.
TaskDefinition, taskDefinition_cpu - The number of cpu units used by the task. If you use the EC2 launch
type, this field is optional. Any value can be used. If you use the
Fargate launch type, this field is required. You must use one of the
following values. The value that you choose determines your range of
valid values for the memory parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
- 256 (.25 vCPU) - Available
memoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - 512 (.5 vCPU) - Available
memoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - 1024 (1 vCPU) - Available
memoryvalues: 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
memoryvalues: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - 4096 (4 vCPU) - Available
memoryvalues: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) 8192 (8 vCPU) - Available
memoryvalues: 16 GB and 60 GB in 4 GB incrementsThis option requires Linux platform
1.4.0or later.16384 (16vCPU) - Available
memoryvalues: 32GB and 120 GB in 8 GB incrementsThis option requires Linux platform
1.4.0or later.
$sel:deregisteredAt:TaskDefinition', taskDefinition_deregisteredAt - The Unix timestamp for the time when the task definition was
deregistered.
$sel:ephemeralStorage:TaskDefinition', taskDefinition_ephemeralStorage - The ephemeral storage settings to use for tasks run with the task
definition.
$sel:executionRoleArn:TaskDefinition', taskDefinition_executionRoleArn - The Amazon Resource Name (ARN) of the task execution role that grants
the Amazon ECS container agent permission to make Amazon Web Services
API calls on your behalf. The task execution IAM role is required
depending on the requirements of your task. For more information, see
Amazon ECS task execution IAM role
in the Amazon Elastic Container Service Developer Guide.
$sel:family:TaskDefinition', taskDefinition_family - The name of a family that this task definition is registered to. Up to
255 characters are allowed. Letters (both uppercase and lowercase
letters), numbers, hyphens (-), and underscores (_) are allowed.
A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
$sel:inferenceAccelerators:TaskDefinition', taskDefinition_inferenceAccelerators - The Elastic Inference accelerator that's associated with the task.
$sel:ipcMode:TaskDefinition', taskDefinition_ipcMode - The IPC resource namespace to use for the containers in the task. The
valid values are host, task, or none. If host is specified, then
all containers within the tasks that specified the host IPC mode on
the same container instance share the same IPC resources with the host
Amazon EC2 instance. If task is specified, all containers within the
specified task share the same IPC resources. If none is specified,
then IPC resources within the containers of a task are private and not
shared with other containers in a task or on the container instance. If
no value is specified, then the IPC resource namespace sharing depends
on the Docker daemon setting on the container instance. For more
information, see
IPC settings
in the Docker run reference.
If the host IPC mode is used, be aware that there is a heightened risk
of undesired IPC namespace expose. For more information, see
Docker security.
If you are setting namespaced kernel parameters using systemControls
for the containers in the task, the following will apply to your IPC
resource namespace. For more information, see
System Controls
in the Amazon Elastic Container Service Developer Guide.
- For tasks that use the
hostIPC mode, IPC namespace relatedsystemControlsare not supported. - For tasks that use the
taskIPC mode, IPC namespace relatedsystemControlswill apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
TaskDefinition, taskDefinition_memory - The amount (in MiB) of memory used by the task.
If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
If your tasks runs on Fargate, this field is required. You must use one
of the following values. The value you choose determines your range of
valid values for the cpu parameter.
- 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
cpuvalues: 256 (.25 vCPU) - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available
cpuvalues: 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
cpuvalues: 1024 (1 vCPU) - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
Available
cpuvalues: 2048 (2 vCPU) - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
Available
cpuvalues: 4096 (4 vCPU) Between 16 GB and 60 GB in 4 GB increments - Available
cpuvalues: 8192 (8 vCPU)This option requires Linux platform
1.4.0or later.Between 32GB and 120 GB in 8 GB increments - Available
cpuvalues: 16384 (16 vCPU)This option requires Linux platform
1.4.0or later.
$sel:networkMode:TaskDefinition', taskDefinition_networkMode - The Docker networking mode to use for the containers in the task. The
valid values are none, bridge, awsvpc, and host. If no network
mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required.
For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can
be used. For Amazon ECS tasks on Amazon EC2 Windows instances,
<default> or awsvpc can be used. If the network mode is set to
none, you cannot specify port mappings in your container definitions,
and the tasks 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.
When using the host network mode, you should not run containers using
the root user (UID 0). It is considered best practice to use a non-root
user.
If the network mode is awsvpc, the task is allocated an elastic
network interface, and you must specify a NetworkConfiguration value
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 cannot run multiple instantiations of
the same task on a single container instance when port mappings are
used.
For more information, see Network settings in the Docker run reference.
$sel:pidMode:TaskDefinition', taskDefinition_pidMode - The process namespace to use for the containers in the task. The valid
values are host or task. If host is specified, then all containers
within the tasks that specified the host PID mode on the same
container instance share the same process namespace with the host Amazon
EC2 instance. If task is specified, all containers within the
specified task share the same process namespace. If no value is
specified, the default is a private namespace. For more information, see
PID settings
in the Docker run reference.
If the host PID mode is used, be aware that there is a heightened risk
of undesired process namespace expose. For more information, see
Docker security.
This parameter is not supported for Windows containers or tasks run on Fargate.
$sel:placementConstraints:TaskDefinition', taskDefinition_placementConstraints - An array of placement constraint objects to use for tasks.
This parameter isn't supported for tasks run on Fargate.
$sel:proxyConfiguration:TaskDefinition', taskDefinition_proxyConfiguration - The configuration details for the App Mesh proxy.
Your Amazon ECS container instances require at least version 1.26.0 of
the container agent and at least version 1.26.0-1 of the ecs-init
package to use a proxy configuration. If your container instances are
launched from the Amazon ECS optimized AMI version 20190301 or later,
they contain the required versions of the container agent and
ecs-init. For more information, see
Amazon ECS-optimized Linux AMI
in the Amazon Elastic Container Service Developer Guide.
$sel:registeredAt:TaskDefinition', taskDefinition_registeredAt - The Unix timestamp for the time when the task definition was registered.
$sel:registeredBy:TaskDefinition', taskDefinition_registeredBy - The principal that registered the task definition.
$sel:requiresAttributes:TaskDefinition', taskDefinition_requiresAttributes - The container instance attributes required by your task. When an Amazon
EC2 instance is registered to your cluster, the Amazon ECS container
agent assigns some standard attributes to the instance. You can apply
custom attributes. These are specified as key-value pairs using the
Amazon ECS console or the PutAttributes API. These attributes are used
when determining task placement for tasks hosted on Amazon EC2
instances. For more information, see
Attributes
in the Amazon Elastic Container Service Developer Guide.
This parameter isn't supported for tasks run on Fargate.
$sel:requiresCompatibilities:TaskDefinition', taskDefinition_requiresCompatibilities - The task launch types the task definition was validated against. To
determine which task launch types the task definition is validated for,
see the TaskDefinition$compatibilities parameter.
$sel:revision:TaskDefinition', taskDefinition_revision - 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 that
you register a new revision of a task definition in the same family, the
revision value always increases by one. This is even if you deregistered
previous revisions in this family.
$sel:runtimePlatform:TaskDefinition', taskDefinition_runtimePlatform - The operating system that your task definitions are running on. A
platform family is specified only for tasks using the Fargate launch
type.
When you specify a task in a service, this value must match the
runtimePlatform value of the service.
$sel:status:TaskDefinition', taskDefinition_status - The status of the task definition.
$sel:taskDefinitionArn:TaskDefinition', taskDefinition_taskDefinitionArn - The full Amazon Resource Name (ARN) of the task definition.
$sel:taskRoleArn:TaskDefinition', taskDefinition_taskRoleArn - The short name or full Amazon Resource Name (ARN) of the Identity and
Access Management role that grants containers in the task permission to
call Amazon Web Services APIs on your behalf. For more information, see
Amazon ECS Task Role
in the Amazon Elastic Container Service Developer Guide.
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 to use the feature. For
more information, see
Windows IAM roles for tasks
in the Amazon Elastic Container Service Developer Guide.
$sel:volumes:TaskDefinition', taskDefinition_volumes - The list of data volume definitions for the task. For more information,
see
Using data volumes in tasks
in the Amazon Elastic Container Service Developer Guide.
The host and sourcePath parameters aren't supported for tasks run
on Fargate.
taskDefinition_compatibilities :: Lens' TaskDefinition (Maybe [Compatibility]) Source #
The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
taskDefinition_containerDefinitions :: Lens' TaskDefinition (Maybe [ContainerDefinition]) Source #
A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
taskDefinition_cpu :: Lens' TaskDefinition (Maybe Text) Source #
The number of cpu units used by the task. If you use the EC2 launch
type, this field is optional. Any value can be used. If you use the
Fargate launch type, this field is required. You must use one of the
following values. The value that you choose determines your range of
valid values for the memory parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
- 256 (.25 vCPU) - Available
memoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - 512 (.5 vCPU) - Available
memoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - 1024 (1 vCPU) - Available
memoryvalues: 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
memoryvalues: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - 4096 (4 vCPU) - Available
memoryvalues: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) 8192 (8 vCPU) - Available
memoryvalues: 16 GB and 60 GB in 4 GB incrementsThis option requires Linux platform
1.4.0or later.16384 (16vCPU) - Available
memoryvalues: 32GB and 120 GB in 8 GB incrementsThis option requires Linux platform
1.4.0or later.
taskDefinition_deregisteredAt :: Lens' TaskDefinition (Maybe UTCTime) Source #
The Unix timestamp for the time when the task definition was deregistered.
taskDefinition_ephemeralStorage :: Lens' TaskDefinition (Maybe EphemeralStorage) Source #
The ephemeral storage settings to use for tasks run with the task definition.
taskDefinition_executionRoleArn :: Lens' TaskDefinition (Maybe Text) Source #
The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
taskDefinition_family :: Lens' TaskDefinition (Maybe Text) Source #
The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and underscores (_) are allowed.
A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
taskDefinition_inferenceAccelerators :: Lens' TaskDefinition (Maybe [InferenceAccelerator]) Source #
The Elastic Inference accelerator that's associated with the task.
taskDefinition_ipcMode :: Lens' TaskDefinition (Maybe IpcMode) Source #
The IPC resource namespace to use for the containers in the task. The
valid values are host, task, or none. If host is specified, then
all containers within the tasks that specified the host IPC mode on
the same container instance share the same IPC resources with the host
Amazon EC2 instance. If task is specified, all containers within the
specified task share the same IPC resources. If none is specified,
then IPC resources within the containers of a task are private and not
shared with other containers in a task or on the container instance. If
no value is specified, then the IPC resource namespace sharing depends
on the Docker daemon setting on the container instance. For more
information, see
IPC settings
in the Docker run reference.
If the host IPC mode is used, be aware that there is a heightened risk
of undesired IPC namespace expose. For more information, see
Docker security.
If you are setting namespaced kernel parameters using systemControls
for the containers in the task, the following will apply to your IPC
resource namespace. For more information, see
System Controls
in the Amazon Elastic Container Service Developer Guide.
- For tasks that use the
hostIPC mode, IPC namespace relatedsystemControlsare not supported. - For tasks that use the
taskIPC mode, IPC namespace relatedsystemControlswill apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
taskDefinition_memory :: Lens' TaskDefinition (Maybe Text) Source #
The amount (in MiB) of memory used by the task.
If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
If your tasks runs on Fargate, this field is required. You must use one
of the following values. The value you choose determines your range of
valid values for the cpu parameter.
- 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
cpuvalues: 256 (.25 vCPU) - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available
cpuvalues: 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
cpuvalues: 1024 (1 vCPU) - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
Available
cpuvalues: 2048 (2 vCPU) - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
Available
cpuvalues: 4096 (4 vCPU) Between 16 GB and 60 GB in 4 GB increments - Available
cpuvalues: 8192 (8 vCPU)This option requires Linux platform
1.4.0or later.Between 32GB and 120 GB in 8 GB increments - Available
cpuvalues: 16384 (16 vCPU)This option requires Linux platform
1.4.0or later.
taskDefinition_networkMode :: Lens' TaskDefinition (Maybe NetworkMode) Source #
The Docker networking mode to use for the containers in the task. The
valid values are none, bridge, awsvpc, and host. If no network
mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required.
For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can
be used. For Amazon ECS tasks on Amazon EC2 Windows instances,
<default> or awsvpc can be used. If the network mode is set to
none, you cannot specify port mappings in your container definitions,
and the tasks 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.
When using the host network mode, you should not run containers using
the root user (UID 0). It is considered best practice to use a non-root
user.
If the network mode is awsvpc, the task is allocated an elastic
network interface, and you must specify a NetworkConfiguration value
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 cannot run multiple instantiations of
the same task on a single container instance when port mappings are
used.
For more information, see Network settings in the Docker run reference.
taskDefinition_pidMode :: Lens' TaskDefinition (Maybe PidMode) Source #
The process namespace to use for the containers in the task. The valid
values are host or task. If host is specified, then all containers
within the tasks that specified the host PID mode on the same
container instance share the same process namespace with the host Amazon
EC2 instance. If task is specified, all containers within the
specified task share the same process namespace. If no value is
specified, the default is a private namespace. For more information, see
PID settings
in the Docker run reference.
If the host PID mode is used, be aware that there is a heightened risk
of undesired process namespace expose. For more information, see
Docker security.
This parameter is not supported for Windows containers or tasks run on Fargate.
taskDefinition_placementConstraints :: Lens' TaskDefinition (Maybe [TaskDefinitionPlacementConstraint]) Source #
An array of placement constraint objects to use for tasks.
This parameter isn't supported for tasks run on Fargate.
taskDefinition_proxyConfiguration :: Lens' TaskDefinition (Maybe ProxyConfiguration) Source #
The configuration details for the App Mesh proxy.
Your Amazon ECS container instances require at least version 1.26.0 of
the container agent and at least version 1.26.0-1 of the ecs-init
package to use a proxy configuration. If your container instances are
launched from the Amazon ECS optimized AMI version 20190301 or later,
they contain the required versions of the container agent and
ecs-init. For more information, see
Amazon ECS-optimized Linux AMI
in the Amazon Elastic Container Service Developer Guide.
taskDefinition_registeredAt :: Lens' TaskDefinition (Maybe UTCTime) Source #
The Unix timestamp for the time when the task definition was registered.
taskDefinition_registeredBy :: Lens' TaskDefinition (Maybe Text) Source #
The principal that registered the task definition.
taskDefinition_requiresAttributes :: Lens' TaskDefinition (Maybe [Attribute]) Source #
The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
This parameter isn't supported for tasks run on Fargate.
taskDefinition_requiresCompatibilities :: Lens' TaskDefinition (Maybe [Compatibility]) Source #
The task launch types the task definition was validated against. To determine which task launch types the task definition is validated for, see the TaskDefinition$compatibilities parameter.
taskDefinition_revision :: Lens' TaskDefinition (Maybe Int) Source #
The revision of the task in a particular family. The revision is a
version number of a task definition in a family. When you register a
task definition for the first time, the revision is 1. Each time that
you register a new revision of a task definition in the same family, the
revision value always increases by one. This is even if you deregistered
previous revisions in this family.
taskDefinition_runtimePlatform :: Lens' TaskDefinition (Maybe RuntimePlatform) Source #
The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.
When you specify a task in a service, this value must match the
runtimePlatform value of the service.
taskDefinition_status :: Lens' TaskDefinition (Maybe TaskDefinitionStatus) Source #
The status of the task definition.
taskDefinition_taskDefinitionArn :: Lens' TaskDefinition (Maybe Text) Source #
The full Amazon Resource Name (ARN) of the task definition.
taskDefinition_taskRoleArn :: Lens' TaskDefinition (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide.
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 to use the feature. For
more information, see
Windows IAM roles for tasks
in the Amazon Elastic Container Service Developer Guide.
taskDefinition_volumes :: Lens' TaskDefinition (Maybe [Volume]) Source #
The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.
The host and sourcePath parameters aren't supported for tasks run
on Fargate.
TaskDefinitionPlacementConstraint
data TaskDefinitionPlacementConstraint Source #
An object representing a constraint on task placement in the task definition. For more information, see Task placement constraints in the Amazon Elastic Container Service Developer Guide.
Task placement constraints aren't supported for tasks run on Fargate.
See: newTaskDefinitionPlacementConstraint smart constructor.
Constructors
| TaskDefinitionPlacementConstraint' | |
Fields
| |
Instances
newTaskDefinitionPlacementConstraint :: TaskDefinitionPlacementConstraint Source #
Create a value of TaskDefinitionPlacementConstraint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expression:TaskDefinitionPlacementConstraint', taskDefinitionPlacementConstraint_expression - 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.
$sel:type':TaskDefinitionPlacementConstraint', taskDefinitionPlacementConstraint_type - The type of constraint. The MemberOf constraint restricts selection to
be from a group of valid candidates.
taskDefinitionPlacementConstraint_expression :: Lens' TaskDefinitionPlacementConstraint (Maybe Text) Source #
A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
taskDefinitionPlacementConstraint_type :: Lens' TaskDefinitionPlacementConstraint (Maybe TaskDefinitionPlacementConstraintType) Source #
The type of constraint. The MemberOf constraint restricts selection to
be from a group of valid candidates.
TaskOverride
data TaskOverride Source #
The overrides that are associated with a task.
See: newTaskOverride smart constructor.
Constructors
| TaskOverride' | |
Fields
| |
Instances
newTaskOverride :: TaskOverride Source #
Create a value of TaskOverride with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containerOverrides:TaskOverride', taskOverride_containerOverrides - One or more container overrides that are sent to a task.
TaskOverride, taskOverride_cpu - The CPU override for the task.
$sel:ephemeralStorage:TaskOverride', taskOverride_ephemeralStorage - The ephemeral storage setting override for the task.
This parameter is only supported for tasks hosted on Fargate that use the following platform versions:
- Linux platform version
1.4.0or later. - Windows platform version
1.0.0or later.
$sel:executionRoleArn:TaskOverride', taskOverride_executionRoleArn - The Amazon Resource Name (ARN) of the task execution IAM role override
for the task. For more information, see
Amazon ECS task execution IAM role
in the Amazon Elastic Container Service Developer Guide.
$sel:inferenceAcceleratorOverrides:TaskOverride', taskOverride_inferenceAcceleratorOverrides - The Elastic Inference accelerator override for the task.
TaskOverride, taskOverride_memory - The memory override for the task.
$sel:taskRoleArn:TaskOverride', taskOverride_taskRoleArn - 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. For more information, see
IAM Role for Tasks
in the Amazon Elastic Container Service Developer Guide.
taskOverride_containerOverrides :: Lens' TaskOverride (Maybe [ContainerOverride]) Source #
One or more container overrides that are sent to a task.
taskOverride_cpu :: Lens' TaskOverride (Maybe Text) Source #
The CPU override for the task.
taskOverride_ephemeralStorage :: Lens' TaskOverride (Maybe EphemeralStorage) Source #
The ephemeral storage setting override for the task.
This parameter is only supported for tasks hosted on Fargate that use the following platform versions:
- Linux platform version
1.4.0or later. - Windows platform version
1.0.0or later.
taskOverride_executionRoleArn :: Lens' TaskOverride (Maybe Text) Source #
The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
taskOverride_inferenceAcceleratorOverrides :: Lens' TaskOverride (Maybe [InferenceAcceleratorOverride]) Source #
The Elastic Inference accelerator override for the task.
taskOverride_memory :: Lens' TaskOverride (Maybe Text) Source #
The memory override for the task.
taskOverride_taskRoleArn :: Lens' TaskOverride (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Role for Tasks in the Amazon Elastic Container Service Developer Guide.
TaskSet
Information about a set of Amazon ECS tasks in either an CodeDeploy or
an EXTERNAL deployment. An Amazon ECS task set includes details such
as the desired number of tasks, how many tasks are running, and whether
the task set serves production traffic.
See: newTaskSet smart constructor.
Constructors
| TaskSet' | |
Fields
| |
Instances
newTaskSet :: TaskSet Source #
Create a value of TaskSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:capacityProviderStrategy:TaskSet', taskSet_capacityProviderStrategy - The capacity provider strategy that are associated with the task set.
$sel:clusterArn:TaskSet', taskSet_clusterArn - The Amazon Resource Name (ARN) of the cluster that the service that
hosts the task set exists in.
$sel:computedDesiredCount:TaskSet', taskSet_computedDesiredCount - The computed desired count for the task set. This is calculated by
multiplying the service's desiredCount by the task set's scale
percentage. The result is always rounded up. For example, if the
computed desired count is 1.2, it rounds up to 2 tasks.
$sel:createdAt:TaskSet', taskSet_createdAt - The Unix timestamp for the time when the task set was created.
$sel:externalId:TaskSet', taskSet_externalId - The external ID associated with the task set.
If an CodeDeploy deployment created a task set, the externalId
parameter contains the CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated
with a service discovery registry, the externalId parameter contains
the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.
$sel:id:TaskSet', taskSet_id - The ID of the task set.
$sel:launchType:TaskSet', taskSet_launchType - The launch type the tasks in the task set are using. For more
information, see
Amazon ECS launch types
in the Amazon Elastic Container Service Developer Guide.
$sel:loadBalancers:TaskSet', taskSet_loadBalancers - Details on a load balancer that are used with a task set.
$sel:networkConfiguration:TaskSet', taskSet_networkConfiguration - The network configuration for the task set.
$sel:pendingCount:TaskSet', taskSet_pendingCount - The number of tasks in the task set that are in the PENDING status
during a deployment. A task in the PENDING state is preparing to enter
the RUNNING state. A task set enters the PENDING status when it
launches for the first time or when it's restarted after being in the
STOPPED state.
$sel:platformFamily:TaskSet', taskSet_platformFamily - The operating system that your tasks in the set are running on. A
platform family is specified only for tasks that use the Fargate launch
type.
All tasks in the set must have the same value.
$sel:platformVersion:TaskSet', taskSet_platformVersion - The Fargate platform version where the tasks in the task set are
running. A platform version is only specified for tasks run on Fargate.
For more information, see
Fargate platform versions
in the Amazon Elastic Container Service Developer Guide.
$sel:runningCount:TaskSet', taskSet_runningCount - The number of tasks in the task set that are in the RUNNING status
during a deployment. A task in the RUNNING state is running and ready
for use.
$sel:scale:TaskSet', taskSet_scale - A floating-point percentage of your desired number of tasks to place and
keep running in the task set.
$sel:serviceArn:TaskSet', taskSet_serviceArn - The Amazon Resource Name (ARN) of the service the task set exists in.
$sel:serviceRegistries:TaskSet', taskSet_serviceRegistries - The details for the service discovery registries to assign to this task
set. For more information, see
Service discovery.
$sel:stabilityStatus:TaskSet', taskSet_stabilityStatus - The stability status. This indicates whether the task set has reached a
steady state. If the following conditions are met, the task set are in
STEADY_STATE:
- The task
runningCountis equal to thecomputedDesiredCount. - The
pendingCountis0. - There are no tasks that are running on container instances in the
DRAININGstatus. - All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions aren't met, the stability status returns
STABILIZING.
$sel:stabilityStatusAt:TaskSet', taskSet_stabilityStatusAt - The Unix timestamp for the time when the task set stability status was
retrieved.
$sel:startedBy:TaskSet', taskSet_startedBy - The tag specified when a task set is started. If an CodeDeploy
deployment created the task set, the startedBy parameter is
CODE_DEPLOY. If an external deployment created the task set, the
startedBy field isn't used.
$sel:status:TaskSet', taskSet_status - The status of the task set. The following describes each state.
- PRIMARY
- The task set is serving production traffic.
- ACTIVE
- The task set isn't serving production traffic.
- DRAINING
- The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.
$sel:tags:TaskSet', taskSet_tags - The metadata that you apply to the task set to help you categorize and
organize them. Each tag consists of a key and an optional value. You
define both.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
$sel:taskDefinition:TaskSet', taskSet_taskDefinition - The task definition that the task set is using.
$sel:taskSetArn:TaskSet', taskSet_taskSetArn - The Amazon Resource Name (ARN) of the task set.
$sel:updatedAt:TaskSet', taskSet_updatedAt - The Unix timestamp for the time when the task set was last updated.
taskSet_capacityProviderStrategy :: Lens' TaskSet (Maybe [CapacityProviderStrategyItem]) Source #
The capacity provider strategy that are associated with the task set.
taskSet_clusterArn :: Lens' TaskSet (Maybe Text) Source #
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
taskSet_computedDesiredCount :: Lens' TaskSet (Maybe Int) Source #
The computed desired count for the task set. This is calculated by
multiplying the service's desiredCount by the task set's scale
percentage. The result is always rounded up. For example, if the
computed desired count is 1.2, it rounds up to 2 tasks.
taskSet_createdAt :: Lens' TaskSet (Maybe UTCTime) Source #
The Unix timestamp for the time when the task set was created.
taskSet_externalId :: Lens' TaskSet (Maybe Text) Source #
The external ID associated with the task set.
If an CodeDeploy deployment created a task set, the externalId
parameter contains the CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated
with a service discovery registry, the externalId parameter contains
the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.
taskSet_launchType :: Lens' TaskSet (Maybe LaunchType) Source #
The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
taskSet_loadBalancers :: Lens' TaskSet (Maybe [LoadBalancer]) Source #
Details on a load balancer that are used with a task set.
taskSet_networkConfiguration :: Lens' TaskSet (Maybe NetworkConfiguration) Source #
The network configuration for the task set.
taskSet_pendingCount :: Lens' TaskSet (Maybe Int) Source #
The number of tasks in the task set that are in the PENDING status
during a deployment. A task in the PENDING state is preparing to enter
the RUNNING state. A task set enters the PENDING status when it
launches for the first time or when it's restarted after being in the
STOPPED state.
taskSet_platformFamily :: Lens' TaskSet (Maybe Text) Source #
The operating system that your tasks in the set are running on. A platform family is specified only for tasks that use the Fargate launch type.
All tasks in the set must have the same value.
taskSet_platformVersion :: Lens' TaskSet (Maybe Text) Source #
The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
taskSet_runningCount :: Lens' TaskSet (Maybe Int) Source #
The number of tasks in the task set that are in the RUNNING status
during a deployment. A task in the RUNNING state is running and ready
for use.
taskSet_scale :: Lens' TaskSet (Maybe Scale) Source #
A floating-point percentage of your desired number of tasks to place and keep running in the task set.
taskSet_serviceArn :: Lens' TaskSet (Maybe Text) Source #
The Amazon Resource Name (ARN) of the service the task set exists in.
taskSet_serviceRegistries :: Lens' TaskSet (Maybe [ServiceRegistry]) Source #
The details for the service discovery registries to assign to this task set. For more information, see Service discovery.
taskSet_stabilityStatus :: Lens' TaskSet (Maybe StabilityStatus) Source #
The stability status. This indicates whether the task set has reached a
steady state. If the following conditions are met, the task set are in
STEADY_STATE:
- The task
runningCountis equal to thecomputedDesiredCount. - The
pendingCountis0. - There are no tasks that are running on container instances in the
DRAININGstatus. - All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions aren't met, the stability status returns
STABILIZING.
taskSet_stabilityStatusAt :: Lens' TaskSet (Maybe UTCTime) Source #
The Unix timestamp for the time when the task set stability status was retrieved.
taskSet_startedBy :: Lens' TaskSet (Maybe Text) Source #
The tag specified when a task set is started. If an CodeDeploy
deployment created the task set, the startedBy parameter is
CODE_DEPLOY. If an external deployment created the task set, the
startedBy field isn't used.
taskSet_status :: Lens' TaskSet (Maybe Text) Source #
The status of the task set. The following describes each state.
- PRIMARY
- The task set is serving production traffic.
- ACTIVE
- The task set isn't serving production traffic.
- DRAINING
- The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.
taskSet_tags :: Lens' TaskSet (Maybe [Tag]) Source #
The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
taskSet_taskDefinition :: Lens' TaskSet (Maybe Text) Source #
The task definition that the task set is using.
taskSet_taskSetArn :: Lens' TaskSet (Maybe Text) Source #
The Amazon Resource Name (ARN) of the task set.
taskSet_updatedAt :: Lens' TaskSet (Maybe UTCTime) Source #
The Unix timestamp for the time when the task set was last updated.
Tmpfs
The container path, mount options, and size of the tmpfs mount.
See: newTmpfs smart constructor.
Constructors
| Tmpfs' | |
Fields
| |
Instances
| FromJSON Tmpfs Source # | |
| ToJSON Tmpfs Source # | |
Defined in Amazonka.ECS.Types.Tmpfs | |
| Generic Tmpfs Source # | |
| Read Tmpfs Source # | |
| Show Tmpfs Source # | |
| NFData Tmpfs Source # | |
Defined in Amazonka.ECS.Types.Tmpfs | |
| Eq Tmpfs Source # | |
| Hashable Tmpfs Source # | |
Defined in Amazonka.ECS.Types.Tmpfs | |
| type Rep Tmpfs Source # | |
Defined in Amazonka.ECS.Types.Tmpfs type Rep Tmpfs = D1 ('MetaData "Tmpfs" "Amazonka.ECS.Types.Tmpfs" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Tmpfs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "mountOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "containerPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))) | |
Create a value of Tmpfs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mountOptions:Tmpfs', tmpfs_mountOptions - 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" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"
$sel:containerPath:Tmpfs', tmpfs_containerPath - The absolute file path where the tmpfs volume is to be mounted.
$sel:size:Tmpfs', tmpfs_size - The maximum size (in MiB) of the tmpfs volume.
tmpfs_mountOptions :: Lens' Tmpfs (Maybe [Text]) Source #
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" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"
tmpfs_containerPath :: Lens' Tmpfs Text Source #
The absolute file path where the tmpfs volume is to be mounted.
Ulimit
The ulimit settings to pass to the container.
Amazon ECS tasks hosted on Fargate use the default resource limit values
set by the operating system with the exception of the nofile resource
limit parameter which Fargate overrides. The nofile resource limit
sets a restriction on the number of open files that a container can use.
The default nofile soft limit is 1024 and hard limit is 4096.
See: newUlimit smart constructor.
Constructors
| Ulimit' | |
Instances
| FromJSON Ulimit Source # | |
| ToJSON Ulimit Source # | |
Defined in Amazonka.ECS.Types.Ulimit | |
| Generic Ulimit Source # | |
| Read Ulimit Source # | |
| Show Ulimit Source # | |
| NFData Ulimit Source # | |
Defined in Amazonka.ECS.Types.Ulimit | |
| Eq Ulimit Source # | |
| Hashable Ulimit Source # | |
Defined in Amazonka.ECS.Types.Ulimit | |
| type Rep Ulimit Source # | |
Defined in Amazonka.ECS.Types.Ulimit type Rep Ulimit = D1 ('MetaData "Ulimit" "Amazonka.ECS.Types.Ulimit" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Ulimit'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UlimitName) :*: (S1 ('MetaSel ('Just "softLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "hardLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))) | |
Arguments
| :: UlimitName | |
| -> Int | |
| -> Int | |
| -> Ulimit |
Create a value of Ulimit with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Ulimit', ulimit_name - The type of the ulimit.
$sel:softLimit:Ulimit', ulimit_softLimit - The soft limit for the ulimit type.
$sel:hardLimit:Ulimit', ulimit_hardLimit - The hard limit for the ulimit type.
ulimit_name :: Lens' Ulimit UlimitName Source #
The type of the ulimit.
VersionInfo
data VersionInfo Source #
The Docker and Amazon ECS container agent version information about a container instance.
See: newVersionInfo smart constructor.
Constructors
| VersionInfo' | |
Fields
| |
Instances
newVersionInfo :: VersionInfo Source #
Create a value of VersionInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentHash:VersionInfo', versionInfo_agentHash - The Git commit hash for the Amazon ECS container agent build on the
amazon-ecs-agent
GitHub repository.
$sel:agentVersion:VersionInfo', versionInfo_agentVersion - The version number of the Amazon ECS container agent.
$sel:dockerVersion:VersionInfo', versionInfo_dockerVersion - The Docker version that's running on the container instance.
versionInfo_agentHash :: Lens' VersionInfo (Maybe Text) Source #
The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
versionInfo_agentVersion :: Lens' VersionInfo (Maybe Text) Source #
The version number of the Amazon ECS container agent.
versionInfo_dockerVersion :: Lens' VersionInfo (Maybe Text) Source #
The Docker version that's running on the container instance.
Volume
A data volume that's used in a task definition. For tasks that use the
Amazon Elastic File System (Amazon EFS), specify an
efsVolumeConfiguration. For Windows tasks that use Amazon FSx for
Windows File Server file system, specify a
fsxWindowsFileServerVolumeConfiguration. For tasks that use a Docker
volume, specify a DockerVolumeConfiguration. For tasks that use a bind
mount host volume, specify a host and optional sourcePath. For more
information, see
Using Data Volumes in Tasks.
See: newVolume smart constructor.
Constructors
| Volume' | |
Fields
| |
Instances
Create a value of Volume with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dockerVolumeConfiguration:Volume', volume_dockerVolumeConfiguration - This parameter is specified when you use Docker volumes.
Windows containers only support the use of the local driver. To use
bind mounts, specify the host parameter instead.
Docker volumes aren't supported by tasks run on Fargate.
$sel:efsVolumeConfiguration:Volume', volume_efsVolumeConfiguration - This parameter is specified when you use an Amazon Elastic File System
file system for task storage.
$sel:fsxWindowsFileServerVolumeConfiguration:Volume', volume_fsxWindowsFileServerVolumeConfiguration - This parameter is specified when you use Amazon FSx for Windows File
Server file system for task storage.
$sel:host:Volume', volume_host - This parameter is specified when you use bind mount host volumes. The
contents of the host parameter determine whether your bind mount host
volume persists on the host container instance and where it's stored.
If the host parameter is empty, then the Docker daemon assigns a host
path for your data volume. However, the data isn't guaranteed to
persist after the containers that are associated with it stop running.
Windows containers can mount whole directories on the same drive as
$env:ProgramData. Windows containers can't mount directories on a
different drive, and mount point can't be across drives. For example,
you can mount C:\my\path:C:\my\path and D:\:D:\, but not
D:\my\path:C:\my\path or D:\:C:\my\path.
$sel:name:Volume', volume_name - The name of the volume. Up to 255 letters (uppercase and lowercase),
numbers, underscores, and hyphens are allowed. This name is referenced
in the sourceVolume parameter of container definition mountPoints.
volume_dockerVolumeConfiguration :: Lens' Volume (Maybe DockerVolumeConfiguration) Source #
This parameter is specified when you use Docker volumes.
Windows containers only support the use of the local driver. To use
bind mounts, specify the host parameter instead.
Docker volumes aren't supported by tasks run on Fargate.
volume_efsVolumeConfiguration :: Lens' Volume (Maybe EFSVolumeConfiguration) Source #
This parameter is specified when you use an Amazon Elastic File System file system for task storage.
volume_fsxWindowsFileServerVolumeConfiguration :: Lens' Volume (Maybe FSxWindowsFileServerVolumeConfiguration) Source #
This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.
volume_host :: Lens' Volume (Maybe HostVolumeProperties) Source #
This parameter is specified when you use bind mount host volumes. The
contents of the host parameter determine whether your bind mount host
volume persists on the host container instance and where it's stored.
If the host parameter is empty, then the Docker daemon assigns a host
path for your data volume. However, the data isn't guaranteed to
persist after the containers that are associated with it stop running.
Windows containers can mount whole directories on the same drive as
$env:ProgramData. Windows containers can't mount directories on a
different drive, and mount point can't be across drives. For example,
you can mount C:\my\path:C:\my\path and D:\:D:\, but not
D:\my\path:C:\my\path or D:\:C:\my\path.
volume_name :: Lens' Volume (Maybe Text) Source #
The name of the volume. Up to 255 letters (uppercase and lowercase),
numbers, underscores, and hyphens are allowed. This name is referenced
in the sourceVolume parameter of container definition mountPoints.
VolumeFrom
data VolumeFrom Source #
Details on a data volume from another container in the same task definition.
See: newVolumeFrom smart constructor.
Constructors
| VolumeFrom' | |
Fields
| |
Instances
newVolumeFrom :: VolumeFrom Source #
Create a value of VolumeFrom with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:readOnly:VolumeFrom', volumeFrom_readOnly - 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.
$sel:sourceContainer:VolumeFrom', volumeFrom_sourceContainer - The name of another container within the same task definition to mount
volumes from.
volumeFrom_readOnly :: Lens' VolumeFrom (Maybe Bool) Source #
If this value is true, the container has read-only access to the
volume. If this value is false, then the container can write to the
volume. The default value is false.
volumeFrom_sourceContainer :: Lens' VolumeFrom (Maybe Text) Source #
The name of another container within the same task definition to mount volumes from.