Show / Hide Table of Contents

Namespace Amazon.CDK.AWS.ECS

Classes

AddAutoScalingGroupCapacityOptions

The properties for adding an AutoScalingGroup.

AddCapacityOptions

The properties for adding instance capacity to an AutoScalingGroup.

AlternateTarget

Configuration for alternate target groups used in blue/green deployments with load balancers.

AlternateTargetConfig

Configuration returned by AlternateTargetConfiguration.bind().

AlternateTargetOptions

Options for AlternateTarget configuration.

AlternateTargetProps

Properties for AlternateTarget configuration.

AppMeshProxyConfiguration

The class for App Mesh proxy configurations.

AppMeshProxyConfigurationConfigProps

The configuration to use when setting an App Mesh proxy configuration.

AppMeshProxyConfigurationProps

Interface for setting the properties of proxy configuration.

AppProtocol

Service connect app protocol.

AsgCapacityProvider

An Auto Scaling Group Capacity Provider.

AsgCapacityProviderProps

The options for creating an Auto Scaling Group Capacity Provider.

AssetEnvironmentFile

Environment file from a local directory.

AssetImage

An image that will be built from a local directory with a Dockerfile.

AssetImageProps

The properties for building an AssetImage.

AssociateCloudMapServiceOptions

The options for using a cloudmap service.

AuthorizationConfig

The authorization configuration details for the Amazon EFS file system.

AwsLogDriver

A log driver that sends log information to CloudWatch Logs.

AwsLogDriverProps

Specifies the awslogs log driver configuration options.

BaseLogDriverProps
BaseMountPoint

The base details of where a volume will be mounted within a container.

BaseService

The base class for Ec2Service and FargateService services.

BaseServiceOptions

The properties for the base Ec2Service or FargateService service.

BaseServiceProps

Complete base service properties that are required to be supplied by the implementation of the BaseService class.

BottleRocketImage

Construct an Bottlerocket image from the latest AMI published in SSM.

BottleRocketImageProps

Properties for BottleRocketImage.

BuiltInAttributes

The built-in container instance attributes.

CapacityProviderStrategy

A Capacity Provider strategy to use for the service.

CfnCapacityProvider

Creates a new capacity provider.

CfnCapacityProvider.AutoScalingGroupProviderProperty

The details of the Auto Scaling group for the capacity provider.

CfnCapacityProvider.ManagedScalingProperty

The managed scaling settings for the Auto Scaling group capacity provider.

CfnCapacityProviderProps

Properties for defining a CfnCapacityProvider.

CfnCluster

The AWS::ECS::Cluster resource creates an Amazon Elastic Container Service (Amazon ECS) cluster.

CfnCluster.CapacityProviderStrategyItemProperty

The CapacityProviderStrategyItem property specifies the details of the default capacity provider strategy for the cluster.

CfnCluster.ClusterConfigurationProperty

The execute command and managed storage configuration for the cluster.

CfnCluster.ClusterSettingsProperty

The settings to use when creating a cluster.

CfnCluster.ExecuteCommandConfigurationProperty

The details of the execute command configuration.

CfnCluster.ExecuteCommandLogConfigurationProperty

The log configuration for the results of the execute command actions.

CfnCluster.ManagedStorageConfigurationProperty

The managed storage configuration for the cluster.

CfnCluster.ServiceConnectDefaultsProperty

Use this parameter to set a default Service Connect namespace.

CfnClusterCapacityProviderAssociations

The AWS::ECS::ClusterCapacityProviderAssociations resource associates one or more capacity providers and a default capacity provider strategy with a cluster.

CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty

The CapacityProviderStrategy property specifies the details of the default capacity provider strategy for the cluster.

CfnClusterCapacityProviderAssociationsProps

Properties for defining a CfnClusterCapacityProviderAssociations.

CfnClusterProps

Properties for defining a CfnCluster.

CfnPrimaryTaskSet

Modifies which task set in a service is the primary task set.

CfnPrimaryTaskSetProps

Properties for defining a CfnPrimaryTaskSet.

CfnService

The AWS::ECS::Service resource creates an Amazon Elastic Container Service (Amazon ECS) service that runs and maintains the requested number of tasks and associated load balancers.

CfnService.AdvancedConfigurationProperty

The advanced settings for a load balancer used in blue/green deployments.

CfnService.AwsVpcConfigurationProperty

An object representing the networking details for a task or service.

CfnService.CapacityProviderStrategyItemProperty

The details of a capacity provider strategy.

CfnService.DeploymentAlarmsProperty

One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment.

CfnService.DeploymentCircuitBreakerProperty

The deployment circuit breaker can only be used for services using the rolling update ( ECS ) deployment type.

CfnService.DeploymentConfigurationProperty

Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.

CfnService.DeploymentControllerProperty

The deployment controller to use for the service.

CfnService.DeploymentLifecycleHookProperty

A deployment lifecycle hook runs custom logic at specific stages of the deployment process.

CfnService.EBSTagSpecificationProperty

The tag specifications of an Amazon EBS volume.

CfnService.ForceNewDeploymentProperty
CfnService.LoadBalancerProperty

The LoadBalancer property specifies details on a load balancer that is used with a service.

CfnService.LogConfigurationProperty

The log configuration for the container.

CfnService.NetworkConfigurationProperty

The network configuration for a task or service.

CfnService.PlacementConstraintProperty

An object representing a constraint on task placement.

CfnService.PlacementStrategyProperty

The task placement strategy for a task or service.

CfnService.SecretProperty

An object representing the secret to expose to your container.

CfnService.ServiceConnectClientAliasProperty

Each alias ("endpoint") is a fully-qualified name and port number that other tasks ("clients") can use to connect to this service.

CfnService.ServiceConnectConfigurationProperty

The Service Connect configuration of your Amazon ECS service.

CfnService.ServiceConnectServiceProperty

The Service Connect service object configuration.

CfnService.ServiceConnectTestTrafficRulesHeaderProperty
CfnService.ServiceConnectTestTrafficRulesHeaderValueProperty
CfnService.ServiceConnectTestTrafficRulesProperty

The test traffic routing configuration for Amazon ECS blue/green deployments.

CfnService.ServiceConnectTlsCertificateAuthorityProperty

The certificate root authority that secures your service.

CfnService.ServiceConnectTlsConfigurationProperty

The key that encrypts and decrypts your resources for Service Connect TLS.

CfnService.ServiceManagedEBSVolumeConfigurationProperty

The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf.

CfnService.ServiceRegistryProperty

The details for the service registry.

CfnService.ServiceVolumeConfigurationProperty

The configuration for a volume specified in the task definition as a volume that is configured at launch time.

CfnService.TimeoutConfigurationProperty

An object that represents the timeout configurations for Service Connect.

CfnService.VpcLatticeConfigurationProperty

The VPC Lattice configuration for your service that holds the information for the target group(s) Amazon ECS tasks will be registered to.

CfnServiceProps

Properties for defining a CfnService.

CfnTaskDefinition

Registers a new task definition from the supplied family and containerDefinitions .

CfnTaskDefinition.AuthorizationConfigProperty

The authorization configuration details for the Amazon EFS file system.

CfnTaskDefinition.ContainerDefinitionProperty

The ContainerDefinition property specifies a container definition.

CfnTaskDefinition.ContainerDependencyProperty

The ContainerDependency property specifies the dependencies defined for container startup and shutdown.

CfnTaskDefinition.DeviceProperty

The Device property specifies an object representing a container instance host device.

CfnTaskDefinition.DockerVolumeConfigurationProperty

The DockerVolumeConfiguration property specifies a Docker volume configuration and is used when you use Docker volumes.

CfnTaskDefinition.EFSVolumeConfigurationProperty

This parameter is specified when you're using an Amazon Elastic File System file system for task storage.

CfnTaskDefinition.EnvironmentFileProperty

A list of files containing the environment variables to pass to a container.

CfnTaskDefinition.EphemeralStorageProperty

The amount of ephemeral storage to allocate for the task.

CfnTaskDefinition.FSxAuthorizationConfigProperty

The authorization configuration details for Amazon FSx for Windows File Server file system.

CfnTaskDefinition.FSxWindowsFileServerVolumeConfigurationProperty

This parameter is specified when you're using Amazon FSx for Windows File Server file system for task storage.

CfnTaskDefinition.FirelensConfigurationProperty

The FireLens configuration for the container.

CfnTaskDefinition.HealthCheckProperty

The HealthCheck property specifies an object representing a container health check.

CfnTaskDefinition.HostEntryProperty

The HostEntry property specifies a hostname and an IP address that are added to the /etc/hosts file of a container through the extraHosts parameter of its ContainerDefinition resource.

CfnTaskDefinition.HostVolumePropertiesProperty

The HostVolumeProperties property specifies details on a container instance bind mount host volume.

CfnTaskDefinition.InferenceAcceleratorProperty
CfnTaskDefinition.KernelCapabilitiesProperty

The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition.

CfnTaskDefinition.KeyValuePairProperty

A key-value pair object.

CfnTaskDefinition.LinuxParametersProperty

The Linux-specific options that are applied to the container, such as Linux KernelCapabilities .

CfnTaskDefinition.LogConfigurationProperty

The LogConfiguration property specifies log configuration options to send to a custom log driver for the container.

CfnTaskDefinition.MountPointProperty

The details for a volume mount point that's used in a container definition.

CfnTaskDefinition.PortMappingProperty

The PortMapping property specifies a port mapping.

CfnTaskDefinition.ProxyConfigurationProperty

The configuration details for the App Mesh proxy.

CfnTaskDefinition.RepositoryCredentialsProperty

The repository credentials for private registry authentication.

CfnTaskDefinition.ResourceRequirementProperty

The type and amount of a resource to assign to a container.

CfnTaskDefinition.RestartPolicyProperty

You can enable a restart policy for each container defined in your task definition, to overcome transient failures faster and maintain task availability.

CfnTaskDefinition.RuntimePlatformProperty

Information about the platform for the Amazon ECS service or task.

CfnTaskDefinition.SecretProperty

An object representing the secret to expose to your container.

CfnTaskDefinition.SystemControlProperty

A list of namespaced kernel parameters to set in the container.

CfnTaskDefinition.TaskDefinitionPlacementConstraintProperty

The constraint on task placement in the task definition.

CfnTaskDefinition.TmpfsProperty

The container path, mount options, and size of the tmpfs mount.

CfnTaskDefinition.UlimitProperty

The ulimit settings to pass to the container.

CfnTaskDefinition.VolumeFromProperty

Details on a data volume from another container in the same task definition.

CfnTaskDefinition.VolumeProperty

The data volume configuration for tasks launched using this task definition.

CfnTaskDefinitionProps

Properties for defining a CfnTaskDefinition.

CfnTaskSet

Create a task set in the specified cluster and service.

CfnTaskSet.AwsVpcConfigurationProperty

An object representing the networking details for a task or service.

CfnTaskSet.CapacityProviderStrategyItemProperty

The details of a capacity provider strategy.

CfnTaskSet.LoadBalancerProperty

The load balancer configuration to use with a service or task set.

CfnTaskSet.NetworkConfigurationProperty

The network configuration for a task or service.

CfnTaskSet.ScaleProperty

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

CfnTaskSet.ServiceRegistryProperty

The details for the service registry.

CfnTaskSetProps

Properties for defining a CfnTaskSet.

CloudMapNamespaceOptions

The options for creating an AWS Cloud Map namespace.

CloudMapOptions

The options to enabling AWS Cloud Map for an Amazon ECS service.

Cluster

A regional grouping of one or more container instances on which you can run tasks and services.

ClusterAttributes

The properties to import from the ECS cluster.

ClusterProps

The properties used to define an ECS cluster.

CommonTaskDefinitionAttributes

The common task definition attributes used across all types of task definitions.

CommonTaskDefinitionProps

The common properties for all task definitions.

ContainerDefinition

A container definition is used in a task definition to describe the containers that are launched as part of a task.

ContainerDefinitionOptions
ContainerDefinitionProps

The properties in a container definition.

ContainerDependency

The details of a dependency on another container in the task definition.

ContainerImage

Constructs for types of container images.

ContainerImageConfig

The configuration for creating a container image.

ContainerMountPoint

Defines the mount point details for attaching a volume to a container.

CpuArchitecture

The CpuArchitecture for Fargate Runtime Platform.

CpuUtilizationScalingProps

The properties for enabling scaling based on CPU utilization.

CredentialSpec

Base construct for a credential specification (CredSpec).

CredentialSpecConfig

Configuration for a credential specification (CredSpec) used for a ECS container.

DeploymentAlarmConfig

Configuration for deployment alarms.

DeploymentAlarmOptions

Options for deployment alarms.

DeploymentCircuitBreaker

The deployment circuit breaker to use for the service.

DeploymentController

The deployment controller to use for the service.

DeploymentLifecycleHookTargetConfig

Configuration for a deployment lifecycle hook target.

DeploymentLifecycleLambdaTarget

Use an AWS Lambda function as a deployment lifecycle hook target.

DeploymentLifecycleLambdaTargetProps

Configuration for a lambda deployment lifecycle hook.

Device

A container instance host device.

DockerVolumeConfiguration

The configuration for a Docker volume.

DomainJoinedCredentialSpec

Credential specification (CredSpec) file.

DomainlessCredentialSpec

Credential specification for domainless gMSA.

EBSTagSpecification

Tag Specification for EBS volume.

Ec2Service

This creates a service using the EC2 launch type on an ECS cluster.

Ec2ServiceAttributes

The properties to import from the service using the EC2 launch type.

Ec2ServiceProps

The properties for defining a service using the EC2 launch type.

Ec2TaskDefinition

The details of a task definition run on an EC2 cluster.

Ec2TaskDefinitionAttributes

Attributes used to import an existing EC2 task definition.

Ec2TaskDefinitionProps

The properties for a task definition run on an EC2 cluster.

EcrImage

An image from an Amazon ECR repository.

EcsOptimizedImage

Construct a Linux or Windows machine image from the latest ECS Optimized AMI published in SSM.

EcsOptimizedImageOptions

Additional configuration properties for EcsOptimizedImage factory functions.

EcsTarget
EfsVolumeConfiguration

The configuration for an Elastic FileSystem volume.

EnvironmentFile

Constructs for types of environment files.

EnvironmentFileConfig

Configuration for the environment file.

ExecuteCommandConfiguration

The details of the execute command configuration.

ExecuteCommandLogConfiguration

The log configuration for the results of the execute command actions.

ExternalService

This creates a service using the External launch type on an ECS cluster.

ExternalServiceAttributes

The properties to import from the service using the External launch type.

ExternalServiceProps

The properties for defining a service using the External launch type.

ExternalTaskDefinition

The details of a task definition run on an External cluster.

ExternalTaskDefinitionAttributes

Attributes used to import an existing External task definition.

ExternalTaskDefinitionProps

The properties for a task definition run on an External cluster.

FargateService

This creates a service using the Fargate launch type on an ECS cluster.

FargateServiceAttributes

The properties to import from the service using the Fargate launch type.

FargateServiceProps

The properties for defining a service using the Fargate launch type.

FargateTaskDefinition

The details of a task definition run on a Fargate cluster.

FargateTaskDefinitionAttributes

Attributes used to import an existing Fargate task definition.

FargateTaskDefinitionProps

The properties for a task definition.

FireLensLogDriver

FireLens enables you to use task definition parameters to route logs to an AWS service or AWS Partner Network (APN) destination for log storage and analytics.

FireLensLogDriverProps

Specifies the firelens log driver configuration options.

FirelensConfig

Firelens Configuration https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef.

FirelensLogRouter

Firelens log router.

FirelensLogRouterDefinitionOptions

The options for creating a firelens log router.

FirelensLogRouterProps

The properties in a firelens log router.

FirelensOptions

The options for firelens log router https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef-customconfig.

FluentdLogDriver

A log driver that sends log information to journald Logs.

FluentdLogDriverProps

Specifies the fluentd log driver configuration options.

GelfLogDriver

A log driver that sends log information to journald Logs.

GelfLogDriverProps

Specifies the journald log driver configuration options.

GenericLogDriver

A log driver that sends logs to the specified driver.

GenericLogDriverProps

The configuration to use when creating a log driver.

HealthCheck

The health check command and associated configuration parameters for the container.

Host

The details on a container instance bind mount host volume.

InferenceAccelerator

Elastic Inference Accelerator.

JournaldLogDriver

A log driver that sends log information to journald Logs.

JournaldLogDriverProps

Specifies the journald log driver configuration options.

JsonFileLogDriver

A log driver that sends log information to json-file Logs.

JsonFileLogDriverProps

Specifies the json-file log driver configuration options.

LinuxParameters

Linux-specific options that are applied to the container.

LinuxParametersProps

The properties for defining Linux-specific options that are applied to the container.

ListenerConfig

Base class for configuring listener when registering targets.

ListenerRuleConfiguration

Represents a listener configuration for advanced load balancer settings.

LoadBalancerTargetOptions

Properties for defining an ECS target.

LogDriver

The base class for log drivers.

LogDriverConfig

The configuration to use when creating a log driver.

LogDrivers

The base class for log drivers.

ManagedStorageConfiguration

Kms Keys for encryption ECS managed storage.

MemoryUtilizationScalingProps

The properties for enabling scaling based on memory utilization.

MountPoint

The details of data volume mount points for a container.

OperatingSystemFamily

The operating system for Fargate Runtime Platform.

PlacementConstraint

The placement constraints to use for tasks in the service. For more information, see Amazon ECS Task Placement Constraints.

PlacementStrategy

The placement strategies to use for tasks in the service. For more information, see Amazon ECS Task Placement Strategies.

PortMap

PortMap ValueObjectClass having by ContainerDefinition.

PortMapping

Port mappings allow containers to access ports on the host container instance to send or receive traffic.

ProxyConfiguration

The base class for proxy configurations.

ProxyConfigurations

The base class for proxy configurations.

RepositoryImage

An image hosted in a public or private repository.

RepositoryImageProps

The properties for an image hosted in a public or private repository.

RequestCountScalingProps

The properties for enabling scaling based on Application Load Balancer (ALB) request counts.

RuntimePlatform

The interface for Runtime Platform.

S3EnvironmentFile

Environment file from S3.

ScalableTaskCount

The scalable attribute representing task count.

ScalableTaskCountProps

The properties of a scalable attribute representing task count.

ScratchSpace

The temporary disk space mounted to the container.

Secret

A secret environment variable.

SecretVersionInfo

Specify the secret's version id or version stage.

ServiceConnect

ServiceConnect ValueObjectClass having by ContainerDefinition.

ServiceConnectProps

Interface for Service Connect configuration.

ServiceConnectService

Interface for service connect Service props.

ServiceConnectTlsConfiguration

TLS configuration for Service Connect service.

ServiceManagedEBSVolumeConfiguration

Represents the configuration for an ECS Service managed EBS volume.

ServiceManagedVolume

Represents a service-managed volume and always configured at launch.

ServiceManagedVolumeProps

Represents the Volume configuration for an ECS service.

SplunkLogDriver

A log driver that sends log information to splunk Logs.

SplunkLogDriverProps

Specifies the splunk log driver configuration options.

SyslogLogDriver

A log driver that sends log information to syslog Logs.

SyslogLogDriverProps

Specifies the syslog log driver configuration options.

SystemControl

Kernel parameters to set in the container.

TagParameterContainerImage

A special type of ContainerImage that uses an ECR repository for the image, but a CloudFormation Parameter for the tag of the image in that repository.

TaskDefinition

The base class for all task definitions.

TaskDefinitionAttributes

A reference to an existing task definition.

TaskDefinitionProps

The properties for task definitions.

TaskDefinitionRevision

Represents revision of a task definition, either a specific numbered revision or the latest revision.

Tmpfs

The details of a tmpfs mount for a container.

TrackCustomMetricProps

The properties for enabling target tracking scaling based on a custom CloudWatch metric.

Ulimit

The ulimit settings to pass to the container.

Volume

A data volume used in a task definition.

VolumeFrom

The details on a data volume from another container in the same task definition.

Interfaces

CfnCapacityProvider.IAutoScalingGroupProviderProperty

The details of the Auto Scaling group for the capacity provider.

CfnCapacityProvider.IManagedScalingProperty

The managed scaling settings for the Auto Scaling group capacity provider.

CfnCluster.ICapacityProviderStrategyItemProperty

The CapacityProviderStrategyItem property specifies the details of the default capacity provider strategy for the cluster.

CfnCluster.IClusterConfigurationProperty

The execute command and managed storage configuration for the cluster.

CfnCluster.IClusterSettingsProperty

The settings to use when creating a cluster.

CfnCluster.IExecuteCommandConfigurationProperty

The details of the execute command configuration.

CfnCluster.IExecuteCommandLogConfigurationProperty

The log configuration for the results of the execute command actions.

CfnCluster.IManagedStorageConfigurationProperty

The managed storage configuration for the cluster.

CfnCluster.IServiceConnectDefaultsProperty

Use this parameter to set a default Service Connect namespace.

CfnClusterCapacityProviderAssociations.ICapacityProviderStrategyProperty

The CapacityProviderStrategy property specifies the details of the default capacity provider strategy for the cluster.

CfnService.IAdvancedConfigurationProperty

The advanced settings for a load balancer used in blue/green deployments.

CfnService.IAwsVpcConfigurationProperty

An object representing the networking details for a task or service.

CfnService.ICapacityProviderStrategyItemProperty

The details of a capacity provider strategy.

CfnService.IDeploymentAlarmsProperty

One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment.

CfnService.IDeploymentCircuitBreakerProperty

The deployment circuit breaker can only be used for services using the rolling update ( ECS ) deployment type.

CfnService.IDeploymentConfigurationProperty

Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.

CfnService.IDeploymentControllerProperty

The deployment controller to use for the service.

CfnService.IDeploymentLifecycleHookProperty

A deployment lifecycle hook runs custom logic at specific stages of the deployment process.

CfnService.IEBSTagSpecificationProperty

The tag specifications of an Amazon EBS volume.

CfnService.IForceNewDeploymentProperty
CfnService.ILoadBalancerProperty

The LoadBalancer property specifies details on a load balancer that is used with a service.

CfnService.ILogConfigurationProperty

The log configuration for the container.

CfnService.INetworkConfigurationProperty

The network configuration for a task or service.

CfnService.IPlacementConstraintProperty

An object representing a constraint on task placement.

CfnService.IPlacementStrategyProperty

The task placement strategy for a task or service.

CfnService.ISecretProperty

An object representing the secret to expose to your container.

CfnService.IServiceConnectClientAliasProperty

Each alias ("endpoint") is a fully-qualified name and port number that other tasks ("clients") can use to connect to this service.

CfnService.IServiceConnectConfigurationProperty

The Service Connect configuration of your Amazon ECS service.

CfnService.IServiceConnectServiceProperty

The Service Connect service object configuration.

CfnService.IServiceConnectTestTrafficRulesHeaderProperty
CfnService.IServiceConnectTestTrafficRulesHeaderValueProperty
CfnService.IServiceConnectTestTrafficRulesProperty

The test traffic routing configuration for Amazon ECS blue/green deployments.

CfnService.IServiceConnectTlsCertificateAuthorityProperty

The certificate root authority that secures your service.

CfnService.IServiceConnectTlsConfigurationProperty

The key that encrypts and decrypts your resources for Service Connect TLS.

CfnService.IServiceManagedEBSVolumeConfigurationProperty

The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf.

CfnService.IServiceRegistryProperty

The details for the service registry.

CfnService.IServiceVolumeConfigurationProperty

The configuration for a volume specified in the task definition as a volume that is configured at launch time.

CfnService.ITimeoutConfigurationProperty

An object that represents the timeout configurations for Service Connect.

CfnService.IVpcLatticeConfigurationProperty

The VPC Lattice configuration for your service that holds the information for the target group(s) Amazon ECS tasks will be registered to.

CfnTaskDefinition.IAuthorizationConfigProperty

The authorization configuration details for the Amazon EFS file system.

CfnTaskDefinition.IContainerDefinitionProperty

The ContainerDefinition property specifies a container definition.

CfnTaskDefinition.IContainerDependencyProperty

The ContainerDependency property specifies the dependencies defined for container startup and shutdown.

CfnTaskDefinition.IDeviceProperty

The Device property specifies an object representing a container instance host device.

CfnTaskDefinition.IDockerVolumeConfigurationProperty

The DockerVolumeConfiguration property specifies a Docker volume configuration and is used when you use Docker volumes.

CfnTaskDefinition.IEFSVolumeConfigurationProperty

This parameter is specified when you're using an Amazon Elastic File System file system for task storage.

CfnTaskDefinition.IEnvironmentFileProperty

A list of files containing the environment variables to pass to a container.

CfnTaskDefinition.IEphemeralStorageProperty

The amount of ephemeral storage to allocate for the task.

CfnTaskDefinition.IFSxAuthorizationConfigProperty

The authorization configuration details for Amazon FSx for Windows File Server file system.

CfnTaskDefinition.IFSxWindowsFileServerVolumeConfigurationProperty

This parameter is specified when you're using Amazon FSx for Windows File Server file system for task storage.

CfnTaskDefinition.IFirelensConfigurationProperty

The FireLens configuration for the container.

CfnTaskDefinition.IHealthCheckProperty

The HealthCheck property specifies an object representing a container health check.

CfnTaskDefinition.IHostEntryProperty

The HostEntry property specifies a hostname and an IP address that are added to the /etc/hosts file of a container through the extraHosts parameter of its ContainerDefinition resource.

CfnTaskDefinition.IHostVolumePropertiesProperty

The HostVolumeProperties property specifies details on a container instance bind mount host volume.

CfnTaskDefinition.IInferenceAcceleratorProperty
CfnTaskDefinition.IKernelCapabilitiesProperty

The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition.

CfnTaskDefinition.IKeyValuePairProperty

A key-value pair object.

CfnTaskDefinition.ILinuxParametersProperty

The Linux-specific options that are applied to the container, such as Linux KernelCapabilities .

CfnTaskDefinition.ILogConfigurationProperty

The LogConfiguration property specifies log configuration options to send to a custom log driver for the container.

CfnTaskDefinition.IMountPointProperty

The details for a volume mount point that's used in a container definition.

CfnTaskDefinition.IPortMappingProperty

The PortMapping property specifies a port mapping.

CfnTaskDefinition.IProxyConfigurationProperty

The configuration details for the App Mesh proxy.

CfnTaskDefinition.IRepositoryCredentialsProperty

The repository credentials for private registry authentication.

CfnTaskDefinition.IResourceRequirementProperty

The type and amount of a resource to assign to a container.

CfnTaskDefinition.IRestartPolicyProperty

You can enable a restart policy for each container defined in your task definition, to overcome transient failures faster and maintain task availability.

CfnTaskDefinition.IRuntimePlatformProperty

Information about the platform for the Amazon ECS service or task.

CfnTaskDefinition.ISecretProperty

An object representing the secret to expose to your container.

CfnTaskDefinition.ISystemControlProperty

A list of namespaced kernel parameters to set in the container.

CfnTaskDefinition.ITaskDefinitionPlacementConstraintProperty

The constraint on task placement in the task definition.

CfnTaskDefinition.ITmpfsProperty

The container path, mount options, and size of the tmpfs mount.

CfnTaskDefinition.IUlimitProperty

The ulimit settings to pass to the container.

CfnTaskDefinition.IVolumeFromProperty

Details on a data volume from another container in the same task definition.

CfnTaskDefinition.IVolumeProperty

The data volume configuration for tasks launched using this task definition.

CfnTaskSet.IAwsVpcConfigurationProperty

An object representing the networking details for a task or service.

CfnTaskSet.ICapacityProviderStrategyItemProperty

The details of a capacity provider strategy.

CfnTaskSet.ILoadBalancerProperty

The load balancer configuration to use with a service or task set.

CfnTaskSet.INetworkConfigurationProperty

The network configuration for a task or service.

CfnTaskSet.IScaleProperty

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

CfnTaskSet.IServiceRegistryProperty

The details for the service registry.

IAddAutoScalingGroupCapacityOptions

The properties for adding an AutoScalingGroup.

IAddCapacityOptions

The properties for adding instance capacity to an AutoScalingGroup.

IAlternateTarget

Interface for configuring alternate target groups for blue/green deployments.

IAlternateTargetConfig

Configuration returned by AlternateTargetConfiguration.bind().

IAlternateTargetOptions

Options for AlternateTarget configuration.

IAlternateTargetProps

Properties for AlternateTarget configuration.

IAppMeshProxyConfigurationConfigProps

The configuration to use when setting an App Mesh proxy configuration.

IAppMeshProxyConfigurationProps

Interface for setting the properties of proxy configuration.

IAsgCapacityProviderProps

The options for creating an Auto Scaling Group Capacity Provider.

IAssetImageProps

The properties for building an AssetImage.

IAssociateCloudMapServiceOptions

The options for using a cloudmap service.

IAuthorizationConfig

The authorization configuration details for the Amazon EFS file system.

IAwsLogDriverProps

Specifies the awslogs log driver configuration options.

IBaseLogDriverProps
IBaseMountPoint

The base details of where a volume will be mounted within a container.

IBaseService

The interface for BaseService.

IBaseServiceOptions

The properties for the base Ec2Service or FargateService service.

IBaseServiceProps

Complete base service properties that are required to be supplied by the implementation of the BaseService class.

IBottleRocketImageProps

Properties for BottleRocketImage.

ICapacityProviderStrategy

A Capacity Provider strategy to use for the service.

ICfnCapacityProviderProps

Properties for defining a CfnCapacityProvider.

ICfnClusterCapacityProviderAssociationsProps

Properties for defining a CfnClusterCapacityProviderAssociations.

ICfnClusterProps

Properties for defining a CfnCluster.

ICfnPrimaryTaskSetProps

Properties for defining a CfnPrimaryTaskSet.

ICfnServiceProps

Properties for defining a CfnService.

ICfnTaskDefinitionProps

Properties for defining a CfnTaskDefinition.

ICfnTaskSetProps

Properties for defining a CfnTaskSet.

ICloudMapNamespaceOptions

The options for creating an AWS Cloud Map namespace.

ICloudMapOptions

The options to enabling AWS Cloud Map for an Amazon ECS service.

ICluster

A regional grouping of one or more container instances on which you can run tasks and services.

IClusterAttributes

The properties to import from the ECS cluster.

IClusterProps

The properties used to define an ECS cluster.

ICommonTaskDefinitionAttributes

The common task definition attributes used across all types of task definitions.

ICommonTaskDefinitionProps

The common properties for all task definitions.

IContainerDefinitionOptions
IContainerDefinitionProps

The properties in a container definition.

IContainerDependency

The details of a dependency on another container in the task definition.

IContainerImageConfig

The configuration for creating a container image.

IContainerMountPoint

Defines the mount point details for attaching a volume to a container.

ICpuUtilizationScalingProps

The properties for enabling scaling based on CPU utilization.

ICredentialSpecConfig

Configuration for a credential specification (CredSpec) used for a ECS container.

IDeploymentAlarmConfig

Configuration for deployment alarms.

IDeploymentAlarmOptions

Options for deployment alarms.

IDeploymentCircuitBreaker

The deployment circuit breaker to use for the service.

IDeploymentController

The deployment controller to use for the service.

IDeploymentLifecycleHookTarget

Interface for deployment lifecycle hook targets.

IDeploymentLifecycleHookTargetConfig

Configuration for a deployment lifecycle hook target.

IDeploymentLifecycleLambdaTargetProps

Configuration for a lambda deployment lifecycle hook.

IDevice

A container instance host device.

IDockerVolumeConfiguration

The configuration for a Docker volume.

IEBSTagSpecification

Tag Specification for EBS volume.

IEc2Service

The interface for a service using the EC2 launch type on an ECS cluster.

IEc2ServiceAttributes

The properties to import from the service using the EC2 launch type.

IEc2ServiceProps

The properties for defining a service using the EC2 launch type.

IEc2TaskDefinition

The interface of a task definition run on an EC2 cluster.

IEc2TaskDefinitionAttributes

Attributes used to import an existing EC2 task definition.

IEc2TaskDefinitionProps

The properties for a task definition run on an EC2 cluster.

IEcsLoadBalancerTarget

Interface for ECS load balancer target.

IEcsOptimizedImageOptions

Additional configuration properties for EcsOptimizedImage factory functions.

IEcsTarget
IEfsVolumeConfiguration

The configuration for an Elastic FileSystem volume.

IEnvironmentFileConfig

Configuration for the environment file.

IExecuteCommandConfiguration

The details of the execute command configuration.

IExecuteCommandLogConfiguration

The log configuration for the results of the execute command actions.

IExternalService

The interface for a service using the External launch type on an ECS cluster.

IExternalServiceAttributes

The properties to import from the service using the External launch type.

IExternalServiceProps

The properties for defining a service using the External launch type.

IExternalTaskDefinition

The interface of a task definition run on an External cluster.

IExternalTaskDefinitionAttributes

Attributes used to import an existing External task definition.

IExternalTaskDefinitionProps

The properties for a task definition run on an External cluster.

IFargateService

The interface for a service using the Fargate launch type on an ECS cluster.

IFargateServiceAttributes

The properties to import from the service using the Fargate launch type.

IFargateServiceProps

The properties for defining a service using the Fargate launch type.

IFargateTaskDefinition

The interface of a task definition run on a Fargate cluster.

IFargateTaskDefinitionAttributes

Attributes used to import an existing Fargate task definition.

IFargateTaskDefinitionProps

The properties for a task definition.

IFireLensLogDriverProps

Specifies the firelens log driver configuration options.

IFirelensConfig

Firelens Configuration https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef.

IFirelensLogRouterDefinitionOptions

The options for creating a firelens log router.

IFirelensLogRouterProps

The properties in a firelens log router.

IFirelensOptions

The options for firelens log router https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef-customconfig.

IFluentdLogDriverProps

Specifies the fluentd log driver configuration options.

IGelfLogDriverProps

Specifies the journald log driver configuration options.

IGenericLogDriverProps

The configuration to use when creating a log driver.

IHealthCheck

The health check command and associated configuration parameters for the container.

IHost

The details on a container instance bind mount host volume.

IInferenceAccelerator

Elastic Inference Accelerator.

IJournaldLogDriverProps

Specifies the journald log driver configuration options.

IJsonFileLogDriverProps

Specifies the json-file log driver configuration options.

ILinuxParametersProps

The properties for defining Linux-specific options that are applied to the container.

ILoadBalancerTargetOptions

Properties for defining an ECS target.

ILogDriverConfig

The configuration to use when creating a log driver.

IManagedStorageConfiguration

Kms Keys for encryption ECS managed storage.

IMemoryUtilizationScalingProps

The properties for enabling scaling based on memory utilization.

IMountPoint

The details of data volume mount points for a container.

IPortMapping

Port mappings allow containers to access ports on the host container instance to send or receive traffic.

IRepositoryImageProps

The properties for an image hosted in a public or private repository.

IRequestCountScalingProps

The properties for enabling scaling based on Application Load Balancer (ALB) request counts.

IRuntimePlatform

The interface for Runtime Platform.

IScalableTaskCountProps

The properties of a scalable attribute representing task count.

IScratchSpace

The temporary disk space mounted to the container.

ISecretVersionInfo

Specify the secret's version id or version stage.

IService

The interface for a service.

IServiceConnectProps

Interface for Service Connect configuration.

IServiceConnectService

Interface for service connect Service props.

IServiceConnectTlsConfiguration

TLS configuration for Service Connect service.

IServiceManagedEBSVolumeConfiguration

Represents the configuration for an ECS Service managed EBS volume.

IServiceManagedVolumeProps

Represents the Volume configuration for an ECS service.

ISplunkLogDriverProps

Specifies the splunk log driver configuration options.

ISyslogLogDriverProps

Specifies the syslog log driver configuration options.

ISystemControl

Kernel parameters to set in the container.

ITaskDefinition

The interface for all task definitions.

ITaskDefinitionAttributes

A reference to an existing task definition.

ITaskDefinitionExtension

An extension for Task Definitions.

ITaskDefinitionProps

The properties for task definitions.

ITmpfs

The details of a tmpfs mount for a container.

ITrackCustomMetricProps

The properties for enabling target tracking scaling based on a custom CloudWatch metric.

IUlimit

The ulimit settings to pass to the container.

IVolume

A data volume used in a task definition.

IVolumeFrom

The details on a data volume from another container in the same task definition.

Enums

AlarmBehavior

Deployment behavior when an ECS Service Deployment Alarm is triggered.

AmiHardwareType

The ECS-optimized AMI variant to use.

AvailabilityZoneRebalancing

Indicates whether to use Availability Zone rebalancing for an ECS service.

AwsLogDriverMode

awslogs provides two modes for delivering messages from the container to the log driver.

BinPackResource

Instance resource used for bin packing.

BottlerocketEcsVariant

Amazon ECS variant.

Capability

A Linux capability.

Compatibility

The task launch type compatibility requirement.

ContainerDependencyCondition
ContainerInsights

The CloudWatch Container Insights setting.

DeploymentControllerType

The deployment controller type to use for the service.

DeploymentLifecycleStage

Deployment lifecycle stages where hooks can be executed.

DeploymentStrategy

The deployment stratergy to use for ECS controller.

DevicePermission

Permissions for device access.

EbsPropagatedTagSource

Propagate tags for EBS Volume Configuration from either service or task definition.

EnvironmentFileType

Type of environment file to be included in the container definition.

ExecuteCommandLogging

The log settings to use to for logging the execute command session.

FargatePlatformVersion

The platform version on which to run your service.

FileSystemType

FileSystemType for Service Managed EBS Volume Configuration.

FirelensConfigFileType

Firelens configuration file type, s3 or file path.

FirelensLogRouterType

Firelens log router type, fluentbit or fluentd.

GelfCompressionType

The type of compression the GELF driver uses to compress each log message.

IpcMode

The IPC resource namespace to use for the containers in the task.

LaunchType

The launch type of an ECS service.

MachineImageType

The machine image type.

NetworkMode

The networking mode to use for the containers in the task.

PidMode

The process namespace to use for the containers in the task.

PropagatedTagSource

Propagate tags from either service or task definition.

Protocol

Network protocol.

Scope

The scope for the Docker volume that determines its lifecycle.

SplunkLogFormat

Log Message Format.

TmpfsMountOption

The supported options for a tmpfs mount for a container.

UlimitName

Type of resource to set a limit on.

VersionConsistency

State of the container version consistency feature.

WindowsOptimizedVersion

ECS-optimized Windows version list.

Back to top Generated by DocFX