Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Operations
- ListServices
- DescribeClusters
- DeleteService
- UpdateService
- DiscoverPollEndpoint
- SubmitAttachmentStateChanges
- SubmitContainerStateChange
- ListTagsForResource
- StopTask
- DescribeTaskDefinition
- SubmitTaskStateChange
- DescribeContainerInstances
- DescribeCapacityProviders
- UpdateContainerInstancesState
- DeleteCluster
- UpdateCluster
- CreateCluster
- PutAccountSetting
- DeleteAccountSetting
- ListTaskDefinitions
- RunTask
- DeleteCapacityProvider
- ListTasks
- UpdateCapacityProvider
- RegisterContainerInstance
- UpdateContainerAgent
- ListContainerInstances
- UpdateServicePrimaryTaskSet
- ListTaskDefinitionFamilies
- StartTask
- PutClusterCapacityProviders
- PutAccountSettingDefault
- ListAttributes
- ExecuteCommand
- DeregisterTaskDefinition
- TagResource
- CreateTaskSet
- DescribeTasks
- ListClusters
- UntagResource
- DescribeServices
- DeregisterContainerInstance
- UpdateClusterSettings
- DeleteAttributes
- PutAttributes
- ListAccountSettings
- DeleteTaskSet
- UpdateTaskSet
- CreateCapacityProvider
- DescribeTaskSets
- RegisterTaskDefinition
- CreateService
- Types
- Attachment
- AttachmentStateChange
- Attribute
- AutoScalingGroupProvider
- AutoScalingGroupProviderUpdate
- AwsVpcConfiguration
- CapacityProvider
- CapacityProviderStrategyItem
- Cluster
- ClusterConfiguration
- ClusterSetting
- Container
- ContainerDefinition
- ContainerDependency
- ContainerInstance
- ContainerOverride
- ContainerService
- ContainerStateChange
- Deployment
- DeploymentCircuitBreaker
- DeploymentConfiguration
- DeploymentController
- Device
- DockerVolumeConfiguration
- EFSAuthorizationConfig
- EFSVolumeConfiguration
- EnvironmentFile
- EphemeralStorage
- ExecuteCommandConfiguration
- ExecuteCommandLogConfiguration
- FSxWindowsFileServerAuthorizationConfig
- FSxWindowsFileServerVolumeConfiguration
- Failure
- FirelensConfiguration
- HealthCheck
- HostEntry
- HostVolumeProperties
- InferenceAccelerator
- InferenceAcceleratorOverride
- KernelCapabilities
- KeyValuePair
- LinuxParameters
- LoadBalancer
- LogConfiguration
- ManagedAgent
- ManagedAgentStateChange
- ManagedScaling
- MountPoint
- NetworkBinding
- NetworkConfiguration
- NetworkInterface
- PlacementConstraint
- PlacementStrategy
- PlatformDevice
- PortMapping
- ProxyConfiguration
- RepositoryCredentials
- Resource
- ResourceRequirement
- Scale
- Secret
- ServiceEvent
- ServiceRegistry
- Session
- Setting
- SystemControl
- Tag
- Task
- TaskDefinition
- TaskDefinitionPlacementConstraint
- TaskOverride
- TaskSet
- Tmpfs
- Ulimit
- VersionInfo
- Volume
- VolumeFrom
Synopsis
- listServices_cluster :: Lens' ListServices (Maybe Text)
- listServices_nextToken :: Lens' ListServices (Maybe Text)
- listServices_launchType :: Lens' ListServices (Maybe LaunchType)
- listServices_schedulingStrategy :: Lens' ListServices (Maybe SchedulingStrategy)
- listServices_maxResults :: Lens' ListServices (Maybe Int)
- listServicesResponse_serviceArns :: Lens' ListServicesResponse (Maybe [Text])
- listServicesResponse_nextToken :: Lens' ListServicesResponse (Maybe Text)
- listServicesResponse_httpStatus :: Lens' ListServicesResponse Int
- describeClusters_include :: Lens' DescribeClusters (Maybe [ClusterField])
- describeClusters_clusters :: Lens' DescribeClusters (Maybe [Text])
- describeClustersResponse_failures :: Lens' DescribeClustersResponse (Maybe [Failure])
- describeClustersResponse_clusters :: Lens' DescribeClustersResponse (Maybe [Cluster])
- describeClustersResponse_httpStatus :: Lens' DescribeClustersResponse Int
- deleteService_cluster :: Lens' DeleteService (Maybe Text)
- deleteService_force :: Lens' DeleteService (Maybe Bool)
- deleteService_service :: Lens' DeleteService Text
- deleteServiceResponse_service :: Lens' DeleteServiceResponse (Maybe ContainerService)
- deleteServiceResponse_httpStatus :: Lens' DeleteServiceResponse Int
- updateService_cluster :: Lens' UpdateService (Maybe Text)
- updateService_platformVersion :: Lens' UpdateService (Maybe Text)
- updateService_desiredCount :: Lens' UpdateService (Maybe Int)
- updateService_placementConstraints :: Lens' UpdateService (Maybe [PlacementConstraint])
- updateService_placementStrategy :: Lens' UpdateService (Maybe [PlacementStrategy])
- updateService_forceNewDeployment :: Lens' UpdateService (Maybe Bool)
- updateService_taskDefinition :: Lens' UpdateService (Maybe Text)
- updateService_healthCheckGracePeriodSeconds :: Lens' UpdateService (Maybe Int)
- updateService_networkConfiguration :: Lens' UpdateService (Maybe NetworkConfiguration)
- updateService_capacityProviderStrategy :: Lens' UpdateService (Maybe [CapacityProviderStrategyItem])
- updateService_enableExecuteCommand :: Lens' UpdateService (Maybe Bool)
- updateService_deploymentConfiguration :: Lens' UpdateService (Maybe DeploymentConfiguration)
- updateService_service :: Lens' UpdateService Text
- updateServiceResponse_service :: Lens' UpdateServiceResponse (Maybe ContainerService)
- updateServiceResponse_httpStatus :: Lens' UpdateServiceResponse Int
- discoverPollEndpoint_cluster :: Lens' DiscoverPollEndpoint (Maybe Text)
- discoverPollEndpoint_containerInstance :: Lens' DiscoverPollEndpoint (Maybe Text)
- discoverPollEndpointResponse_telemetryEndpoint :: Lens' DiscoverPollEndpointResponse (Maybe Text)
- discoverPollEndpointResponse_endpoint :: Lens' DiscoverPollEndpointResponse (Maybe Text)
- discoverPollEndpointResponse_httpStatus :: Lens' DiscoverPollEndpointResponse Int
- submitAttachmentStateChanges_cluster :: Lens' SubmitAttachmentStateChanges (Maybe Text)
- submitAttachmentStateChanges_attachments :: Lens' SubmitAttachmentStateChanges [AttachmentStateChange]
- submitAttachmentStateChangesResponse_acknowledgment :: Lens' SubmitAttachmentStateChangesResponse (Maybe Text)
- submitAttachmentStateChangesResponse_httpStatus :: Lens' SubmitAttachmentStateChangesResponse Int
- submitContainerStateChange_networkBindings :: Lens' SubmitContainerStateChange (Maybe [NetworkBinding])
- submitContainerStateChange_status :: Lens' SubmitContainerStateChange (Maybe Text)
- submitContainerStateChange_cluster :: Lens' SubmitContainerStateChange (Maybe Text)
- submitContainerStateChange_containerName :: Lens' SubmitContainerStateChange (Maybe Text)
- submitContainerStateChange_reason :: Lens' SubmitContainerStateChange (Maybe Text)
- submitContainerStateChange_exitCode :: Lens' SubmitContainerStateChange (Maybe Int)
- submitContainerStateChange_task :: Lens' SubmitContainerStateChange (Maybe Text)
- submitContainerStateChange_runtimeId :: Lens' SubmitContainerStateChange (Maybe Text)
- submitContainerStateChangeResponse_acknowledgment :: Lens' SubmitContainerStateChangeResponse (Maybe Text)
- submitContainerStateChangeResponse_httpStatus :: Lens' SubmitContainerStateChangeResponse Int
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag])
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- stopTask_cluster :: Lens' StopTask (Maybe Text)
- stopTask_reason :: Lens' StopTask (Maybe Text)
- stopTask_task :: Lens' StopTask Text
- stopTaskResponse_task :: Lens' StopTaskResponse (Maybe Task)
- stopTaskResponse_httpStatus :: Lens' StopTaskResponse Int
- describeTaskDefinition_include :: Lens' DescribeTaskDefinition (Maybe [TaskDefinitionField])
- describeTaskDefinition_taskDefinition :: Lens' DescribeTaskDefinition Text
- describeTaskDefinitionResponse_taskDefinition :: Lens' DescribeTaskDefinitionResponse (Maybe TaskDefinition)
- describeTaskDefinitionResponse_tags :: Lens' DescribeTaskDefinitionResponse (Maybe [Tag])
- describeTaskDefinitionResponse_httpStatus :: Lens' DescribeTaskDefinitionResponse Int
- submitTaskStateChange_status :: Lens' SubmitTaskStateChange (Maybe Text)
- submitTaskStateChange_managedAgents :: Lens' SubmitTaskStateChange (Maybe [ManagedAgentStateChange])
- submitTaskStateChange_cluster :: Lens' SubmitTaskStateChange (Maybe Text)
- submitTaskStateChange_attachments :: Lens' SubmitTaskStateChange (Maybe [AttachmentStateChange])
- submitTaskStateChange_executionStoppedAt :: Lens' SubmitTaskStateChange (Maybe UTCTime)
- submitTaskStateChange_pullStoppedAt :: Lens' SubmitTaskStateChange (Maybe UTCTime)
- submitTaskStateChange_containers :: Lens' SubmitTaskStateChange (Maybe [ContainerStateChange])
- submitTaskStateChange_reason :: Lens' SubmitTaskStateChange (Maybe Text)
- submitTaskStateChange_task :: Lens' SubmitTaskStateChange (Maybe Text)
- submitTaskStateChange_pullStartedAt :: Lens' SubmitTaskStateChange (Maybe UTCTime)
- submitTaskStateChangeResponse_acknowledgment :: Lens' SubmitTaskStateChangeResponse (Maybe Text)
- submitTaskStateChangeResponse_httpStatus :: Lens' SubmitTaskStateChangeResponse Int
- describeContainerInstances_include :: Lens' DescribeContainerInstances (Maybe [ContainerInstanceField])
- describeContainerInstances_cluster :: Lens' DescribeContainerInstances (Maybe Text)
- describeContainerInstances_containerInstances :: Lens' DescribeContainerInstances [Text]
- describeContainerInstancesResponse_failures :: Lens' DescribeContainerInstancesResponse (Maybe [Failure])
- describeContainerInstancesResponse_containerInstances :: Lens' DescribeContainerInstancesResponse (Maybe [ContainerInstance])
- describeContainerInstancesResponse_httpStatus :: Lens' DescribeContainerInstancesResponse Int
- describeCapacityProviders_include :: Lens' DescribeCapacityProviders (Maybe [CapacityProviderField])
- describeCapacityProviders_nextToken :: Lens' DescribeCapacityProviders (Maybe Text)
- describeCapacityProviders_capacityProviders :: Lens' DescribeCapacityProviders (Maybe [Text])
- describeCapacityProviders_maxResults :: Lens' DescribeCapacityProviders (Maybe Int)
- describeCapacityProvidersResponse_failures :: Lens' DescribeCapacityProvidersResponse (Maybe [Failure])
- describeCapacityProvidersResponse_nextToken :: Lens' DescribeCapacityProvidersResponse (Maybe Text)
- describeCapacityProvidersResponse_capacityProviders :: Lens' DescribeCapacityProvidersResponse (Maybe [CapacityProvider])
- describeCapacityProvidersResponse_httpStatus :: Lens' DescribeCapacityProvidersResponse Int
- updateContainerInstancesState_cluster :: Lens' UpdateContainerInstancesState (Maybe Text)
- updateContainerInstancesState_containerInstances :: Lens' UpdateContainerInstancesState [Text]
- updateContainerInstancesState_status :: Lens' UpdateContainerInstancesState ContainerInstanceStatus
- updateContainerInstancesStateResponse_failures :: Lens' UpdateContainerInstancesStateResponse (Maybe [Failure])
- updateContainerInstancesStateResponse_containerInstances :: Lens' UpdateContainerInstancesStateResponse (Maybe [ContainerInstance])
- updateContainerInstancesStateResponse_httpStatus :: Lens' UpdateContainerInstancesStateResponse Int
- deleteCluster_cluster :: Lens' DeleteCluster Text
- deleteClusterResponse_cluster :: Lens' DeleteClusterResponse (Maybe Cluster)
- deleteClusterResponse_httpStatus :: Lens' DeleteClusterResponse Int
- updateCluster_settings :: Lens' UpdateCluster (Maybe [ClusterSetting])
- updateCluster_configuration :: Lens' UpdateCluster (Maybe ClusterConfiguration)
- updateCluster_cluster :: Lens' UpdateCluster Text
- updateClusterResponse_cluster :: Lens' UpdateClusterResponse (Maybe Cluster)
- updateClusterResponse_httpStatus :: Lens' UpdateClusterResponse Int
- createCluster_defaultCapacityProviderStrategy :: Lens' CreateCluster (Maybe [CapacityProviderStrategyItem])
- createCluster_settings :: Lens' CreateCluster (Maybe [ClusterSetting])
- createCluster_clusterName :: Lens' CreateCluster (Maybe Text)
- createCluster_configuration :: Lens' CreateCluster (Maybe ClusterConfiguration)
- createCluster_capacityProviders :: Lens' CreateCluster (Maybe [Text])
- createCluster_tags :: Lens' CreateCluster (Maybe [Tag])
- createClusterResponse_cluster :: Lens' CreateClusterResponse (Maybe Cluster)
- createClusterResponse_httpStatus :: Lens' CreateClusterResponse Int
- putAccountSetting_principalArn :: Lens' PutAccountSetting (Maybe Text)
- putAccountSetting_name :: Lens' PutAccountSetting SettingName
- putAccountSetting_value :: Lens' PutAccountSetting Text
- putAccountSettingResponse_setting :: Lens' PutAccountSettingResponse (Maybe Setting)
- putAccountSettingResponse_httpStatus :: Lens' PutAccountSettingResponse Int
- deleteAccountSetting_principalArn :: Lens' DeleteAccountSetting (Maybe Text)
- deleteAccountSetting_name :: Lens' DeleteAccountSetting SettingName
- deleteAccountSettingResponse_setting :: Lens' DeleteAccountSettingResponse (Maybe Setting)
- deleteAccountSettingResponse_httpStatus :: Lens' DeleteAccountSettingResponse Int
- listTaskDefinitions_status :: Lens' ListTaskDefinitions (Maybe TaskDefinitionStatus)
- listTaskDefinitions_familyPrefix :: Lens' ListTaskDefinitions (Maybe Text)
- listTaskDefinitions_nextToken :: Lens' ListTaskDefinitions (Maybe Text)
- listTaskDefinitions_sort :: Lens' ListTaskDefinitions (Maybe SortOrder)
- listTaskDefinitions_maxResults :: Lens' ListTaskDefinitions (Maybe Int)
- listTaskDefinitionsResponse_taskDefinitionArns :: Lens' ListTaskDefinitionsResponse (Maybe [Text])
- listTaskDefinitionsResponse_nextToken :: Lens' ListTaskDefinitionsResponse (Maybe Text)
- listTaskDefinitionsResponse_httpStatus :: Lens' ListTaskDefinitionsResponse Int
- runTask_overrides :: Lens' RunTask (Maybe TaskOverride)
- runTask_group :: Lens' RunTask (Maybe Text)
- runTask_cluster :: Lens' RunTask (Maybe Text)
- runTask_propagateTags :: Lens' RunTask (Maybe PropagateTags)
- runTask_platformVersion :: Lens' RunTask (Maybe Text)
- runTask_enableECSManagedTags :: Lens' RunTask (Maybe Bool)
- runTask_count :: Lens' RunTask (Maybe Int)
- runTask_referenceId :: Lens' RunTask (Maybe Text)
- runTask_placementConstraints :: Lens' RunTask (Maybe [PlacementConstraint])
- runTask_placementStrategy :: Lens' RunTask (Maybe [PlacementStrategy])
- runTask_startedBy :: Lens' RunTask (Maybe Text)
- runTask_launchType :: Lens' RunTask (Maybe LaunchType)
- runTask_networkConfiguration :: Lens' RunTask (Maybe NetworkConfiguration)
- runTask_capacityProviderStrategy :: Lens' RunTask (Maybe [CapacityProviderStrategyItem])
- runTask_enableExecuteCommand :: Lens' RunTask (Maybe Bool)
- runTask_tags :: Lens' RunTask (Maybe [Tag])
- runTask_taskDefinition :: Lens' RunTask Text
- runTaskResponse_failures :: Lens' RunTaskResponse (Maybe [Failure])
- runTaskResponse_tasks :: Lens' RunTaskResponse (Maybe [Task])
- runTaskResponse_httpStatus :: Lens' RunTaskResponse Int
- deleteCapacityProvider_capacityProvider :: Lens' DeleteCapacityProvider Text
- deleteCapacityProviderResponse_capacityProvider :: Lens' DeleteCapacityProviderResponse (Maybe CapacityProvider)
- deleteCapacityProviderResponse_httpStatus :: Lens' DeleteCapacityProviderResponse Int
- listTasks_desiredStatus :: Lens' ListTasks (Maybe DesiredStatus)
- listTasks_cluster :: Lens' ListTasks (Maybe Text)
- listTasks_family :: Lens' ListTasks (Maybe Text)
- listTasks_nextToken :: Lens' ListTasks (Maybe Text)
- listTasks_startedBy :: Lens' ListTasks (Maybe Text)
- listTasks_serviceName :: Lens' ListTasks (Maybe Text)
- listTasks_launchType :: Lens' ListTasks (Maybe LaunchType)
- listTasks_containerInstance :: Lens' ListTasks (Maybe Text)
- listTasks_maxResults :: Lens' ListTasks (Maybe Int)
- listTasksResponse_nextToken :: Lens' ListTasksResponse (Maybe Text)
- listTasksResponse_taskArns :: Lens' ListTasksResponse (Maybe [Text])
- listTasksResponse_httpStatus :: Lens' ListTasksResponse Int
- updateCapacityProvider_name :: Lens' UpdateCapacityProvider Text
- updateCapacityProvider_autoScalingGroupProvider :: Lens' UpdateCapacityProvider AutoScalingGroupProviderUpdate
- updateCapacityProviderResponse_capacityProvider :: Lens' UpdateCapacityProviderResponse (Maybe CapacityProvider)
- updateCapacityProviderResponse_httpStatus :: Lens' UpdateCapacityProviderResponse Int
- registerContainerInstance_platformDevices :: Lens' RegisterContainerInstance (Maybe [PlatformDevice])
- registerContainerInstance_instanceIdentityDocumentSignature :: Lens' RegisterContainerInstance (Maybe Text)
- registerContainerInstance_cluster :: Lens' RegisterContainerInstance (Maybe Text)
- registerContainerInstance_instanceIdentityDocument :: Lens' RegisterContainerInstance (Maybe Text)
- registerContainerInstance_containerInstanceArn :: Lens' RegisterContainerInstance (Maybe Text)
- registerContainerInstance_versionInfo :: Lens' RegisterContainerInstance (Maybe VersionInfo)
- registerContainerInstance_attributes :: Lens' RegisterContainerInstance (Maybe [Attribute])
- registerContainerInstance_totalResources :: Lens' RegisterContainerInstance (Maybe [Resource])
- registerContainerInstance_tags :: Lens' RegisterContainerInstance (Maybe [Tag])
- registerContainerInstanceResponse_containerInstance :: Lens' RegisterContainerInstanceResponse (Maybe ContainerInstance)
- registerContainerInstanceResponse_httpStatus :: Lens' RegisterContainerInstanceResponse Int
- updateContainerAgent_cluster :: Lens' UpdateContainerAgent (Maybe Text)
- updateContainerAgent_containerInstance :: Lens' UpdateContainerAgent Text
- updateContainerAgentResponse_containerInstance :: Lens' UpdateContainerAgentResponse (Maybe ContainerInstance)
- updateContainerAgentResponse_httpStatus :: Lens' UpdateContainerAgentResponse Int
- listContainerInstances_status :: Lens' ListContainerInstances (Maybe ContainerInstanceStatus)
- listContainerInstances_cluster :: Lens' ListContainerInstances (Maybe Text)
- listContainerInstances_nextToken :: Lens' ListContainerInstances (Maybe Text)
- listContainerInstances_filter :: Lens' ListContainerInstances (Maybe Text)
- listContainerInstances_maxResults :: Lens' ListContainerInstances (Maybe Int)
- listContainerInstancesResponse_containerInstanceArns :: Lens' ListContainerInstancesResponse (Maybe [Text])
- listContainerInstancesResponse_nextToken :: Lens' ListContainerInstancesResponse (Maybe Text)
- listContainerInstancesResponse_httpStatus :: Lens' ListContainerInstancesResponse Int
- updateServicePrimaryTaskSet_cluster :: Lens' UpdateServicePrimaryTaskSet Text
- updateServicePrimaryTaskSet_service :: Lens' UpdateServicePrimaryTaskSet Text
- updateServicePrimaryTaskSet_primaryTaskSet :: Lens' UpdateServicePrimaryTaskSet Text
- updateServicePrimaryTaskSetResponse_taskSet :: Lens' UpdateServicePrimaryTaskSetResponse (Maybe TaskSet)
- updateServicePrimaryTaskSetResponse_httpStatus :: Lens' UpdateServicePrimaryTaskSetResponse Int
- listTaskDefinitionFamilies_status :: Lens' ListTaskDefinitionFamilies (Maybe TaskDefinitionFamilyStatus)
- listTaskDefinitionFamilies_familyPrefix :: Lens' ListTaskDefinitionFamilies (Maybe Text)
- listTaskDefinitionFamilies_nextToken :: Lens' ListTaskDefinitionFamilies (Maybe Text)
- listTaskDefinitionFamilies_maxResults :: Lens' ListTaskDefinitionFamilies (Maybe Int)
- listTaskDefinitionFamiliesResponse_families :: Lens' ListTaskDefinitionFamiliesResponse (Maybe [Text])
- listTaskDefinitionFamiliesResponse_nextToken :: Lens' ListTaskDefinitionFamiliesResponse (Maybe Text)
- listTaskDefinitionFamiliesResponse_httpStatus :: Lens' ListTaskDefinitionFamiliesResponse Int
- startTask_overrides :: Lens' StartTask (Maybe TaskOverride)
- startTask_group :: Lens' StartTask (Maybe Text)
- startTask_cluster :: Lens' StartTask (Maybe Text)
- startTask_propagateTags :: Lens' StartTask (Maybe PropagateTags)
- startTask_enableECSManagedTags :: Lens' StartTask (Maybe Bool)
- startTask_referenceId :: Lens' StartTask (Maybe Text)
- startTask_startedBy :: Lens' StartTask (Maybe Text)
- startTask_networkConfiguration :: Lens' StartTask (Maybe NetworkConfiguration)
- startTask_enableExecuteCommand :: Lens' StartTask (Maybe Bool)
- startTask_tags :: Lens' StartTask (Maybe [Tag])
- startTask_containerInstances :: Lens' StartTask [Text]
- startTask_taskDefinition :: Lens' StartTask Text
- startTaskResponse_failures :: Lens' StartTaskResponse (Maybe [Failure])
- startTaskResponse_tasks :: Lens' StartTaskResponse (Maybe [Task])
- startTaskResponse_httpStatus :: Lens' StartTaskResponse Int
- putClusterCapacityProviders_cluster :: Lens' PutClusterCapacityProviders Text
- putClusterCapacityProviders_capacityProviders :: Lens' PutClusterCapacityProviders [Text]
- putClusterCapacityProviders_defaultCapacityProviderStrategy :: Lens' PutClusterCapacityProviders [CapacityProviderStrategyItem]
- putClusterCapacityProvidersResponse_cluster :: Lens' PutClusterCapacityProvidersResponse (Maybe Cluster)
- putClusterCapacityProvidersResponse_httpStatus :: Lens' PutClusterCapacityProvidersResponse Int
- putAccountSettingDefault_name :: Lens' PutAccountSettingDefault SettingName
- putAccountSettingDefault_value :: Lens' PutAccountSettingDefault Text
- putAccountSettingDefaultResponse_setting :: Lens' PutAccountSettingDefaultResponse (Maybe Setting)
- putAccountSettingDefaultResponse_httpStatus :: Lens' PutAccountSettingDefaultResponse Int
- listAttributes_attributeValue :: Lens' ListAttributes (Maybe Text)
- listAttributes_cluster :: Lens' ListAttributes (Maybe Text)
- listAttributes_nextToken :: Lens' ListAttributes (Maybe Text)
- listAttributes_attributeName :: Lens' ListAttributes (Maybe Text)
- listAttributes_maxResults :: Lens' ListAttributes (Maybe Int)
- listAttributes_targetType :: Lens' ListAttributes TargetType
- listAttributesResponse_nextToken :: Lens' ListAttributesResponse (Maybe Text)
- listAttributesResponse_attributes :: Lens' ListAttributesResponse (Maybe [Attribute])
- listAttributesResponse_httpStatus :: Lens' ListAttributesResponse Int
- executeCommand_cluster :: Lens' ExecuteCommand (Maybe Text)
- executeCommand_container :: Lens' ExecuteCommand (Maybe Text)
- executeCommand_command :: Lens' ExecuteCommand Text
- executeCommand_interactive :: Lens' ExecuteCommand Bool
- executeCommand_task :: Lens' ExecuteCommand Text
- executeCommandResponse_clusterArn :: Lens' ExecuteCommandResponse (Maybe Text)
- executeCommandResponse_containerArn :: Lens' ExecuteCommandResponse (Maybe Text)
- executeCommandResponse_taskArn :: Lens' ExecuteCommandResponse (Maybe Text)
- executeCommandResponse_containerName :: Lens' ExecuteCommandResponse (Maybe Text)
- executeCommandResponse_interactive :: Lens' ExecuteCommandResponse (Maybe Bool)
- executeCommandResponse_session :: Lens' ExecuteCommandResponse (Maybe Session)
- executeCommandResponse_httpStatus :: Lens' ExecuteCommandResponse Int
- deregisterTaskDefinition_taskDefinition :: Lens' DeregisterTaskDefinition Text
- deregisterTaskDefinitionResponse_taskDefinition :: Lens' DeregisterTaskDefinitionResponse (Maybe TaskDefinition)
- deregisterTaskDefinitionResponse_httpStatus :: Lens' DeregisterTaskDefinitionResponse Int
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource [Tag]
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- createTaskSet_clientToken :: Lens' CreateTaskSet (Maybe Text)
- createTaskSet_platformVersion :: Lens' CreateTaskSet (Maybe Text)
- createTaskSet_scale :: Lens' CreateTaskSet (Maybe Scale)
- createTaskSet_loadBalancers :: Lens' CreateTaskSet (Maybe [LoadBalancer])
- createTaskSet_launchType :: Lens' CreateTaskSet (Maybe LaunchType)
- createTaskSet_externalId :: Lens' CreateTaskSet (Maybe Text)
- createTaskSet_networkConfiguration :: Lens' CreateTaskSet (Maybe NetworkConfiguration)
- createTaskSet_serviceRegistries :: Lens' CreateTaskSet (Maybe [ServiceRegistry])
- createTaskSet_capacityProviderStrategy :: Lens' CreateTaskSet (Maybe [CapacityProviderStrategyItem])
- createTaskSet_tags :: Lens' CreateTaskSet (Maybe [Tag])
- createTaskSet_service :: Lens' CreateTaskSet Text
- createTaskSet_cluster :: Lens' CreateTaskSet Text
- createTaskSet_taskDefinition :: Lens' CreateTaskSet Text
- createTaskSetResponse_taskSet :: Lens' CreateTaskSetResponse (Maybe TaskSet)
- createTaskSetResponse_httpStatus :: Lens' CreateTaskSetResponse Int
- describeTasks_include :: Lens' DescribeTasks (Maybe [TaskField])
- describeTasks_cluster :: Lens' DescribeTasks (Maybe Text)
- describeTasks_tasks :: Lens' DescribeTasks [Text]
- describeTasksResponse_failures :: Lens' DescribeTasksResponse (Maybe [Failure])
- describeTasksResponse_tasks :: Lens' DescribeTasksResponse (Maybe [Task])
- describeTasksResponse_httpStatus :: Lens' DescribeTasksResponse Int
- listClusters_nextToken :: Lens' ListClusters (Maybe Text)
- listClusters_maxResults :: Lens' ListClusters (Maybe Int)
- listClustersResponse_clusterArns :: Lens' ListClustersResponse (Maybe [Text])
- listClustersResponse_nextToken :: Lens' ListClustersResponse (Maybe Text)
- listClustersResponse_httpStatus :: Lens' ListClustersResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource [Text]
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- describeServices_include :: Lens' DescribeServices (Maybe [ServiceField])
- describeServices_cluster :: Lens' DescribeServices (Maybe Text)
- describeServices_services :: Lens' DescribeServices [Text]
- describeServicesResponse_failures :: Lens' DescribeServicesResponse (Maybe [Failure])
- describeServicesResponse_services :: Lens' DescribeServicesResponse (Maybe [ContainerService])
- describeServicesResponse_httpStatus :: Lens' DescribeServicesResponse Int
- deregisterContainerInstance_cluster :: Lens' DeregisterContainerInstance (Maybe Text)
- deregisterContainerInstance_force :: Lens' DeregisterContainerInstance (Maybe Bool)
- deregisterContainerInstance_containerInstance :: Lens' DeregisterContainerInstance Text
- deregisterContainerInstanceResponse_containerInstance :: Lens' DeregisterContainerInstanceResponse (Maybe ContainerInstance)
- deregisterContainerInstanceResponse_httpStatus :: Lens' DeregisterContainerInstanceResponse Int
- updateClusterSettings_cluster :: Lens' UpdateClusterSettings Text
- updateClusterSettings_settings :: Lens' UpdateClusterSettings [ClusterSetting]
- updateClusterSettingsResponse_cluster :: Lens' UpdateClusterSettingsResponse (Maybe Cluster)
- updateClusterSettingsResponse_httpStatus :: Lens' UpdateClusterSettingsResponse Int
- deleteAttributes_cluster :: Lens' DeleteAttributes (Maybe Text)
- deleteAttributes_attributes :: Lens' DeleteAttributes [Attribute]
- deleteAttributesResponse_attributes :: Lens' DeleteAttributesResponse (Maybe [Attribute])
- deleteAttributesResponse_httpStatus :: Lens' DeleteAttributesResponse Int
- putAttributes_cluster :: Lens' PutAttributes (Maybe Text)
- putAttributes_attributes :: Lens' PutAttributes [Attribute]
- putAttributesResponse_attributes :: Lens' PutAttributesResponse (Maybe [Attribute])
- putAttributesResponse_httpStatus :: Lens' PutAttributesResponse Int
- listAccountSettings_value :: Lens' ListAccountSettings (Maybe Text)
- listAccountSettings_nextToken :: Lens' ListAccountSettings (Maybe Text)
- listAccountSettings_name :: Lens' ListAccountSettings (Maybe SettingName)
- listAccountSettings_principalArn :: Lens' ListAccountSettings (Maybe Text)
- listAccountSettings_effectiveSettings :: Lens' ListAccountSettings (Maybe Bool)
- listAccountSettings_maxResults :: Lens' ListAccountSettings (Maybe Int)
- listAccountSettingsResponse_settings :: Lens' ListAccountSettingsResponse (Maybe [Setting])
- listAccountSettingsResponse_nextToken :: Lens' ListAccountSettingsResponse (Maybe Text)
- listAccountSettingsResponse_httpStatus :: Lens' ListAccountSettingsResponse Int
- deleteTaskSet_force :: Lens' DeleteTaskSet (Maybe Bool)
- deleteTaskSet_cluster :: Lens' DeleteTaskSet Text
- deleteTaskSet_service :: Lens' DeleteTaskSet Text
- deleteTaskSet_taskSet :: Lens' DeleteTaskSet Text
- deleteTaskSetResponse_taskSet :: Lens' DeleteTaskSetResponse (Maybe TaskSet)
- deleteTaskSetResponse_httpStatus :: Lens' DeleteTaskSetResponse Int
- updateTaskSet_cluster :: Lens' UpdateTaskSet Text
- updateTaskSet_service :: Lens' UpdateTaskSet Text
- updateTaskSet_taskSet :: Lens' UpdateTaskSet Text
- updateTaskSet_scale :: Lens' UpdateTaskSet Scale
- updateTaskSetResponse_taskSet :: Lens' UpdateTaskSetResponse (Maybe TaskSet)
- updateTaskSetResponse_httpStatus :: Lens' UpdateTaskSetResponse Int
- createCapacityProvider_tags :: Lens' CreateCapacityProvider (Maybe [Tag])
- createCapacityProvider_name :: Lens' CreateCapacityProvider Text
- createCapacityProvider_autoScalingGroupProvider :: Lens' CreateCapacityProvider AutoScalingGroupProvider
- createCapacityProviderResponse_capacityProvider :: Lens' CreateCapacityProviderResponse (Maybe CapacityProvider)
- createCapacityProviderResponse_httpStatus :: Lens' CreateCapacityProviderResponse Int
- describeTaskSets_taskSets :: Lens' DescribeTaskSets (Maybe [Text])
- describeTaskSets_include :: Lens' DescribeTaskSets (Maybe [TaskSetField])
- describeTaskSets_cluster :: Lens' DescribeTaskSets Text
- describeTaskSets_service :: Lens' DescribeTaskSets Text
- describeTaskSetsResponse_taskSets :: Lens' DescribeTaskSetsResponse (Maybe [TaskSet])
- describeTaskSetsResponse_failures :: Lens' DescribeTaskSetsResponse (Maybe [Failure])
- describeTaskSetsResponse_httpStatus :: Lens' DescribeTaskSetsResponse Int
- registerTaskDefinition_inferenceAccelerators :: Lens' RegisterTaskDefinition (Maybe [InferenceAccelerator])
- registerTaskDefinition_executionRoleArn :: Lens' RegisterTaskDefinition (Maybe Text)
- registerTaskDefinition_requiresCompatibilities :: Lens' RegisterTaskDefinition (Maybe [Compatibility])
- registerTaskDefinition_ephemeralStorage :: Lens' RegisterTaskDefinition (Maybe EphemeralStorage)
- registerTaskDefinition_pidMode :: Lens' RegisterTaskDefinition (Maybe PidMode)
- registerTaskDefinition_ipcMode :: Lens' RegisterTaskDefinition (Maybe IpcMode)
- registerTaskDefinition_memory :: Lens' RegisterTaskDefinition (Maybe Text)
- registerTaskDefinition_proxyConfiguration :: Lens' RegisterTaskDefinition (Maybe ProxyConfiguration)
- registerTaskDefinition_taskRoleArn :: Lens' RegisterTaskDefinition (Maybe Text)
- registerTaskDefinition_placementConstraints :: Lens' RegisterTaskDefinition (Maybe [TaskDefinitionPlacementConstraint])
- registerTaskDefinition_networkMode :: Lens' RegisterTaskDefinition (Maybe NetworkMode)
- registerTaskDefinition_volumes :: Lens' RegisterTaskDefinition (Maybe [Volume])
- registerTaskDefinition_cpu :: Lens' RegisterTaskDefinition (Maybe Text)
- registerTaskDefinition_tags :: Lens' RegisterTaskDefinition (Maybe [Tag])
- registerTaskDefinition_family :: Lens' RegisterTaskDefinition Text
- registerTaskDefinition_containerDefinitions :: Lens' RegisterTaskDefinition [ContainerDefinition]
- registerTaskDefinitionResponse_taskDefinition :: Lens' RegisterTaskDefinitionResponse (Maybe TaskDefinition)
- registerTaskDefinitionResponse_tags :: Lens' RegisterTaskDefinitionResponse (Maybe [Tag])
- registerTaskDefinitionResponse_httpStatus :: Lens' RegisterTaskDefinitionResponse Int
- createService_cluster :: Lens' CreateService (Maybe Text)
- createService_clientToken :: Lens' CreateService (Maybe Text)
- createService_propagateTags :: Lens' CreateService (Maybe PropagateTags)
- createService_platformVersion :: Lens' CreateService (Maybe Text)
- createService_enableECSManagedTags :: Lens' CreateService (Maybe Bool)
- createService_desiredCount :: Lens' CreateService (Maybe Int)
- createService_loadBalancers :: Lens' CreateService (Maybe [LoadBalancer])
- createService_role :: Lens' CreateService (Maybe Text)
- createService_placementConstraints :: Lens' CreateService (Maybe [PlacementConstraint])
- createService_placementStrategy :: Lens' CreateService (Maybe [PlacementStrategy])
- createService_deploymentController :: Lens' CreateService (Maybe DeploymentController)
- createService_launchType :: Lens' CreateService (Maybe LaunchType)
- createService_taskDefinition :: Lens' CreateService (Maybe Text)
- createService_schedulingStrategy :: Lens' CreateService (Maybe SchedulingStrategy)
- createService_healthCheckGracePeriodSeconds :: Lens' CreateService (Maybe Int)
- createService_networkConfiguration :: Lens' CreateService (Maybe NetworkConfiguration)
- createService_serviceRegistries :: Lens' CreateService (Maybe [ServiceRegistry])
- createService_capacityProviderStrategy :: Lens' CreateService (Maybe [CapacityProviderStrategyItem])
- createService_enableExecuteCommand :: Lens' CreateService (Maybe Bool)
- createService_tags :: Lens' CreateService (Maybe [Tag])
- createService_deploymentConfiguration :: Lens' CreateService (Maybe DeploymentConfiguration)
- createService_serviceName :: Lens' CreateService Text
- createServiceResponse_service :: Lens' CreateServiceResponse (Maybe ContainerService)
- createServiceResponse_httpStatus :: Lens' CreateServiceResponse Int
- attachment_status :: Lens' Attachment (Maybe Text)
- attachment_details :: Lens' Attachment (Maybe [KeyValuePair])
- attachment_id :: Lens' Attachment (Maybe Text)
- attachment_type :: Lens' Attachment (Maybe Text)
- attachmentStateChange_attachmentArn :: Lens' AttachmentStateChange Text
- attachmentStateChange_status :: Lens' AttachmentStateChange Text
- attribute_targetId :: Lens' Attribute (Maybe Text)
- attribute_value :: Lens' Attribute (Maybe Text)
- attribute_targetType :: Lens' Attribute (Maybe TargetType)
- attribute_name :: Lens' Attribute Text
- autoScalingGroupProvider_managedScaling :: Lens' AutoScalingGroupProvider (Maybe ManagedScaling)
- autoScalingGroupProvider_managedTerminationProtection :: Lens' AutoScalingGroupProvider (Maybe ManagedTerminationProtection)
- autoScalingGroupProvider_autoScalingGroupArn :: Lens' AutoScalingGroupProvider Text
- autoScalingGroupProviderUpdate_managedScaling :: Lens' AutoScalingGroupProviderUpdate (Maybe ManagedScaling)
- autoScalingGroupProviderUpdate_managedTerminationProtection :: Lens' AutoScalingGroupProviderUpdate (Maybe ManagedTerminationProtection)
- awsVpcConfiguration_securityGroups :: Lens' AwsVpcConfiguration (Maybe [Text])
- awsVpcConfiguration_assignPublicIp :: Lens' AwsVpcConfiguration (Maybe AssignPublicIp)
- awsVpcConfiguration_subnets :: Lens' AwsVpcConfiguration [Text]
- capacityProvider_status :: Lens' CapacityProvider (Maybe CapacityProviderStatus)
- capacityProvider_updateStatusReason :: Lens' CapacityProvider (Maybe Text)
- capacityProvider_autoScalingGroupProvider :: Lens' CapacityProvider (Maybe AutoScalingGroupProvider)
- capacityProvider_name :: Lens' CapacityProvider (Maybe Text)
- capacityProvider_updateStatus :: Lens' CapacityProvider (Maybe CapacityProviderUpdateStatus)
- capacityProvider_capacityProviderArn :: Lens' CapacityProvider (Maybe Text)
- capacityProvider_tags :: Lens' CapacityProvider (Maybe [Tag])
- capacityProviderStrategyItem_base :: Lens' CapacityProviderStrategyItem (Maybe Natural)
- capacityProviderStrategyItem_weight :: Lens' CapacityProviderStrategyItem (Maybe Natural)
- capacityProviderStrategyItem_capacityProvider :: Lens' CapacityProviderStrategyItem Text
- cluster_status :: Lens' Cluster (Maybe Text)
- cluster_clusterArn :: Lens' Cluster (Maybe Text)
- cluster_attachments :: Lens' Cluster (Maybe [Attachment])
- cluster_runningTasksCount :: Lens' Cluster (Maybe Int)
- cluster_defaultCapacityProviderStrategy :: Lens' Cluster (Maybe [CapacityProviderStrategyItem])
- cluster_settings :: Lens' Cluster (Maybe [ClusterSetting])
- cluster_registeredContainerInstancesCount :: Lens' Cluster (Maybe Int)
- cluster_pendingTasksCount :: Lens' Cluster (Maybe Int)
- cluster_clusterName :: Lens' Cluster (Maybe Text)
- cluster_statistics :: Lens' Cluster (Maybe [KeyValuePair])
- cluster_configuration :: Lens' Cluster (Maybe ClusterConfiguration)
- cluster_attachmentsStatus :: Lens' Cluster (Maybe Text)
- cluster_capacityProviders :: Lens' Cluster (Maybe [Text])
- cluster_activeServicesCount :: Lens' Cluster (Maybe Int)
- cluster_tags :: Lens' Cluster (Maybe [Tag])
- clusterConfiguration_executeCommandConfiguration :: Lens' ClusterConfiguration (Maybe ExecuteCommandConfiguration)
- clusterSetting_value :: Lens' ClusterSetting (Maybe Text)
- clusterSetting_name :: Lens' ClusterSetting (Maybe ClusterSettingName)
- container_gpuIds :: Lens' Container (Maybe [Text])
- container_networkBindings :: Lens' Container (Maybe [NetworkBinding])
- container_managedAgents :: Lens' Container (Maybe [ManagedAgent])
- container_image :: Lens' Container (Maybe Text)
- container_containerArn :: Lens' Container (Maybe Text)
- container_networkInterfaces :: Lens' Container (Maybe [NetworkInterface])
- container_taskArn :: Lens' Container (Maybe Text)
- container_lastStatus :: Lens' Container (Maybe Text)
- container_memory :: Lens' Container (Maybe Text)
- container_reason :: Lens' Container (Maybe Text)
- container_name :: Lens' Container (Maybe Text)
- container_imageDigest :: Lens' Container (Maybe Text)
- container_exitCode :: Lens' Container (Maybe Int)
- container_healthStatus :: Lens' Container (Maybe HealthStatus)
- container_cpu :: Lens' Container (Maybe Text)
- container_runtimeId :: Lens' Container (Maybe Text)
- container_memoryReservation :: Lens' Container (Maybe Text)
- containerDefinition_image :: Lens' ContainerDefinition (Maybe Text)
- containerDefinition_command :: Lens' ContainerDefinition (Maybe [Text])
- containerDefinition_hostname :: Lens' ContainerDefinition (Maybe Text)
- containerDefinition_repositoryCredentials :: Lens' ContainerDefinition (Maybe RepositoryCredentials)
- containerDefinition_dockerSecurityOptions :: Lens' ContainerDefinition (Maybe [Text])
- containerDefinition_healthCheck :: Lens' ContainerDefinition (Maybe HealthCheck)
- containerDefinition_disableNetworking :: Lens' ContainerDefinition (Maybe Bool)
- containerDefinition_secrets :: Lens' ContainerDefinition (Maybe [Secret])
- containerDefinition_volumesFrom :: Lens' ContainerDefinition (Maybe [VolumeFrom])
- containerDefinition_environment :: Lens' ContainerDefinition (Maybe [KeyValuePair])
- containerDefinition_environmentFiles :: Lens' ContainerDefinition (Maybe [EnvironmentFile])
- containerDefinition_entryPoint :: Lens' ContainerDefinition (Maybe [Text])
- containerDefinition_workingDirectory :: Lens' ContainerDefinition (Maybe Text)
- containerDefinition_ulimits :: Lens' ContainerDefinition (Maybe [Ulimit])
- containerDefinition_stopTimeout :: Lens' ContainerDefinition (Maybe Int)
- containerDefinition_privileged :: Lens' ContainerDefinition (Maybe Bool)
- containerDefinition_portMappings :: Lens' ContainerDefinition (Maybe [PortMapping])
- containerDefinition_resourceRequirements :: Lens' ContainerDefinition (Maybe [ResourceRequirement])
- containerDefinition_dockerLabels :: Lens' ContainerDefinition (Maybe (HashMap Text Text))
- containerDefinition_extraHosts :: Lens' ContainerDefinition (Maybe [HostEntry])
- containerDefinition_memory :: Lens' ContainerDefinition (Maybe Int)
- containerDefinition_systemControls :: Lens' ContainerDefinition (Maybe [SystemControl])
- containerDefinition_user :: Lens' ContainerDefinition (Maybe Text)
- containerDefinition_firelensConfiguration :: Lens' ContainerDefinition (Maybe FirelensConfiguration)
- containerDefinition_dnsSearchDomains :: Lens' ContainerDefinition (Maybe [Text])
- containerDefinition_logConfiguration :: Lens' ContainerDefinition (Maybe LogConfiguration)
- containerDefinition_linuxParameters :: Lens' ContainerDefinition (Maybe LinuxParameters)
- containerDefinition_pseudoTerminal :: Lens' ContainerDefinition (Maybe Bool)
- containerDefinition_dependsOn :: Lens' ContainerDefinition (Maybe [ContainerDependency])
- containerDefinition_name :: Lens' ContainerDefinition (Maybe Text)
- containerDefinition_dnsServers :: Lens' ContainerDefinition (Maybe [Text])
- containerDefinition_mountPoints :: Lens' ContainerDefinition (Maybe [MountPoint])
- containerDefinition_interactive :: Lens' ContainerDefinition (Maybe Bool)
- containerDefinition_startTimeout :: Lens' ContainerDefinition (Maybe Int)
- containerDefinition_links :: Lens' ContainerDefinition (Maybe [Text])
- containerDefinition_readonlyRootFilesystem :: Lens' ContainerDefinition (Maybe Bool)
- containerDefinition_essential :: Lens' ContainerDefinition (Maybe Bool)
- containerDefinition_cpu :: Lens' ContainerDefinition (Maybe Int)
- containerDefinition_memoryReservation :: Lens' ContainerDefinition (Maybe Int)
- containerDependency_containerName :: Lens' ContainerDependency Text
- containerDependency_condition :: Lens' ContainerDependency ContainerCondition
- containerInstance_status :: Lens' ContainerInstance (Maybe Text)
- containerInstance_attachments :: Lens' ContainerInstance (Maybe [Attachment])
- containerInstance_runningTasksCount :: Lens' ContainerInstance (Maybe Int)
- containerInstance_remainingResources :: Lens' ContainerInstance (Maybe [Resource])
- containerInstance_ec2InstanceId :: Lens' ContainerInstance (Maybe Text)
- containerInstance_containerInstanceArn :: Lens' ContainerInstance (Maybe Text)
- containerInstance_agentConnected :: Lens' ContainerInstance (Maybe Bool)
- containerInstance_versionInfo :: Lens' ContainerInstance (Maybe VersionInfo)
- containerInstance_agentUpdateStatus :: Lens' ContainerInstance (Maybe AgentUpdateStatus)
- containerInstance_attributes :: Lens' ContainerInstance (Maybe [Attribute])
- containerInstance_version :: Lens' ContainerInstance (Maybe Integer)
- containerInstance_pendingTasksCount :: Lens' ContainerInstance (Maybe Int)
- containerInstance_capacityProviderName :: Lens' ContainerInstance (Maybe Text)
- containerInstance_registeredAt :: Lens' ContainerInstance (Maybe UTCTime)
- containerInstance_statusReason :: Lens' ContainerInstance (Maybe Text)
- containerInstance_tags :: Lens' ContainerInstance (Maybe [Tag])
- containerInstance_registeredResources :: Lens' ContainerInstance (Maybe [Resource])
- containerOverride_command :: Lens' ContainerOverride (Maybe [Text])
- containerOverride_environment :: Lens' ContainerOverride (Maybe [KeyValuePair])
- containerOverride_environmentFiles :: Lens' ContainerOverride (Maybe [EnvironmentFile])
- containerOverride_resourceRequirements :: Lens' ContainerOverride (Maybe [ResourceRequirement])
- containerOverride_memory :: Lens' ContainerOverride (Maybe Int)
- containerOverride_name :: Lens' ContainerOverride (Maybe Text)
- containerOverride_cpu :: Lens' ContainerOverride (Maybe Int)
- containerOverride_memoryReservation :: Lens' ContainerOverride (Maybe Int)
- containerService_taskSets :: Lens' ContainerService (Maybe [TaskSet])
- containerService_runningCount :: Lens' ContainerService (Maybe Int)
- containerService_status :: Lens' ContainerService (Maybe Text)
- containerService_clusterArn :: Lens' ContainerService (Maybe Text)
- containerService_propagateTags :: Lens' ContainerService (Maybe PropagateTags)
- containerService_createdAt :: Lens' ContainerService (Maybe UTCTime)
- containerService_platformVersion :: Lens' ContainerService (Maybe Text)
- containerService_enableECSManagedTags :: Lens' ContainerService (Maybe Bool)
- containerService_createdBy :: Lens' ContainerService (Maybe Text)
- containerService_desiredCount :: Lens' ContainerService (Maybe Int)
- containerService_loadBalancers :: Lens' ContainerService (Maybe [LoadBalancer])
- containerService_pendingCount :: Lens' ContainerService (Maybe Int)
- containerService_placementConstraints :: Lens' ContainerService (Maybe [PlacementConstraint])
- containerService_events :: Lens' ContainerService (Maybe [ServiceEvent])
- containerService_placementStrategy :: Lens' ContainerService (Maybe [PlacementStrategy])
- containerService_deployments :: Lens' ContainerService (Maybe [Deployment])
- containerService_serviceName :: Lens' ContainerService (Maybe Text)
- containerService_deploymentController :: Lens' ContainerService (Maybe DeploymentController)
- containerService_launchType :: Lens' ContainerService (Maybe LaunchType)
- containerService_serviceArn :: Lens' ContainerService (Maybe Text)
- containerService_taskDefinition :: Lens' ContainerService (Maybe Text)
- containerService_schedulingStrategy :: Lens' ContainerService (Maybe SchedulingStrategy)
- containerService_healthCheckGracePeriodSeconds :: Lens' ContainerService (Maybe Int)
- containerService_networkConfiguration :: Lens' ContainerService (Maybe NetworkConfiguration)
- containerService_serviceRegistries :: Lens' ContainerService (Maybe [ServiceRegistry])
- containerService_capacityProviderStrategy :: Lens' ContainerService (Maybe [CapacityProviderStrategyItem])
- containerService_enableExecuteCommand :: Lens' ContainerService (Maybe Bool)
- containerService_tags :: Lens' ContainerService (Maybe [Tag])
- containerService_roleArn :: Lens' ContainerService (Maybe Text)
- containerService_deploymentConfiguration :: Lens' ContainerService (Maybe DeploymentConfiguration)
- containerStateChange_networkBindings :: Lens' ContainerStateChange (Maybe [NetworkBinding])
- containerStateChange_status :: Lens' ContainerStateChange (Maybe Text)
- containerStateChange_containerName :: Lens' ContainerStateChange (Maybe Text)
- containerStateChange_reason :: Lens' ContainerStateChange (Maybe Text)
- containerStateChange_imageDigest :: Lens' ContainerStateChange (Maybe Text)
- containerStateChange_exitCode :: Lens' ContainerStateChange (Maybe Int)
- containerStateChange_runtimeId :: Lens' ContainerStateChange (Maybe Text)
- deployment_rolloutState :: Lens' Deployment (Maybe DeploymentRolloutState)
- deployment_runningCount :: Lens' Deployment (Maybe Int)
- deployment_status :: Lens' Deployment (Maybe Text)
- deployment_createdAt :: Lens' Deployment (Maybe UTCTime)
- deployment_platformVersion :: Lens' Deployment (Maybe Text)
- deployment_desiredCount :: Lens' Deployment (Maybe Int)
- deployment_pendingCount :: Lens' Deployment (Maybe Int)
- deployment_id :: Lens' Deployment (Maybe Text)
- deployment_failedTasks :: Lens' Deployment (Maybe Int)
- deployment_launchType :: Lens' Deployment (Maybe LaunchType)
- deployment_updatedAt :: Lens' Deployment (Maybe UTCTime)
- deployment_taskDefinition :: Lens' Deployment (Maybe Text)
- deployment_rolloutStateReason :: Lens' Deployment (Maybe Text)
- deployment_networkConfiguration :: Lens' Deployment (Maybe NetworkConfiguration)
- deployment_capacityProviderStrategy :: Lens' Deployment (Maybe [CapacityProviderStrategyItem])
- deploymentCircuitBreaker_enable :: Lens' DeploymentCircuitBreaker Bool
- deploymentCircuitBreaker_rollback :: Lens' DeploymentCircuitBreaker Bool
- deploymentConfiguration_minimumHealthyPercent :: Lens' DeploymentConfiguration (Maybe Int)
- deploymentConfiguration_maximumPercent :: Lens' DeploymentConfiguration (Maybe Int)
- deploymentConfiguration_deploymentCircuitBreaker :: Lens' DeploymentConfiguration (Maybe DeploymentCircuitBreaker)
- deploymentController_type :: Lens' DeploymentController DeploymentControllerType
- device_containerPath :: Lens' Device (Maybe Text)
- device_permissions :: Lens' Device (Maybe [DeviceCgroupPermission])
- device_hostPath :: Lens' Device Text
- dockerVolumeConfiguration_driverOpts :: Lens' DockerVolumeConfiguration (Maybe (HashMap Text Text))
- dockerVolumeConfiguration_driver :: Lens' DockerVolumeConfiguration (Maybe Text)
- dockerVolumeConfiguration_scope :: Lens' DockerVolumeConfiguration (Maybe Scope)
- dockerVolumeConfiguration_labels :: Lens' DockerVolumeConfiguration (Maybe (HashMap Text Text))
- dockerVolumeConfiguration_autoprovision :: Lens' DockerVolumeConfiguration (Maybe Bool)
- eFSAuthorizationConfig_accessPointId :: Lens' EFSAuthorizationConfig (Maybe Text)
- eFSAuthorizationConfig_iam :: Lens' EFSAuthorizationConfig (Maybe EFSAuthorizationConfigIAM)
- eFSVolumeConfiguration_rootDirectory :: Lens' EFSVolumeConfiguration (Maybe Text)
- eFSVolumeConfiguration_transitEncryption :: Lens' EFSVolumeConfiguration (Maybe EFSTransitEncryption)
- eFSVolumeConfiguration_authorizationConfig :: Lens' EFSVolumeConfiguration (Maybe EFSAuthorizationConfig)
- eFSVolumeConfiguration_transitEncryptionPort :: Lens' EFSVolumeConfiguration (Maybe Int)
- eFSVolumeConfiguration_fileSystemId :: Lens' EFSVolumeConfiguration Text
- environmentFile_value :: Lens' EnvironmentFile Text
- environmentFile_type :: Lens' EnvironmentFile EnvironmentFileType
- ephemeralStorage_sizeInGiB :: Lens' EphemeralStorage Int
- executeCommandConfiguration_logConfiguration :: Lens' ExecuteCommandConfiguration (Maybe ExecuteCommandLogConfiguration)
- executeCommandConfiguration_kmsKeyId :: Lens' ExecuteCommandConfiguration (Maybe Text)
- executeCommandConfiguration_logging :: Lens' ExecuteCommandConfiguration (Maybe ExecuteCommandLogging)
- executeCommandLogConfiguration_cloudWatchLogGroupName :: Lens' ExecuteCommandLogConfiguration (Maybe Text)
- executeCommandLogConfiguration_s3KeyPrefix :: Lens' ExecuteCommandLogConfiguration (Maybe Text)
- executeCommandLogConfiguration_cloudWatchEncryptionEnabled :: Lens' ExecuteCommandLogConfiguration (Maybe Bool)
- executeCommandLogConfiguration_s3EncryptionEnabled :: Lens' ExecuteCommandLogConfiguration (Maybe Bool)
- executeCommandLogConfiguration_s3BucketName :: Lens' ExecuteCommandLogConfiguration (Maybe Text)
- fSxWindowsFileServerAuthorizationConfig_credentialsParameter :: Lens' FSxWindowsFileServerAuthorizationConfig Text
- fSxWindowsFileServerAuthorizationConfig_domain :: Lens' FSxWindowsFileServerAuthorizationConfig Text
- fSxWindowsFileServerVolumeConfiguration_fileSystemId :: Lens' FSxWindowsFileServerVolumeConfiguration Text
- fSxWindowsFileServerVolumeConfiguration_rootDirectory :: Lens' FSxWindowsFileServerVolumeConfiguration Text
- fSxWindowsFileServerVolumeConfiguration_authorizationConfig :: Lens' FSxWindowsFileServerVolumeConfiguration FSxWindowsFileServerAuthorizationConfig
- failure_arn :: Lens' Failure (Maybe Text)
- failure_reason :: Lens' Failure (Maybe Text)
- failure_detail :: Lens' Failure (Maybe Text)
- firelensConfiguration_options :: Lens' FirelensConfiguration (Maybe (HashMap Text Text))
- firelensConfiguration_type :: Lens' FirelensConfiguration FirelensConfigurationType
- healthCheck_startPeriod :: Lens' HealthCheck (Maybe Int)
- healthCheck_retries :: Lens' HealthCheck (Maybe Int)
- healthCheck_interval :: Lens' HealthCheck (Maybe Int)
- healthCheck_timeout :: Lens' HealthCheck (Maybe Int)
- healthCheck_command :: Lens' HealthCheck [Text]
- hostEntry_hostname :: Lens' HostEntry Text
- hostEntry_ipAddress :: Lens' HostEntry Text
- hostVolumeProperties_sourcePath :: Lens' HostVolumeProperties (Maybe Text)
- inferenceAccelerator_deviceName :: Lens' InferenceAccelerator Text
- inferenceAccelerator_deviceType :: Lens' InferenceAccelerator Text
- inferenceAcceleratorOverride_deviceName :: Lens' InferenceAcceleratorOverride (Maybe Text)
- inferenceAcceleratorOverride_deviceType :: Lens' InferenceAcceleratorOverride (Maybe Text)
- kernelCapabilities_drop :: Lens' KernelCapabilities (Maybe [Text])
- kernelCapabilities_add :: Lens' KernelCapabilities (Maybe [Text])
- keyValuePair_value :: Lens' KeyValuePair (Maybe Text)
- keyValuePair_name :: Lens' KeyValuePair (Maybe Text)
- linuxParameters_sharedMemorySize :: Lens' LinuxParameters (Maybe Int)
- linuxParameters_initProcessEnabled :: Lens' LinuxParameters (Maybe Bool)
- linuxParameters_tmpfs :: Lens' LinuxParameters (Maybe [Tmpfs])
- linuxParameters_swappiness :: Lens' LinuxParameters (Maybe Int)
- linuxParameters_devices :: Lens' LinuxParameters (Maybe [Device])
- linuxParameters_capabilities :: Lens' LinuxParameters (Maybe KernelCapabilities)
- linuxParameters_maxSwap :: Lens' LinuxParameters (Maybe Int)
- loadBalancer_loadBalancerName :: Lens' LoadBalancer (Maybe Text)
- loadBalancer_containerName :: Lens' LoadBalancer (Maybe Text)
- loadBalancer_targetGroupArn :: Lens' LoadBalancer (Maybe Text)
- loadBalancer_containerPort :: Lens' LoadBalancer (Maybe Int)
- logConfiguration_options :: Lens' LogConfiguration (Maybe (HashMap Text Text))
- logConfiguration_secretOptions :: Lens' LogConfiguration (Maybe [Secret])
- logConfiguration_logDriver :: Lens' LogConfiguration LogDriver
- managedAgent_lastStatus :: Lens' ManagedAgent (Maybe Text)
- managedAgent_reason :: Lens' ManagedAgent (Maybe Text)
- managedAgent_name :: Lens' ManagedAgent (Maybe ManagedAgentName)
- managedAgent_lastStartedAt :: Lens' ManagedAgent (Maybe UTCTime)
- managedAgentStateChange_reason :: Lens' ManagedAgentStateChange (Maybe Text)
- managedAgentStateChange_containerName :: Lens' ManagedAgentStateChange Text
- managedAgentStateChange_managedAgentName :: Lens' ManagedAgentStateChange ManagedAgentName
- managedAgentStateChange_status :: Lens' ManagedAgentStateChange Text
- managedScaling_status :: Lens' ManagedScaling (Maybe ManagedScalingStatus)
- managedScaling_maximumScalingStepSize :: Lens' ManagedScaling (Maybe Natural)
- managedScaling_targetCapacity :: Lens' ManagedScaling (Maybe Natural)
- managedScaling_minimumScalingStepSize :: Lens' ManagedScaling (Maybe Natural)
- managedScaling_instanceWarmupPeriod :: Lens' ManagedScaling (Maybe Natural)
- mountPoint_containerPath :: Lens' MountPoint (Maybe Text)
- mountPoint_sourceVolume :: Lens' MountPoint (Maybe Text)
- mountPoint_readOnly :: Lens' MountPoint (Maybe Bool)
- networkBinding_bindIP :: Lens' NetworkBinding (Maybe Text)
- networkBinding_protocol :: Lens' NetworkBinding (Maybe TransportProtocol)
- networkBinding_hostPort :: Lens' NetworkBinding (Maybe Int)
- networkBinding_containerPort :: Lens' NetworkBinding (Maybe Int)
- networkConfiguration_awsvpcConfiguration :: Lens' NetworkConfiguration (Maybe AwsVpcConfiguration)
- networkInterface_ipv6Address :: Lens' NetworkInterface (Maybe Text)
- networkInterface_privateIpv4Address :: Lens' NetworkInterface (Maybe Text)
- networkInterface_attachmentId :: Lens' NetworkInterface (Maybe Text)
- placementConstraint_expression :: Lens' PlacementConstraint (Maybe Text)
- placementConstraint_type :: Lens' PlacementConstraint (Maybe PlacementConstraintType)
- placementStrategy_field :: Lens' PlacementStrategy (Maybe Text)
- placementStrategy_type :: Lens' PlacementStrategy (Maybe PlacementStrategyType)
- platformDevice_id :: Lens' PlatformDevice Text
- platformDevice_type :: Lens' PlatformDevice PlatformDeviceType
- portMapping_protocol :: Lens' PortMapping (Maybe TransportProtocol)
- portMapping_hostPort :: Lens' PortMapping (Maybe Int)
- portMapping_containerPort :: Lens' PortMapping (Maybe Int)
- proxyConfiguration_type :: Lens' ProxyConfiguration (Maybe ProxyConfigurationType)
- proxyConfiguration_properties :: Lens' ProxyConfiguration (Maybe [KeyValuePair])
- proxyConfiguration_containerName :: Lens' ProxyConfiguration Text
- repositoryCredentials_credentialsParameter :: Lens' RepositoryCredentials Text
- resource_stringSetValue :: Lens' Resource (Maybe [Text])
- resource_integerValue :: Lens' Resource (Maybe Int)
- resource_doubleValue :: Lens' Resource (Maybe Double)
- resource_longValue :: Lens' Resource (Maybe Integer)
- resource_name :: Lens' Resource (Maybe Text)
- resource_type :: Lens' Resource (Maybe Text)
- resourceRequirement_value :: Lens' ResourceRequirement Text
- resourceRequirement_type :: Lens' ResourceRequirement ResourceType
- scale_value :: Lens' Scale (Maybe Double)
- scale_unit :: Lens' Scale (Maybe ScaleUnit)
- secret_name :: Lens' Secret Text
- secret_valueFrom :: Lens' Secret Text
- serviceEvent_createdAt :: Lens' ServiceEvent (Maybe UTCTime)
- serviceEvent_id :: Lens' ServiceEvent (Maybe Text)
- serviceEvent_message :: Lens' ServiceEvent (Maybe Text)
- serviceRegistry_registryArn :: Lens' ServiceRegistry (Maybe Text)
- serviceRegistry_containerName :: Lens' ServiceRegistry (Maybe Text)
- serviceRegistry_containerPort :: Lens' ServiceRegistry (Maybe Int)
- serviceRegistry_port :: Lens' ServiceRegistry (Maybe Int)
- session_streamUrl :: Lens' Session (Maybe Text)
- session_tokenValue :: Lens' Session (Maybe Text)
- session_sessionId :: Lens' Session (Maybe Text)
- setting_value :: Lens' Setting (Maybe Text)
- setting_name :: Lens' Setting (Maybe SettingName)
- setting_principalArn :: Lens' Setting (Maybe Text)
- systemControl_value :: Lens' SystemControl (Maybe Text)
- systemControl_namespace :: Lens' SystemControl (Maybe Text)
- tag_value :: Lens' Tag (Maybe Text)
- tag_key :: Lens' Tag (Maybe Text)
- task_stoppedAt :: Lens' Task (Maybe UTCTime)
- task_desiredStatus :: Lens' Task (Maybe Text)
- task_overrides :: Lens' Task (Maybe TaskOverride)
- task_inferenceAccelerators :: Lens' Task (Maybe [InferenceAccelerator])
- task_clusterArn :: Lens' Task (Maybe Text)
- task_group :: Lens' Task (Maybe Text)
- task_attachments :: Lens' Task (Maybe [Attachment])
- task_createdAt :: Lens' Task (Maybe UTCTime)
- task_stopCode :: Lens' Task (Maybe TaskStopCode)
- task_platformVersion :: Lens' Task (Maybe Text)
- task_taskArn :: Lens' Task (Maybe Text)
- task_containerInstanceArn :: Lens' Task (Maybe Text)
- task_executionStoppedAt :: Lens' Task (Maybe UTCTime)
- task_ephemeralStorage :: Lens' Task (Maybe EphemeralStorage)
- task_lastStatus :: Lens' Task (Maybe Text)
- task_memory :: Lens' Task (Maybe Text)
- task_pullStoppedAt :: Lens' Task (Maybe UTCTime)
- task_containers :: Lens' Task (Maybe [Container])
- task_startedAt :: Lens' Task (Maybe UTCTime)
- task_availabilityZone :: Lens' Task (Maybe Text)
- task_attributes :: Lens' Task (Maybe [Attribute])
- task_version :: Lens' Task (Maybe Integer)
- task_capacityProviderName :: Lens' Task (Maybe Text)
- task_startedBy :: Lens' Task (Maybe Text)
- task_stoppedReason :: Lens' Task (Maybe Text)
- task_connectivity :: Lens' Task (Maybe Connectivity)
- task_stoppingAt :: Lens' Task (Maybe UTCTime)
- task_launchType :: Lens' Task (Maybe LaunchType)
- task_taskDefinitionArn :: Lens' Task (Maybe Text)
- task_healthStatus :: Lens' Task (Maybe HealthStatus)
- task_connectivityAt :: Lens' Task (Maybe UTCTime)
- task_cpu :: Lens' Task (Maybe Text)
- task_enableExecuteCommand :: Lens' Task (Maybe Bool)
- task_pullStartedAt :: Lens' Task (Maybe UTCTime)
- task_tags :: Lens' Task (Maybe [Tag])
- taskDefinition_status :: Lens' TaskDefinition (Maybe TaskDefinitionStatus)
- taskDefinition_inferenceAccelerators :: Lens' TaskDefinition (Maybe [InferenceAccelerator])
- taskDefinition_executionRoleArn :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_requiresCompatibilities :: Lens' TaskDefinition (Maybe [Compatibility])
- taskDefinition_ephemeralStorage :: Lens' TaskDefinition (Maybe EphemeralStorage)
- taskDefinition_pidMode :: Lens' TaskDefinition (Maybe PidMode)
- taskDefinition_family :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_ipcMode :: Lens' TaskDefinition (Maybe IpcMode)
- taskDefinition_containerDefinitions :: Lens' TaskDefinition (Maybe [ContainerDefinition])
- taskDefinition_memory :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_proxyConfiguration :: Lens' TaskDefinition (Maybe ProxyConfiguration)
- taskDefinition_taskRoleArn :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_deregisteredAt :: Lens' TaskDefinition (Maybe UTCTime)
- taskDefinition_placementConstraints :: Lens' TaskDefinition (Maybe [TaskDefinitionPlacementConstraint])
- taskDefinition_registeredAt :: Lens' TaskDefinition (Maybe UTCTime)
- taskDefinition_networkMode :: Lens' TaskDefinition (Maybe NetworkMode)
- taskDefinition_taskDefinitionArn :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_compatibilities :: Lens' TaskDefinition (Maybe [Compatibility])
- taskDefinition_registeredBy :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_revision :: Lens' TaskDefinition (Maybe Int)
- taskDefinition_volumes :: Lens' TaskDefinition (Maybe [Volume])
- taskDefinition_cpu :: Lens' TaskDefinition (Maybe Text)
- taskDefinition_requiresAttributes :: Lens' TaskDefinition (Maybe [Attribute])
- taskDefinitionPlacementConstraint_expression :: Lens' TaskDefinitionPlacementConstraint (Maybe Text)
- taskDefinitionPlacementConstraint_type :: Lens' TaskDefinitionPlacementConstraint (Maybe TaskDefinitionPlacementConstraintType)
- taskOverride_containerOverrides :: Lens' TaskOverride (Maybe [ContainerOverride])
- taskOverride_executionRoleArn :: Lens' TaskOverride (Maybe Text)
- taskOverride_ephemeralStorage :: Lens' TaskOverride (Maybe EphemeralStorage)
- taskOverride_memory :: Lens' TaskOverride (Maybe Text)
- taskOverride_taskRoleArn :: Lens' TaskOverride (Maybe Text)
- taskOverride_inferenceAcceleratorOverrides :: Lens' TaskOverride (Maybe [InferenceAcceleratorOverride])
- taskOverride_cpu :: Lens' TaskOverride (Maybe Text)
- taskSet_runningCount :: Lens' TaskSet (Maybe Int)
- taskSet_status :: Lens' TaskSet (Maybe Text)
- taskSet_clusterArn :: Lens' TaskSet (Maybe Text)
- taskSet_computedDesiredCount :: Lens' TaskSet (Maybe Int)
- taskSet_createdAt :: Lens' TaskSet (Maybe UTCTime)
- taskSet_platformVersion :: Lens' TaskSet (Maybe Text)
- taskSet_scale :: Lens' TaskSet (Maybe Scale)
- taskSet_loadBalancers :: Lens' TaskSet (Maybe [LoadBalancer])
- taskSet_stabilityStatusAt :: Lens' TaskSet (Maybe UTCTime)
- taskSet_pendingCount :: Lens' TaskSet (Maybe Int)
- taskSet_taskSetArn :: Lens' TaskSet (Maybe Text)
- taskSet_startedBy :: Lens' TaskSet (Maybe Text)
- taskSet_id :: Lens' TaskSet (Maybe Text)
- taskSet_launchType :: Lens' TaskSet (Maybe LaunchType)
- taskSet_updatedAt :: Lens' TaskSet (Maybe UTCTime)
- taskSet_serviceArn :: Lens' TaskSet (Maybe Text)
- taskSet_taskDefinition :: Lens' TaskSet (Maybe Text)
- taskSet_externalId :: Lens' TaskSet (Maybe Text)
- taskSet_networkConfiguration :: Lens' TaskSet (Maybe NetworkConfiguration)
- taskSet_serviceRegistries :: Lens' TaskSet (Maybe [ServiceRegistry])
- taskSet_capacityProviderStrategy :: Lens' TaskSet (Maybe [CapacityProviderStrategyItem])
- taskSet_stabilityStatus :: Lens' TaskSet (Maybe StabilityStatus)
- taskSet_tags :: Lens' TaskSet (Maybe [Tag])
- tmpfs_mountOptions :: Lens' Tmpfs (Maybe [Text])
- tmpfs_containerPath :: Lens' Tmpfs Text
- tmpfs_size :: Lens' Tmpfs Int
- ulimit_name :: Lens' Ulimit UlimitName
- ulimit_softLimit :: Lens' Ulimit Int
- ulimit_hardLimit :: Lens' Ulimit Int
- versionInfo_agentHash :: Lens' VersionInfo (Maybe Text)
- versionInfo_agentVersion :: Lens' VersionInfo (Maybe Text)
- versionInfo_dockerVersion :: Lens' VersionInfo (Maybe Text)
- volume_dockerVolumeConfiguration :: Lens' Volume (Maybe DockerVolumeConfiguration)
- volume_fsxWindowsFileServerVolumeConfiguration :: Lens' Volume (Maybe FSxWindowsFileServerVolumeConfiguration)
- volume_name :: Lens' Volume (Maybe Text)
- volume_efsVolumeConfiguration :: Lens' Volume (Maybe EFSVolumeConfiguration)
- volume_host :: Lens' Volume (Maybe HostVolumeProperties)
- volumeFrom_sourceContainer :: Lens' VolumeFrom (Maybe Text)
- volumeFrom_readOnly :: Lens' VolumeFrom (Maybe Bool)
Operations
ListServices
listServices_cluster :: Lens' ListServices (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster to use
when filtering the ListServices
results. If you do not specify a
cluster, the default cluster is assumed.
listServices_nextToken :: Lens' ListServices (Maybe Text) Source #
The nextToken
value returned from a ListServices
request indicating
that more results are available to fulfill the request and further calls
will be needed. If maxResults
was provided, it is possible the number
of results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
listServices_launchType :: Lens' ListServices (Maybe LaunchType) Source #
The launch type to use when filtering the ListServices
results.
listServices_schedulingStrategy :: Lens' ListServices (Maybe SchedulingStrategy) Source #
The scheduling strategy to use when filtering the ListServices
results.
listServices_maxResults :: Lens' ListServices (Maybe Int) Source #
The maximum number of service results returned by ListServices
in
paginated output. When this parameter is used, ListServices
only
returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be
seen by sending another ListServices
request with the returned
nextToken
value. This value can be between 1 and 100. If this
parameter is not used, then ListServices
returns up to 10 results and
a nextToken
value if applicable.
listServicesResponse_serviceArns :: Lens' ListServicesResponse (Maybe [Text]) Source #
The list of full ARN entries for each service associated with the specified cluster.
listServicesResponse_nextToken :: Lens' ListServicesResponse (Maybe Text) Source #
The nextToken
value to include in a future ListServices
request.
When the results of a ListServices
request exceed maxResults
, this
value can be used to retrieve the next page of results. This value is
null
when there are no more results to return.
listServicesResponse_httpStatus :: Lens' ListServicesResponse Int Source #
The response's http status code.
DescribeClusters
describeClusters_include :: Lens' DescribeClusters (Maybe [ClusterField]) Source #
Whether to include additional information about the clusters in the response. If this field is omitted, this information isn't included.
If ATTACHMENTS
is specified, the attachments for the container
instances or tasks within the cluster are included.
If SETTINGS
is specified, the settings for the cluster are included.
If CONFIGURATIONS
is specified, the configuration for the cluster is
included.
If STATISTICS
is specified, the task and service count is included,
separated by launch type.
If TAGS
is specified, the metadata tags associated with the cluster
are included.
describeClusters_clusters :: Lens' DescribeClusters (Maybe [Text]) Source #
A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.
describeClustersResponse_failures :: Lens' DescribeClustersResponse (Maybe [Failure]) Source #
Any failures associated with the call.
describeClustersResponse_clusters :: Lens' DescribeClustersResponse (Maybe [Cluster]) Source #
The list of clusters.
describeClustersResponse_httpStatus :: Lens' DescribeClustersResponse Int Source #
The response's http status code.
DeleteService
deleteService_cluster :: Lens' DeleteService (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.
deleteService_force :: Lens' DeleteService (Maybe Bool) Source #
If true
, allows you to delete a service even if it has not been scaled
down to zero tasks. It is only necessary to use this if the service is
using the REPLICA
scheduling strategy.
deleteService_service :: Lens' DeleteService Text Source #
The name of the service to delete.
deleteServiceResponse_service :: Lens' DeleteServiceResponse (Maybe ContainerService) Source #
The full description of the deleted service.
deleteServiceResponse_httpStatus :: Lens' DeleteServiceResponse Int Source #
The response's http status code.
UpdateService
updateService_cluster :: Lens' UpdateService (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
updateService_platformVersion :: Lens' UpdateService (Maybe Text) Source #
The platform version on which your tasks in the service are running. A
platform version is only specified for tasks using the Fargate launch
type. If a platform version is not specified, the LATEST
platform
version is used by default. For more information, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
updateService_desiredCount :: Lens' UpdateService (Maybe Int) Source #
The number of instantiations of the task to place and keep running in your service.
updateService_placementConstraints :: Lens' UpdateService (Maybe [PlacementConstraint]) Source #
An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.
You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
updateService_placementStrategy :: Lens' UpdateService (Maybe [PlacementStrategy]) Source #
The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.
You can specify a maximum of five strategy rules per service.
updateService_forceNewDeployment :: Lens' UpdateService (Maybe Bool) Source #
Whether to force a new deployment of the service. Deployments are not
forced by default. You can use this option to trigger a new deployment
with no service definition changes. For example, you can update a
service's tasks to use a newer Docker image with the same image/tag
combination (my_image:latest
) or to roll Fargate tasks onto a newer
platform version.
updateService_taskDefinition :: Lens' UpdateService (Maybe Text) Source #
The family
and revision
(family:revision
) or full ARN of the task
definition to run in your service. If a revision
is not specified, the
latest ACTIVE
revision is used. If you modify the task definition with
UpdateService
, Amazon ECS spawns a task with the new version of the
task definition and then stops an old task after the new version is
running.
updateService_healthCheckGracePeriodSeconds :: Lens' UpdateService (Maybe Int) Source #
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
updateService_networkConfiguration :: Lens' UpdateService (Maybe NetworkConfiguration) Source #
An object representing the network configuration for the service.
updateService_capacityProviderStrategy :: Lens' UpdateService (Maybe [CapacityProviderStrategyItem]) Source #
The capacity provider strategy to update the service to use.
If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.
A capacity provider strategy consists of one or more capacity providers
along with the base
and weight
to assign to them. A capacity
provider must be associated with the cluster to be used in a capacity
provider strategy. The PutClusterCapacityProviders API is used to
associate a capacity provider with a cluster. Only capacity providers
with an ACTIVE
or UPDATING
status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New 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.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
updateService_enableExecuteCommand :: Lens' UpdateService (Maybe Bool) Source #
If true
, this enables execute command functionality on all task
containers.
If you do not want to override the value that was set when the service
was created, you can set this to null
when performing this action.
updateService_deploymentConfiguration :: Lens' UpdateService (Maybe DeploymentConfiguration) Source #
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
updateService_service :: Lens' UpdateService Text Source #
The name of the service to update.
updateServiceResponse_service :: Lens' UpdateServiceResponse (Maybe ContainerService) Source #
The full description of your service following the update call.
updateServiceResponse_httpStatus :: Lens' UpdateServiceResponse Int Source #
The response's http status code.
DiscoverPollEndpoint
discoverPollEndpoint_cluster :: Lens' DiscoverPollEndpoint (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance belongs.
discoverPollEndpoint_containerInstance :: Lens' DiscoverPollEndpoint (Maybe Text) Source #
The container instance ID or full ARN of the container instance. The ARN
contains the arn:aws:ecs
namespace, followed by the Region of the
container instance, the Amazon Web Services account ID of the container
instance owner, the container-instance
namespace, and then the
container instance ID. For example,
arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
discoverPollEndpointResponse_telemetryEndpoint :: Lens' DiscoverPollEndpointResponse (Maybe Text) Source #
The telemetry endpoint for the Amazon ECS agent.
discoverPollEndpointResponse_endpoint :: Lens' DiscoverPollEndpointResponse (Maybe Text) Source #
The endpoint for the Amazon ECS agent to poll.
discoverPollEndpointResponse_httpStatus :: Lens' DiscoverPollEndpointResponse Int Source #
The response's http status code.
SubmitAttachmentStateChanges
submitAttachmentStateChanges_cluster :: Lens' SubmitAttachmentStateChanges (Maybe Text) Source #
The short name or full ARN of the cluster that hosts the container instance the attachment belongs to.
submitAttachmentStateChanges_attachments :: Lens' SubmitAttachmentStateChanges [AttachmentStateChange] Source #
Any attachments associated with the state change request.
submitAttachmentStateChangesResponse_acknowledgment :: Lens' SubmitAttachmentStateChangesResponse (Maybe Text) Source #
Acknowledgement of the state change.
submitAttachmentStateChangesResponse_httpStatus :: Lens' SubmitAttachmentStateChangesResponse Int Source #
The response's http status code.
SubmitContainerStateChange
submitContainerStateChange_networkBindings :: Lens' SubmitContainerStateChange (Maybe [NetworkBinding]) Source #
The network bindings of the container.
submitContainerStateChange_status :: Lens' SubmitContainerStateChange (Maybe Text) Source #
The status of the state change request.
submitContainerStateChange_cluster :: Lens' SubmitContainerStateChange (Maybe Text) Source #
The short name or full ARN of the cluster that hosts the container.
submitContainerStateChange_containerName :: Lens' SubmitContainerStateChange (Maybe Text) Source #
The name of the container.
submitContainerStateChange_reason :: Lens' SubmitContainerStateChange (Maybe Text) Source #
The reason for the state change request.
submitContainerStateChange_exitCode :: Lens' SubmitContainerStateChange (Maybe Int) Source #
The exit code returned for the state change request.
submitContainerStateChange_task :: Lens' SubmitContainerStateChange (Maybe Text) Source #
The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.
submitContainerStateChange_runtimeId :: Lens' SubmitContainerStateChange (Maybe Text) Source #
The ID of the Docker container.
submitContainerStateChangeResponse_acknowledgment :: Lens' SubmitContainerStateChangeResponse (Maybe Text) Source #
Acknowledgement of the state change.
submitContainerStateChangeResponse_httpStatus :: Lens' SubmitContainerStateChangeResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #
The tags for the resource.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
StopTask
stopTask_cluster :: Lens' StopTask (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.
stopTask_reason :: Lens' StopTask (Maybe Text) Source #
An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.
stopTask_task :: Lens' StopTask Text Source #
The task ID or full Amazon Resource Name (ARN) of the task to stop.
stopTaskResponse_task :: Lens' StopTaskResponse (Maybe Task) Source #
The task that was stopped.
stopTaskResponse_httpStatus :: Lens' StopTaskResponse Int Source #
The response's http status code.
DescribeTaskDefinition
describeTaskDefinition_include :: Lens' DescribeTaskDefinition (Maybe [TaskDefinitionField]) Source #
Specifies whether to see the resource tags for the task definition. If
TAGS
is specified, the tags are included in the response. If this
field is omitted, tags are not included in the response.
describeTaskDefinition_taskDefinition :: Lens' DescribeTaskDefinition Text Source #
The family
for the latest ACTIVE
revision, family
and revision
(family:revision
) for a specific revision in the family, or full
Amazon Resource Name (ARN) of the task definition to describe.
describeTaskDefinitionResponse_taskDefinition :: Lens' DescribeTaskDefinitionResponse (Maybe TaskDefinition) Source #
The full task definition description.
describeTaskDefinitionResponse_tags :: Lens' DescribeTaskDefinitionResponse (Maybe [Tag]) Source #
The metadata that is applied to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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.
describeTaskDefinitionResponse_httpStatus :: Lens' DescribeTaskDefinitionResponse Int Source #
The response's http status code.
SubmitTaskStateChange
submitTaskStateChange_status :: Lens' SubmitTaskStateChange (Maybe Text) Source #
The status of the state change request.
submitTaskStateChange_managedAgents :: Lens' SubmitTaskStateChange (Maybe [ManagedAgentStateChange]) Source #
The details for the managed agent associated with the task.
submitTaskStateChange_cluster :: Lens' SubmitTaskStateChange (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.
submitTaskStateChange_attachments :: Lens' SubmitTaskStateChange (Maybe [AttachmentStateChange]) Source #
Any attachments associated with the state change request.
submitTaskStateChange_executionStoppedAt :: Lens' SubmitTaskStateChange (Maybe UTCTime) Source #
The Unix timestamp for when the task execution stopped.
submitTaskStateChange_pullStoppedAt :: Lens' SubmitTaskStateChange (Maybe UTCTime) Source #
The Unix timestamp for when the container image pull completed.
submitTaskStateChange_containers :: Lens' SubmitTaskStateChange (Maybe [ContainerStateChange]) Source #
Any containers associated with the state change request.
submitTaskStateChange_reason :: Lens' SubmitTaskStateChange (Maybe Text) Source #
The reason for the state change request.
submitTaskStateChange_task :: Lens' SubmitTaskStateChange (Maybe Text) Source #
The task ID or full ARN of the task in the state change request.
submitTaskStateChange_pullStartedAt :: Lens' SubmitTaskStateChange (Maybe UTCTime) Source #
The Unix timestamp for when the container image pull began.
submitTaskStateChangeResponse_acknowledgment :: Lens' SubmitTaskStateChangeResponse (Maybe Text) Source #
Acknowledgement of the state change.
submitTaskStateChangeResponse_httpStatus :: Lens' SubmitTaskStateChangeResponse Int Source #
The response's http status code.
DescribeContainerInstances
describeContainerInstances_include :: Lens' DescribeContainerInstances (Maybe [ContainerInstanceField]) Source #
Specifies whether you want to see the resource tags for the container
instance. If TAGS
is specified, the tags are included in the response.
If this field is omitted, tags are not included in the response.
describeContainerInstances_cluster :: Lens' DescribeContainerInstances (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.
describeContainerInstances_containerInstances :: Lens' DescribeContainerInstances [Text] Source #
A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
describeContainerInstancesResponse_failures :: Lens' DescribeContainerInstancesResponse (Maybe [Failure]) Source #
Any failures associated with the call.
describeContainerInstancesResponse_containerInstances :: Lens' DescribeContainerInstancesResponse (Maybe [ContainerInstance]) Source #
The list of container instances.
describeContainerInstancesResponse_httpStatus :: Lens' DescribeContainerInstancesResponse Int Source #
The response's http status code.
DescribeCapacityProviders
describeCapacityProviders_include :: Lens' DescribeCapacityProviders (Maybe [CapacityProviderField]) Source #
Specifies whether or not you want to see the resource tags for the
capacity provider. If TAGS
is specified, the tags are included in the
response. If this field is omitted, tags are not included in the
response.
describeCapacityProviders_nextToken :: Lens' DescribeCapacityProviders (Maybe Text) Source #
The nextToken
value returned from a previous paginated
DescribeCapacityProviders
request where maxResults
was used and the
results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
describeCapacityProviders_capacityProviders :: Lens' DescribeCapacityProviders (Maybe [Text]) Source #
The short name or full Amazon Resource Name (ARN) of one or more
capacity providers. Up to 100
capacity providers can be described in
an action.
describeCapacityProviders_maxResults :: Lens' DescribeCapacityProviders (Maybe Int) Source #
The maximum number of account setting results returned by
DescribeCapacityProviders
in paginated output. When this parameter is
used, DescribeCapacityProviders
only returns maxResults
results in a
single page along with a nextToken
response element. The remaining
results of the initial request can be seen by sending another
DescribeCapacityProviders
request with the returned nextToken
value.
This value can be between 1 and 10. If this parameter is not used, then
DescribeCapacityProviders
returns up to 10 results and a nextToken
value if applicable.
describeCapacityProvidersResponse_failures :: Lens' DescribeCapacityProvidersResponse (Maybe [Failure]) Source #
Any failures associated with the call.
describeCapacityProvidersResponse_nextToken :: Lens' DescribeCapacityProvidersResponse (Maybe Text) Source #
The nextToken
value to include in a future DescribeCapacityProviders
request. When the results of a DescribeCapacityProviders
request
exceed maxResults
, this value can be used to retrieve the next page of
results. This value is null
when there are no more results to return.
describeCapacityProvidersResponse_capacityProviders :: Lens' DescribeCapacityProvidersResponse (Maybe [CapacityProvider]) Source #
The list of capacity providers.
describeCapacityProvidersResponse_httpStatus :: Lens' DescribeCapacityProvidersResponse Int Source #
The response's http status code.
UpdateContainerInstancesState
updateContainerInstancesState_cluster :: Lens' UpdateContainerInstancesState (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.
updateContainerInstancesState_containerInstances :: Lens' UpdateContainerInstancesState [Text] Source #
A list of container instance IDs or full ARN entries.
updateContainerInstancesState_status :: Lens' UpdateContainerInstancesState ContainerInstanceStatus Source #
The container instance state with which to update the container
instance. The only valid values for this action are ACTIVE
and
DRAINING
. A container instance can only be updated to DRAINING
status once it has reached an ACTIVE
state. If a container instance is
in REGISTERING
, DEREGISTERING
, or REGISTRATION_FAILED
state you
can describe the container instance but will be unable to update the
container instance state.
updateContainerInstancesStateResponse_failures :: Lens' UpdateContainerInstancesStateResponse (Maybe [Failure]) Source #
Any failures associated with the call.
updateContainerInstancesStateResponse_containerInstances :: Lens' UpdateContainerInstancesStateResponse (Maybe [ContainerInstance]) Source #
The list of container instances.
updateContainerInstancesStateResponse_httpStatus :: Lens' UpdateContainerInstancesStateResponse Int Source #
The response's http status code.
DeleteCluster
deleteCluster_cluster :: Lens' DeleteCluster Text Source #
The short name or full Amazon Resource Name (ARN) of the cluster to delete.
deleteClusterResponse_cluster :: Lens' DeleteClusterResponse (Maybe Cluster) Source #
The full description of the deleted cluster.
deleteClusterResponse_httpStatus :: Lens' DeleteClusterResponse Int Source #
The response's http status code.
UpdateCluster
updateCluster_settings :: Lens' UpdateCluster (Maybe [ClusterSetting]) Source #
The cluster settings for your cluster.
updateCluster_configuration :: Lens' UpdateCluster (Maybe ClusterConfiguration) Source #
The execute command configuration for the cluster.
updateCluster_cluster :: Lens' UpdateCluster Text Source #
The name of the cluster to modify the settings for.
updateClusterResponse_cluster :: Lens' UpdateClusterResponse (Maybe Cluster) Source #
Details about the cluster.
updateClusterResponse_httpStatus :: Lens' UpdateClusterResponse Int Source #
The response's http status code.
CreateCluster
createCluster_defaultCapacityProviderStrategy :: Lens' CreateCluster (Maybe [CapacityProviderStrategyItem]) Source #
The capacity provider strategy to set as the default for the cluster. When a default capacity provider strategy is set for a cluster, when calling the RunTask or CreateService APIs with no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.
If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.
createCluster_settings :: Lens' CreateCluster (Maybe [ClusterSetting]) Source #
The setting to use when creating a cluster. This parameter is used to
enable CloudWatch Container Insights for a cluster. If this value is
specified, it will override the containerInsights
value set with
PutAccountSetting or PutAccountSettingDefault.
createCluster_clusterName :: Lens' CreateCluster (Maybe Text) Source #
The name of your cluster. If you do not specify a name for your cluster,
you create a cluster named default
. Up to 255 letters (uppercase and
lowercase), numbers, underscores, and hyphens are allowed.
createCluster_configuration :: Lens' CreateCluster (Maybe ClusterConfiguration) Source #
The execute command configuration for the cluster.
createCluster_capacityProviders :: Lens' CreateCluster (Maybe [Text]) Source #
The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. 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.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
createCluster_tags :: Lens' CreateCluster (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, both of which you define.
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.
createClusterResponse_cluster :: Lens' CreateClusterResponse (Maybe Cluster) Source #
The full description of your new cluster.
createClusterResponse_httpStatus :: Lens' CreateClusterResponse Int Source #
The response's http status code.
PutAccountSetting
putAccountSetting_principalArn :: Lens' PutAccountSetting (Maybe Text) Source #
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the account setting for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
Federated users assume the account setting of the root user and can't have explicit account settings set for them.
putAccountSetting_name :: Lens' PutAccountSetting SettingName Source #
The Amazon ECS resource name for which to modify the account setting. If
serviceLongArnFormat
is specified, the ARN for your Amazon ECS
services is affected. If taskLongArnFormat
is specified, the ARN and
resource ID for your Amazon ECS tasks is affected. If
containerInstanceLongArnFormat
is specified, the ARN and resource ID
for your Amazon ECS container instances is affected. If awsvpcTrunking
is specified, the elastic network interface (ENI) limit for your Amazon
ECS container instances is affected. If containerInsights
is
specified, the default setting for CloudWatch Container Insights for
your clusters is affected.
putAccountSetting_value :: Lens' PutAccountSetting Text Source #
The account setting value for the specified principal ARN. Accepted
values are enabled
and disabled
.
putAccountSettingResponse_setting :: Lens' PutAccountSettingResponse (Maybe Setting) Source #
The current account setting for a resource.
putAccountSettingResponse_httpStatus :: Lens' PutAccountSettingResponse Int Source #
The response's http status code.
DeleteAccountSetting
deleteAccountSetting_principalArn :: Lens' DeleteAccountSetting (Maybe Text) Source #
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it disables the account setting for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
deleteAccountSetting_name :: Lens' DeleteAccountSetting SettingName Source #
The resource name for which to disable the account setting. If
serviceLongArnFormat
is specified, the ARN for your Amazon ECS
services is affected. If taskLongArnFormat
is specified, the ARN and
resource ID for your Amazon ECS tasks is affected. If
containerInstanceLongArnFormat
is specified, the ARN and resource ID
for your Amazon ECS container instances is affected. If awsvpcTrunking
is specified, the ENI limit for your Amazon ECS container instances is
affected.
deleteAccountSettingResponse_setting :: Lens' DeleteAccountSettingResponse (Maybe Setting) Source #
The account setting for the specified principal ARN.
deleteAccountSettingResponse_httpStatus :: Lens' DeleteAccountSettingResponse Int Source #
The response's http status code.
ListTaskDefinitions
listTaskDefinitions_status :: Lens' ListTaskDefinitions (Maybe TaskDefinitionStatus) Source #
The task definition status with which to filter the
ListTaskDefinitions
results. By default, only ACTIVE
task
definitions are listed. By setting this parameter to INACTIVE
, you can
view task definitions that are INACTIVE
as long as an active task or
service still references them. If you paginate the resulting output, be
sure to keep the status
value constant in each subsequent request.
listTaskDefinitions_familyPrefix :: Lens' ListTaskDefinitions (Maybe Text) Source #
The full family name with which to filter the ListTaskDefinitions
results. Specifying a familyPrefix
limits the listed task definitions
to task definition revisions that belong to that family.
listTaskDefinitions_nextToken :: Lens' ListTaskDefinitions (Maybe Text) Source #
The nextToken
value returned from a ListTaskDefinitions
request
indicating that more results are available to fulfill the request and
further calls will be needed. If maxResults
was provided, it is
possible the number of results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
listTaskDefinitions_sort :: Lens' ListTaskDefinitions (Maybe SortOrder) Source #
The order in which to sort the results. Valid values are ASC
and
DESC
. By default (ASC
), task definitions are listed
lexicographically by family name and in ascending numerical order by
revision so that the newest task definitions in a family are listed
last. Setting this parameter to DESC
reverses the sort order on family
name and revision so that the newest task definitions in a family are
listed first.
listTaskDefinitions_maxResults :: Lens' ListTaskDefinitions (Maybe Int) Source #
The maximum number of task definition results returned by
ListTaskDefinitions
in paginated output. When this parameter is used,
ListTaskDefinitions
only returns maxResults
results in a single page
along with a nextToken
response element. The remaining results of the
initial request can be seen by sending another ListTaskDefinitions
request with the returned nextToken
value. This value can be between 1
and 100. If this parameter is not used, then ListTaskDefinitions
returns up to 100 results and a nextToken
value if applicable.
listTaskDefinitionsResponse_taskDefinitionArns :: Lens' ListTaskDefinitionsResponse (Maybe [Text]) Source #
The list of task definition Amazon Resource Name (ARN) entries for the
ListTaskDefinitions
request.
listTaskDefinitionsResponse_nextToken :: Lens' ListTaskDefinitionsResponse (Maybe Text) Source #
The nextToken
value to include in a future ListTaskDefinitions
request. When the results of a ListTaskDefinitions
request exceed
maxResults
, this value can be used to retrieve the next page of
results. This value is null
when there are no more results to return.
listTaskDefinitionsResponse_httpStatus :: Lens' ListTaskDefinitionsResponse Int Source #
The response's http status code.
RunTask
runTask_overrides :: Lens' RunTask (Maybe TaskOverride) Source #
A list of container overrides in JSON format that specify the name of a
container in the specified task definition and the overrides it should
receive. You can override the default command for a container (that is
specified in the task definition or Docker image) with a command
override. You can also override existing environment variables (that are
specified in the task definition or Docker image) on a container or add
new environment variables to it with an environment
override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
runTask_group :: Lens' RunTask (Maybe Text) Source #
The name of the task group to associate with the task. The default value
is the family name of the task definition (for example,
family:my-family-name
).
runTask_cluster :: Lens' RunTask (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.
runTask_propagateTags :: Lens' RunTask (Maybe PropagateTags) Source #
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
An error will be received if you specify the SERVICE
option when
running a task.
runTask_platformVersion :: Lens' RunTask (Maybe Text) Source #
The platform version the task should use. A platform version is only
specified for tasks hosted on Fargate. If one is not specified, the
LATEST
platform version is used by default. For more information, see
Fargate platform versions
in the Amazon Elastic Container Service Developer Guide.
runTask_enableECSManagedTags :: Lens' RunTask (Maybe Bool) Source #
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
runTask_count :: Lens' RunTask (Maybe Int) Source #
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.
runTask_referenceId :: Lens' RunTask (Maybe Text) Source #
The reference ID to use for the task. The reference ID can have a maximum length of 1024 characters.
runTask_placementConstraints :: Lens' RunTask (Maybe [PlacementConstraint]) Source #
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
runTask_placementStrategy :: Lens' RunTask (Maybe [PlacementStrategy]) Source #
The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per task.
runTask_startedBy :: Lens' RunTask (Maybe Text) Source #
An optional tag specified when a task is started. For example, if you
automatically trigger a task to run a batch process job, you could apply
a unique identifier for that job to your task with the startedBy
parameter. You can then identify which tasks belong to that job by
filtering the results of a ListTasks call with the startedBy
value. Up
to 36 letters (uppercase and lowercase), numbers, hyphens, and
underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy
parameter contains the deployment ID of the service that starts it.
runTask_launchType :: Lens' RunTask (Maybe LaunchType) Source #
The infrastructure on which to run your standalone task. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand
infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.
The EC2
launch type runs your tasks on Amazon EC2 instances registered
to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premise server or
virtual machine (VM) capacity registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If
a launchType
is specified, the capacityProviderStrategy
parameter
must be omitted.
When you use cluster auto scaling, you must specify
capacityProviderStrategy
and not launchType
.
runTask_networkConfiguration :: Lens' RunTask (Maybe NetworkConfiguration) Source #
The network configuration for the task. This parameter is required for
task definitions that use the awsvpc
network mode to receive their own
elastic network interface, and it is not supported for other network
modes. For more information, see
Task networking
in the Amazon Elastic Container Service Developer Guide.
runTask_capacityProviderStrategy :: Lens' RunTask (Maybe [CapacityProviderStrategyItem]) Source #
The capacity provider strategy to use for the task.
If a capacityProviderStrategy
is specified, the launchType
parameter
must be omitted. If no capacityProviderStrategy
or launchType
is
specified, the defaultCapacityProviderStrategy
for the cluster is
used.
When you use cluster auto scaling, you must specify
capacityProviderStrategy
and not launchType
.
A capacity provider strategy may contain a maximum of 6 capacity providers.
runTask_enableExecuteCommand :: Lens' RunTask (Maybe Bool) Source #
Whether or not to enable the execute command functionality for the
containers in this task. If true
, this enables execute command
functionality on all containers in the task.
runTask_tags :: Lens' RunTask (Maybe [Tag]) Source #
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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.
runTask_taskDefinition :: Lens' RunTask Text Source #
The family
and revision
(family:revision
) or full ARN of the task
definition to run. If a revision
is not specified, the latest ACTIVE
revision is used.
The full ARN value must match the value that you specified ias the
Resource
of the IAM principal's permissions policy. For example, if
the Resource
is
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*,
the taskDefinition
ARN value must be
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName
.
runTaskResponse_failures :: Lens' RunTaskResponse (Maybe [Failure]) Source #
Any failures associated with the call.
runTaskResponse_tasks :: Lens' RunTaskResponse (Maybe [Task]) Source #
A full description of the tasks that were run. The tasks that were successfully placed on your cluster are described here.
runTaskResponse_httpStatus :: Lens' RunTaskResponse Int Source #
The response's http status code.
DeleteCapacityProvider
deleteCapacityProvider_capacityProvider :: Lens' DeleteCapacityProvider Text Source #
The short name or full Amazon Resource Name (ARN) of the capacity provider to delete.
deleteCapacityProviderResponse_capacityProvider :: Lens' DeleteCapacityProviderResponse (Maybe CapacityProvider) Source #
The details of the capacity provider.
deleteCapacityProviderResponse_httpStatus :: Lens' DeleteCapacityProviderResponse Int Source #
The response's http status code.
ListTasks
listTasks_desiredStatus :: Lens' ListTasks (Maybe DesiredStatus) Source #
The task desired status to use when filtering the ListTasks
results.
Specifying a desiredStatus
of STOPPED
limits the results to tasks
that Amazon ECS has set the desired status to STOPPED
. This can be
useful for debugging tasks that are not starting properly or have died
or finished. The default status filter is RUNNING
, which shows tasks
that Amazon ECS has set the desired status to RUNNING
.
Although you can filter results based on a desired status of PENDING
,
this does not return any results. Amazon ECS never sets the desired
status of a task to that value (only a task's lastStatus
may have a
value of PENDING
).
listTasks_cluster :: Lens' ListTasks (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster to use
when filtering the ListTasks
results. If you do not specify a cluster,
the default cluster is assumed.
listTasks_family :: Lens' ListTasks (Maybe Text) Source #
The name of the task definition family to use when filtering the
ListTasks
results. Specifying a family
limits the results to tasks
that belong to that family.
listTasks_nextToken :: Lens' ListTasks (Maybe Text) Source #
The nextToken
value returned from a ListTasks
request indicating
that more results are available to fulfill the request and further calls
will be needed. If maxResults
was provided, it is possible the number
of results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
listTasks_startedBy :: Lens' ListTasks (Maybe Text) Source #
The startedBy
value with which to filter the task results. Specifying
a startedBy
value limits the results to tasks that were started with
that value.
listTasks_serviceName :: Lens' ListTasks (Maybe Text) Source #
The name of the service to use when filtering the ListTasks
results.
Specifying a serviceName
limits the results to tasks that belong to
that service.
listTasks_launchType :: Lens' ListTasks (Maybe LaunchType) Source #
The launch type to use when filtering the ListTasks
results.
listTasks_containerInstance :: Lens' ListTasks (Maybe Text) Source #
The container instance ID or full ARN of the container instance to use
when filtering the ListTasks
results. Specifying a containerInstance
limits the results to tasks that belong to that container instance.
listTasks_maxResults :: Lens' ListTasks (Maybe Int) Source #
The maximum number of task results returned by ListTasks
in paginated
output. When this parameter is used, ListTasks
only returns
maxResults
results in a single page along with a nextToken
response
element. The remaining results of the initial request can be seen by
sending another ListTasks
request with the returned nextToken
value.
This value can be between 1 and 100. If this parameter is not used, then
ListTasks
returns up to 100 results and a nextToken
value if
applicable.
listTasksResponse_nextToken :: Lens' ListTasksResponse (Maybe Text) Source #
The nextToken
value to include in a future ListTasks
request. When
the results of a ListTasks
request exceed maxResults
, this value can
be used to retrieve the next page of results. This value is null
when
there are no more results to return.
listTasksResponse_taskArns :: Lens' ListTasksResponse (Maybe [Text]) Source #
The list of task ARN entries for the ListTasks
request.
listTasksResponse_httpStatus :: Lens' ListTasksResponse Int Source #
The response's http status code.
UpdateCapacityProvider
updateCapacityProvider_name :: Lens' UpdateCapacityProvider Text Source #
The name of the capacity provider to update.
updateCapacityProvider_autoScalingGroupProvider :: Lens' UpdateCapacityProvider AutoScalingGroupProviderUpdate Source #
An object representing the parameters to update for the Auto Scaling group capacity provider.
updateCapacityProviderResponse_capacityProvider :: Lens' UpdateCapacityProviderResponse (Maybe CapacityProvider) Source #
Details about the capacity provider.
updateCapacityProviderResponse_httpStatus :: Lens' UpdateCapacityProviderResponse Int Source #
The response's http status code.
RegisterContainerInstance
registerContainerInstance_platformDevices :: Lens' RegisterContainerInstance (Maybe [PlatformDevice]) Source #
The devices that are available on the container instance. The only supported device type is a GPU.
registerContainerInstance_instanceIdentityDocumentSignature :: Lens' RegisterContainerInstance (Maybe Text) Source #
The instance identity document signature for the EC2 instance to
register. This signature can be found by running the following command
from the instance:
curl http://169.254.169.254/latest/dynamic/instance-identity/signature/
registerContainerInstance_cluster :: Lens' RegisterContainerInstance (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance. If you do not specify a cluster, the default cluster is assumed.
registerContainerInstance_instanceIdentityDocument :: Lens' RegisterContainerInstance (Maybe Text) Source #
The instance identity document for the EC2 instance to register. This
document can be found by running the following command from the
instance:
curl http://169.254.169.254/latest/dynamic/instance-identity/document/
registerContainerInstance_containerInstanceArn :: Lens' RegisterContainerInstance (Maybe Text) Source #
The ARN of the container instance (if it was previously registered).
registerContainerInstance_versionInfo :: Lens' RegisterContainerInstance (Maybe VersionInfo) Source #
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
registerContainerInstance_attributes :: Lens' RegisterContainerInstance (Maybe [Attribute]) Source #
The container instance attributes that this container instance supports.
registerContainerInstance_totalResources :: Lens' RegisterContainerInstance (Maybe [Resource]) Source #
The resources available on the instance.
registerContainerInstance_tags :: Lens' RegisterContainerInstance (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, both of which you define.
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.
registerContainerInstanceResponse_containerInstance :: Lens' RegisterContainerInstanceResponse (Maybe ContainerInstance) Source #
The container instance that was registered.
registerContainerInstanceResponse_httpStatus :: Lens' RegisterContainerInstanceResponse Int Source #
The response's http status code.
UpdateContainerAgent
updateContainerAgent_cluster :: Lens' UpdateContainerAgent (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.
updateContainerAgent_containerInstance :: Lens' UpdateContainerAgent Text Source #
The container instance ID or full ARN entries for the container instance on which you would like to update the Amazon ECS container agent.
updateContainerAgentResponse_containerInstance :: Lens' UpdateContainerAgentResponse (Maybe ContainerInstance) Source #
The container instance for which the container agent was updated.
updateContainerAgentResponse_httpStatus :: Lens' UpdateContainerAgentResponse Int Source #
The response's http status code.
ListContainerInstances
listContainerInstances_status :: Lens' ListContainerInstances (Maybe ContainerInstanceStatus) Source #
Filters the container instances by status. For example, if you specify
the DRAINING
status, the results include only container instances that
have been set to DRAINING
using UpdateContainerInstancesState. If you
do not specify this parameter, the default is to include container
instances set to all states other than INACTIVE
.
listContainerInstances_cluster :: Lens' ListContainerInstances (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.
listContainerInstances_nextToken :: Lens' ListContainerInstances (Maybe Text) Source #
The nextToken
value returned from a ListContainerInstances
request
indicating that more results are available to fulfill the request and
further calls will be needed. If maxResults
was provided, it is
possible the number of results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
listContainerInstances_filter :: Lens' ListContainerInstances (Maybe Text) Source #
You can filter the results of a ListContainerInstances
operation with
cluster query language statements. For more information, see
Cluster Query Language
in the Amazon Elastic Container Service Developer Guide.
listContainerInstances_maxResults :: Lens' ListContainerInstances (Maybe Int) Source #
The maximum number of container instance results returned by
ListContainerInstances
in paginated output. When this parameter is
used, ListContainerInstances
only returns maxResults
results in a
single page along with a nextToken
response element. The remaining
results of the initial request can be seen by sending another
ListContainerInstances
request with the returned nextToken
value.
This value can be between 1 and 100. If this parameter is not used, then
ListContainerInstances
returns up to 100 results and a nextToken
value if applicable.
listContainerInstancesResponse_containerInstanceArns :: Lens' ListContainerInstancesResponse (Maybe [Text]) Source #
The list of container instances with full ARN entries for each container instance associated with the specified cluster.
listContainerInstancesResponse_nextToken :: Lens' ListContainerInstancesResponse (Maybe Text) Source #
The nextToken
value to include in a future ListContainerInstances
request. When the results of a ListContainerInstances
request exceed
maxResults
, this value can be used to retrieve the next page of
results. This value is null
when there are no more results to return.
listContainerInstancesResponse_httpStatus :: Lens' ListContainerInstancesResponse Int Source #
The response's http status code.
UpdateServicePrimaryTaskSet
updateServicePrimaryTaskSet_cluster :: Lens' UpdateServicePrimaryTaskSet Text Source #
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.
updateServicePrimaryTaskSet_service :: Lens' UpdateServicePrimaryTaskSet Text Source #
The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
updateServicePrimaryTaskSet_primaryTaskSet :: Lens' UpdateServicePrimaryTaskSet Text Source #
The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment.
updateServicePrimaryTaskSetResponse_taskSet :: Lens' UpdateServicePrimaryTaskSetResponse (Maybe TaskSet) Source #
Details about the task set.
updateServicePrimaryTaskSetResponse_httpStatus :: Lens' UpdateServicePrimaryTaskSetResponse Int Source #
The response's http status code.
ListTaskDefinitionFamilies
listTaskDefinitionFamilies_status :: Lens' ListTaskDefinitionFamilies (Maybe TaskDefinitionFamilyStatus) Source #
The task definition family status with which to filter the
ListTaskDefinitionFamilies
results. By default, both ACTIVE
and
INACTIVE
task definition families are listed. If this parameter is set
to ACTIVE
, only task definition families that have an ACTIVE
task
definition revision are returned. If this parameter is set to
INACTIVE
, only task definition families that do not have any ACTIVE
task definition revisions are returned. If you paginate the resulting
output, be sure to keep the status
value constant in each subsequent
request.
listTaskDefinitionFamilies_familyPrefix :: Lens' ListTaskDefinitionFamilies (Maybe Text) Source #
The familyPrefix
is a string that is used to filter the results of
ListTaskDefinitionFamilies
. If you specify a familyPrefix
, only task
definition family names that begin with the familyPrefix
string are
returned.
listTaskDefinitionFamilies_nextToken :: Lens' ListTaskDefinitionFamilies (Maybe Text) Source #
The nextToken
value returned from a ListTaskDefinitionFamilies
request indicating that more results are available to fulfill the
request and further calls will be needed. If maxResults
was provided,
it is possible the number of results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
listTaskDefinitionFamilies_maxResults :: Lens' ListTaskDefinitionFamilies (Maybe Int) Source #
The maximum number of task definition family results returned by
ListTaskDefinitionFamilies
in paginated output. When this parameter is
used, ListTaskDefinitions
only returns maxResults
results in a
single page along with a nextToken
response element. The remaining
results of the initial request can be seen by sending another
ListTaskDefinitionFamilies
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not
used, then ListTaskDefinitionFamilies
returns up to 100 results and a
nextToken
value if applicable.
listTaskDefinitionFamiliesResponse_families :: Lens' ListTaskDefinitionFamiliesResponse (Maybe [Text]) Source #
The list of task definition family names that match the
ListTaskDefinitionFamilies
request.
listTaskDefinitionFamiliesResponse_nextToken :: Lens' ListTaskDefinitionFamiliesResponse (Maybe Text) Source #
The nextToken
value to include in a future
ListTaskDefinitionFamilies
request. When the results of a
ListTaskDefinitionFamilies
request exceed maxResults
, this value can
be used to retrieve the next page of results. This value is null
when
there are no more results to return.
listTaskDefinitionFamiliesResponse_httpStatus :: Lens' ListTaskDefinitionFamiliesResponse Int Source #
The response's http status code.
StartTask
startTask_overrides :: Lens' StartTask (Maybe TaskOverride) Source #
A list of container overrides in JSON format that specify the name of a
container in the specified task definition and the overrides it should
receive. You can override the default command for a container (that is
specified in the task definition or Docker image) with a command
override. You can also override existing environment variables (that are
specified in the task definition or Docker image) on a container or add
new environment variables to it with an environment
override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
startTask_group :: Lens' StartTask (Maybe Text) Source #
The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).
startTask_cluster :: Lens' StartTask (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.
startTask_propagateTags :: Lens' StartTask (Maybe PropagateTags) Source #
Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
startTask_enableECSManagedTags :: Lens' StartTask (Maybe Bool) Source #
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
startTask_startedBy :: Lens' StartTask (Maybe Text) Source #
An optional tag specified when a task is started. For example, if you
automatically trigger a task to run a batch process job, you could apply
a unique identifier for that job to your task with the startedBy
parameter. You can then identify which tasks belong to that job by
filtering the results of a ListTasks call with the startedBy
value. Up
to 36 letters (uppercase and lowercase), numbers, hyphens, and
underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy
parameter contains the deployment ID of the service that starts it.
startTask_networkConfiguration :: Lens' StartTask (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.
startTask_enableExecuteCommand :: Lens' StartTask (Maybe Bool) Source #
Whether or not the execute command functionality is enabled for the
task. If true
, this enables execute command functionality on all
containers in the task.
startTask_tags :: Lens' StartTask (Maybe [Tag]) Source #
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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.
startTask_containerInstances :: Lens' StartTask [Text] Source #
The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.
startTask_taskDefinition :: Lens' StartTask Text Source #
The family
and revision
(family:revision
) or full ARN of the task
definition to start. If a revision
is not specified, the latest
ACTIVE
revision is used.
startTaskResponse_failures :: Lens' StartTaskResponse (Maybe [Failure]) Source #
Any failures associated with the call.
startTaskResponse_tasks :: Lens' StartTaskResponse (Maybe [Task]) Source #
A full description of the tasks that were started. Each task that was successfully placed on your container instances is described.
startTaskResponse_httpStatus :: Lens' StartTaskResponse Int Source #
The response's http status code.
PutClusterCapacityProviders
putClusterCapacityProviders_cluster :: Lens' PutClusterCapacityProviders Text Source #
The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you do not specify a cluster, the default cluster is assumed.
putClusterCapacityProviders_capacityProviders :: Lens' PutClusterCapacityProviders [Text] Source #
The name of one or more capacity providers to associate with the cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New 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.
putClusterCapacityProviders_defaultCapacityProviderStrategy :: Lens' PutClusterCapacityProviders [CapacityProviderStrategyItem] Source #
The capacity provider strategy to use by default for the cluster.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.
A capacity provider strategy consists of one or more capacity providers
along with the base
and weight
to assign to them. A capacity
provider must be associated with the cluster to be used in a capacity
provider strategy. The PutClusterCapacityProviders API is used to
associate a capacity provider with a cluster. Only capacity providers
with an ACTIVE
or UPDATING
status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New 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.
putClusterCapacityProvidersResponse_cluster :: Lens' PutClusterCapacityProvidersResponse (Maybe Cluster) Source #
Details about the cluster.
putClusterCapacityProvidersResponse_httpStatus :: Lens' PutClusterCapacityProvidersResponse Int Source #
The response's http status code.
PutAccountSettingDefault
putAccountSettingDefault_name :: Lens' PutAccountSettingDefault SettingName Source #
The resource name for which to modify the account setting. If
serviceLongArnFormat
is specified, the ARN for your Amazon ECS
services is affected. If taskLongArnFormat
is specified, the ARN and
resource ID for your Amazon ECS tasks is affected. If
containerInstanceLongArnFormat
is specified, the ARN and resource ID
for your Amazon ECS container instances is affected. If awsvpcTrunking
is specified, the ENI limit for your Amazon ECS container instances is
affected. If containerInsights
is specified, the default setting for
CloudWatch Container Insights for your clusters is affected.
putAccountSettingDefault_value :: Lens' PutAccountSettingDefault Text Source #
The account setting value for the specified principal ARN. Accepted
values are enabled
and disabled
.
putAccountSettingDefaultResponse_setting :: Lens' PutAccountSettingDefaultResponse (Maybe Setting) Source #
The current setting for a resource.
putAccountSettingDefaultResponse_httpStatus :: Lens' PutAccountSettingDefaultResponse Int Source #
The response's http status code.
ListAttributes
listAttributes_attributeValue :: Lens' ListAttributes (Maybe Text) Source #
The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.
listAttributes_cluster :: Lens' ListAttributes (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.
listAttributes_nextToken :: Lens' ListAttributes (Maybe Text) Source #
The nextToken
value returned from a ListAttributes
request
indicating that more results are available to fulfill the request and
further calls will be needed. If maxResults
was provided, it is
possible the number of results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
listAttributes_attributeName :: Lens' ListAttributes (Maybe Text) Source #
The name of the attribute with which to filter the results.
listAttributes_maxResults :: Lens' ListAttributes (Maybe Int) Source #
The maximum number of cluster results returned by ListAttributes
in
paginated output. When this parameter is used, ListAttributes
only
returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be
seen by sending another ListAttributes
request with the returned
nextToken
value. This value can be between 1 and 100. If this
parameter is not used, then ListAttributes
returns up to 100 results
and a nextToken
value if applicable.
listAttributes_targetType :: Lens' ListAttributes TargetType Source #
The type of the target with which to list attributes.
listAttributesResponse_nextToken :: Lens' ListAttributesResponse (Maybe Text) Source #
The nextToken
value to include in a future ListAttributes
request.
When the results of a ListAttributes
request exceed maxResults
, this
value can be used to retrieve the next page of results. This value is
null
when there are no more results to return.
listAttributesResponse_attributes :: Lens' ListAttributesResponse (Maybe [Attribute]) Source #
A list of attribute objects that meet the criteria of the request.
listAttributesResponse_httpStatus :: Lens' ListAttributesResponse Int Source #
The response's http status code.
ExecuteCommand
executeCommand_cluster :: Lens' ExecuteCommand (Maybe Text) Source #
The Amazon Resource Name (ARN) or short name of the cluster the task is running in. If you do not specify a cluster, the default cluster is assumed.
executeCommand_container :: Lens' ExecuteCommand (Maybe Text) Source #
The name of the container to execute the command on. A container name only needs to be specified for tasks containing multiple containers.
executeCommand_command :: Lens' ExecuteCommand Text Source #
The command to run on the container.
executeCommand_interactive :: Lens' ExecuteCommand Bool Source #
Use this flag to run your command in interactive mode.
executeCommand_task :: Lens' ExecuteCommand Text Source #
The Amazon Resource Name (ARN) or ID of the task the container is part of.
executeCommandResponse_clusterArn :: Lens' ExecuteCommandResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the cluster.
executeCommandResponse_containerArn :: Lens' ExecuteCommandResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the container.
executeCommandResponse_taskArn :: Lens' ExecuteCommandResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the task.
executeCommandResponse_containerName :: Lens' ExecuteCommandResponse (Maybe Text) Source #
The name of the container.
executeCommandResponse_interactive :: Lens' ExecuteCommandResponse (Maybe Bool) Source #
Whether or not the execute command session is running in interactive
mode. Amazon ECS only supports initiating interactive sessions, so you
must specify true
for this value.
executeCommandResponse_session :: Lens' ExecuteCommandResponse (Maybe Session) Source #
The details of the SSM session that was created for this instance of execute-command.
executeCommandResponse_httpStatus :: Lens' ExecuteCommandResponse Int Source #
The response's http status code.
DeregisterTaskDefinition
deregisterTaskDefinition_taskDefinition :: Lens' DeregisterTaskDefinition Text Source #
The family
and revision
(family:revision
) or full Amazon Resource
Name (ARN) of the task definition to deregister. You must specify a
revision
.
deregisterTaskDefinitionResponse_taskDefinition :: Lens' DeregisterTaskDefinitionResponse (Maybe TaskDefinition) Source #
The full description of the deregistered task.
deregisterTaskDefinitionResponse_httpStatus :: Lens' DeregisterTaskDefinitionResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.
tagResource_tags :: Lens' TagResource [Tag] Source #
The tags to add to the resource. A tag is an array of key-value pairs.
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.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
CreateTaskSet
createTaskSet_clientToken :: Lens' CreateTaskSet (Maybe Text) Source #
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
createTaskSet_platformVersion :: Lens' CreateTaskSet (Maybe Text) Source #
The platform version that the tasks in the task set should use. A
platform version is specified only for tasks using the Fargate launch
type. If one isn't specified, the LATEST
platform version is used by
default.
createTaskSet_scale :: Lens' CreateTaskSet (Maybe Scale) Source #
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
createTaskSet_loadBalancers :: Lens' CreateTaskSet (Maybe [LoadBalancer]) Source #
A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.
createTaskSet_launchType :: Lens' CreateTaskSet (Maybe LaunchType) Source #
The launch type that new tasks in the task set will use. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
If a launchType
is specified, the capacityProviderStrategy
parameter
must be omitted.
createTaskSet_externalId :: Lens' CreateTaskSet (Maybe Text) Source #
An optional non-unique tag that identifies this task set in external
systems. If the task set is associated with a service discovery
registry, the tasks in this task set will have the
ECS_TASK_SET_EXTERNAL_ID
Cloud Map attribute set to the provided
value.
createTaskSet_networkConfiguration :: Lens' CreateTaskSet (Maybe NetworkConfiguration) Source #
An object representing the network configuration for a task set.
createTaskSet_serviceRegistries :: Lens' CreateTaskSet (Maybe [ServiceRegistry]) Source #
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.
createTaskSet_capacityProviderStrategy :: Lens' CreateTaskSet (Maybe [CapacityProviderStrategyItem]) Source #
The capacity provider strategy to use for the task set.
A capacity provider strategy consists of one or more capacity providers
along with the base
and weight
to assign to them. A capacity
provider must be associated with the cluster to be used in a capacity
provider strategy. The PutClusterCapacityProviders API is used to
associate a capacity provider with a cluster. Only capacity providers
with an ACTIVE
or UPDATING
status can be used.
If a capacityProviderStrategy
is specified, the launchType
parameter
must be omitted. If no capacityProviderStrategy
or launchType
is
specified, the defaultCapacityProviderStrategy
for the cluster is
used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New 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.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
createTaskSet_tags :: Lens' CreateTaskSet (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, both of which you define. When a service is deleted, the tags are deleted as well.
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.
createTaskSet_service :: Lens' CreateTaskSet Text Source #
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
createTaskSet_cluster :: Lens' CreateTaskSet Text Source #
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
createTaskSet_taskDefinition :: Lens' CreateTaskSet Text Source #
The task definition for the tasks in the task set to use.
createTaskSetResponse_taskSet :: Lens' CreateTaskSetResponse (Maybe TaskSet) Source #
Information about a set of Amazon ECS tasks in either an CodeDeploy or
an EXTERNAL
deployment. A task set includes details such as the
desired number of tasks, how many tasks are running, and whether the
task set serves production traffic.
createTaskSetResponse_httpStatus :: Lens' CreateTaskSetResponse Int Source #
The response's http status code.
DescribeTasks
describeTasks_include :: Lens' DescribeTasks (Maybe [TaskField]) Source #
Specifies whether you want to see the resource tags for the task. If
TAGS
is specified, the tags are included in the response. If this
field is omitted, tags are not included in the response.
describeTasks_cluster :: Lens' DescribeTasks (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.
describeTasks_tasks :: Lens' DescribeTasks [Text] Source #
A list of up to 100 task IDs or full ARN entries.
describeTasksResponse_failures :: Lens' DescribeTasksResponse (Maybe [Failure]) Source #
Any failures associated with the call.
describeTasksResponse_tasks :: Lens' DescribeTasksResponse (Maybe [Task]) Source #
The list of tasks.
describeTasksResponse_httpStatus :: Lens' DescribeTasksResponse Int Source #
The response's http status code.
ListClusters
listClusters_nextToken :: Lens' ListClusters (Maybe Text) Source #
The nextToken
value returned from a ListClusters
request indicating
that more results are available to fulfill the request and further calls
will be needed. If maxResults
was provided, it is possible the number
of results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
listClusters_maxResults :: Lens' ListClusters (Maybe Int) Source #
The maximum number of cluster results returned by ListClusters
in
paginated output. When this parameter is used, ListClusters
only
returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be
seen by sending another ListClusters
request with the returned
nextToken
value. This value can be between 1 and 100. If this
parameter is not used, then ListClusters
returns up to 100 results and
a nextToken
value if applicable.
listClustersResponse_clusterArns :: Lens' ListClustersResponse (Maybe [Text]) Source #
The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.
listClustersResponse_nextToken :: Lens' ListClustersResponse (Maybe Text) Source #
The nextToken
value to include in a future ListClusters
request.
When the results of a ListClusters
request exceed maxResults
, this
value can be used to retrieve the next page of results. This value is
null
when there are no more results to return.
listClustersResponse_httpStatus :: Lens' ListClustersResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.
untagResource_tagKeys :: Lens' UntagResource [Text] Source #
The keys of the tags to be removed.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
DescribeServices
describeServices_include :: Lens' DescribeServices (Maybe [ServiceField]) Source #
Specifies whether you want to see the resource tags for the service. If
TAGS
is specified, the tags are included in the response. If this
field is omitted, tags are not included in the response.
describeServices_cluster :: Lens' DescribeServices (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were launched in any cluster other than the default cluster.
describeServices_services :: Lens' DescribeServices [Text] Source #
A list of services to describe. You may specify up to 10 services to describe in a single operation.
describeServicesResponse_failures :: Lens' DescribeServicesResponse (Maybe [Failure]) Source #
Any failures associated with the call.
describeServicesResponse_services :: Lens' DescribeServicesResponse (Maybe [ContainerService]) Source #
The list of services described.
describeServicesResponse_httpStatus :: Lens' DescribeServicesResponse Int Source #
The response's http status code.
DeregisterContainerInstance
deregisterContainerInstance_cluster :: Lens' DeregisterContainerInstance (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.
deregisterContainerInstance_force :: Lens' DeregisterContainerInstance (Maybe Bool) Source #
Forces the deregistration of the container instance. If you have tasks
running on the container instance when you deregister it with the
force
option, these tasks remain running until you terminate the
instance or the tasks stop through some other means, but they are
orphaned (no longer monitored or accounted for by Amazon ECS). If an
orphaned task on your container instance is part of an Amazon ECS
service, then the service scheduler starts another copy of that task, on
a different container instance if possible.
Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.
deregisterContainerInstance_containerInstance :: Lens' DeregisterContainerInstance Text Source #
The container instance ID or full ARN of the container instance to
deregister. The ARN contains the arn:aws:ecs
namespace, followed by
the Region of the container instance, the Amazon Web Services account ID
of the container instance owner, the container-instance
namespace, and
then the container instance ID. For example,
arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
deregisterContainerInstanceResponse_containerInstance :: Lens' DeregisterContainerInstanceResponse (Maybe ContainerInstance) Source #
The container instance that was deregistered.
deregisterContainerInstanceResponse_httpStatus :: Lens' DeregisterContainerInstanceResponse Int Source #
The response's http status code.
UpdateClusterSettings
updateClusterSettings_cluster :: Lens' UpdateClusterSettings Text Source #
The name of the cluster to modify the settings for.
updateClusterSettings_settings :: Lens' UpdateClusterSettings [ClusterSetting] Source #
The setting to use by default for a cluster. This parameter is used to
enable CloudWatch Container Insights for a cluster. If this value is
specified, it will override the containerInsights
value set with
PutAccountSetting or PutAccountSettingDefault.
updateClusterSettingsResponse_cluster :: Lens' UpdateClusterSettingsResponse (Maybe Cluster) Source #
Details about the cluster
updateClusterSettingsResponse_httpStatus :: Lens' UpdateClusterSettingsResponse Int Source #
The response's http status code.
DeleteAttributes
deleteAttributes_cluster :: Lens' DeleteAttributes (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.
deleteAttributes_attributes :: Lens' DeleteAttributes [Attribute] Source #
The attributes to delete from your resource. You can specify up to 10 attributes per request. For custom attributes, specify the attribute name and target ID, but do not specify the value. If you specify the target ID using the short form, you must also specify the target type.
deleteAttributesResponse_attributes :: Lens' DeleteAttributesResponse (Maybe [Attribute]) Source #
A list of attribute objects that were successfully deleted from your resource.
deleteAttributesResponse_httpStatus :: Lens' DeleteAttributesResponse Int Source #
The response's http status code.
PutAttributes
putAttributes_cluster :: Lens' PutAttributes (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed.
putAttributes_attributes :: Lens' PutAttributes [Attribute] Source #
The attributes to apply to your resource. You can specify up to 10 custom attributes per resource. You can specify up to 10 attributes in a single call.
putAttributesResponse_attributes :: Lens' PutAttributesResponse (Maybe [Attribute]) Source #
The attributes applied to your resource.
putAttributesResponse_httpStatus :: Lens' PutAttributesResponse Int Source #
The response's http status code.
ListAccountSettings
listAccountSettings_value :: Lens' ListAccountSettings (Maybe Text) Source #
The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.
listAccountSettings_nextToken :: Lens' ListAccountSettings (Maybe Text) Source #
The nextToken
value returned from a ListAccountSettings
request
indicating that more results are available to fulfill the request and
further calls will be needed. If maxResults
was provided, it is
possible the number of results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
listAccountSettings_name :: Lens' ListAccountSettings (Maybe SettingName) Source #
The name of the account setting you want to list the settings for.
listAccountSettings_principalArn :: Lens' ListAccountSettings (Maybe Text) Source #
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.
Federated users assume the account setting of the root user and can't have explicit account settings set for them.
listAccountSettings_effectiveSettings :: Lens' ListAccountSettings (Maybe Bool) Source #
Specifies whether to return the effective settings. If true
, the
account settings for the root user or the default setting for the
principalArn
are returned. If false
, the account settings for the
principalArn
are returned if they are set. Otherwise, no account
settings are returned.
listAccountSettings_maxResults :: Lens' ListAccountSettings (Maybe Int) Source #
The maximum number of account setting results returned by
ListAccountSettings
in paginated output. When this parameter is used,
ListAccountSettings
only returns maxResults
results in a single page
along with a nextToken
response element. The remaining results of the
initial request can be seen by sending another ListAccountSettings
request with the returned nextToken
value. This value can be between 1
and 10. If this parameter is not used, then ListAccountSettings
returns up to 10 results and a nextToken
value if applicable.
listAccountSettingsResponse_settings :: Lens' ListAccountSettingsResponse (Maybe [Setting]) Source #
The account settings for the resource.
listAccountSettingsResponse_nextToken :: Lens' ListAccountSettingsResponse (Maybe Text) Source #
The nextToken
value to include in a future ListAccountSettings
request. When the results of a ListAccountSettings
request exceed
maxResults
, this value can be used to retrieve the next page of
results. This value is null
when there are no more results to return.
listAccountSettingsResponse_httpStatus :: Lens' ListAccountSettingsResponse Int Source #
The response's http status code.
DeleteTaskSet
deleteTaskSet_force :: Lens' DeleteTaskSet (Maybe Bool) Source #
If true
, this allows you to delete a task set even if it hasn't been
scaled down to zero.
deleteTaskSet_cluster :: Lens' DeleteTaskSet Text Source #
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in to delete.
deleteTaskSet_service :: Lens' DeleteTaskSet Text Source #
The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete.
deleteTaskSet_taskSet :: Lens' DeleteTaskSet Text Source #
The task set ID or full Amazon Resource Name (ARN) of the task set to delete.
deleteTaskSetResponse_taskSet :: Lens' DeleteTaskSetResponse (Maybe TaskSet) Source #
Details about the task set.
deleteTaskSetResponse_httpStatus :: Lens' DeleteTaskSetResponse Int Source #
The response's http status code.
UpdateTaskSet
updateTaskSet_cluster :: Lens' UpdateTaskSet Text Source #
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.
updateTaskSet_service :: Lens' UpdateTaskSet Text Source #
The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
updateTaskSet_taskSet :: Lens' UpdateTaskSet Text Source #
The short name or full Amazon Resource Name (ARN) of the task set to update.
updateTaskSet_scale :: Lens' UpdateTaskSet Scale Source #
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
updateTaskSetResponse_taskSet :: Lens' UpdateTaskSetResponse (Maybe TaskSet) Source #
Details about the task set.
updateTaskSetResponse_httpStatus :: Lens' UpdateTaskSetResponse Int Source #
The response's http status code.
CreateCapacityProvider
createCapacityProvider_tags :: Lens' CreateCapacityProvider (Maybe [Tag]) Source #
The metadata that you apply to the capacity provider to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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.
createCapacityProvider_name :: Lens' CreateCapacityProvider Text Source #
The name of the capacity provider. Up to 255 characters are allowed,
including letters (upper and lowercase), numbers, underscores, and
hyphens. The name cannot be prefixed with "aws
", "ecs
", or
"fargate
".
createCapacityProvider_autoScalingGroupProvider :: Lens' CreateCapacityProvider AutoScalingGroupProvider Source #
The details of the Auto Scaling group for the capacity provider.
createCapacityProviderResponse_capacityProvider :: Lens' CreateCapacityProviderResponse (Maybe CapacityProvider) Source #
The full description of the new capacity provider.
createCapacityProviderResponse_httpStatus :: Lens' CreateCapacityProviderResponse Int Source #
The response's http status code.
DescribeTaskSets
describeTaskSets_taskSets :: Lens' DescribeTaskSets (Maybe [Text]) Source #
The ID or full Amazon Resource Name (ARN) of task sets to describe.
describeTaskSets_include :: Lens' DescribeTaskSets (Maybe [TaskSetField]) Source #
Specifies whether to see the resource tags for the task set. If TAGS
is specified, the tags are included in the response. If this field is
omitted, tags are not included in the response.
describeTaskSets_cluster :: Lens' DescribeTaskSets Text Source #
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.
describeTaskSets_service :: Lens' DescribeTaskSets Text Source #
The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.
describeTaskSetsResponse_taskSets :: Lens' DescribeTaskSetsResponse (Maybe [TaskSet]) Source #
The list of task sets described.
describeTaskSetsResponse_failures :: Lens' DescribeTaskSetsResponse (Maybe [Failure]) Source #
Any failures associated with the call.
describeTaskSetsResponse_httpStatus :: Lens' DescribeTaskSetsResponse Int Source #
The response's http status code.
RegisterTaskDefinition
registerTaskDefinition_inferenceAccelerators :: Lens' RegisterTaskDefinition (Maybe [InferenceAccelerator]) Source #
The Elastic Inference accelerators to use for the containers in the task.
registerTaskDefinition_executionRoleArn :: Lens' RegisterTaskDefinition (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.
registerTaskDefinition_requiresCompatibilities :: Lens' RegisterTaskDefinition (Maybe [Compatibility]) Source #
The task launch type that Amazon ECS should validate the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.
registerTaskDefinition_ephemeralStorage :: Lens' RegisterTaskDefinition (Maybe 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
platform version 1.4.0
or later.
registerTaskDefinition_pidMode :: Lens' RegisterTaskDefinition (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.
registerTaskDefinition_ipcMode :: Lens' RegisterTaskDefinition (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
host
IPC mode, IPC namespace relatedsystemControls
are not supported. - For tasks that use the
task
IPC mode, IPC namespace relatedsystemControls
will apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
registerTaskDefinition_memory :: Lens' RegisterTaskDefinition (Maybe Text) Source #
The amount of memory (in MiB) used by the task. It can be expressed as
an integer using MiB, for example 1024
, or as a string using GB, for
example 1GB
or 1 GB
, in a task definition. String values are
converted to an integer indicating the MiB when the task definition is
registered.
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If using the EC2 launch type, this field is optional.
If using the Fargate launch type, this field is required and you must
use one of the following values, which determines your range of
supported values for the cpu
parameter:
- 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
cpu
values: 256 (.25 vCPU) - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available
cpu
values: 512 (.5 vCPU) - 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB),
7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU) - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
Available
cpu
values: 2048 (2 vCPU) - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
Available
cpu
values: 4096 (4 vCPU)
registerTaskDefinition_proxyConfiguration :: Lens' RegisterTaskDefinition (Maybe ProxyConfiguration) Source #
The configuration details for the App Mesh proxy.
For tasks hosted on Amazon EC2 instances, 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 enable 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 AMI versions
in the Amazon Elastic Container Service Developer Guide.
registerTaskDefinition_taskRoleArn :: Lens' RegisterTaskDefinition (Maybe Text) Source #
The short name or full 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 Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
registerTaskDefinition_placementConstraints :: Lens' RegisterTaskDefinition (Maybe [TaskDefinitionPlacementConstraint]) Source #
An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
registerTaskDefinition_networkMode :: Lens' RegisterTaskDefinition (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.
registerTaskDefinition_volumes :: Lens' RegisterTaskDefinition (Maybe [Volume]) Source #
A list of volume definitions in JSON format that containers in your task may use.
registerTaskDefinition_cpu :: Lens' RegisterTaskDefinition (Maybe Text) Source #
The number of CPU units used by the task. It can be expressed as an
integer using CPU units, for example 1024
, or as a string using vCPUs,
for example 1 vCPU
or 1 vcpu
, in a task definition. String values
are converted to an integer indicating the CPU units when the task
definition is registered.
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If you are using the EC2 launch type, this field is optional. Supported
values are between 128
CPU units (0.125
vCPUs) and 10240
CPU units
(10
vCPUs).
If you are using the Fargate launch type, this field is required and you
must use one of the following values, which determines your range of
supported values for the memory
parameter:
- 256 (.25 vCPU) - Available
memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - 512 (.5 vCPU) - Available
memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - 1024 (1 vCPU) - Available
memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - 2048 (2 vCPU) - Available
memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - 4096 (4 vCPU) - Available
memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
registerTaskDefinition_tags :: Lens' RegisterTaskDefinition (Maybe [Tag]) Source #
The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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.
registerTaskDefinition_family :: Lens' RegisterTaskDefinition Text Source #
You must specify a family
for a task definition, which allows you to
track multiple versions of the same task definition. The family
is
used as a name for your task definition. Up to 255 letters (uppercase
and lowercase), numbers, underscores, and hyphens are allowed.
registerTaskDefinition_containerDefinitions :: Lens' RegisterTaskDefinition [ContainerDefinition] Source #
A list of container definitions in JSON format that describe the different containers that make up your task.
registerTaskDefinitionResponse_taskDefinition :: Lens' RegisterTaskDefinitionResponse (Maybe TaskDefinition) Source #
The full description of the registered task definition.
registerTaskDefinitionResponse_tags :: Lens' RegisterTaskDefinitionResponse (Maybe [Tag]) Source #
The list of tags associated with the task definition.
registerTaskDefinitionResponse_httpStatus :: Lens' RegisterTaskDefinitionResponse Int Source #
The response's http status code.
CreateService
createService_cluster :: Lens' CreateService (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.
createService_clientToken :: Lens' CreateService (Maybe Text) Source #
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
createService_propagateTags :: Lens' CreateService (Maybe PropagateTags) Source #
Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation or task creation, use the TagResource API action.
createService_platformVersion :: Lens' CreateService (Maybe Text) Source #
The platform version that your tasks in the service are running on. A
platform version is specified only for tasks using the Fargate launch
type. If one isn't specified, the LATEST
platform version is used by
default. For more information, see
Fargate platform versions
in the Amazon Elastic Container Service Developer Guide.
createService_enableECSManagedTags :: Lens' CreateService (Maybe Bool) Source #
Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
createService_desiredCount :: Lens' CreateService (Maybe Int) Source #
The number of instantiations of the specified task definition to place and keep running on your cluster.
This is required if schedulingStrategy
is REPLICA
or is not
specified. If schedulingStrategy
is DAEMON
then this is not
required.
createService_loadBalancers :: Lens' CreateService (Maybe [LoadBalancer]) Source #
A load balancer object representing the load balancers to use with your service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.
If the service is using the rolling update (ECS
) deployment controller
and using either an Application Load Balancer or Network Load Balancer,
you must specify one or more target group ARNs to attach to the service.
The service-linked role is required for services that make use of
multiple target groups. For more information, see
Using service-linked roles for Amazon ECS
in the Amazon Elastic Container Service Developer Guide.
If the service is using the CODE_DEPLOY
deployment controller, the
service is required to use either an Application Load Balancer or
Network Load Balancer. When creating an CodeDeploy deployment group, you
specify two target groups (referred to as a targetGroupPair
). During a
deployment, CodeDeploy determines which task set in your service has the
status PRIMARY
and associates one target group with it, and then
associates the other target group with the replacement task set. The
load balancer can also have up to two listeners: a required listener for
production traffic and an optional listener that allows you perform
validation tests with Lambda functions before routing production traffic
to it.
After you create a service using the ECS
deployment controller, the
load balancer name or target group ARN, container name, and container
port specified in the service definition are immutable. If you are using
the CODE_DEPLOY
deployment controller, these values can be changed
when updating the service.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
Services with tasks that use the awsvpc
network mode (for example,
those with the Fargate launch type) only support Application Load
Balancers and Network Load Balancers. Classic Load Balancers are not
supported. Also, when you create any target groups for these services,
you must choose ip
as the target type, not instance
, because tasks
that use the awsvpc
network mode are associated with an elastic
network interface, not an Amazon EC2 instance.
createService_role :: Lens' CreateService (Maybe Text) Source #
The name or full Amazon Resource Name (ARN) of the IAM role that allows
Amazon ECS to make calls to your load balancer on your behalf. This
parameter is only permitted if you are using a load balancer with your
service and your task definition does not use the awsvpc
network mode.
If you specify the role
parameter, you must also specify a load
balancer object with the loadBalancers
parameter.
If your account has already created the Amazon ECS service-linked role,
that role is used by default for your service unless you specify a role
here. The service-linked role is required if your task definition uses
the awsvpc
network mode or if the service is configured to use service
discovery, an external deployment controller, multiple target groups, or
Elastic Inference accelerators in which case you should not specify a
role here. For more information, see
Using service-linked roles for Amazon ECS
in the Amazon Elastic Container Service Developer Guide.
If your specified role has a path other than /
, then you must either
specify the full role ARN (this is recommended) or prefix the role name
with the path. For example, if a role with the name bar
has a path of
/foo/
then you would specify /foo/bar
as the role name. For more
information, see
Friendly names and paths
in the IAM User Guide.
createService_placementConstraints :: Lens' CreateService (Maybe [PlacementConstraint]) Source #
An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
createService_placementStrategy :: Lens' CreateService (Maybe [PlacementStrategy]) Source #
The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service.
createService_deploymentController :: Lens' CreateService (Maybe DeploymentController) Source #
The deployment controller to use for the service. If no deployment
controller is specified, the default value of ECS
is used.
createService_launchType :: Lens' CreateService (Maybe LaunchType) Source #
The infrastructure on which to run your service. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand
infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.
The EC2
launch type runs your tasks on Amazon EC2 instances registered
to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premise server or
virtual machine (VM) capacity registered to your cluster.
A service can use either a launch type or a capacity provider strategy.
If a launchType
is specified, the capacityProviderStrategy
parameter
must be omitted.
createService_taskDefinition :: Lens' CreateService (Maybe Text) Source #
The family
and revision
(family:revision
) or full ARN of the task
definition to run in your service. If a revision
is not specified, the
latest ACTIVE
revision is used.
A task definition must be specified if the service is using either the
ECS
or CODE_DEPLOY
deployment controllers.
createService_schedulingStrategy :: Lens' CreateService (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. This scheduler strategy is required if the service is using theCODE_DEPLOY
orEXTERNAL
deployment controller types.DAEMON
-The daemon scheduling strategy deploys exactly one task on each active container instance that 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 and will stop tasks that do not meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.Tasks using the Fargate launch type or the
CODE_DEPLOY
orEXTERNAL
deployment controller types don't support theDAEMON
scheduling strategy.
createService_healthCheckGracePeriodSeconds :: Lens' CreateService (Maybe Int) Source #
The period of time, in seconds, that the Amazon ECS service scheduler
should ignore unhealthy Elastic Load Balancing target health checks
after a task has first started. This is only used when your service is
configured to use a load balancer. If your service has a load balancer
defined and you don't specify a health check grace period value, the
default value of 0
is used.
If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
createService_networkConfiguration :: Lens' CreateService (Maybe NetworkConfiguration) Source #
The network configuration for the service. This parameter is required
for task definitions that use the awsvpc
network mode to receive their
own elastic network interface, and it is not supported for other network
modes. For more information, see
Task networking
in the Amazon Elastic Container Service Developer Guide.
createService_serviceRegistries :: Lens' CreateService (Maybe [ServiceRegistry]) Source #
The details of the service discovery registry to associate with this service. For more information, see Service discovery.
Each service may be associated with one service registry. Multiple service registries per service isn't supported.
createService_capacityProviderStrategy :: Lens' CreateService (Maybe [CapacityProviderStrategyItem]) Source #
The capacity provider strategy to use for the service.
If a capacityProviderStrategy
is specified, the launchType
parameter
must be omitted. If no capacityProviderStrategy
or launchType
is
specified, the defaultCapacityProviderStrategy
for the cluster is
used.
A capacity provider strategy may contain a maximum of 6 capacity providers.
createService_enableExecuteCommand :: Lens' CreateService (Maybe Bool) Source #
Whether or not the execute command functionality is enabled for the
service. If true
, this enables execute command functionality on all
containers in the service tasks.
createService_tags :: Lens' CreateService (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, both of which you define. When a service is deleted, the tags are deleted as well.
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.
createService_deploymentConfiguration :: Lens' CreateService (Maybe DeploymentConfiguration) Source #
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
createService_serviceName :: Lens' CreateService 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, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
createServiceResponse_service :: Lens' CreateServiceResponse (Maybe ContainerService) Source #
The full description of your service following the create call.
A service will return either a capacityProviderStrategy
or
launchType
parameter, but not both, depending on which one was
specified during creation.
If a service is using the ECS
deployment controller, the
deploymentController
and taskSets
parameters will not be returned.
If the service is using the CODE_DEPLOY
deployment controller, the
deploymentController
, taskSets
and deployments
parameters will be
returned, however the deployments
parameter will be an empty list.
createServiceResponse_httpStatus :: Lens' CreateServiceResponse Int Source #
The response's http status code.
Types
Attachment
attachment_status :: Lens' Attachment (Maybe Text) Source #
The status of the attachment. Valid values are PRECREATED
, CREATED
,
ATTACHING
, ATTACHED
, DETACHING
, DETACHED
, and DELETED
.
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_type :: Lens' Attachment (Maybe Text) Source #
The type of the attachment, such as ElasticNetworkInterface
.
AttachmentStateChange
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
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_value :: Lens' Attribute (Maybe Text) Source #
The value of the attribute. The value
must contain between 1 and 128
characters and may contain letters (uppercase and lowercase), numbers,
hyphens, underscores, periods, at signs (@), forward slashes, back
slashes, colons, or spaces. The value cannot contain any leading or
trailing whitespace.
attribute_targetType :: Lens' Attribute (Maybe TargetType) Source #
The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
attribute_name :: Lens' Attribute Text Source #
The name of the attribute. The name
must contain between 1 and 128
characters and name may contain letters (uppercase and lowercase),
numbers, hyphens, underscores, forward slashes, back slashes, or
periods.
AutoScalingGroupProvider
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.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection will not 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 are not 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
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 will not 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 are not protected from termination when the Auto Scaling group scales in.
AwsVpcConfiguration
awsVpcConfiguration_securityGroups :: Lens' AwsVpcConfiguration (Maybe [Text]) Source #
The IDs of the security groups associated with the task or service. If
you do not specify a security group, the default security group for the
VPC is used. There is a limit of 5 security groups that can be specified
per AwsVpcConfiguration
.
All specified security groups 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_subnets :: Lens' AwsVpcConfiguration [Text] Source #
The IDs of the subnets associated with the task or service. There is a
limit of 16 subnets that can be specified per AwsVpcConfiguration
.
All specified subnets must be from the same VPC.
CapacityProvider
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 will have an INACTIVE
status.
capacityProvider_updateStatusReason :: Lens' CapacityProvider (Maybe Text) Source #
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_name :: Lens' CapacityProvider (Maybe Text) Source #
The name of the capacity provider.
capacityProvider_updateStatus :: Lens' CapacityProvider (Maybe CapacityProviderUpdateStatus) Source #
The update status of the capacity provider. The following are the possible states that will be returned.
- DELETE_IN_PROGRESS
- The capacity provider is in the process of being deleted.
- DELETE_COMPLETE
- The capacity provider has been successfully deleted and will have an
INACTIVE
status. - DELETE_FAILED
- The capacity provider was unable to be deleted. The update status reason will provide further details about why the delete failed.
capacityProvider_capacityProviderArn :: Lens' CapacityProvider (Maybe Text) Source #
The Amazon Resource Name (ARN) that identifies the capacity provider.
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, both of which you define.
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.
CapacityProviderStrategyItem
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
will not 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 is run using capacityProviderA, four
tasks would use capacityProviderB.
capacityProviderStrategyItem_capacityProvider :: Lens' CapacityProviderStrategyItem Text Source #
The short name of the capacity provider.
Cluster
cluster_status :: Lens' Cluster (Maybe Text) Source #
The status of the cluster. The following are the possible states that will be 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 associated with it and the resources needed for the capacity provider are being created.
- DEPROVISIONING
- The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.
- FAILED
- The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.
- INACTIVE
- The cluster has been deleted. Clusters with an
INACTIVE
status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely onINACTIVE
clusters persisting.
cluster_clusterArn :: Lens' Cluster (Maybe Text) Source #
The Amazon Resource Name (ARN) that identifies the cluster. The ARN
contains the arn:aws:ecs
namespace, followed by the Region of the
cluster, the Amazon Web Services account ID of the cluster owner, the
cluster
namespace, and then the cluster name. For example,
arn:aws:ecs:region:012345678910:cluster/test
.
cluster_attachments :: Lens' Cluster (Maybe [Attachment]) Source #
The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.
cluster_runningTasksCount :: Lens' Cluster (Maybe Int) Source #
The number of tasks in the cluster that are in the RUNNING
state.
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_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_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_pendingTasksCount :: Lens' Cluster (Maybe Int) Source #
The number of tasks in the cluster that are in the PENDING
state.
cluster_clusterName :: Lens' Cluster (Maybe Text) Source #
A user-generated string that you use to identify your cluster.
cluster_statistics :: Lens' Cluster (Maybe [KeyValuePair]) Source #
Additional information about your clusters that are separated by launch type, including:
- runningEC2TasksCount
- RunningFargateTasksCount
- pendingEC2TasksCount
- pendingFargateTasksCount
- activeEC2ServiceCount
- activeFargateServiceCount
- drainingEC2ServiceCount
- drainingFargateServiceCount
cluster_configuration :: Lens' Cluster (Maybe ClusterConfiguration) Source #
The execute command configuration for the cluster.
cluster_attachmentsStatus :: Lens' Cluster (Maybe Text) Source #
The status of the capacity providers associated with the cluster. The following are the states that will be returned:
- UPDATE_IN_PROGRESS
- The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.
- 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_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_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, both of which you define.
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
clusterConfiguration_executeCommandConfiguration :: Lens' ClusterConfiguration (Maybe ExecuteCommandConfiguration) Source #
The details of the execute command configuration.
ClusterSetting
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.
clusterSetting_name :: Lens' ClusterSetting (Maybe ClusterSettingName) Source #
The name of the cluster setting. The only supported value is
containerInsights
.
Container
container_gpuIds :: Lens' Container (Maybe [Text]) Source #
The IDs of each GPU assigned to the container.
container_networkBindings :: Lens' Container (Maybe [NetworkBinding]) Source #
The network bindings associated with the container.
container_managedAgents :: Lens' Container (Maybe [ManagedAgent]) Source #
The details of any Amazon ECS managed agents associated with the container.
container_containerArn :: Lens' Container (Maybe Text) Source #
The Amazon Resource Name (ARN) of the container.
container_networkInterfaces :: Lens' Container (Maybe [NetworkInterface]) Source #
The network interfaces associated with the container.
container_lastStatus :: Lens' Container (Maybe Text) Source #
The last known status of the container.
container_memory :: Lens' Container (Maybe Text) Source #
The hard limit (in MiB) of memory set for 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.
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_exitCode :: Lens' Container (Maybe Int) Source #
The exit code returned from the container.
container_healthStatus :: Lens' Container (Maybe HealthStatus) Source #
The health status of the container. If health checks are not configured
for this container in its task definition, then it reports the health
status as UNKNOWN
.
container_cpu :: Lens' Container (Maybe Text) Source #
The number of CPU units set for the container. The value will be 0
if
no value was specified in the container definition when the task
definition was registered.
container_memoryReservation :: Lens' Container (Maybe Text) Source #
The soft limit (in MiB) of memory set for the container.
ContainerDefinition
containerDefinition_image :: Lens' ContainerDefinition (Maybe Text) Source #
The image used to start a container. This string is passed directly to
the Docker daemon. Images in the Docker Hub registry are available by
default. Other repositories are specified with either
repository-url/image:tag
or repository-url/image@digest
. Up
to 255 letters (uppercase and lowercase), numbers, hyphens, underscores,
colons, periods, forward slashes, and number signs are allowed. This
parameter maps to Image
in the
Create a container
section of the
Docker Remote API and the
IMAGE
parameter of
docker run.
- When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.
- Images in Amazon ECR repositories can be specified by either using
the full
registry/repository:tag
orregistry/repository@digest
. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest
or012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE
. - Images in official repositories on Docker Hub use a single name (for
example,
ubuntu
ormongo
). - 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_command :: Lens' ContainerDefinition (Maybe [Text]) Source #
The command that is passed to the container. This parameter maps to
Cmd
in the
Create a container
section of the
Docker Remote API and the
COMMAND
parameter to
docker run.
For more information, see
https://docs.docker.com/engine/reference/builder/#cmd. If there are
multiple arguments, each argument should be a separated string in the
array.
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 are using the awsvpc
network mode.
containerDefinition_repositoryCredentials :: Lens' ContainerDefinition (Maybe RepositoryCredentials) Source #
The private repository authentication credentials to use.
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 is not 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_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_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_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_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_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 do not recommend using 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 should contain an
environment variable in VARIABLE=VALUE
format. Lines beginning with
#
are treated as comments and are ignored. For more information on 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 are processed
from the top down. It is recommended to use unique variable names. For
more information, see
Specifying Environment Variables
in the Amazon Elastic Container Service Developer Guide.
containerDefinition_entryPoint :: Lens' ContainerDefinition (Maybe [Text]) Source #
Early versions of the Amazon ECS container agent do not properly handle
entryPoint
parameters. If you have problems using entryPoint
, update
your container agent or enter your commands and arguments as command
array items instead.
The entry point that is passed to the container. This parameter maps to
Entrypoint
in the
Create a container
section of the
Docker Remote API and the
--entrypoint
option to
docker run.
For more information, see
https://docs.docker.com/engine/reference/builder/#entrypoint.
containerDefinition_workingDirectory :: Lens' ContainerDefinition (Maybe Text) Source #
The working directory in which to run commands inside the container.
This parameter maps to WorkingDir
in the
Create a container
section of the
Docker Remote API and the
--workdir
option to
docker run.
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 will override 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_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 platform version 1.3.0 or 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 using the EC2 launch type, if the stopTimeout
parameter is
not specified, the value set for the Amazon ECS container agent
configuration variable ECS_CONTAINER_STOP_TIMEOUT
is used by default.
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 enable 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 are
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_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_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, you should only
specify the containerPort
. The hostPort
can be left blank or it must
be the same value as the containerPort
.
Port mappings on Windows use the NetNAT
gateway address rather than
localhost
. There is no loopback for port mappings on Windows, so you
cannot access a container's mapped port from the host itself.
This parameter maps to PortBindings
in the
Create a container
section of the
Docker Remote API and the
--publish
option to
docker run.
If the network mode of a task definition is set to none
, then you
can't specify port mappings. If the network mode of a task definition
is set to host
, then host ports must either be undefined or they must
match the container port in the port mapping.
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_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_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_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 is not supported for Windows containers or tasks that use
the awsvpc
network mode.
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 on which the container is placed. Otherwise, the
value of memory
is used.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
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.
It is not 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 is 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_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, you should not run
containers using the root user (UID 0). It is considered best practice
to use a non-root user.
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_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_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_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 may use a different logging driver
than the Docker daemon by specifying a log driver with this parameter in
the container definition. To use a different logging driver for a
container, the log system must be configured properly on the container
instance (or on a different log server for remote logging options). For
more information on the options for different supported log drivers, see
Configure logging drivers
in the Docker documentation.
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_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_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_dependsOn :: Lens' ContainerDefinition (Maybe [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.
For tasks using the EC2 launch type, the container instances require at
least version 1.26.0 of the container agent to enable 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 are
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
platform version 1.3.0
or later.
containerDefinition_name :: Lens' ContainerDefinition (Maybe Text) Source #
The name of a container. If you are linking multiple containers together
in a task definition, the name
of one container can be entered in the
links
of another container to connect the containers. Up to 255
letters (uppercase and lowercase), numbers, 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_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_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 cannot mount directories on a
different drive, and mount point cannot be across drives.
containerDefinition_interactive :: Lens' ContainerDefinition (Maybe Bool) Source #
When this parameter is true
, this allows you to 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_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 does not reach
the desired status within that time then containerA will give 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 is enforced indendently from this start timeout
value.
For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.
For tasks using the EC2 launch type, your container instances require at
least version 1.26.0
of the container agent to enable 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 are
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_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_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_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
, then its failure does not affect the
rest of the containers in a task. If this parameter is omitted, a
container is assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.
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 is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
- Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 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 is 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_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 on which the container is placed. Otherwise, the value of
memory
is used.
For example, if your container normally uses 128 MiB of memory, but
occasionally bursts to 256 MiB of memory for short periods of time, you
can set a memoryReservation
of 128 MiB, and a memory
hard limit of
300 MiB. This configuration would allow the container to only reserve
128 MiB of memory from the remaining resources on the container
instance, but also allow the container to consume more memory resources
when needed.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
ContainerDependency
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 cannot be set on an essential container.SUCCESS
- This condition is the same asCOMPLETE
, but it also requires that the container exits with azero
status. This condition cannot 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
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 are not placed on the
container instance and any service tasks running on the container
instance are removed if possible. For more information, see
Container Instance Draining
in the Amazon Elastic Container Service Developer Guide.
containerInstance_attachments :: Lens' ContainerInstance (Maybe [Attachment]) Source #
The resources attached to a container instance, such as elastic network interfaces.
containerInstance_runningTasksCount :: Lens' ContainerInstance (Maybe Int) Source #
The number of tasks on the container instance that are in the RUNNING
status.
containerInstance_remainingResources :: Lens' ContainerInstance (Maybe [Resource]) Source #
For CPU and memory resource types, this parameter describes the
remaining CPU and memory that has not already been allocated to tasks
and is therefore available for new tasks. For port resource types, this
parameter describes the ports that were reserved by the Amazon ECS
container agent (at instance registration time) and any task containers
that have reserved port mappings on the host (with the host
or
bridge
network mode). Any port that is not specified here is available
for new tasks.
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_containerInstanceArn :: Lens' ContainerInstance (Maybe Text) Source #
The Amazon Resource Name (ARN) of the container instance. The ARN
contains the arn:aws:ecs
namespace, followed by the Region of the
container instance, the Amazon Web Services account ID of the container
instance owner, the container-instance
namespace, and then the
container instance ID. For example,
arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
containerInstance_agentConnected :: Lens' ContainerInstance (Maybe Bool) Source #
This parameter returns true
if the agent is connected to Amazon ECS.
Registered instances with an agent that may be unhealthy or stopped
return false
. Only instances connected to an agent can accept
placement requests.
containerInstance_versionInfo :: Lens' ContainerInstance (Maybe VersionInfo) Source #
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
containerInstance_agentUpdateStatus :: Lens' ContainerInstance (Maybe AgentUpdateStatus) Source #
The status of the most recent agent update. If an update has never been
requested, this value is NULL
.
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_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 are replicating your Amazon ECS
container instance state with CloudWatch Events, you can compare the
version of a container instance reported by the Amazon ECS APIs with the
version reported in CloudWatch Events for the container instance (inside
the detail
object) to verify that the version in your event stream is
current.
containerInstance_pendingTasksCount :: Lens' ContainerInstance (Maybe Int) Source #
The number of tasks on the container instance that are in the PENDING
status.
containerInstance_capacityProviderName :: Lens' ContainerInstance (Maybe Text) Source #
The capacity provider associated with the container instance.
containerInstance_registeredAt :: Lens' ContainerInstance (Maybe UTCTime) Source #
The Unix timestamp for when the container instance was registered.
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, both of which you define.
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_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.
ContainerOverride
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_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_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.
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_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_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_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.
ContainerService
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.
containerService_runningCount :: Lens' ContainerService (Maybe Int) Source #
The number of tasks in the cluster that are in the RUNNING
state.
containerService_status :: Lens' ContainerService (Maybe Text) Source #
The status of the service. The valid values are ACTIVE
, DRAINING
, or
INACTIVE
.
containerService_clusterArn :: Lens' ContainerService (Maybe Text) Source #
The Amazon Resource Name (ARN) of the cluster that hosts the service.
containerService_propagateTags :: Lens' ContainerService (Maybe PropagateTags) Source #
Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
containerService_createdAt :: Lens' ContainerService (Maybe UTCTime) Source #
The Unix timestamp for when the service was created.
containerService_platformVersion :: Lens' ContainerService (Maybe Text) Source #
The platform version on which to run your service. A platform version is
only specified for tasks hosted on Fargate. If one is not specified, the
LATEST
platform version is used by default. For more information, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
containerService_enableECSManagedTags :: Lens' ContainerService (Maybe Bool) Source #
Specifies whether to enable 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_createdBy :: Lens' ContainerService (Maybe Text) Source #
The principal that created 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_loadBalancers :: Lens' ContainerService (Maybe [LoadBalancer]) Source #
A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
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_events :: Lens' ContainerService (Maybe [ServiceEvent]) Source #
The event stream for your service. A maximum of 100 of the latest events are displayed.
containerService_placementStrategy :: Lens' ContainerService (Maybe [PlacementStrategy]) Source #
The placement strategy that determines how tasks for the service are placed.
containerService_deployments :: Lens' ContainerService (Maybe [Deployment]) Source #
The current state of deployments for the service.
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, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
containerService_deploymentController :: Lens' ContainerService (Maybe DeploymentController) Source #
The deployment controller type the service is using. When using the
DescribeServices API, this field is omitted if the service is using the
ECS
deployment controller type.
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_serviceArn :: Lens' ContainerService (Maybe Text) Source #
The ARN that identifies the service. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the service, the Amazon Web
Services account ID of the service owner, the service
namespace, and
then the service name. For example,
arn:aws:ecs:region:012345678910:service/my-service
.
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_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 that 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 and will stop tasks that do not meet the placement constraints.Fargate tasks do not support the
DAEMON
scheduling strategy.
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_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_serviceRegistries :: Lens' ContainerService (Maybe [ServiceRegistry]) Source #
The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
containerService_capacityProviderStrategy :: Lens' ContainerService (Maybe [CapacityProviderStrategyItem]) Source #
The capacity provider strategy the service is using. When using the DescribeServices API, this field is omitted if the service was created using a launch type.
containerService_enableExecuteCommand :: Lens' ContainerService (Maybe Bool) Source #
Whether or not 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_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, both of which you define.
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_roleArn :: Lens' ContainerService (Maybe Text) Source #
The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
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.
ContainerStateChange
containerStateChange_networkBindings :: Lens' ContainerStateChange (Maybe [NetworkBinding]) Source #
Any network bindings associated with the container.
containerStateChange_status :: Lens' ContainerStateChange (Maybe Text) Source #
The status of the container.
containerStateChange_containerName :: Lens' ContainerStateChange (Maybe Text) Source #
The name of the container.
containerStateChange_reason :: Lens' ContainerStateChange (Maybe Text) Source #
The reason for the state change.
containerStateChange_imageDigest :: Lens' ContainerStateChange (Maybe Text) Source #
The container image SHA 256 digest.
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_runtimeId :: Lens' ContainerStateChange (Maybe Text) Source #
The ID of the Docker container.
Deployment
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 are not 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 will transition to a COMPLETED
state. If
the service fails to reach a steady state and circuit breaker is
enabled, the deployment will transition to a FAILED
state. A
deployment in FAILED
state will launch no new tasks. For more
information, see DeploymentCircuitBreaker.
deployment_runningCount :: Lens' Deployment (Maybe Int) Source #
The number of tasks in the deployment that are in the RUNNING
status.
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
PRIMARY
deployment. - INACTIVE
- A deployment that has been completely replaced.
deployment_createdAt :: Lens' Deployment (Maybe UTCTime) Source #
The Unix timestamp for when the service deployment was created.
deployment_platformVersion :: Lens' Deployment (Maybe Text) Source #
The platform version on which your tasks in the service are running. A
platform version is only specified for tasks using the Fargate launch
type. If one is not specified, the LATEST
platform version is used by
default. For more information, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
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_pendingCount :: Lens' Deployment (Maybe Int) Source #
The number of tasks in the deployment that are in the PENDING
status.
deployment_id :: Lens' Deployment (Maybe Text) Source #
The ID of the deployment.
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_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_updatedAt :: Lens' Deployment (Maybe UTCTime) Source #
The Unix timestamp for when the service deployment was last updated.
deployment_taskDefinition :: Lens' Deployment (Maybe Text) Source #
The most recent task definition that was specified for the tasks in the service to use.
deployment_rolloutStateReason :: Lens' Deployment (Maybe Text) Source #
A description of the rollout state of a deployment.
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_capacityProviderStrategy :: Lens' Deployment (Maybe [CapacityProviderStrategyItem]) Source #
The capacity provider strategy that the deployment is using.
DeploymentCircuitBreaker
deploymentCircuitBreaker_enable :: Lens' DeploymentCircuitBreaker Bool Source #
Whether to enable the deployment circuit breaker logic for the service.
deploymentCircuitBreaker_rollback :: Lens' DeploymentCircuitBreaker Bool Source #
Whether to enable Amazon ECS to roll back the service if a service deployment fails. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
DeploymentConfiguration
deploymentConfiguration_minimumHealthyPercent :: Lens' DeploymentConfiguration (Maybe Int) Source #
If a service is using the rolling update (ECS
) deployment type, the
minimum healthy percent represents a lower limit on the number of
tasks in a service that must remain in the RUNNING
state during a
deployment, as a percentage of the desired number of tasks (rounded up
to the nearest integer), and while any container instances are in the
DRAINING
state if the service contains tasks using the EC2 launch
type. This parameter enables you to deploy without using additional
cluster capacity. For example, if your service has a desired number of
four tasks and a minimum healthy percent of 50%, the scheduler may stop
two existing tasks to free up cluster capacity before starting two new
tasks. Tasks for services that do not use a load balancer are
considered healthy if they are in the RUNNING
state; tasks for
services that do use a load balancer are considered healthy if they
are in the RUNNING
state and they are reported as healthy by the load
balancer. The default value for minimum healthy percent is 100%.
If a service is using the blue/green (CODE_DEPLOY
) or EXTERNAL
deployment types and 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 the tasks in the service use the Fargate launch
type, the minimum healthy percent value is not used, although it is
returned when describing your service.
deploymentConfiguration_maximumPercent :: Lens' DeploymentConfiguration (Maybe Int) Source #
If a service is using the rolling update (ECS
) deployment type, the
maximum percent parameter represents an upper limit on the number of
tasks in a service that are allowed in the RUNNING
or PENDING
state
during a deployment, as a percentage of the desired number of tasks
(rounded down to the nearest integer), and while any container instances
are in the DRAINING
state if the service contains tasks using the EC2
launch type. This parameter enables you to define the deployment batch
size. For example, if your service has a desired number of four tasks
and a maximum percent 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 value for
maximum percent is 200%.
If a service is using 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_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.
DeploymentController
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
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
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_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_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.
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_autoprovision :: Lens' DockerVolumeConfiguration (Maybe Bool) Source #
If this value is true
, the Docker volume is created if it does not
already exist.
This field is only used if the scope
is shared
.
EFSAuthorizationConfig
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 #
Whether or not 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
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 #
Whether or not to enable 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_authorizationConfig :: Lens' EFSVolumeConfiguration (Maybe EFSAuthorizationConfig) Source #
The authorization configuration details for the Amazon EFS file system.
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
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
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
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_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_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
: Theawslogs
configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If noawslogs
log driver is configured in the task definition, the output won't be logged.OVERRIDE
: Specify the logging details as a part oflogConfiguration
. If theOVERRIDE
logging option is specified, thelogConfiguration
is required.
ExecuteCommandLogConfiguration
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_s3KeyPrefix :: Lens' ExecuteCommandLogConfiguration (Maybe Text) Source #
An optional folder in the S3 bucket to place logs in.
executeCommandLogConfiguration_cloudWatchEncryptionEnabled :: Lens' ExecuteCommandLogConfiguration (Maybe Bool) Source #
Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
executeCommandLogConfiguration_s3EncryptionEnabled :: Lens' ExecuteCommandLogConfiguration (Maybe Bool) Source #
Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
executeCommandLogConfiguration_s3BucketName :: Lens' ExecuteCommandLogConfiguration (Maybe Text) Source #
The name of the S3 bucket to send logs to.
The S3 bucket must already be created.
FSxWindowsFileServerAuthorizationConfig
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 ARNs refer 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
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
failure_arn :: Lens' Failure (Maybe Text) Source #
The Amazon Resource Name (ARN) of the failed resource.
FirelensConfiguration
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
healthCheck_startPeriod :: Lens' HealthCheck (Maybe Int) Source #
The optional grace period within which to provide containers time to
bootstrap before failed health checks count towards the maximum number
of retries. You may specify between 0 and 300 seconds. The startPeriod
is disabled by default.
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_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_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_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
execute 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, you should enclose the list of commands in brackets, as shown below.
[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
You do not need to include the brackets when you use the Amazon Web Services Management Consoleas shown below.
"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
HostVolumeProperties
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 is presented to the container.
If this parameter is empty, then the Docker daemon has assigned a host
path for you. If the host
parameter contains a sourcePath
file
location, then the data volume persists at the specified location on the
host container instance until you delete it manually. If the
sourcePath
value does not exist on the host container instance, the
Docker daemon creates it. If the location does exist, the contents of
the source path folder are exported.
If you are using the Fargate launch type, the sourcePath
parameter is
not supported.
InferenceAccelerator
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
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.
KernelCapabilities
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"
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"
KeyValuePair
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.
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.
LinuxParameters
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_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_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 are using tasks that use the Fargate launch type, the tmpfs
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 are using tasks that use the Fargate launch type, the
swappiness
parameter is not supported.
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 are using tasks that use the Fargate launch type, the devices
parameter is not 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_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 are using tasks that use the Fargate launch type, the maxSwap
parameter is not supported.
LoadBalancer
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_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_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 are using a Classic Load Balancer the target group ARN should be omitted.
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 are
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 (which
is required for the Fargate launch type), you must choose ip
as the
target type, not instance
, 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.
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 are launched on must allow ingress traffic on
the hostPort
of the port mapping.
LogConfiguration
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 is not listed, you can fork the Amazon ECS container agent project that is 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 do not currently provide support for running modified copies of this software.
ManagedAgent
managedAgent_lastStatus :: Lens' ManagedAgent (Maybe Text) Source #
The last known status of the managed agent.
managedAgent_reason :: Lens' ManagedAgent (Maybe Text) Source #
The reason for why the managed agent is in the state it is in.
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_lastStartedAt :: Lens' ManagedAgent (Maybe UTCTime) Source #
The Unix timestamp for when the managed agent was last started.
ManagedAgentStateChange
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 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
managedScaling_status :: Lens' ManagedScaling (Maybe ManagedScalingStatus) Source #
Whether or not to enable managed scaling for the capacity provider.
managedScaling_maximumScalingStepSize :: Lens' ManagedScaling (Maybe Natural) Source #
The maximum number of container instances that Amazon ECS will scale in
or scale out at one time. If this parameter is omitted, the default
value of 10000
is used.
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
will result in the Amazon EC2 instances in your Auto Scaling group
being completely utilized.
managedScaling_minimumScalingStepSize :: Lens' ManagedScaling (Maybe Natural) Source #
The minimum number of container instances that Amazon ECS will scale in
or scale out at one time. If this parameter is omitted, the default
value of 1
is 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.
MountPoint
mountPoint_containerPath :: Lens' MountPoint (Maybe Text) Source #
The path on the container to mount the host volume at.
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
.
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
.
NetworkBinding
networkBinding_bindIP :: Lens' NetworkBinding (Maybe Text) Source #
The IP address that the container is bound to on the container instance.
networkBinding_protocol :: Lens' NetworkBinding (Maybe TransportProtocol) Source #
The protocol used for the network binding.
networkBinding_hostPort :: Lens' NetworkBinding (Maybe Int) Source #
The port number on the host that is used with the network binding.
networkBinding_containerPort :: Lens' NetworkBinding (Maybe Int) Source #
The port number on the container that is used with the network binding.
NetworkConfiguration
networkConfiguration_awsvpcConfiguration :: Lens' NetworkConfiguration (Maybe AwsVpcConfiguration) Source #
The VPC subnets and security groups associated with a task.
All specified subnets and security groups must be from the same VPC.
NetworkInterface
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.
networkInterface_attachmentId :: Lens' NetworkInterface (Maybe Text) Source #
The attachment ID for the network interface.
PlacementConstraint
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
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 is applied to
a container instance, such as attribute:ecs.availability-zone
. For the
binpack
placement strategy, valid values are cpu
and memory
. For
the random
placement strategy, this field is not used.
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 is
specified with the field
parameter. For example, if you binpack on
memory, a task is placed on the instance with the least amount of
remaining memory (but still enough to run the task).
PlatformDevice
platformDevice_id :: Lens' PlatformDevice Text Source #
The ID for the GPU(s) 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 is available on the container instance. The only
supported value is GPU
.
PortMapping
portMapping_protocol :: Lens' PortMapping (Maybe TransportProtocol) Source #
The protocol used for the port mapping. Valid values are tcp
and
udp
. The default is tcp
.
portMapping_hostPort :: Lens' PortMapping (Maybe Int) Source #
The port number on the container instance to reserve for your container.
If you are using containers in a task with the awsvpc
or host
network mode, the hostPort
can either be left blank or set to the same
value as the containerPort
.
If you are using containers in a task with the bridge
network mode,
you can specify a non-reserved host port for your container port
mapping, or you can omit the hostPort
(or set it to 0
) while
specifying a containerPort
and your container automatically receives a
port in the ephemeral port range for your container instance operating
system and Docker version.
The default ephemeral port range for Docker version 1.6.0 and later is
listed on the instance under
/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 ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
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 (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, including the
default reserved ports. Automatically assigned ports don't count toward
the 100 reserved ports limit.
portMapping_containerPort :: Lens' PortMapping (Maybe Int) Source #
The port number on the container that is bound to the user-specified or automatically assigned host port.
If you are using containers in a task with the awsvpc
or host
network mode, exposed ports should be specified using containerPort
.
If you are using containers in a task with the bridge
network mode and
you specify a container port and not a host port, your container
automatically receives a host port in the ephemeral port range. For more
information, see hostPort
. Port mappings that are automatically
assigned in this way do not count toward the 100 reserved ports limit of
a container instance.
ProxyConfiguration
proxyConfiguration_type :: Lens' ProxyConfiguration (Maybe ProxyConfigurationType) Source #
The proxy type. The only supported value is APPMESH
.
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 theuser
parameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGID
is specified, this field can be empty.IgnoredGID
- (Required) The group ID (GID) of the proxy container as defined by theuser
parameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUID
is specified, this field can be empty.AppPorts
- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPort
andProxyEgressPort
.ProxyIngressPort
- (Required) Specifies the port that incoming traffic to theAppPorts
is directed to.ProxyEgressPort
- (Required) Specifies the port that outgoing traffic from theAppPorts
is 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_containerName :: Lens' ProxyConfiguration Text Source #
The name of the container that will serve as the App Mesh proxy.
RepositoryCredentials
repositoryCredentials_credentialsParameter :: Lens' RepositoryCredentials Text Source #
The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
When you are using the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the Amazon Web Services Management Console, you must specify the full ARN of the secret.
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_integerValue :: Lens' Resource (Maybe Int) Source #
When the integerValue
type is set, the value of the resource must be
an integer.
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_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_type :: Lens' Resource (Maybe Text) Source #
The type of the resource, such as INTEGER
, DOUBLE
, LONG
, or
STRINGSET
.
ResourceRequirement
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 will reserve for the container. The
number of GPUs reserved for all containers in a task should not exceed
the number of available GPUs on the container instance the task is
launched on.
If the InferenceAccelerator
type is used, the value
should match 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
.
Scale
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
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.
If the SSM Parameter Store parameter exists in the same Region as the task you are 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.
ServiceEvent
serviceEvent_createdAt :: Lens' ServiceEvent (Maybe UTCTime) Source #
The Unix timestamp for when the event was triggered.
serviceEvent_id :: Lens' ServiceEvent (Maybe Text) Source #
The ID string of the event.
serviceEvent_message :: Lens' ServiceEvent (Maybe Text) Source #
The event message.
ServiceRegistry
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.
serviceRegistry_containerName :: Lens' ServiceRegistry (Maybe Text) Source #
The container name value, already specified in the task definition, to
be used for your service discovery service. 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, but not both.
serviceRegistry_containerPort :: Lens' ServiceRegistry (Maybe Int) Source #
The port value, already specified in the task definition, to be used for
your service discovery service. 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, but not both.
serviceRegistry_port :: Lens' ServiceRegistry (Maybe Int) Source #
The port value used if your service discovery service specified an SRV
record. This field may be used if both the awsvpc
network mode and SRV
records are used.
Session
session_streamUrl :: Lens' Session (Maybe Text) Source #
A URL back to 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. Used to authenticate the connection to the container.
Setting
setting_value :: Lens' Setting (Maybe Text) Source #
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, which can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.
SystemControl
systemControl_value :: Lens' SystemControl (Maybe Text) Source #
The value for the namespaced kernel parameter specified in namespace
.
systemControl_namespace :: Lens' SystemControl (Maybe Text) Source #
The namespaced kernel parameter for which to set a value
.
Tag
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).
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.
Task
task_stoppedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for when the task was stopped (the task transitioned
from the RUNNING
state to the STOPPED
state).
task_desiredStatus :: Lens' Task (Maybe Text) Source #
The desired status of the task. For more information, see Task Lifecycle.
task_overrides :: Lens' Task (Maybe TaskOverride) Source #
One or more container overrides.
task_inferenceAccelerators :: Lens' Task (Maybe [InferenceAccelerator]) Source #
The Elastic Inference accelerator associated with the task.
task_attachments :: Lens' Task (Maybe [Attachment]) Source #
The Elastic Network Adapter associated with the task if the task uses
the awsvpc
network mode.
task_createdAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for when the task was created (the task entered the
PENDING
state).
task_stopCode :: Lens' Task (Maybe TaskStopCode) Source #
The stop code indicating why a task was stopped. The stoppedReason
may
contain additional details.
task_platformVersion :: Lens' Task (Maybe Text) Source #
The platform version on which your task is running. A platform version
is only specified for tasks using the Fargate launch type. If one is not
specified, the LATEST
platform version is used by default. For more
information, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
task_containerInstanceArn :: Lens' Task (Maybe Text) Source #
The ARN of the container instances that host the task.
task_executionStoppedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for when the task execution stopped.
task_ephemeralStorage :: Lens' Task (Maybe EphemeralStorage) Source #
The ephemeral storage settings for the task.
task_lastStatus :: Lens' Task (Maybe Text) Source #
The last known status of the task. For more information, see Task Lifecycle.
task_memory :: Lens' Task (Maybe Text) Source #
The amount of memory (in MiB) used by the task as expressed in a task
definition. It can be expressed as an integer using MiB, for example
1024
. It can also be expressed as a string using GB, for example 1GB
or 1 GB
. String values are converted to an integer indicating the MiB
when the task definition is registered.
If you are using the EC2 launch type, this field is optional.
If you are using the Fargate launch type, this field is required and you
must use one of the following values, which determines your range of
supported values for the cpu
parameter:
- 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
cpu
values: 256 (.25 vCPU) - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available
cpu
values: 512 (.5 vCPU) - 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB),
7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU) - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
Available
cpu
values: 2048 (2 vCPU) - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
Available
cpu
values: 4096 (4 vCPU)
task_pullStoppedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for when the container image pull completed.
task_startedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for when the task started (the task transitioned from
the PENDING
state to the RUNNING
state).
task_version :: Lens' Task (Maybe Integer) Source #
The version counter for the task. Every time a task experiences a change
that triggers a CloudWatch event, the version counter is incremented. If
you are replicating your Amazon ECS task state with CloudWatch Events,
you can compare the version of a task reported by the Amazon ECS 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_capacityProviderName :: Lens' Task (Maybe Text) Source #
The capacity provider associated with the task.
task_startedBy :: Lens' Task (Maybe Text) Source #
The tag specified when a task is started. If the task is started by an
Amazon ECS service, then the startedBy
parameter contains the
deployment ID of the service that starts it.
task_connectivity :: Lens' Task (Maybe Connectivity) Source #
The connectivity status of a task.
task_stoppingAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for when the task stops (transitions from the
RUNNING
state to STOPPED
).
task_launchType :: Lens' Task (Maybe LaunchType) Source #
The infrastructure on which your task is running. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
task_taskDefinitionArn :: Lens' Task (Maybe Text) Source #
The ARN of the task definition that creates the task.
task_healthStatus :: Lens' Task (Maybe HealthStatus) Source #
The health status for the task, which is determined by the health of the
essential containers in the task. If all essential containers in the
task are reporting as HEALTHY
, then the task status also reports as
HEALTHY
. If any essential containers in the task are reporting as
UNHEALTHY
or UNKNOWN
, then the task status also reports as
UNHEALTHY
or UNKNOWN
, accordingly.
The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) 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.
task_connectivityAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for when the task last went into CONNECTED
status.
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
indicating the CPU units when the task definition is registered.
If you are using the EC2 launch type, this field is optional. Supported
values are between 128
CPU units (0.125
vCPUs) and 10240
CPU units
(10
vCPUs).
If you are using the Fargate launch type, this field is required and you
must use one of the following values, which determines your range of
supported values for the memory
parameter:
- 256 (.25 vCPU) - Available
memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - 512 (.5 vCPU) - Available
memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - 1024 (1 vCPU) - Available
memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - 2048 (2 vCPU) - Available
memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - 4096 (4 vCPU) - Available
memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
task_enableExecuteCommand :: Lens' Task (Maybe Bool) Source #
Whether or not execute command functionality is enabled for this task.
If true
, this enables execute command functionality on all containers
in the task.
task_pullStartedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for when the container image pull began.
task_tags :: Lens' Task (Maybe [Tag]) Source #
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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.
TaskDefinition
taskDefinition_status :: Lens' TaskDefinition (Maybe TaskDefinitionStatus) Source #
The status of the task definition.
taskDefinition_inferenceAccelerators :: Lens' TaskDefinition (Maybe [InferenceAccelerator]) Source #
The Elastic Inference accelerator associated with the task.
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_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_ephemeralStorage :: Lens' TaskDefinition (Maybe EphemeralStorage) Source #
The ephemeral storage settings to use for tasks run with the task definition.
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_family :: Lens' TaskDefinition (Maybe Text) Source #
The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), 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_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
host
IPC mode, IPC namespace relatedsystemControls
are not supported. - For tasks that use the
task
IPC mode, IPC namespace relatedsystemControls
will apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on Fargate.
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_memory :: Lens' TaskDefinition (Maybe Text) Source #
The amount (in MiB) of memory used by the task.
If your tasks will be run 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 then the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
If your tasks will be run on Fargate, this field is required and you
must use one of the following values, which determines your range of
valid values for the cpu
parameter:
- 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
cpu
values: 256 (.25 vCPU) - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available
cpu
values: 512 (.5 vCPU) - 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB),
7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU) - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
Available
cpu
values: 2048 (2 vCPU) - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
Available
cpu
values: 4096 (4 vCPU)
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 enable 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
in the Amazon Elastic Container Service Developer Guide.
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 in order to take
advantage of the feature. For more information, see
Windows IAM roles for tasks
in the Amazon Elastic Container Service Developer Guide.
taskDefinition_deregisteredAt :: Lens' TaskDefinition (Maybe UTCTime) Source #
The Unix timestamp for when the task definition was deregistered.
taskDefinition_placementConstraints :: Lens' TaskDefinition (Maybe [TaskDefinitionPlacementConstraint]) Source #
An array of placement constraint objects to use for tasks.
This parameter is not supported for tasks run on Fargate.
taskDefinition_registeredAt :: Lens' TaskDefinition (Maybe UTCTime) Source #
The Unix timestamp for when the task definition was registered.
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_taskDefinitionArn :: Lens' TaskDefinition (Maybe Text) Source #
The full Amazon Resource Name (ARN) of the task definition.
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_registeredBy :: Lens' TaskDefinition (Maybe Text) Source #
The principal that registered the task definition.
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, even if you have deregistered
previous revisions in this family.
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 are not supported for tasks run
on Fargate.
taskDefinition_cpu :: Lens' TaskDefinition (Maybe Text) Source #
The number of cpu
units used by the task. If you are using the EC2
launch type, this field is optional and any value can be used. If you
are using the Fargate launch type, this field is required and you must
use one of the following values, which determines your range of valid
values for the memory
parameter:
- 256 (.25 vCPU) - Available
memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - 512 (.5 vCPU) - Available
memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - 1024 (1 vCPU) - Available
memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - 2048 (2 vCPU) - Available
memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - 4096 (4 vCPU) - Available
memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
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, specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when considering task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
This parameter is not supported for tasks run on Fargate.
TaskDefinitionPlacementConstraint
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
taskOverride_containerOverrides :: Lens' TaskOverride (Maybe [ContainerOverride]) Source #
One or more container overrides sent to a task.
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_ephemeralStorage :: Lens' TaskOverride (Maybe EphemeralStorage) Source #
The ephemeral storage setting override for the task.
This parameter is only supported for tasks hosted on Fargate using
platform version 1.4.0
or later.
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.
taskOverride_inferenceAcceleratorOverrides :: Lens' TaskOverride (Maybe [InferenceAcceleratorOverride]) Source #
The Elastic Inference accelerator override for the task.
taskOverride_cpu :: Lens' TaskOverride (Maybe Text) Source #
The cpu override for the task.
TaskSet
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_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 is not 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_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 when the task set was created.
taskSet_platformVersion :: Lens' TaskSet (Maybe Text) Source #
The Fargate platform version on which 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_scale :: Lens' TaskSet (Maybe Scale) Source #
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
taskSet_loadBalancers :: Lens' TaskSet (Maybe [LoadBalancer]) Source #
Details on a load balancer that is used with a task set.
taskSet_stabilityStatusAt :: Lens' TaskSet (Maybe UTCTime) Source #
The Unix timestamp for when the task set stability status was retrieved.
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 is restarted after being in the
STOPPED
state.
taskSet_taskSetArn :: Lens' TaskSet (Maybe Text) Source #
The Amazon Resource Name (ARN) of the task set.
taskSet_startedBy :: Lens' TaskSet (Maybe Text) Source #
The tag specified when a task set is started. If the task set is created
by an CodeDeploy deployment, the startedBy
parameter is CODE_DEPLOY
.
For a task set created for an external deployment, the startedBy field
isn't used.
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_updatedAt :: Lens' TaskSet (Maybe UTCTime) Source #
The Unix timestamp for when the task set was last updated.
taskSet_serviceArn :: Lens' TaskSet (Maybe Text) Source #
The Amazon Resource Name (ARN) of the service the task set exists in.
taskSet_taskDefinition :: Lens' TaskSet (Maybe Text) Source #
The task definition the task set is using.
taskSet_externalId :: Lens' TaskSet (Maybe Text) Source #
The external ID associated with the task set.
If a task set is created by an CodeDeploy deployment, 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_networkConfiguration :: Lens' TaskSet (Maybe NetworkConfiguration) Source #
The network configuration for the task set.
taskSet_serviceRegistries :: Lens' TaskSet (Maybe [ServiceRegistry]) Source #
The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
taskSet_capacityProviderStrategy :: Lens' TaskSet (Maybe [CapacityProviderStrategyItem]) Source #
The capacity provider strategy associated with the task set.
taskSet_stabilityStatus :: Lens' TaskSet (Maybe StabilityStatus) Source #
The stability status, which indicates whether the task set has reached a
steady state. If the following conditions are met, the task set will be
in STEADY_STATE
:
- The task
runningCount
is equal to thecomputedDesiredCount
. - The
pendingCount
is0
. - There are no tasks running on container instances in the
DRAINING
status. - All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions are not met, the stability status returns
STABILIZING
.
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, both of which you define.
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.
Tmpfs
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
ulimit_name :: Lens' Ulimit UlimitName Source #
The type
of the ulimit
.
VersionInfo
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 running on the container instance.
Volume
volume_dockerVolumeConfiguration :: Lens' Volume (Maybe DockerVolumeConfiguration) Source #
This parameter is specified when you are using Docker volumes.
Windows containers only support the use of the local
driver. To use
bind mounts, specify the host
parameter instead.
Docker volumes are not supported by tasks run on Fargate.
volume_fsxWindowsFileServerVolumeConfiguration :: Lens' Volume (Maybe FSxWindowsFileServerVolumeConfiguration) Source #
This parameter is specified when you are using Amazon FSx for Windows File Server file system for task storage.
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
.
volume_efsVolumeConfiguration :: Lens' Volume (Maybe EFSVolumeConfiguration) Source #
This parameter is specified when you are using an Amazon Elastic File System file system for task storage.
volume_host :: Lens' Volume (Maybe HostVolumeProperties) Source #
This parameter is specified when you are using 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 is
stored. If the host
parameter is empty, then the Docker daemon assigns
a host path for your data volume. However, the data is not guaranteed to
persist after the containers associated with it stop running.
Windows containers can mount whole directories on the same drive as
$env:ProgramData
. Windows containers cannot mount directories on a
different drive, and mount point cannot be across drives. For example,
you can mount C:\my\path:C:\my\path
and D:\:D:\
, but not
D:\my\path:C:\my\path
or D:\:C:\my\path
.
VolumeFrom
volumeFrom_sourceContainer :: Lens' VolumeFrom (Maybe Text) Source #
The name of another container within the same task definition from which to mount volumes.
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
.