ecs-2014-11-13 library

Classes

Attachment
An object representing a container instance or task attachment.
AttachmentStateChange
An object representing a change in state for a task attachment.
Attribute
An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
AutoScalingGroupProvider
The details of the Auto Scaling group for the capacity provider.
AutoScalingGroupProviderUpdate
The details of the Auto Scaling group capacity provider to update.
AwsClientCredentials
AWS credentials.
AwsVpcConfiguration
An object representing the networking details for a task or service.
CapacityProvider
The details of a capacity provider.
CapacityProviderStrategyItem
The details of a capacity provider strategy.
Cluster
A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
ClusterSetting
The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster.
Container
A Docker container that is part of a task.
ContainerDefinition
Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
ContainerDependency
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.
ContainerInstance
An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
ContainerOverride
The overrides that should be sent to a container. An empty container override can be passed in. An example of an empty container override would be {"containerOverrides": }. If a non-empty container override is specified, the name parameter must be included.
ContainerStateChange
An object representing a change in state for a container.
CreateCapacityProviderResponse
CreateClusterResponse
CreateServiceResponse
CreateTaskSetResponse
DeleteAccountSettingResponse
DeleteAttributesResponse
DeleteCapacityProviderResponse
DeleteClusterResponse
DeleteServiceResponse
DeleteTaskSetResponse
Deployment
The details of an Amazon ECS service deployment. This is used only when a service uses the ECS deployment controller type.
DeploymentCircuitBreaker
deployment circuit breaker
DeploymentConfiguration
Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.
DeploymentController
The deployment controller to use for the service. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
DeregisterContainerInstanceResponse
DeregisterTaskDefinitionResponse
DescribeCapacityProvidersResponse
DescribeClustersResponse
DescribeContainerInstancesResponse
DescribeServicesResponse
DescribeTaskDefinitionResponse
DescribeTaskSetsResponse
DescribeTasksResponse
Device
An object representing a container instance host device.
DiscoverPollEndpointResponse
DockerVolumeConfiguration
This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.
ECS
Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see Amazon ECS Launch Types.
EFSAuthorizationConfig
The authorization configuration details for the Amazon EFS file system.
EFSVolumeConfiguration
This parameter is specified when you are using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS Volumes in the Amazon Elastic Container Service Developer Guide.
EnvironmentFile
A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information on the environment variable file syntax, see Declare default environment variables in file.
Failure
A failed resource. For a list of common causes, see API failure reasons in the Amazon Elastic Container Service Developer Guide.
FirelensConfiguration
The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.
FSxWindowsFileServerAuthorizationConfig
The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon Elastic Container Service API Reference.
FSxWindowsFileServerVolumeConfiguration
This parameter is specified when you are using Amazon FSx for Windows File Server file system for task storage.
HealthCheck
An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).
HostEntry
Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition.
HostVolumeProperties
Details on a container instance bind mount host volume.
InferenceAccelerator
Details on a Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
InferenceAcceleratorOverride
Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
KernelCapabilities
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information on these Linux capabilities, see the capabilities(7) Linux manual page.
KeyValuePair
A key-value pair object.
LinuxParameters
Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
ListAccountSettingsResponse
ListAttributesResponse
ListClustersResponse
ListContainerInstancesResponse
ListServicesResponse
ListTagsForResourceResponse
ListTaskDefinitionFamiliesResponse
ListTaskDefinitionsResponse
ListTasksResponse
LoadBalancer
The load balancer configuration to use with a service or task set.
LogConfiguration
The log configuration for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run .
ManagedScaling
The managed scaling settings for the Auto Scaling group capacity provider.
MountPoint
Details on a volume mount point that is used in a container definition.
NetworkBinding
Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
NetworkConfiguration
An object representing the network configuration for a task or service.
NetworkInterface
An object representing the elastic network interface for tasks that use the awsvpc network mode.
PlacementConstraint
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
PlacementStrategy
The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide.
PlatformDevice
The devices that are available on the container instance. The only supported device type is a GPU.
PortMapping
Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.
ProxyConfiguration
The configuration details for the App Mesh proxy.
PutAccountSettingDefaultResponse
PutAccountSettingResponse
PutAttributesResponse
PutClusterCapacityProvidersResponse
RegisterContainerInstanceResponse
RegisterTaskDefinitionResponse
RepositoryCredentials
The repository credentials for private registry authentication.
Resource
Describes the resources available for a container instance.
ResourceRequirement
The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide
RunTaskResponse
Scale
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
Secret
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
Service
Details on a service within a cluster
ServiceEvent
Details on an event associated with a service.
ServiceRegistry
Details of the service registry.
Setting
The current account setting for a resource.
StartTaskResponse
StopTaskResponse
SubmitAttachmentStateChangesResponse
SubmitContainerStateChangeResponse
SubmitTaskStateChangeResponse
SystemControl
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.
Tag
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
TagResourceResponse
Task
Details on a task in a cluster.
TaskDefinition
The details of a task definition which describes the container and volume definitions of an Amazon Elastic Container Service task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.
TaskDefinitionPlacementConstraint
An object representing a constraint on task placement in the task definition. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
TaskOverride
The overrides associated with a task.
TaskSet
Information about a set of Amazon ECS tasks in either an AWS 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.
Tmpfs
The container path, mount options, and size of the tmpfs mount.
Ulimit
The ulimit settings to pass to the container.
UntagResourceResponse
UpdateCapacityProviderResponse
UpdateClusterSettingsResponse
UpdateContainerAgentResponse
UpdateContainerInstancesStateResponse
UpdateServicePrimaryTaskSetResponse
UpdateServiceResponse
UpdateTaskSetResponse
VersionInfo
The Docker and Amazon ECS container agent version information about a container instance.
Volume
A data volume used in a task definition. For tasks that use the Amazon Elastic File System (Amazon EFS), specify an efsVolumeConfiguration. For Windows tasks that use Amazon FSx for Windows File Server file system, specify a fsxWindowsFileServerVolumeConfiguration. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information, see Using Data Volumes in Tasks.
VolumeFrom
Details on a data volume from another container in the same task definition.