amazonka-ecs-2.0: Amazon EC2 Container Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ECS.Types

Contents

Description

 
Synopsis

Service Configuration

defaultService :: Service Source #

API version 2014-11-13 of the Amazon EC2 Container Service SDK configuration.

Errors

_AccessDeniedException :: AsError a => Fold a ServiceError Source #

You don't have authorization to perform the requested action.

_AttributeLimitExceededException :: AsError a => Fold a ServiceError Source #

You can apply up to 10 custom attributes for each resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.

_BlockedException :: AsError a => Fold a ServiceError Source #

Your Amazon Web Services account was blocked. For more information, contact Amazon Web Services Support.

_ClientException :: AsError a => Fold a ServiceError Source #

These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource,. Or, it might be specifying an identifier that isn't valid.

_ClusterContainsContainerInstancesException :: AsError a => Fold a ServiceError Source #

You can't delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.

_ClusterContainsServicesException :: AsError a => Fold a ServiceError Source #

You can't delete a cluster that contains services. First, update the service to reduce its desired task count to 0, and then delete the service. For more information, see UpdateService and DeleteService.

_ClusterContainsTasksException :: AsError a => Fold a ServiceError Source #

You can't delete a cluster that has active tasks.

_ClusterNotFoundException :: AsError a => Fold a ServiceError Source #

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

_InvalidParameterException :: AsError a => Fold a ServiceError Source #

The specified parameter isn't valid. Review the available parameters for the API request.

_LimitExceededException :: AsError a => Fold a ServiceError Source #

The limit for the resource was exceeded.

_MissingVersionException :: AsError a => Fold a ServiceError Source #

Amazon ECS can't determine the current version of the Amazon ECS container agent on the container instance and doesn't have enough information to proceed with an update. This could be because the agent running on the container instance is a previous or custom version that doesn't use our version information.

_NamespaceNotFoundException :: AsError a => Fold a ServiceError Source #

The specified namespace wasn't found.

_NoUpdateAvailableException :: AsError a => Fold a ServiceError Source #

There's no update available for this Amazon ECS container agent. This might be because the agent is already running the latest version or because it's so old that there's no update path to the current version.

_PlatformTaskDefinitionIncompatibilityException :: AsError a => Fold a ServiceError Source #

The specified platform version doesn't satisfy the required capabilities of the task definition.

_PlatformUnknownException :: AsError a => Fold a ServiceError Source #

The specified platform version doesn't exist.

_ResourceInUseException :: AsError a => Fold a ServiceError Source #

The specified resource is in-use and can't be removed.

_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #

The specified resource wasn't found.

_ServerException :: AsError a => Fold a ServiceError Source #

These errors are usually caused by a server issue.

_ServiceNotActiveException :: AsError a => Fold a ServiceError Source #

The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.

_ServiceNotFoundException :: AsError a => Fold a ServiceError Source #

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

_TargetNotConnectedException :: AsError a => Fold a ServiceError Source #

The execute command cannot run. This error can be caused by any of the following configuration issues:

  • Incorrect IAM permissions
  • The SSM agent is not installed or is not running
  • There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for for Systems Manager Session Manager

For information about how to troubleshoot the issues, see Troubleshooting issues with ECS Exec in the Amazon Elastic Container Service Developer Guide.

_TargetNotFoundException :: AsError a => Fold a ServiceError Source #

The specified target wasn't found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.

_TaskSetNotFoundException :: AsError a => Fold a ServiceError Source #

The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.

_UnsupportedFeatureException :: AsError a => Fold a ServiceError Source #

The specified task isn't supported in this Region.

_UpdateInProgressException :: AsError a => Fold a ServiceError Source #

There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.

AgentUpdateStatus

newtype AgentUpdateStatus Source #

Instances

Instances details
FromJSON AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

FromJSONKey AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

ToJSON AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

ToJSONKey AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

ToByteString AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

ToHeader AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

ToLog AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

ToQuery AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

FromText AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

ToText AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

FromXML AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

ToXML AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

Generic AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

Associated Types

type Rep AgentUpdateStatus :: Type -> Type #

Read AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

Show AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

NFData AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

Methods

rnf :: AgentUpdateStatus -> () #

Eq AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

Ord AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

Hashable AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

type Rep AgentUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.AgentUpdateStatus

type Rep AgentUpdateStatus = D1 ('MetaData "AgentUpdateStatus" "Amazonka.ECS.Types.AgentUpdateStatus" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "AgentUpdateStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAgentUpdateStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ApplicationProtocol

newtype ApplicationProtocol Source #

Instances

Instances details
FromJSON ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

FromJSONKey ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

ToJSON ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

ToJSONKey ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

ToByteString ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

ToHeader ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

ToLog ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

ToQuery ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

FromText ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

ToText ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

FromXML ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

ToXML ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

Generic ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

Associated Types

type Rep ApplicationProtocol :: Type -> Type #

Read ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

Show ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

NFData ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

Methods

rnf :: ApplicationProtocol -> () #

Eq ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

Ord ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

Hashable ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

type Rep ApplicationProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.ApplicationProtocol

type Rep ApplicationProtocol = D1 ('MetaData "ApplicationProtocol" "Amazonka.ECS.Types.ApplicationProtocol" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "ApplicationProtocol'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromApplicationProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AssignPublicIp

newtype AssignPublicIp Source #

Constructors

AssignPublicIp' 

Instances

Instances details
FromJSON AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

FromJSONKey AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

ToJSON AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

ToJSONKey AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

ToByteString AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

ToHeader AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

ToLog AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

ToQuery AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

FromText AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

ToText AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

FromXML AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

ToXML AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

Methods

toXML :: AssignPublicIp -> XML #

Generic AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

Associated Types

type Rep AssignPublicIp :: Type -> Type #

Read AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

Show AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

NFData AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

Methods

rnf :: AssignPublicIp -> () #

Eq AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

Ord AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

Hashable AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

type Rep AssignPublicIp Source # 
Instance details

Defined in Amazonka.ECS.Types.AssignPublicIp

type Rep AssignPublicIp = D1 ('MetaData "AssignPublicIp" "Amazonka.ECS.Types.AssignPublicIp" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "AssignPublicIp'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAssignPublicIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CPUArchitecture

newtype CPUArchitecture Source #

Constructors

CPUArchitecture' 

Instances

Instances details
FromJSON CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

FromJSONKey CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

ToJSON CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

ToJSONKey CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

ToByteString CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

ToHeader CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

ToLog CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

ToQuery CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

FromText CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

ToText CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

FromXML CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

ToXML CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

Methods

toXML :: CPUArchitecture -> XML #

Generic CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

Associated Types

type Rep CPUArchitecture :: Type -> Type #

Read CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

Show CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

NFData CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

Methods

rnf :: CPUArchitecture -> () #

Eq CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

Ord CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

Hashable CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

type Rep CPUArchitecture Source # 
Instance details

Defined in Amazonka.ECS.Types.CPUArchitecture

type Rep CPUArchitecture = D1 ('MetaData "CPUArchitecture" "Amazonka.ECS.Types.CPUArchitecture" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "CPUArchitecture'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCPUArchitecture") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CapacityProviderField

newtype CapacityProviderField Source #

Instances

Instances details
FromJSON CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

FromJSONKey CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

ToJSON CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

ToJSONKey CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

ToByteString CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

ToHeader CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

ToLog CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

ToQuery CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

FromText CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

ToText CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

FromXML CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

ToXML CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

Generic CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

Associated Types

type Rep CapacityProviderField :: Type -> Type #

Read CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

Show CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

NFData CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

Methods

rnf :: CapacityProviderField -> () #

Eq CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

Ord CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

Hashable CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

type Rep CapacityProviderField Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderField

type Rep CapacityProviderField = D1 ('MetaData "CapacityProviderField" "Amazonka.ECS.Types.CapacityProviderField" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "CapacityProviderField'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCapacityProviderField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CapacityProviderStatus

newtype CapacityProviderStatus Source #

Instances

Instances details
FromJSON CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

FromJSONKey CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

ToJSON CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

ToJSONKey CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

ToByteString CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

ToHeader CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

ToLog CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

ToQuery CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

FromText CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

ToText CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

FromXML CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

ToXML CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

Generic CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

Associated Types

type Rep CapacityProviderStatus :: Type -> Type #

Read CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

Show CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

NFData CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

Methods

rnf :: CapacityProviderStatus -> () #

Eq CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

Ord CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

Hashable CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

type Rep CapacityProviderStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStatus

type Rep CapacityProviderStatus = D1 ('MetaData "CapacityProviderStatus" "Amazonka.ECS.Types.CapacityProviderStatus" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "CapacityProviderStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCapacityProviderStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CapacityProviderUpdateStatus

newtype CapacityProviderUpdateStatus Source #

Instances

Instances details
FromJSON CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

FromJSONKey CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

ToJSON CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

ToJSONKey CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

ToByteString CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

ToHeader CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

ToLog CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

ToQuery CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

FromText CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

ToText CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

FromXML CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

ToXML CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

Generic CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

Associated Types

type Rep CapacityProviderUpdateStatus :: Type -> Type #

Read CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

Show CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

NFData CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

Eq CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

Ord CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

Hashable CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

type Rep CapacityProviderUpdateStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderUpdateStatus

type Rep CapacityProviderUpdateStatus = D1 ('MetaData "CapacityProviderUpdateStatus" "Amazonka.ECS.Types.CapacityProviderUpdateStatus" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "CapacityProviderUpdateStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCapacityProviderUpdateStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ClusterField

newtype ClusterField Source #

Constructors

ClusterField' 

Instances

Instances details
FromJSON ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

FromJSONKey ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

ToJSON ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

ToJSONKey ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

ToByteString ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

ToHeader ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

ToLog ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

ToQuery ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

FromText ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

ToText ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

Methods

toText :: ClusterField -> Text #

FromXML ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

ToXML ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

Methods

toXML :: ClusterField -> XML #

Generic ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

Associated Types

type Rep ClusterField :: Type -> Type #

Read ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

Show ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

NFData ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

Methods

rnf :: ClusterField -> () #

Eq ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

Ord ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

Hashable ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

type Rep ClusterField Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterField

type Rep ClusterField = D1 ('MetaData "ClusterField" "Amazonka.ECS.Types.ClusterField" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "ClusterField'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromClusterField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ClusterSettingName

newtype ClusterSettingName Source #

Instances

Instances details
FromJSON ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

FromJSONKey ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

ToJSON ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

ToJSONKey ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

ToByteString ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

ToHeader ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

ToLog ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

ToQuery ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

FromText ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

ToText ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

FromXML ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

ToXML ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

Generic ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

Associated Types

type Rep ClusterSettingName :: Type -> Type #

Read ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

Show ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

NFData ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

Methods

rnf :: ClusterSettingName -> () #

Eq ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

Ord ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

Hashable ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

type Rep ClusterSettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSettingName

type Rep ClusterSettingName = D1 ('MetaData "ClusterSettingName" "Amazonka.ECS.Types.ClusterSettingName" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "ClusterSettingName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromClusterSettingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Compatibility

newtype Compatibility Source #

Constructors

Compatibility' 

Instances

Instances details
FromJSON Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

FromJSONKey Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

ToJSON Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

ToJSONKey Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

ToByteString Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

ToHeader Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

ToLog Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

ToQuery Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

FromText Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

ToText Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

Methods

toText :: Compatibility -> Text #

FromXML Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

ToXML Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

Methods

toXML :: Compatibility -> XML #

Generic Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

Associated Types

type Rep Compatibility :: Type -> Type #

Read Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

Show Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

NFData Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

Methods

rnf :: Compatibility -> () #

Eq Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

Ord Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

Hashable Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

type Rep Compatibility Source # 
Instance details

Defined in Amazonka.ECS.Types.Compatibility

type Rep Compatibility = D1 ('MetaData "Compatibility" "Amazonka.ECS.Types.Compatibility" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "Compatibility'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCompatibility") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Connectivity

newtype Connectivity Source #

Constructors

Connectivity' 

Instances

Instances details
FromJSON Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

FromJSONKey Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

ToJSON Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

ToJSONKey Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

ToByteString Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

ToHeader Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

ToLog Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

ToQuery Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

FromText Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

ToText Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

Methods

toText :: Connectivity -> Text #

FromXML Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

ToXML Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

Methods

toXML :: Connectivity -> XML #

Generic Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

Associated Types

type Rep Connectivity :: Type -> Type #

Read Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

Show Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

NFData Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

Methods

rnf :: Connectivity -> () #

Eq Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

Ord Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

Hashable Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

type Rep Connectivity Source # 
Instance details

Defined in Amazonka.ECS.Types.Connectivity

type Rep Connectivity = D1 ('MetaData "Connectivity" "Amazonka.ECS.Types.Connectivity" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "Connectivity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConnectivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ContainerCondition

newtype ContainerCondition Source #

Instances

Instances details
FromJSON ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

FromJSONKey ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

ToJSON ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

ToJSONKey ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

ToByteString ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

ToHeader ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

ToLog ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

ToQuery ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

FromText ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

ToText ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

FromXML ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

ToXML ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

Generic ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

Associated Types

type Rep ContainerCondition :: Type -> Type #

Read ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

Show ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

NFData ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

Methods

rnf :: ContainerCondition -> () #

Eq ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

Ord ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

Hashable ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

type Rep ContainerCondition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerCondition

type Rep ContainerCondition = D1 ('MetaData "ContainerCondition" "Amazonka.ECS.Types.ContainerCondition" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "ContainerCondition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromContainerCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ContainerInstanceField

newtype ContainerInstanceField Source #

Instances

Instances details
FromJSON ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

FromJSONKey ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

ToJSON ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

ToJSONKey ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

ToByteString ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

ToHeader ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

ToLog ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

ToQuery ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

FromText ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

ToText ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

FromXML ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

ToXML ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

Generic ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

Associated Types

type Rep ContainerInstanceField :: Type -> Type #

Read ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

Show ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

NFData ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

Methods

rnf :: ContainerInstanceField -> () #

Eq ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

Ord ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

Hashable ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

type Rep ContainerInstanceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceField

type Rep ContainerInstanceField = D1 ('MetaData "ContainerInstanceField" "Amazonka.ECS.Types.ContainerInstanceField" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "ContainerInstanceField'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromContainerInstanceField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ContainerInstanceStatus

newtype ContainerInstanceStatus Source #

Instances

Instances details
FromJSON ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

FromJSONKey ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

ToJSON ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

ToJSONKey ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

ToByteString ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

ToHeader ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

ToLog ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

ToQuery ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

FromText ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

ToText ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

FromXML ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

ToXML ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

Generic ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

Associated Types

type Rep ContainerInstanceStatus :: Type -> Type #

Read ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

Show ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

NFData ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

Methods

rnf :: ContainerInstanceStatus -> () #

Eq ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

Ord ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

Hashable ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

type Rep ContainerInstanceStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceStatus

type Rep ContainerInstanceStatus = D1 ('MetaData "ContainerInstanceStatus" "Amazonka.ECS.Types.ContainerInstanceStatus" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "ContainerInstanceStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromContainerInstanceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DeploymentControllerType

newtype DeploymentControllerType Source #

Instances

Instances details
FromJSON DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

FromJSONKey DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

ToJSON DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

ToJSONKey DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

ToByteString DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

ToHeader DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

ToLog DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

ToQuery DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

FromText DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

ToText DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

FromXML DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

ToXML DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

Generic DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

Associated Types

type Rep DeploymentControllerType :: Type -> Type #

Read DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

Show DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

NFData DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

Eq DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

Ord DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

Hashable DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

type Rep DeploymentControllerType Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentControllerType

type Rep DeploymentControllerType = D1 ('MetaData "DeploymentControllerType" "Amazonka.ECS.Types.DeploymentControllerType" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "DeploymentControllerType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDeploymentControllerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DeploymentRolloutState

newtype DeploymentRolloutState Source #

Instances

Instances details
FromJSON DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

FromJSONKey DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

ToJSON DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

ToJSONKey DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

ToByteString DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

ToHeader DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

ToLog DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

ToQuery DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

FromText DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

ToText DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

FromXML DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

ToXML DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

Generic DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

Associated Types

type Rep DeploymentRolloutState :: Type -> Type #

Read DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

Show DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

NFData DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

Methods

rnf :: DeploymentRolloutState -> () #

Eq DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

Ord DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

Hashable DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

type Rep DeploymentRolloutState Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentRolloutState

type Rep DeploymentRolloutState = D1 ('MetaData "DeploymentRolloutState" "Amazonka.ECS.Types.DeploymentRolloutState" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "DeploymentRolloutState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDeploymentRolloutState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DesiredStatus

newtype DesiredStatus Source #

Constructors

DesiredStatus' 

Instances

Instances details
FromJSON DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

FromJSONKey DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

ToJSON DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

ToJSONKey DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

ToByteString DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

ToHeader DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

ToLog DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

ToQuery DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

FromText DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

ToText DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

Methods

toText :: DesiredStatus -> Text #

FromXML DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

ToXML DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

Methods

toXML :: DesiredStatus -> XML #

Generic DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

Associated Types

type Rep DesiredStatus :: Type -> Type #

Read DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

Show DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

NFData DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

Methods

rnf :: DesiredStatus -> () #

Eq DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

Ord DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

Hashable DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

type Rep DesiredStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.DesiredStatus

type Rep DesiredStatus = D1 ('MetaData "DesiredStatus" "Amazonka.ECS.Types.DesiredStatus" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "DesiredStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDesiredStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DeviceCgroupPermission

newtype DeviceCgroupPermission Source #

Instances

Instances details
FromJSON DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

FromJSONKey DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

ToJSON DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

ToJSONKey DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

ToByteString DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

ToHeader DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

ToLog DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

ToQuery DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

FromText DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

ToText DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

FromXML DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

ToXML DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

Generic DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

Associated Types

type Rep DeviceCgroupPermission :: Type -> Type #

Read DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

Show DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

NFData DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

Methods

rnf :: DeviceCgroupPermission -> () #

Eq DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

Ord DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

Hashable DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

type Rep DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.ECS.Types.DeviceCgroupPermission

type Rep DeviceCgroupPermission = D1 ('MetaData "DeviceCgroupPermission" "Amazonka.ECS.Types.DeviceCgroupPermission" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "DeviceCgroupPermission'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDeviceCgroupPermission") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EFSAuthorizationConfigIAM

newtype EFSAuthorizationConfigIAM Source #

Instances

Instances details
FromJSON EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

FromJSONKey EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

ToJSON EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

ToJSONKey EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

ToByteString EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

ToHeader EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

ToLog EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

ToQuery EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

FromText EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

ToText EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

FromXML EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

ToXML EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

Generic EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

Associated Types

type Rep EFSAuthorizationConfigIAM :: Type -> Type #

Read EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

Show EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

NFData EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

Eq EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

Ord EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

Hashable EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

type Rep EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfigIAM

type Rep EFSAuthorizationConfigIAM = D1 ('MetaData "EFSAuthorizationConfigIAM" "Amazonka.ECS.Types.EFSAuthorizationConfigIAM" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "EFSAuthorizationConfigIAM'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEFSAuthorizationConfigIAM") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EFSTransitEncryption

newtype EFSTransitEncryption Source #

Instances

Instances details
FromJSON EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

FromJSONKey EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

ToJSON EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

ToJSONKey EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

ToByteString EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

ToHeader EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

ToLog EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

ToQuery EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

FromText EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

ToText EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

FromXML EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

ToXML EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

Generic EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

Associated Types

type Rep EFSTransitEncryption :: Type -> Type #

Read EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

Show EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

NFData EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

Methods

rnf :: EFSTransitEncryption -> () #

Eq EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

Ord EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

Hashable EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

type Rep EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSTransitEncryption

type Rep EFSTransitEncryption = D1 ('MetaData "EFSTransitEncryption" "Amazonka.ECS.Types.EFSTransitEncryption" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "EFSTransitEncryption'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEFSTransitEncryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EnvironmentFileType

newtype EnvironmentFileType Source #

Bundled Patterns

pattern EnvironmentFileType_S3 :: EnvironmentFileType 

Instances

Instances details
FromJSON EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

FromJSONKey EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

ToJSON EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

ToJSONKey EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

ToByteString EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

ToHeader EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

ToLog EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

ToQuery EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

FromText EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

ToText EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

FromXML EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

ToXML EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

Generic EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

Associated Types

type Rep EnvironmentFileType :: Type -> Type #

Read EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

Show EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

NFData EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

Methods

rnf :: EnvironmentFileType -> () #

Eq EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

Ord EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

Hashable EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

type Rep EnvironmentFileType Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFileType

type Rep EnvironmentFileType = D1 ('MetaData "EnvironmentFileType" "Amazonka.ECS.Types.EnvironmentFileType" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "EnvironmentFileType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEnvironmentFileType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ExecuteCommandLogging

newtype ExecuteCommandLogging Source #

Instances

Instances details
FromJSON ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

FromJSONKey ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

ToJSON ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

ToJSONKey ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

ToByteString ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

ToHeader ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

ToLog ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

ToQuery ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

FromText ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

ToText ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

FromXML ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

ToXML ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

Generic ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

Associated Types

type Rep ExecuteCommandLogging :: Type -> Type #

Read ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

Show ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

NFData ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

Methods

rnf :: ExecuteCommandLogging -> () #

Eq ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

Ord ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

Hashable ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

type Rep ExecuteCommandLogging Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogging

type Rep ExecuteCommandLogging = D1 ('MetaData "ExecuteCommandLogging" "Amazonka.ECS.Types.ExecuteCommandLogging" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "ExecuteCommandLogging'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromExecuteCommandLogging") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

FirelensConfigurationType

newtype FirelensConfigurationType Source #

Instances

Instances details
FromJSON FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

FromJSONKey FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

ToJSON FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

ToJSONKey FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

ToByteString FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

ToHeader FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

ToLog FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

ToQuery FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

FromText FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

ToText FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

FromXML FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

ToXML FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

Generic FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

Associated Types

type Rep FirelensConfigurationType :: Type -> Type #

Read FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

Show FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

NFData FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

Eq FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

Ord FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

Hashable FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

type Rep FirelensConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfigurationType

type Rep FirelensConfigurationType = D1 ('MetaData "FirelensConfigurationType" "Amazonka.ECS.Types.FirelensConfigurationType" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "FirelensConfigurationType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromFirelensConfigurationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

HealthStatus

newtype HealthStatus Source #

Constructors

HealthStatus' 

Instances

Instances details
FromJSON HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

FromJSONKey HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

ToJSON HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

ToJSONKey HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

ToByteString HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

ToHeader HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

ToLog HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

ToQuery HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

FromText HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

ToText HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

Methods

toText :: HealthStatus -> Text #

FromXML HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

ToXML HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

Methods

toXML :: HealthStatus -> XML #

Generic HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

Associated Types

type Rep HealthStatus :: Type -> Type #

Read HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

Show HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

NFData HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

Methods

rnf :: HealthStatus -> () #

Eq HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

Ord HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

Hashable HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

type Rep HealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthStatus

type Rep HealthStatus = D1 ('MetaData "HealthStatus" "Amazonka.ECS.Types.HealthStatus" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "HealthStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromHealthStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

InstanceHealthCheckState

newtype InstanceHealthCheckState Source #

Instances

Instances details
FromJSON InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

FromJSONKey InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

ToJSON InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

ToJSONKey InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

ToByteString InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

ToHeader InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

ToLog InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

ToQuery InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

FromText InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

ToText InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

FromXML InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

ToXML InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

Generic InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

Associated Types

type Rep InstanceHealthCheckState :: Type -> Type #

Read InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

Show InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

NFData InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

Eq InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

Ord InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

Hashable InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

type Rep InstanceHealthCheckState Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckState

type Rep InstanceHealthCheckState = D1 ('MetaData "InstanceHealthCheckState" "Amazonka.ECS.Types.InstanceHealthCheckState" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "InstanceHealthCheckState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromInstanceHealthCheckState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

InstanceHealthCheckType

newtype InstanceHealthCheckType Source #

Instances

Instances details
FromJSON InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

FromJSONKey InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

ToJSON InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

ToJSONKey InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

ToByteString InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

ToHeader InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

ToLog InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

ToQuery InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

FromText InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

ToText InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

FromXML InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

ToXML InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

Generic InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

Associated Types

type Rep InstanceHealthCheckType :: Type -> Type #

Read InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

Show InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

NFData InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

Methods

rnf :: InstanceHealthCheckType -> () #

Eq InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

Ord InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

Hashable InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

type Rep InstanceHealthCheckType Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckType

type Rep InstanceHealthCheckType = D1 ('MetaData "InstanceHealthCheckType" "Amazonka.ECS.Types.InstanceHealthCheckType" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "InstanceHealthCheckType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromInstanceHealthCheckType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

IpcMode

newtype IpcMode Source #

Constructors

IpcMode' 

Fields

Bundled Patterns

pattern IpcMode_Host :: IpcMode 
pattern IpcMode_None :: IpcMode 
pattern IpcMode_Task :: IpcMode 

Instances

Instances details
FromJSON IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

FromJSONKey IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

ToJSON IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

ToJSONKey IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

ToByteString IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

Methods

toBS :: IpcMode -> ByteString #

ToHeader IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

Methods

toHeader :: HeaderName -> IpcMode -> [Header] #

ToLog IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

ToQuery IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

FromText IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

ToText IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

Methods

toText :: IpcMode -> Text #

FromXML IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

ToXML IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

Methods

toXML :: IpcMode -> XML #

Generic IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

Associated Types

type Rep IpcMode :: Type -> Type #

Methods

from :: IpcMode -> Rep IpcMode x #

to :: Rep IpcMode x -> IpcMode #

Read IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

Show IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

NFData IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

Methods

rnf :: IpcMode -> () #

Eq IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

Methods

(==) :: IpcMode -> IpcMode -> Bool #

(/=) :: IpcMode -> IpcMode -> Bool #

Ord IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

Hashable IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

Methods

hashWithSalt :: Int -> IpcMode -> Int #

hash :: IpcMode -> Int #

type Rep IpcMode Source # 
Instance details

Defined in Amazonka.ECS.Types.IpcMode

type Rep IpcMode = D1 ('MetaData "IpcMode" "Amazonka.ECS.Types.IpcMode" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "IpcMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromIpcMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

LaunchType

newtype LaunchType Source #

Constructors

LaunchType' 

Fields

Bundled Patterns

pattern LaunchType_EC2 :: LaunchType 
pattern LaunchType_EXTERNAL :: LaunchType 
pattern LaunchType_FARGATE :: LaunchType 

Instances

Instances details
FromJSON LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

FromJSONKey LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

ToJSON LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

ToJSONKey LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

ToByteString LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

ToHeader LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

ToLog LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

ToQuery LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

FromText LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

ToText LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

Methods

toText :: LaunchType -> Text #

FromXML LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

ToXML LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

Methods

toXML :: LaunchType -> XML #

Generic LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

Associated Types

type Rep LaunchType :: Type -> Type #

Read LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

Show LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

NFData LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

Methods

rnf :: LaunchType -> () #

Eq LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

Ord LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

Hashable LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

type Rep LaunchType Source # 
Instance details

Defined in Amazonka.ECS.Types.LaunchType

type Rep LaunchType = D1 ('MetaData "LaunchType" "Amazonka.ECS.Types.LaunchType" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "LaunchType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromLaunchType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

LogDriver

newtype LogDriver Source #

Constructors

LogDriver' 

Fields

Instances

Instances details
FromJSON LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

FromJSONKey LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

ToJSON LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

ToJSONKey LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

ToByteString LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

Methods

toBS :: LogDriver -> ByteString #

ToHeader LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

ToLog LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

ToQuery LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

FromText LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

ToText LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

Methods

toText :: LogDriver -> Text #

FromXML LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

ToXML LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

Methods

toXML :: LogDriver -> XML #

Generic LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

Associated Types

type Rep LogDriver :: Type -> Type #

Read LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

Show LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

NFData LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

Methods

rnf :: LogDriver -> () #

Eq LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

Ord LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

Hashable LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

type Rep LogDriver Source # 
Instance details

Defined in Amazonka.ECS.Types.LogDriver

type Rep LogDriver = D1 ('MetaData "LogDriver" "Amazonka.ECS.Types.LogDriver" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "LogDriver'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromLogDriver") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ManagedAgentName

newtype ManagedAgentName Source #

Instances

Instances details
FromJSON ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

FromJSONKey ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

ToJSON ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

ToJSONKey ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

ToByteString ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

ToHeader ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

ToLog ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

ToQuery ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

FromText ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

ToText ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

FromXML ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

ToXML ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

Generic ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

Associated Types

type Rep ManagedAgentName :: Type -> Type #

Read ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

Show ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

NFData ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

Methods

rnf :: ManagedAgentName -> () #

Eq ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

Ord ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

Hashable ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

type Rep ManagedAgentName Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentName

type Rep ManagedAgentName = D1 ('MetaData "ManagedAgentName" "Amazonka.ECS.Types.ManagedAgentName" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "ManagedAgentName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromManagedAgentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ManagedScalingStatus

newtype ManagedScalingStatus Source #

Instances

Instances details
FromJSON ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

FromJSONKey ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

ToJSON ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

ToJSONKey ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

ToByteString ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

ToHeader ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

ToLog ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

ToQuery ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

FromText ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

ToText ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

FromXML ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

ToXML ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

Generic ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

Associated Types

type Rep ManagedScalingStatus :: Type -> Type #

Read ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

Show ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

NFData ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

Methods

rnf :: ManagedScalingStatus -> () #

Eq ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

Ord ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

Hashable ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

type Rep ManagedScalingStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScalingStatus

type Rep ManagedScalingStatus = D1 ('MetaData "ManagedScalingStatus" "Amazonka.ECS.Types.ManagedScalingStatus" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "ManagedScalingStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromManagedScalingStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ManagedTerminationProtection

newtype ManagedTerminationProtection Source #

Instances

Instances details
FromJSON ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

FromJSONKey ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

ToJSON ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

ToJSONKey ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

ToByteString ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

ToHeader ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

ToLog ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

ToQuery ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

FromText ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

ToText ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

FromXML ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

ToXML ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

Generic ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

Associated Types

type Rep ManagedTerminationProtection :: Type -> Type #

Read ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

Show ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

NFData ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

Eq ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

Ord ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

Hashable ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

type Rep ManagedTerminationProtection Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedTerminationProtection

type Rep ManagedTerminationProtection = D1 ('MetaData "ManagedTerminationProtection" "Amazonka.ECS.Types.ManagedTerminationProtection" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "ManagedTerminationProtection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromManagedTerminationProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

NetworkMode

newtype NetworkMode Source #

Constructors

NetworkMode' 

Instances

Instances details
FromJSON NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

FromJSONKey NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

ToJSON NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

ToJSONKey NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

ToByteString NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

ToHeader NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

ToLog NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

ToQuery NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

FromText NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

ToText NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

Methods

toText :: NetworkMode -> Text #

FromXML NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

ToXML NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

Methods

toXML :: NetworkMode -> XML #

Generic NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

Associated Types

type Rep NetworkMode :: Type -> Type #

Read NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

Show NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

NFData NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

Methods

rnf :: NetworkMode -> () #

Eq NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

Ord NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

Hashable NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

type Rep NetworkMode Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkMode

type Rep NetworkMode = D1 ('MetaData "NetworkMode" "Amazonka.ECS.Types.NetworkMode" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "NetworkMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromNetworkMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

OSFamily

newtype OSFamily Source #

Constructors

OSFamily' 

Fields

Instances

Instances details
FromJSON OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

FromJSONKey OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

ToJSON OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

ToJSONKey OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

ToByteString OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

Methods

toBS :: OSFamily -> ByteString #

ToHeader OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

Methods

toHeader :: HeaderName -> OSFamily -> [Header] #

ToLog OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

ToQuery OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

FromText OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

ToText OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

Methods

toText :: OSFamily -> Text #

FromXML OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

ToXML OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

Methods

toXML :: OSFamily -> XML #

Generic OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

Associated Types

type Rep OSFamily :: Type -> Type #

Methods

from :: OSFamily -> Rep OSFamily x #

to :: Rep OSFamily x -> OSFamily #

Read OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

Show OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

NFData OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

Methods

rnf :: OSFamily -> () #

Eq OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

Ord OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

Hashable OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

Methods

hashWithSalt :: Int -> OSFamily -> Int #

hash :: OSFamily -> Int #

type Rep OSFamily Source # 
Instance details

Defined in Amazonka.ECS.Types.OSFamily

type Rep OSFamily = D1 ('MetaData "OSFamily" "Amazonka.ECS.Types.OSFamily" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "OSFamily'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromOSFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

PidMode

newtype PidMode Source #

Constructors

PidMode' 

Fields

Bundled Patterns

pattern PidMode_Host :: PidMode 
pattern PidMode_Task :: PidMode 

Instances

Instances details
FromJSON PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

FromJSONKey PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

ToJSON PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

ToJSONKey PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

ToByteString PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

Methods

toBS :: PidMode -> ByteString #

ToHeader PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

Methods

toHeader :: HeaderName -> PidMode -> [Header] #

ToLog PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

ToQuery PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

FromText PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

ToText PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

Methods

toText :: PidMode -> Text #

FromXML PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

ToXML PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

Methods

toXML :: PidMode -> XML #

Generic PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

Associated Types

type Rep PidMode :: Type -> Type #

Methods

from :: PidMode -> Rep PidMode x #

to :: Rep PidMode x -> PidMode #

Read PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

Show PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

NFData PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

Methods

rnf :: PidMode -> () #

Eq PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

Methods

(==) :: PidMode -> PidMode -> Bool #

(/=) :: PidMode -> PidMode -> Bool #

Ord PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

Hashable PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

Methods

hashWithSalt :: Int -> PidMode -> Int #

hash :: PidMode -> Int #

type Rep PidMode Source # 
Instance details

Defined in Amazonka.ECS.Types.PidMode

type Rep PidMode = D1 ('MetaData "PidMode" "Amazonka.ECS.Types.PidMode" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "PidMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPidMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

PlacementConstraintType

newtype PlacementConstraintType Source #

Instances

Instances details
FromJSON PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

FromJSONKey PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

ToJSON PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

ToJSONKey PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

ToByteString PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

ToHeader PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

ToLog PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

ToQuery PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

FromText PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

ToText PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

FromXML PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

ToXML PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

Generic PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

Associated Types

type Rep PlacementConstraintType :: Type -> Type #

Read PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

Show PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

NFData PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

Methods

rnf :: PlacementConstraintType -> () #

Eq PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

Ord PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

Hashable PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

type Rep PlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraintType

type Rep PlacementConstraintType = D1 ('MetaData "PlacementConstraintType" "Amazonka.ECS.Types.PlacementConstraintType" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "PlacementConstraintType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPlacementConstraintType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

PlacementStrategyType

newtype PlacementStrategyType Source #

Instances

Instances details
FromJSON PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

FromJSONKey PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

ToJSON PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

ToJSONKey PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

ToByteString PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

ToHeader PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

ToLog PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

ToQuery PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

FromText PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

ToText PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

FromXML PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

ToXML PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

Generic PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

Associated Types

type Rep PlacementStrategyType :: Type -> Type #

Read PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

Show PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

NFData PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

Methods

rnf :: PlacementStrategyType -> () #

Eq PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

Ord PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

Hashable PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

type Rep PlacementStrategyType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategyType

type Rep PlacementStrategyType = D1 ('MetaData "PlacementStrategyType" "Amazonka.ECS.Types.PlacementStrategyType" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "PlacementStrategyType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPlacementStrategyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

PlatformDeviceType

newtype PlatformDeviceType Source #

Bundled Patterns

pattern PlatformDeviceType_GPU :: PlatformDeviceType 

Instances

Instances details
FromJSON PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

FromJSONKey PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

ToJSON PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

ToJSONKey PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

ToByteString PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

ToHeader PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

ToLog PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

ToQuery PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

FromText PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

ToText PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

FromXML PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

ToXML PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

Generic PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

Associated Types

type Rep PlatformDeviceType :: Type -> Type #

Read PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

Show PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

NFData PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

Methods

rnf :: PlatformDeviceType -> () #

Eq PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

Ord PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

Hashable PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

type Rep PlatformDeviceType Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDeviceType

type Rep PlatformDeviceType = D1 ('MetaData "PlatformDeviceType" "Amazonka.ECS.Types.PlatformDeviceType" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "PlatformDeviceType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPlatformDeviceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

PropagateTags

newtype PropagateTags Source #

Constructors

PropagateTags' 

Instances

Instances details
FromJSON PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

FromJSONKey PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

ToJSON PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

ToJSONKey PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

ToByteString PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

ToHeader PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

ToLog PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

ToQuery PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

FromText PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

ToText PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

Methods

toText :: PropagateTags -> Text #

FromXML PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

ToXML PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

Methods

toXML :: PropagateTags -> XML #

Generic PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

Associated Types

type Rep PropagateTags :: Type -> Type #

Read PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

Show PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

NFData PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

Methods

rnf :: PropagateTags -> () #

Eq PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

Ord PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

Hashable PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

type Rep PropagateTags Source # 
Instance details

Defined in Amazonka.ECS.Types.PropagateTags

type Rep PropagateTags = D1 ('MetaData "PropagateTags" "Amazonka.ECS.Types.PropagateTags" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "PropagateTags'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPropagateTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ProxyConfigurationType

newtype ProxyConfigurationType Source #

Instances

Instances details
FromJSON ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

FromJSONKey ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

ToJSON ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

ToJSONKey ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

ToByteString ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

ToHeader ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

ToLog ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

ToQuery ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

FromText ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

ToText ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

FromXML ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

ToXML ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

Generic ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

Associated Types

type Rep ProxyConfigurationType :: Type -> Type #

Read ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

Show ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

NFData ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

Methods

rnf :: ProxyConfigurationType -> () #

Eq ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

Ord ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

Hashable ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

type Rep ProxyConfigurationType Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfigurationType

type Rep ProxyConfigurationType = D1 ('MetaData "ProxyConfigurationType" "Amazonka.ECS.Types.ProxyConfigurationType" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "ProxyConfigurationType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromProxyConfigurationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ResourceType

newtype ResourceType Source #

Constructors

ResourceType' 

Instances

Instances details
FromJSON ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

FromJSONKey ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

ToJSON ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

ToJSONKey ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

ToByteString ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

ToHeader ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

ToLog ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

ToQuery ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

FromText ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

ToText ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

Methods

toText :: ResourceType -> Text #

FromXML ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

ToXML ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

Methods

toXML :: ResourceType -> XML #

Generic ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

Associated Types

type Rep ResourceType :: Type -> Type #

Read ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

Show ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

NFData ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

Methods

rnf :: ResourceType -> () #

Eq ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

Ord ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

Hashable ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

type Rep ResourceType Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceType

type Rep ResourceType = D1 ('MetaData "ResourceType" "Amazonka.ECS.Types.ResourceType" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "ResourceType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromResourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ScaleUnit

newtype ScaleUnit Source #

Constructors

ScaleUnit' 

Fields

Bundled Patterns

pattern ScaleUnit_PERCENT :: ScaleUnit 

Instances

Instances details
FromJSON ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

FromJSONKey ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

ToJSON ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

ToJSONKey ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

ToByteString ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

Methods

toBS :: ScaleUnit -> ByteString #

ToHeader ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

ToLog ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

ToQuery ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

FromText ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

ToText ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

Methods

toText :: ScaleUnit -> Text #

FromXML ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

ToXML ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

Methods

toXML :: ScaleUnit -> XML #

Generic ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

Associated Types

type Rep ScaleUnit :: Type -> Type #

Read ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

Show ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

NFData ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

Methods

rnf :: ScaleUnit -> () #

Eq ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

Ord ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

Hashable ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

type Rep ScaleUnit Source # 
Instance details

Defined in Amazonka.ECS.Types.ScaleUnit

type Rep ScaleUnit = D1 ('MetaData "ScaleUnit" "Amazonka.ECS.Types.ScaleUnit" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "ScaleUnit'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromScaleUnit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SchedulingStrategy

newtype SchedulingStrategy Source #

Instances

Instances details
FromJSON SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

FromJSONKey SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

ToJSON SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

ToJSONKey SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

ToByteString SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

ToHeader SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

ToLog SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

ToQuery SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

FromText SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

ToText SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

FromXML SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

ToXML SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

Generic SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

Associated Types

type Rep SchedulingStrategy :: Type -> Type #

Read SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

Show SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

NFData SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

Methods

rnf :: SchedulingStrategy -> () #

Eq SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

Ord SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

Hashable SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

type Rep SchedulingStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.SchedulingStrategy

type Rep SchedulingStrategy = D1 ('MetaData "SchedulingStrategy" "Amazonka.ECS.Types.SchedulingStrategy" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "SchedulingStrategy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSchedulingStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Scope

newtype Scope Source #

Constructors

Scope' 

Fields

Bundled Patterns

pattern Scope_Shared :: Scope 
pattern Scope_Task :: Scope 

Instances

Instances details
FromJSON Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

FromJSONKey Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

ToJSON Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

ToJSONKey Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

ToByteString Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

Methods

toBS :: Scope -> ByteString #

ToHeader Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

Methods

toHeader :: HeaderName -> Scope -> [Header] #

ToLog Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

ToQuery Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

Methods

toQuery :: Scope -> QueryString #

FromText Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

ToText Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

Methods

toText :: Scope -> Text #

FromXML Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

Methods

parseXML :: [Node] -> Either String Scope #

ToXML Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

Methods

toXML :: Scope -> XML #

Generic Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

Associated Types

type Rep Scope :: Type -> Type #

Methods

from :: Scope -> Rep Scope x #

to :: Rep Scope x -> Scope #

Read Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

Show Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

Methods

showsPrec :: Int -> Scope -> ShowS #

show :: Scope -> String #

showList :: [Scope] -> ShowS #

NFData Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

Methods

rnf :: Scope -> () #

Eq Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

Methods

(==) :: Scope -> Scope -> Bool #

(/=) :: Scope -> Scope -> Bool #

Ord Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

Methods

compare :: Scope -> Scope -> Ordering #

(<) :: Scope -> Scope -> Bool #

(<=) :: Scope -> Scope -> Bool #

(>) :: Scope -> Scope -> Bool #

(>=) :: Scope -> Scope -> Bool #

max :: Scope -> Scope -> Scope #

min :: Scope -> Scope -> Scope #

Hashable Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

Methods

hashWithSalt :: Int -> Scope -> Int #

hash :: Scope -> Int #

type Rep Scope Source # 
Instance details

Defined in Amazonka.ECS.Types.Scope

type Rep Scope = D1 ('MetaData "Scope" "Amazonka.ECS.Types.Scope" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "Scope'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ServiceField

newtype ServiceField Source #

Constructors

ServiceField' 

Bundled Patterns

pattern ServiceField_TAGS :: ServiceField 

Instances

Instances details
FromJSON ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

FromJSONKey ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

ToJSON ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

ToJSONKey ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

ToByteString ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

ToHeader ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

ToLog ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

ToQuery ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

FromText ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

ToText ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

Methods

toText :: ServiceField -> Text #

FromXML ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

ToXML ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

Methods

toXML :: ServiceField -> XML #

Generic ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

Associated Types

type Rep ServiceField :: Type -> Type #

Read ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

Show ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

NFData ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

Methods

rnf :: ServiceField -> () #

Eq ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

Ord ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

Hashable ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

type Rep ServiceField Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceField

type Rep ServiceField = D1 ('MetaData "ServiceField" "Amazonka.ECS.Types.ServiceField" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "ServiceField'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromServiceField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SettingName

newtype SettingName Source #

Constructors

SettingName' 

Instances

Instances details
FromJSON SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

FromJSONKey SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

ToJSON SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

ToJSONKey SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

ToByteString SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

ToHeader SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

ToLog SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

ToQuery SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

FromText SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

ToText SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

Methods

toText :: SettingName -> Text #

FromXML SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

ToXML SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

Methods

toXML :: SettingName -> XML #

Generic SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

Associated Types

type Rep SettingName :: Type -> Type #

Read SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

Show SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

NFData SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

Methods

rnf :: SettingName -> () #

Eq SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

Ord SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

Hashable SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

type Rep SettingName Source # 
Instance details

Defined in Amazonka.ECS.Types.SettingName

type Rep SettingName = D1 ('MetaData "SettingName" "Amazonka.ECS.Types.SettingName" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "SettingName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSettingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SortOrder

newtype SortOrder Source #

Constructors

SortOrder' 

Fields

Bundled Patterns

pattern SortOrder_ASC :: SortOrder 
pattern SortOrder_DESC :: SortOrder 

Instances

Instances details
FromJSON SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

FromJSONKey SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

ToJSON SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

ToJSONKey SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

ToByteString SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

Methods

toBS :: SortOrder -> ByteString #

ToHeader SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

ToLog SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

ToQuery SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

FromText SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

ToText SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

Methods

toText :: SortOrder -> Text #

FromXML SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

ToXML SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

Methods

toXML :: SortOrder -> XML #

Generic SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

Associated Types

type Rep SortOrder :: Type -> Type #

Read SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

Show SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

NFData SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

Methods

rnf :: SortOrder -> () #

Eq SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

Ord SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

Hashable SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

type Rep SortOrder Source # 
Instance details

Defined in Amazonka.ECS.Types.SortOrder

type Rep SortOrder = D1 ('MetaData "SortOrder" "Amazonka.ECS.Types.SortOrder" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "SortOrder'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

StabilityStatus

newtype StabilityStatus Source #

Constructors

StabilityStatus' 

Instances

Instances details
FromJSON StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

FromJSONKey StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

ToJSON StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

ToJSONKey StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

ToByteString StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

ToHeader StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

ToLog StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

ToQuery StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

FromText StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

ToText StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

FromXML StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

ToXML StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

Methods

toXML :: StabilityStatus -> XML #

Generic StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

Associated Types

type Rep StabilityStatus :: Type -> Type #

Read StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

Show StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

NFData StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

Methods

rnf :: StabilityStatus -> () #

Eq StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

Ord StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

Hashable StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

type Rep StabilityStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.StabilityStatus

type Rep StabilityStatus = D1 ('MetaData "StabilityStatus" "Amazonka.ECS.Types.StabilityStatus" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "StabilityStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromStabilityStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TargetType

newtype TargetType Source #

Constructors

TargetType' 

Fields

Bundled Patterns

pattern TargetType_Container_instance :: TargetType 

Instances

Instances details
FromJSON TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

FromJSONKey TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

ToJSON TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

ToJSONKey TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

ToByteString TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

ToHeader TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

ToLog TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

ToQuery TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

FromText TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

ToText TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

Methods

toText :: TargetType -> Text #

FromXML TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

ToXML TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

Methods

toXML :: TargetType -> XML #

Generic TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

Associated Types

type Rep TargetType :: Type -> Type #

Read TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

Show TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

NFData TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

Methods

rnf :: TargetType -> () #

Eq TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

Ord TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

Hashable TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

type Rep TargetType Source # 
Instance details

Defined in Amazonka.ECS.Types.TargetType

type Rep TargetType = D1 ('MetaData "TargetType" "Amazonka.ECS.Types.TargetType" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "TargetType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTargetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TaskDefinitionFamilyStatus

newtype TaskDefinitionFamilyStatus Source #

Instances

Instances details
FromJSON TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

FromJSONKey TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

ToJSON TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

ToJSONKey TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

ToByteString TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

ToHeader TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

ToLog TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

ToQuery TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

FromText TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

ToText TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

FromXML TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

ToXML TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

Generic TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

Associated Types

type Rep TaskDefinitionFamilyStatus :: Type -> Type #

Read TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

Show TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

NFData TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

Eq TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

Ord TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

Hashable TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

type Rep TaskDefinitionFamilyStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionFamilyStatus

type Rep TaskDefinitionFamilyStatus = D1 ('MetaData "TaskDefinitionFamilyStatus" "Amazonka.ECS.Types.TaskDefinitionFamilyStatus" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "TaskDefinitionFamilyStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTaskDefinitionFamilyStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TaskDefinitionField

newtype TaskDefinitionField Source #

Bundled Patterns

pattern TaskDefinitionField_TAGS :: TaskDefinitionField 

Instances

Instances details
FromJSON TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

FromJSONKey TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

ToJSON TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

ToJSONKey TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

ToByteString TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

ToHeader TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

ToLog TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

ToQuery TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

FromText TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

ToText TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

FromXML TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

ToXML TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

Generic TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

Associated Types

type Rep TaskDefinitionField :: Type -> Type #

Read TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

Show TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

NFData TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

Methods

rnf :: TaskDefinitionField -> () #

Eq TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

Ord TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

Hashable TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

type Rep TaskDefinitionField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionField

type Rep TaskDefinitionField = D1 ('MetaData "TaskDefinitionField" "Amazonka.ECS.Types.TaskDefinitionField" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "TaskDefinitionField'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTaskDefinitionField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TaskDefinitionPlacementConstraintType

newtype TaskDefinitionPlacementConstraintType Source #

Instances

Instances details
FromJSON TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

FromJSONKey TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

ToJSON TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

ToJSONKey TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

ToByteString TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

ToHeader TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

ToLog TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

ToQuery TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

FromText TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

ToText TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

FromXML TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

ToXML TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

Generic TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

Read TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

Show TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

NFData TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

Eq TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

Ord TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

Hashable TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

type Rep TaskDefinitionPlacementConstraintType Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType

type Rep TaskDefinitionPlacementConstraintType = D1 ('MetaData "TaskDefinitionPlacementConstraintType" "Amazonka.ECS.Types.TaskDefinitionPlacementConstraintType" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "TaskDefinitionPlacementConstraintType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTaskDefinitionPlacementConstraintType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TaskDefinitionStatus

newtype TaskDefinitionStatus Source #

Instances

Instances details
FromJSON TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

FromJSONKey TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

ToJSON TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

ToJSONKey TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

ToByteString TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

ToHeader TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

ToLog TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

ToQuery TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

FromText TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

ToText TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

FromXML TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

ToXML TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

Generic TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

Associated Types

type Rep TaskDefinitionStatus :: Type -> Type #

Read TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

Show TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

NFData TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

Methods

rnf :: TaskDefinitionStatus -> () #

Eq TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

Ord TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

Hashable TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

type Rep TaskDefinitionStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionStatus

type Rep TaskDefinitionStatus = D1 ('MetaData "TaskDefinitionStatus" "Amazonka.ECS.Types.TaskDefinitionStatus" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "TaskDefinitionStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTaskDefinitionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TaskField

newtype TaskField Source #

Constructors

TaskField' 

Fields

Bundled Patterns

pattern TaskField_TAGS :: TaskField 

Instances

Instances details
FromJSON TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

FromJSONKey TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

ToJSON TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

ToJSONKey TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

ToByteString TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

Methods

toBS :: TaskField -> ByteString #

ToHeader TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

ToLog TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

ToQuery TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

FromText TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

ToText TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

Methods

toText :: TaskField -> Text #

FromXML TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

ToXML TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

Methods

toXML :: TaskField -> XML #

Generic TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

Associated Types

type Rep TaskField :: Type -> Type #

Read TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

Show TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

NFData TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

Methods

rnf :: TaskField -> () #

Eq TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

Ord TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

Hashable TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

type Rep TaskField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskField

type Rep TaskField = D1 ('MetaData "TaskField" "Amazonka.ECS.Types.TaskField" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "TaskField'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTaskField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TaskSetField

newtype TaskSetField Source #

Constructors

TaskSetField' 

Bundled Patterns

pattern TaskSetField_TAGS :: TaskSetField 

Instances

Instances details
FromJSON TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

FromJSONKey TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

ToJSON TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

ToJSONKey TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

ToByteString TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

ToHeader TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

ToLog TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

ToQuery TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

FromText TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

ToText TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

Methods

toText :: TaskSetField -> Text #

FromXML TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

ToXML TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

Methods

toXML :: TaskSetField -> XML #

Generic TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

Associated Types

type Rep TaskSetField :: Type -> Type #

Read TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

Show TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

NFData TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

Methods

rnf :: TaskSetField -> () #

Eq TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

Ord TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

Hashable TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

type Rep TaskSetField Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSetField

type Rep TaskSetField = D1 ('MetaData "TaskSetField" "Amazonka.ECS.Types.TaskSetField" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "TaskSetField'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTaskSetField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TaskStopCode

newtype TaskStopCode Source #

Constructors

TaskStopCode' 

Instances

Instances details
FromJSON TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

FromJSONKey TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

ToJSON TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

ToJSONKey TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

ToByteString TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

ToHeader TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

ToLog TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

ToQuery TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

FromText TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

ToText TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

Methods

toText :: TaskStopCode -> Text #

FromXML TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

ToXML TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

Methods

toXML :: TaskStopCode -> XML #

Generic TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

Associated Types

type Rep TaskStopCode :: Type -> Type #

Read TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

Show TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

NFData TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

Methods

rnf :: TaskStopCode -> () #

Eq TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

Ord TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

Hashable TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

type Rep TaskStopCode Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskStopCode

type Rep TaskStopCode = D1 ('MetaData "TaskStopCode" "Amazonka.ECS.Types.TaskStopCode" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "TaskStopCode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTaskStopCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TransportProtocol

newtype TransportProtocol Source #

Instances

Instances details
FromJSON TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

FromJSONKey TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

ToJSON TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

ToJSONKey TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

ToByteString TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

ToHeader TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

ToLog TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

ToQuery TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

FromText TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

ToText TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

FromXML TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

ToXML TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

Generic TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

Associated Types

type Rep TransportProtocol :: Type -> Type #

Read TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

Show TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

NFData TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

Methods

rnf :: TransportProtocol -> () #

Eq TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

Ord TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

Hashable TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

type Rep TransportProtocol Source # 
Instance details

Defined in Amazonka.ECS.Types.TransportProtocol

type Rep TransportProtocol = D1 ('MetaData "TransportProtocol" "Amazonka.ECS.Types.TransportProtocol" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "TransportProtocol'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTransportProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

UlimitName

newtype UlimitName Source #

Constructors

UlimitName' 

Fields

Instances

Instances details
FromJSON UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

FromJSONKey UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

ToJSON UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

ToJSONKey UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

ToByteString UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

ToHeader UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

ToLog UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

ToQuery UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

FromText UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

ToText UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

Methods

toText :: UlimitName -> Text #

FromXML UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

ToXML UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

Methods

toXML :: UlimitName -> XML #

Generic UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

Associated Types

type Rep UlimitName :: Type -> Type #

Read UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

Show UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

NFData UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

Methods

rnf :: UlimitName -> () #

Eq UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

Ord UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

Hashable UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

type Rep UlimitName Source # 
Instance details

Defined in Amazonka.ECS.Types.UlimitName

type Rep UlimitName = D1 ('MetaData "UlimitName" "Amazonka.ECS.Types.UlimitName" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'True) (C1 ('MetaCons "UlimitName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromUlimitName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Attachment

data Attachment Source #

An object representing a container instance or task attachment.

See: newAttachment smart constructor.

Constructors

Attachment' 

Fields

  • details :: Maybe [KeyValuePair]

    Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.

  • id :: Maybe Text

    The unique identifier for the attachment.

  • status :: Maybe Text

    The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED, and FAILED.

  • type' :: Maybe Text

    The type of the attachment, such as ElasticNetworkInterface.

Instances

Instances details
FromJSON Attachment Source # 
Instance details

Defined in Amazonka.ECS.Types.Attachment

Generic Attachment Source # 
Instance details

Defined in Amazonka.ECS.Types.Attachment

Associated Types

type Rep Attachment :: Type -> Type #

Read Attachment Source # 
Instance details

Defined in Amazonka.ECS.Types.Attachment

Show Attachment Source # 
Instance details

Defined in Amazonka.ECS.Types.Attachment

NFData Attachment Source # 
Instance details

Defined in Amazonka.ECS.Types.Attachment

Methods

rnf :: Attachment -> () #

Eq Attachment Source # 
Instance details

Defined in Amazonka.ECS.Types.Attachment

Hashable Attachment Source # 
Instance details

Defined in Amazonka.ECS.Types.Attachment

type Rep Attachment Source # 
Instance details

Defined in Amazonka.ECS.Types.Attachment

type Rep Attachment = D1 ('MetaData "Attachment" "Amazonka.ECS.Types.Attachment" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Attachment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyValuePair])) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newAttachment :: Attachment Source #

Create a value of Attachment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:details:Attachment', attachment_details - Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.

$sel:id:Attachment', attachment_id - The unique identifier for the attachment.

$sel:status:Attachment', attachment_status - The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED, and FAILED.

$sel:type':Attachment', attachment_type - The type of the attachment, such as ElasticNetworkInterface.

attachment_details :: Lens' Attachment (Maybe [KeyValuePair]) Source #

Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.

attachment_id :: Lens' Attachment (Maybe Text) Source #

The unique identifier for the attachment.

attachment_status :: Lens' Attachment (Maybe Text) Source #

The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED, and FAILED.

attachment_type :: Lens' Attachment (Maybe Text) Source #

The type of the attachment, such as ElasticNetworkInterface.

AttachmentStateChange

data AttachmentStateChange Source #

An object representing a change in state for a task attachment.

See: newAttachmentStateChange smart constructor.

Constructors

AttachmentStateChange' 

Fields

Instances

Instances details
ToJSON AttachmentStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.AttachmentStateChange

Generic AttachmentStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.AttachmentStateChange

Associated Types

type Rep AttachmentStateChange :: Type -> Type #

Read AttachmentStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.AttachmentStateChange

Show AttachmentStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.AttachmentStateChange

NFData AttachmentStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.AttachmentStateChange

Methods

rnf :: AttachmentStateChange -> () #

Eq AttachmentStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.AttachmentStateChange

Hashable AttachmentStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.AttachmentStateChange

type Rep AttachmentStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.AttachmentStateChange

type Rep AttachmentStateChange = D1 ('MetaData "AttachmentStateChange" "Amazonka.ECS.Types.AttachmentStateChange" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "AttachmentStateChange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attachmentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newAttachmentStateChange Source #

Create a value of AttachmentStateChange with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attachmentArn:AttachmentStateChange', attachmentStateChange_attachmentArn - The Amazon Resource Name (ARN) of the attachment.

$sel:status:AttachmentStateChange', attachmentStateChange_status - The status of the attachment.

attachmentStateChange_attachmentArn :: Lens' AttachmentStateChange Text Source #

The Amazon Resource Name (ARN) of the attachment.

Attribute

data Attribute Source #

An attribute is a name-value pair that's associated with an Amazon ECS object. Use attributes to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

See: newAttribute smart constructor.

Constructors

Attribute' 

Fields

  • targetId :: Maybe Text

    The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

  • targetType :: Maybe TargetType

    The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.

  • value :: Maybe Text

    The value of the attribute. The value must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (\), colons (:), or spaces. The value can't start or end with a space.

  • name :: Text

    The name of the attribute. The name must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (\), or periods (.).

Instances

Instances details
FromJSON Attribute Source # 
Instance details

Defined in Amazonka.ECS.Types.Attribute

ToJSON Attribute Source # 
Instance details

Defined in Amazonka.ECS.Types.Attribute

Generic Attribute Source # 
Instance details

Defined in Amazonka.ECS.Types.Attribute

Associated Types

type Rep Attribute :: Type -> Type #

Read Attribute Source # 
Instance details

Defined in Amazonka.ECS.Types.Attribute

Show Attribute Source # 
Instance details

Defined in Amazonka.ECS.Types.Attribute

NFData Attribute Source # 
Instance details

Defined in Amazonka.ECS.Types.Attribute

Methods

rnf :: Attribute -> () #

Eq Attribute Source # 
Instance details

Defined in Amazonka.ECS.Types.Attribute

Hashable Attribute Source # 
Instance details

Defined in Amazonka.ECS.Types.Attribute

type Rep Attribute Source # 
Instance details

Defined in Amazonka.ECS.Types.Attribute

type Rep Attribute = D1 ('MetaData "Attribute" "Amazonka.ECS.Types.Attribute" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Attribute'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "targetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "targetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetType))) :*: (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newAttribute Source #

Create a value of Attribute with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:targetId:Attribute', attribute_targetId - The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

$sel:targetType:Attribute', attribute_targetType - The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.

$sel:value:Attribute', attribute_value - The value of the attribute. The value must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (\), colons (:), or spaces. The value can't start or end with a space.

$sel:name:Attribute', attribute_name - The name of the attribute. The name must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (\), or periods (.).

attribute_targetId :: Lens' Attribute (Maybe Text) Source #

The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

attribute_targetType :: Lens' Attribute (Maybe TargetType) Source #

The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.

attribute_value :: Lens' Attribute (Maybe Text) Source #

The value of the attribute. The value must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (\), colons (:), or spaces. The value can't start or end with a space.

attribute_name :: Lens' Attribute Text Source #

The name of the attribute. The name must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (\), or periods (.).

AutoScalingGroupProvider

data AutoScalingGroupProvider Source #

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

See: newAutoScalingGroupProvider smart constructor.

Constructors

AutoScalingGroupProvider' 

Fields

  • managedScaling :: Maybe ManagedScaling

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

  • managedTerminationProtection :: Maybe ManagedTerminationProtection

    The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is disabled.

    When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.

    When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.

    When managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.

  • autoScalingGroupArn :: Text

    The Amazon Resource Name (ARN) that identifies the Auto Scaling group.

Instances

Instances details
FromJSON AutoScalingGroupProvider Source # 
Instance details

Defined in Amazonka.ECS.Types.AutoScalingGroupProvider

ToJSON AutoScalingGroupProvider Source # 
Instance details

Defined in Amazonka.ECS.Types.AutoScalingGroupProvider

Generic AutoScalingGroupProvider Source # 
Instance details

Defined in Amazonka.ECS.Types.AutoScalingGroupProvider

Associated Types

type Rep AutoScalingGroupProvider :: Type -> Type #

Read AutoScalingGroupProvider Source # 
Instance details

Defined in Amazonka.ECS.Types.AutoScalingGroupProvider

Show AutoScalingGroupProvider Source # 
Instance details

Defined in Amazonka.ECS.Types.AutoScalingGroupProvider

NFData AutoScalingGroupProvider Source # 
Instance details

Defined in Amazonka.ECS.Types.AutoScalingGroupProvider

Eq AutoScalingGroupProvider Source # 
Instance details

Defined in Amazonka.ECS.Types.AutoScalingGroupProvider

Hashable AutoScalingGroupProvider Source # 
Instance details

Defined in Amazonka.ECS.Types.AutoScalingGroupProvider

type Rep AutoScalingGroupProvider Source # 
Instance details

Defined in Amazonka.ECS.Types.AutoScalingGroupProvider

type Rep AutoScalingGroupProvider = D1 ('MetaData "AutoScalingGroupProvider" "Amazonka.ECS.Types.AutoScalingGroupProvider" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "AutoScalingGroupProvider'" 'PrefixI 'True) (S1 ('MetaSel ('Just "managedScaling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ManagedScaling)) :*: (S1 ('MetaSel ('Just "managedTerminationProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ManagedTerminationProtection)) :*: S1 ('MetaSel ('Just "autoScalingGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newAutoScalingGroupProvider Source #

Create a value of AutoScalingGroupProvider with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:managedScaling:AutoScalingGroupProvider', autoScalingGroupProvider_managedScaling - The managed scaling settings for the Auto Scaling group capacity provider.

$sel:managedTerminationProtection:AutoScalingGroupProvider', autoScalingGroupProvider_managedTerminationProtection - The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is disabled.

When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.

When managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.

$sel:autoScalingGroupArn:AutoScalingGroupProvider', autoScalingGroupProvider_autoScalingGroupArn - The Amazon Resource Name (ARN) that identifies the Auto Scaling group.

autoScalingGroupProvider_managedScaling :: Lens' AutoScalingGroupProvider (Maybe ManagedScaling) Source #

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

autoScalingGroupProvider_managedTerminationProtection :: Lens' AutoScalingGroupProvider (Maybe ManagedTerminationProtection) Source #

The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is disabled.

When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.

When managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.

autoScalingGroupProvider_autoScalingGroupArn :: Lens' AutoScalingGroupProvider Text Source #

The Amazon Resource Name (ARN) that identifies the Auto Scaling group.

AutoScalingGroupProviderUpdate

data AutoScalingGroupProviderUpdate Source #

The details of the Auto Scaling group capacity provider to update.

See: newAutoScalingGroupProviderUpdate smart constructor.

Constructors

AutoScalingGroupProviderUpdate' 

Fields

  • managedScaling :: Maybe ManagedScaling

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

  • managedTerminationProtection :: Maybe ManagedTerminationProtection

    The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.

    When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.

    When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled. For more information, see Instance Protection in the Auto Scaling User Guide.

    When managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.

Instances

Instances details
ToJSON AutoScalingGroupProviderUpdate Source # 
Instance details

Defined in Amazonka.ECS.Types.AutoScalingGroupProviderUpdate

Generic AutoScalingGroupProviderUpdate Source # 
Instance details

Defined in Amazonka.ECS.Types.AutoScalingGroupProviderUpdate

Associated Types

type Rep AutoScalingGroupProviderUpdate :: Type -> Type #

Read AutoScalingGroupProviderUpdate Source # 
Instance details

Defined in Amazonka.ECS.Types.AutoScalingGroupProviderUpdate

Show AutoScalingGroupProviderUpdate Source # 
Instance details

Defined in Amazonka.ECS.Types.AutoScalingGroupProviderUpdate

NFData AutoScalingGroupProviderUpdate Source # 
Instance details

Defined in Amazonka.ECS.Types.AutoScalingGroupProviderUpdate

Eq AutoScalingGroupProviderUpdate Source # 
Instance details

Defined in Amazonka.ECS.Types.AutoScalingGroupProviderUpdate

Hashable AutoScalingGroupProviderUpdate Source # 
Instance details

Defined in Amazonka.ECS.Types.AutoScalingGroupProviderUpdate

type Rep AutoScalingGroupProviderUpdate Source # 
Instance details

Defined in Amazonka.ECS.Types.AutoScalingGroupProviderUpdate

type Rep AutoScalingGroupProviderUpdate = D1 ('MetaData "AutoScalingGroupProviderUpdate" "Amazonka.ECS.Types.AutoScalingGroupProviderUpdate" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "AutoScalingGroupProviderUpdate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "managedScaling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ManagedScaling)) :*: S1 ('MetaSel ('Just "managedTerminationProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ManagedTerminationProtection))))

newAutoScalingGroupProviderUpdate :: AutoScalingGroupProviderUpdate Source #

Create a value of AutoScalingGroupProviderUpdate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:managedScaling:AutoScalingGroupProviderUpdate', autoScalingGroupProviderUpdate_managedScaling - The managed scaling settings for the Auto Scaling group capacity provider.

$sel:managedTerminationProtection:AutoScalingGroupProviderUpdate', autoScalingGroupProviderUpdate_managedTerminationProtection - The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.

When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled. For more information, see Instance Protection in the Auto Scaling User Guide.

When managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.

autoScalingGroupProviderUpdate_managedScaling :: Lens' AutoScalingGroupProviderUpdate (Maybe ManagedScaling) Source #

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

autoScalingGroupProviderUpdate_managedTerminationProtection :: Lens' AutoScalingGroupProviderUpdate (Maybe ManagedTerminationProtection) Source #

The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.

When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled. For more information, see Instance Protection in the Auto Scaling User Guide.

When managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.

AwsVpcConfiguration

data AwsVpcConfiguration Source #

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

See: newAwsVpcConfiguration smart constructor.

Constructors

AwsVpcConfiguration' 

Fields

  • assignPublicIp :: Maybe AssignPublicIp

    Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

  • securityGroups :: Maybe [Text]

    The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per AwsVpcConfiguration.

    All specified security groups must be from the same VPC.

  • subnets :: [Text]

    The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per AwsVpcConfiguration.

    All specified subnets must be from the same VPC.

Instances

Instances details
FromJSON AwsVpcConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.AwsVpcConfiguration

ToJSON AwsVpcConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.AwsVpcConfiguration

Generic AwsVpcConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.AwsVpcConfiguration

Associated Types

type Rep AwsVpcConfiguration :: Type -> Type #

Read AwsVpcConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.AwsVpcConfiguration

Show AwsVpcConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.AwsVpcConfiguration

NFData AwsVpcConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.AwsVpcConfiguration

Methods

rnf :: AwsVpcConfiguration -> () #

Eq AwsVpcConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.AwsVpcConfiguration

Hashable AwsVpcConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.AwsVpcConfiguration

type Rep AwsVpcConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.AwsVpcConfiguration

type Rep AwsVpcConfiguration = D1 ('MetaData "AwsVpcConfiguration" "Amazonka.ECS.Types.AwsVpcConfiguration" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "AwsVpcConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "assignPublicIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AssignPublicIp)) :*: (S1 ('MetaSel ('Just "securityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "subnets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newAwsVpcConfiguration :: AwsVpcConfiguration Source #

Create a value of AwsVpcConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:assignPublicIp:AwsVpcConfiguration', awsVpcConfiguration_assignPublicIp - Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

$sel:securityGroups:AwsVpcConfiguration', awsVpcConfiguration_securityGroups - The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per AwsVpcConfiguration.

All specified security groups must be from the same VPC.

$sel:subnets:AwsVpcConfiguration', awsVpcConfiguration_subnets - The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per AwsVpcConfiguration.

All specified subnets must be from the same VPC.

awsVpcConfiguration_assignPublicIp :: Lens' AwsVpcConfiguration (Maybe AssignPublicIp) Source #

Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

awsVpcConfiguration_securityGroups :: Lens' AwsVpcConfiguration (Maybe [Text]) Source #

The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per AwsVpcConfiguration.

All specified security groups must be from the same VPC.

awsVpcConfiguration_subnets :: Lens' AwsVpcConfiguration [Text] Source #

The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per AwsVpcConfiguration.

All specified subnets must be from the same VPC.

CapacityProvider

data CapacityProvider Source #

The details for a capacity provider.

See: newCapacityProvider smart constructor.

Constructors

CapacityProvider' 

Fields

  • autoScalingGroupProvider :: Maybe AutoScalingGroupProvider

    The Auto Scaling group settings for the capacity provider.

  • capacityProviderArn :: Maybe Text

    The Amazon Resource Name (ARN) that identifies the capacity provider.

  • name :: Maybe Text

    The name of the capacity provider.

  • status :: Maybe CapacityProviderStatus

    The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.

  • tags :: Maybe [Tag]

    The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.

    The following basic restrictions apply to tags:

    • Maximum number of tags per resource - 50
    • For each resource, each tag key must be unique, and each tag key can have only one value.
    • Maximum key length - 128 Unicode characters in UTF-8
    • Maximum value length - 256 Unicode characters in UTF-8
    • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    • Tag keys and values are case-sensitive.
    • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
  • updateStatus :: Maybe CapacityProviderUpdateStatus

    The update status of the capacity provider. The following are the possible states that is returned.

    DELETE_IN_PROGRESS
    The capacity provider is in the process of being deleted.
    DELETE_COMPLETE
    The capacity provider was successfully deleted and has an INACTIVE status.
    DELETE_FAILED
    The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.
  • updateStatusReason :: Maybe Text

    The update status reason. This provides further details about the update status for the capacity provider.

Instances

Instances details
FromJSON CapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProvider

Generic CapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProvider

Associated Types

type Rep CapacityProvider :: Type -> Type #

Read CapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProvider

Show CapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProvider

NFData CapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProvider

Methods

rnf :: CapacityProvider -> () #

Eq CapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProvider

Hashable CapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProvider

type Rep CapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProvider

newCapacityProvider :: CapacityProvider Source #

Create a value of CapacityProvider with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:autoScalingGroupProvider:CapacityProvider', capacityProvider_autoScalingGroupProvider - The Auto Scaling group settings for the capacity provider.

$sel:capacityProviderArn:CapacityProvider', capacityProvider_capacityProviderArn - The Amazon Resource Name (ARN) that identifies the capacity provider.

$sel:name:CapacityProvider', capacityProvider_name - The name of the capacity provider.

$sel:status:CapacityProvider', capacityProvider_status - The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.

$sel:tags:CapacityProvider', capacityProvider_tags - The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8
  • Maximum value length - 256 Unicode characters in UTF-8
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case-sensitive.
  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

$sel:updateStatus:CapacityProvider', capacityProvider_updateStatus - The update status of the capacity provider. The following are the possible states that is returned.

DELETE_IN_PROGRESS
The capacity provider is in the process of being deleted.
DELETE_COMPLETE
The capacity provider was successfully deleted and has an INACTIVE status.
DELETE_FAILED
The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.

$sel:updateStatusReason:CapacityProvider', capacityProvider_updateStatusReason - The update status reason. This provides further details about the update status for the capacity provider.

capacityProvider_autoScalingGroupProvider :: Lens' CapacityProvider (Maybe AutoScalingGroupProvider) Source #

The Auto Scaling group settings for the capacity provider.

capacityProvider_capacityProviderArn :: Lens' CapacityProvider (Maybe Text) Source #

The Amazon Resource Name (ARN) that identifies the capacity provider.

capacityProvider_name :: Lens' CapacityProvider (Maybe Text) Source #

The name of the capacity provider.

capacityProvider_status :: Lens' CapacityProvider (Maybe CapacityProviderStatus) Source #

The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.

capacityProvider_tags :: Lens' CapacityProvider (Maybe [Tag]) Source #

The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8
  • Maximum value length - 256 Unicode characters in UTF-8
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case-sensitive.
  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

capacityProvider_updateStatus :: Lens' CapacityProvider (Maybe CapacityProviderUpdateStatus) Source #

The update status of the capacity provider. The following are the possible states that is returned.

DELETE_IN_PROGRESS
The capacity provider is in the process of being deleted.
DELETE_COMPLETE
The capacity provider was successfully deleted and has an INACTIVE status.
DELETE_FAILED
The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.

capacityProvider_updateStatusReason :: Lens' CapacityProvider (Maybe Text) Source #

The update status reason. This provides further details about the update status for the capacity provider.

CapacityProviderStrategyItem

data CapacityProviderStrategyItem Source #

The details of a capacity provider strategy. A capacity provider strategy can be set when using the RunTask or CreateCluster APIs or as the default capacity provider strategy for a cluster with the CreateCluster API.

Only capacity providers that are already associated with a cluster and have an ACTIVE or UPDATING status can be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.

A capacity provider strategy may contain a maximum of 6 capacity providers.

See: newCapacityProviderStrategyItem smart constructor.

Constructors

CapacityProviderStrategyItem' 

Fields

  • base :: Maybe Natural

    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.

  • weight :: Maybe Natural

    The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

    If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

    An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

  • capacityProvider :: Text

    The short name of the capacity provider.

Instances

Instances details
FromJSON CapacityProviderStrategyItem Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStrategyItem

ToJSON CapacityProviderStrategyItem Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStrategyItem

Generic CapacityProviderStrategyItem Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStrategyItem

Associated Types

type Rep CapacityProviderStrategyItem :: Type -> Type #

Read CapacityProviderStrategyItem Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStrategyItem

Show CapacityProviderStrategyItem Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStrategyItem

NFData CapacityProviderStrategyItem Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStrategyItem

Eq CapacityProviderStrategyItem Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStrategyItem

Hashable CapacityProviderStrategyItem Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStrategyItem

type Rep CapacityProviderStrategyItem Source # 
Instance details

Defined in Amazonka.ECS.Types.CapacityProviderStrategyItem

type Rep CapacityProviderStrategyItem = D1 ('MetaData "CapacityProviderStrategyItem" "Amazonka.ECS.Types.CapacityProviderStrategyItem" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "CapacityProviderStrategyItem'" 'PrefixI 'True) (S1 ('MetaSel ('Just "base") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "weight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "capacityProvider") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCapacityProviderStrategyItem Source #

Create a value of CapacityProviderStrategyItem with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:base:CapacityProviderStrategyItem', capacityProviderStrategyItem_base - The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

$sel:weight:CapacityProviderStrategyItem', capacityProviderStrategyItem_weight - The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

$sel:capacityProvider:CapacityProviderStrategyItem', capacityProviderStrategyItem_capacityProvider - The short name of the capacity provider.

capacityProviderStrategyItem_base :: Lens' CapacityProviderStrategyItem (Maybe Natural) Source #

The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

capacityProviderStrategyItem_weight :: Lens' CapacityProviderStrategyItem (Maybe Natural) Source #

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

Cluster

data Cluster Source #

A regional grouping of one or more container instances where you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.

See: newCluster smart constructor.

Constructors

Cluster' 

Fields

  • activeServicesCount :: Maybe Int

    The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

  • attachments :: Maybe [Attachment]

    The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.

  • attachmentsStatus :: Maybe Text

    The status of the capacity providers associated with the cluster. The following are the states that are returned.

    UPDATE_IN_PROGRESS
    The available capacity providers for the cluster are updating.
    UPDATE_COMPLETE
    The capacity providers have successfully updated.
    UPDATE_FAILED
    The capacity provider updates failed.
  • capacityProviders :: Maybe [Text]

    The capacity providers associated with the cluster.

  • clusterArn :: Maybe Text

    The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

  • clusterName :: Maybe Text

    A user-generated string that you use to identify your cluster.

  • configuration :: Maybe ClusterConfiguration

    The execute command configuration for the cluster.

  • defaultCapacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]

    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.

  • pendingTasksCount :: Maybe Int

    The number of tasks in the cluster that are in the PENDING state.

  • registeredContainerInstancesCount :: Maybe Int

    The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

  • runningTasksCount :: Maybe Int

    The number of tasks in the cluster that are in the RUNNING state.

  • serviceConnectDefaults :: Maybe ClusterServiceConnectDefaults

    Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

    Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

  • settings :: Maybe [ClusterSetting]

    The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

  • statistics :: Maybe [KeyValuePair]

    Additional information about your clusters that are separated by launch type. They include the following:

    • runningEC2TasksCount
    • RunningFargateTasksCount
    • pendingEC2TasksCount
    • pendingFargateTasksCount
    • activeEC2ServiceCount
    • activeFargateServiceCount
    • drainingEC2ServiceCount
    • drainingFargateServiceCount
  • status :: Maybe Text

    The status of the cluster. The following are the possible states that are returned.

    ACTIVE
    The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
    PROVISIONING
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.
    DEPROVISIONING
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.
    FAILED
    The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.
    INACTIVE
    The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting.
  • tags :: Maybe [Tag]

    The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

    The following basic restrictions apply to tags:

    • Maximum number of tags per resource - 50
    • For each resource, each tag key must be unique, and each tag key can have only one value.
    • Maximum key length - 128 Unicode characters in UTF-8
    • Maximum value length - 256 Unicode characters in UTF-8
    • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    • Tag keys and values are case-sensitive.
    • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Instances

Instances details
FromJSON Cluster Source # 
Instance details

Defined in Amazonka.ECS.Types.Cluster

Generic Cluster Source # 
Instance details

Defined in Amazonka.ECS.Types.Cluster

Associated Types

type Rep Cluster :: Type -> Type #

Methods

from :: Cluster -> Rep Cluster x #

to :: Rep Cluster x -> Cluster #

Read Cluster Source # 
Instance details

Defined in Amazonka.ECS.Types.Cluster

Show Cluster Source # 
Instance details

Defined in Amazonka.ECS.Types.Cluster

NFData Cluster Source # 
Instance details

Defined in Amazonka.ECS.Types.Cluster

Methods

rnf :: Cluster -> () #

Eq Cluster Source # 
Instance details

Defined in Amazonka.ECS.Types.Cluster

Methods

(==) :: Cluster -> Cluster -> Bool #

(/=) :: Cluster -> Cluster -> Bool #

Hashable Cluster Source # 
Instance details

Defined in Amazonka.ECS.Types.Cluster

Methods

hashWithSalt :: Int -> Cluster -> Int #

hash :: Cluster -> Int #

type Rep Cluster Source # 
Instance details

Defined in Amazonka.ECS.Types.Cluster

type Rep Cluster = D1 ('MetaData "Cluster" "Amazonka.ECS.Types.Cluster" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Cluster'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "activeServicesCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "attachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Attachment]))) :*: (S1 ('MetaSel ('Just "attachmentsStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "capacityProviders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterConfiguration)) :*: S1 ('MetaSel ('Just "defaultCapacityProviderStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CapacityProviderStrategyItem]))))) :*: (((S1 ('MetaSel ('Just "pendingTasksCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "registeredContainerInstancesCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "runningTasksCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "serviceConnectDefaults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterServiceConnectDefaults)))) :*: ((S1 ('MetaSel ('Just "settings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ClusterSetting])) :*: S1 ('MetaSel ('Just "statistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyValuePair]))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))))))

newCluster :: Cluster Source #

Create a value of Cluster with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:activeServicesCount:Cluster', cluster_activeServicesCount - The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

$sel:attachments:Cluster', cluster_attachments - The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.

$sel:attachmentsStatus:Cluster', cluster_attachmentsStatus - The status of the capacity providers associated with the cluster. The following are the states that are returned.

UPDATE_IN_PROGRESS
The available capacity providers for the cluster are updating.
UPDATE_COMPLETE
The capacity providers have successfully updated.
UPDATE_FAILED
The capacity provider updates failed.

$sel:capacityProviders:Cluster', cluster_capacityProviders - The capacity providers associated with the cluster.

$sel:clusterArn:Cluster', cluster_clusterArn - The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

$sel:clusterName:Cluster', cluster_clusterName - A user-generated string that you use to identify your cluster.

$sel:configuration:Cluster', cluster_configuration - The execute command configuration for the cluster.

$sel:defaultCapacityProviderStrategy:Cluster', cluster_defaultCapacityProviderStrategy - The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

$sel:pendingTasksCount:Cluster', cluster_pendingTasksCount - The number of tasks in the cluster that are in the PENDING state.

$sel:registeredContainerInstancesCount:Cluster', cluster_registeredContainerInstancesCount - The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

$sel:runningTasksCount:Cluster', cluster_runningTasksCount - The number of tasks in the cluster that are in the RUNNING state.

$sel:serviceConnectDefaults:Cluster', cluster_serviceConnectDefaults - Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

$sel:settings:Cluster', cluster_settings - The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

$sel:statistics:Cluster', cluster_statistics - Additional information about your clusters that are separated by launch type. They include the following:

  • runningEC2TasksCount
  • RunningFargateTasksCount
  • pendingEC2TasksCount
  • pendingFargateTasksCount
  • activeEC2ServiceCount
  • activeFargateServiceCount
  • drainingEC2ServiceCount
  • drainingFargateServiceCount

Cluster, cluster_status - The status of the cluster. The following are the possible states that are returned.

ACTIVE
The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
PROVISIONING
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.
DEPROVISIONING
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.
FAILED
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.
INACTIVE
The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting.

$sel:tags:Cluster', cluster_tags - The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8
  • Maximum value length - 256 Unicode characters in UTF-8
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case-sensitive.
  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

cluster_activeServicesCount :: Lens' Cluster (Maybe Int) Source #

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

cluster_attachments :: Lens' Cluster (Maybe [Attachment]) Source #

The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.

cluster_attachmentsStatus :: Lens' Cluster (Maybe Text) Source #

The status of the capacity providers associated with the cluster. The following are the states that are returned.

UPDATE_IN_PROGRESS
The available capacity providers for the cluster are updating.
UPDATE_COMPLETE
The capacity providers have successfully updated.
UPDATE_FAILED
The capacity provider updates failed.

cluster_capacityProviders :: Lens' Cluster (Maybe [Text]) Source #

The capacity providers associated with the cluster.

cluster_clusterArn :: Lens' Cluster (Maybe Text) Source #

The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

cluster_clusterName :: Lens' Cluster (Maybe Text) Source #

A user-generated string that you use to identify your cluster.

cluster_configuration :: Lens' Cluster (Maybe ClusterConfiguration) Source #

The execute command configuration for the cluster.

cluster_defaultCapacityProviderStrategy :: Lens' Cluster (Maybe [CapacityProviderStrategyItem]) Source #

The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

cluster_pendingTasksCount :: Lens' Cluster (Maybe Int) Source #

The number of tasks in the cluster that are in the PENDING state.

cluster_registeredContainerInstancesCount :: Lens' Cluster (Maybe Int) Source #

The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

cluster_runningTasksCount :: Lens' Cluster (Maybe Int) Source #

The number of tasks in the cluster that are in the RUNNING state.

cluster_serviceConnectDefaults :: Lens' Cluster (Maybe ClusterServiceConnectDefaults) Source #

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

cluster_settings :: Lens' Cluster (Maybe [ClusterSetting]) Source #

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

cluster_statistics :: Lens' Cluster (Maybe [KeyValuePair]) Source #

Additional information about your clusters that are separated by launch type. They include the following:

  • runningEC2TasksCount
  • RunningFargateTasksCount
  • pendingEC2TasksCount
  • pendingFargateTasksCount
  • activeEC2ServiceCount
  • activeFargateServiceCount
  • drainingEC2ServiceCount
  • drainingFargateServiceCount

cluster_status :: Lens' Cluster (Maybe Text) Source #

The status of the cluster. The following are the possible states that are returned.

ACTIVE
The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
PROVISIONING
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.
DEPROVISIONING
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.
FAILED
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.
INACTIVE
The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting.

cluster_tags :: Lens' Cluster (Maybe [Tag]) Source #

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8
  • Maximum value length - 256 Unicode characters in UTF-8
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case-sensitive.
  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

ClusterConfiguration

data ClusterConfiguration Source #

The execute command configuration for the cluster.

See: newClusterConfiguration smart constructor.

Constructors

ClusterConfiguration' 

Fields

Instances

Instances details
FromJSON ClusterConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterConfiguration

ToJSON ClusterConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterConfiguration

Generic ClusterConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterConfiguration

Associated Types

type Rep ClusterConfiguration :: Type -> Type #

Read ClusterConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterConfiguration

Show ClusterConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterConfiguration

NFData ClusterConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterConfiguration

Methods

rnf :: ClusterConfiguration -> () #

Eq ClusterConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterConfiguration

Hashable ClusterConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterConfiguration

type Rep ClusterConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterConfiguration

type Rep ClusterConfiguration = D1 ('MetaData "ClusterConfiguration" "Amazonka.ECS.Types.ClusterConfiguration" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ClusterConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "executeCommandConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecuteCommandConfiguration))))

newClusterConfiguration :: ClusterConfiguration Source #

Create a value of ClusterConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:executeCommandConfiguration:ClusterConfiguration', clusterConfiguration_executeCommandConfiguration - The details of the execute command configuration.

ClusterServiceConnectDefaults

data ClusterServiceConnectDefaults Source #

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

See: newClusterServiceConnectDefaults smart constructor.

Constructors

ClusterServiceConnectDefaults' 

Fields

  • namespace :: Maybe Text

    The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a Service Connect configuration, this namespace is used.

Instances

Instances details
FromJSON ClusterServiceConnectDefaults Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaults

Generic ClusterServiceConnectDefaults Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaults

Associated Types

type Rep ClusterServiceConnectDefaults :: Type -> Type #

Read ClusterServiceConnectDefaults Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaults

Show ClusterServiceConnectDefaults Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaults

NFData ClusterServiceConnectDefaults Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaults

Eq ClusterServiceConnectDefaults Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaults

Hashable ClusterServiceConnectDefaults Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaults

type Rep ClusterServiceConnectDefaults Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaults

type Rep ClusterServiceConnectDefaults = D1 ('MetaData "ClusterServiceConnectDefaults" "Amazonka.ECS.Types.ClusterServiceConnectDefaults" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ClusterServiceConnectDefaults'" 'PrefixI 'True) (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newClusterServiceConnectDefaults :: ClusterServiceConnectDefaults Source #

Create a value of ClusterServiceConnectDefaults with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:namespace:ClusterServiceConnectDefaults', clusterServiceConnectDefaults_namespace - The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a Service Connect configuration, this namespace is used.

clusterServiceConnectDefaults_namespace :: Lens' ClusterServiceConnectDefaults (Maybe Text) Source #

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a Service Connect configuration, this namespace is used.

ClusterServiceConnectDefaultsRequest

data ClusterServiceConnectDefaultsRequest Source #

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

See: newClusterServiceConnectDefaultsRequest smart constructor.

Constructors

ClusterServiceConnectDefaultsRequest' 

Fields

  • namespace :: Text

    The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/).

    If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this Amazon Web Services Region.

    If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a Cloud Map namespace with the "API calls" method of instance discovery only. This instance discovery method is the "HTTP" namespace type in the Command Line Interface. Other types of instance discovery aren't used by Service Connect.

    If you update the service with an empty string "" for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in Cloud Map and must be deleted separately.

    For more information about Cloud Map, see Working with Services in the /Cloud Map Developer Guide/.

Instances

Instances details
ToJSON ClusterServiceConnectDefaultsRequest Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaultsRequest

Generic ClusterServiceConnectDefaultsRequest Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaultsRequest

Read ClusterServiceConnectDefaultsRequest Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaultsRequest

Show ClusterServiceConnectDefaultsRequest Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaultsRequest

NFData ClusterServiceConnectDefaultsRequest Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaultsRequest

Eq ClusterServiceConnectDefaultsRequest Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaultsRequest

Hashable ClusterServiceConnectDefaultsRequest Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaultsRequest

type Rep ClusterServiceConnectDefaultsRequest Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaultsRequest

type Rep ClusterServiceConnectDefaultsRequest = D1 ('MetaData "ClusterServiceConnectDefaultsRequest" "Amazonka.ECS.Types.ClusterServiceConnectDefaultsRequest" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ClusterServiceConnectDefaultsRequest'" 'PrefixI 'True) (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newClusterServiceConnectDefaultsRequest Source #

Create a value of ClusterServiceConnectDefaultsRequest with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:namespace:ClusterServiceConnectDefaultsRequest', clusterServiceConnectDefaultsRequest_namespace - The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/).

If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this Amazon Web Services Region.

If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a Cloud Map namespace with the "API calls" method of instance discovery only. This instance discovery method is the "HTTP" namespace type in the Command Line Interface. Other types of instance discovery aren't used by Service Connect.

If you update the service with an empty string "" for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in Cloud Map and must be deleted separately.

For more information about Cloud Map, see Working with Services in the /Cloud Map Developer Guide/.

clusterServiceConnectDefaultsRequest_namespace :: Lens' ClusterServiceConnectDefaultsRequest Text Source #

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/).

If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this Amazon Web Services Region.

If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a Cloud Map namespace with the "API calls" method of instance discovery only. This instance discovery method is the "HTTP" namespace type in the Command Line Interface. Other types of instance discovery aren't used by Service Connect.

If you update the service with an empty string "" for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in Cloud Map and must be deleted separately.

For more information about Cloud Map, see Working with Services in the /Cloud Map Developer Guide/.

ClusterSetting

data ClusterSetting Source #

The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.

See: newClusterSetting smart constructor.

Constructors

ClusterSetting' 

Fields

  • name :: Maybe ClusterSettingName

    The name of the cluster setting. The only supported value is containerInsights.

  • value :: Maybe Text

    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.

Instances

Instances details
FromJSON ClusterSetting Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSetting

ToJSON ClusterSetting Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSetting

Generic ClusterSetting Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSetting

Associated Types

type Rep ClusterSetting :: Type -> Type #

Read ClusterSetting Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSetting

Show ClusterSetting Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSetting

NFData ClusterSetting Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSetting

Methods

rnf :: ClusterSetting -> () #

Eq ClusterSetting Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSetting

Hashable ClusterSetting Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSetting

type Rep ClusterSetting Source # 
Instance details

Defined in Amazonka.ECS.Types.ClusterSetting

type Rep ClusterSetting = D1 ('MetaData "ClusterSetting" "Amazonka.ECS.Types.ClusterSetting" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ClusterSetting'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterSettingName)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newClusterSetting :: ClusterSetting Source #

Create a value of ClusterSetting with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:ClusterSetting', clusterSetting_name - The name of the cluster setting. The only supported value is containerInsights.

$sel:value:ClusterSetting', clusterSetting_value - The value to set for the cluster setting. The supported values are enabled and disabled. If enabled is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the containerInsights account setting is enabled. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

clusterSetting_name :: Lens' ClusterSetting (Maybe ClusterSettingName) Source #

The name of the cluster setting. The only supported value is containerInsights.

clusterSetting_value :: Lens' ClusterSetting (Maybe Text) Source #

The value to set for the cluster setting. The supported values are enabled and disabled. If enabled is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the containerInsights account setting is enabled. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

Container

data Container Source #

A Docker container that's part of a task.

See: newContainer smart constructor.

Constructors

Container' 

Fields

Instances

Instances details
FromJSON Container Source # 
Instance details

Defined in Amazonka.ECS.Types.Container

Generic Container Source # 
Instance details

Defined in Amazonka.ECS.Types.Container

Associated Types

type Rep Container :: Type -> Type #

Read Container Source # 
Instance details

Defined in Amazonka.ECS.Types.Container

Show Container Source # 
Instance details

Defined in Amazonka.ECS.Types.Container

NFData Container Source # 
Instance details

Defined in Amazonka.ECS.Types.Container

Methods

rnf :: Container -> () #

Eq Container Source # 
Instance details

Defined in Amazonka.ECS.Types.Container

Hashable Container Source # 
Instance details

Defined in Amazonka.ECS.Types.Container

type Rep Container Source # 
Instance details

Defined in Amazonka.ECS.Types.Container

type Rep Container = D1 ('MetaData "Container" "Amazonka.ECS.Types.Container" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Container'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "containerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cpu") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "exitCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "gpuIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "healthStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HealthStatus)) :*: S1 ('MetaSel ('Just "image") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "imageDigest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "managedAgents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ManagedAgent])) :*: S1 ('MetaSel ('Just "memory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "memoryReservation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "networkBindings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NetworkBinding])) :*: S1 ('MetaSel ('Just "networkInterfaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NetworkInterface]))) :*: (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "runtimeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "taskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newContainer :: Container Source #

Create a value of Container with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containerArn:Container', container_containerArn - The Amazon Resource Name (ARN) of the container.

$sel:cpu:Container', container_cpu - The number of CPU units set for the container. The value is 0 if no value was specified in the container definition when the task definition was registered.

$sel:exitCode:Container', container_exitCode - The exit code returned from the container.

$sel:gpuIds:Container', container_gpuIds - The IDs of each GPU assigned to the container.

$sel:healthStatus:Container', container_healthStatus - The health status of the container. If health checks aren't configured for this container in its task definition, then it reports the health status as UNKNOWN.

$sel:image:Container', container_image - The image used for the container.

$sel:imageDigest:Container', container_imageDigest - The container image manifest digest.

The imageDigest is only returned if the container is using an image hosted in Amazon ECR, otherwise it is omitted.

Container, container_lastStatus - The last known status of the container.

$sel:managedAgents:Container', container_managedAgents - The details of any Amazon ECS managed agents associated with the container.

$sel:memory:Container', container_memory - The hard limit (in MiB) of memory set for the container.

$sel:memoryReservation:Container', container_memoryReservation - The soft limit (in MiB) of memory set for the container.

Container, container_name - The name of the container.

$sel:networkBindings:Container', container_networkBindings - The network bindings associated with the container.

$sel:networkInterfaces:Container', container_networkInterfaces - The network interfaces associated with the container.

Container, container_reason - A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

$sel:runtimeId:Container', container_runtimeId - The ID of the Docker container.

$sel:taskArn:Container', container_taskArn - The ARN of the task.

container_containerArn :: Lens' Container (Maybe Text) Source #

The Amazon Resource Name (ARN) of the container.

container_cpu :: Lens' Container (Maybe Text) Source #

The number of CPU units set for the container. The value is 0 if no value was specified in the container definition when the task definition was registered.

container_exitCode :: Lens' Container (Maybe Int) Source #

The exit code returned from the container.

container_gpuIds :: Lens' Container (Maybe [Text]) Source #

The IDs of each GPU assigned to the container.

container_healthStatus :: Lens' Container (Maybe HealthStatus) Source #

The health status of the container. If health checks aren't configured for this container in its task definition, then it reports the health status as UNKNOWN.

container_image :: Lens' Container (Maybe Text) Source #

The image used for the 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_lastStatus :: Lens' Container (Maybe Text) Source #

The last known status of the container.

container_managedAgents :: Lens' Container (Maybe [ManagedAgent]) Source #

The details of any Amazon ECS managed agents associated with the container.

container_memory :: Lens' Container (Maybe Text) Source #

The hard limit (in MiB) of memory set for the container.

container_memoryReservation :: Lens' Container (Maybe Text) Source #

The soft limit (in MiB) of memory set for the container.

container_name :: Lens' Container (Maybe Text) Source #

The name of the container.

container_networkBindings :: Lens' Container (Maybe [NetworkBinding]) Source #

The network bindings associated with the container.

container_networkInterfaces :: Lens' Container (Maybe [NetworkInterface]) Source #

The network interfaces associated with the container.

container_reason :: Lens' Container (Maybe Text) Source #

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

container_runtimeId :: Lens' Container (Maybe Text) Source #

The ID of the Docker container.

ContainerDefinition

data ContainerDefinition Source #

Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

See: newContainerDefinition smart constructor.

Constructors

ContainerDefinition' 

Fields

  • command :: Maybe [Text]

    The command that's passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array.

  • cpu :: Maybe Int

    The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.

    This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.

    You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.

    Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.

    On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:

    • Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.
    • Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.

    On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as 0, which Windows interprets as 1% of one CPU.

  • dependsOn :: Maybe [ContainerDependency]

    The dependencies defined for container startup and shutdown. A container can contain multiple dependencies on other containers in a task definition. When a dependency is defined for container startup, for container shutdown it is reversed.

    For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

    For tasks using the Fargate launch type, the task or service requires the following platforms:

    • Linux platform version 1.3.0 or later.
    • Windows platform version 1.0.0 or later.
  • disableNetworking :: Maybe Bool

    When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.

    This parameter is not supported for Windows containers.

  • dnsSearchDomains :: Maybe [Text]

    A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.

    This parameter is not supported for Windows containers.

  • dnsServers :: Maybe [Text]

    A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.

    This parameter is not supported for Windows containers.

  • dockerLabels :: Maybe (HashMap Text Text)

    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}}'

  • dockerSecurityOptions :: Maybe [Text]

    A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field isn't valid for containers in tasks using the Fargate launch type.

    With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.

    This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.

    The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

    For more information about valid values, see Docker Run Security Configuration.

    Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"

  • entryPoint :: Maybe [Text]

    Early versions of the Amazon ECS container agent don't properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

    The entry point that's passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

  • environment :: Maybe [KeyValuePair]

    The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

    We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.

  • environmentFiles :: Maybe [EnvironmentFile]

    A list of files containing the environment variables to pass to a container. This parameter maps to the --env-file option to docker run.

    You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file contains an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file.

    If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.

  • essential :: Maybe Bool

    If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

    All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

  • extraHosts :: Maybe [HostEntry]

    A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.

    This parameter isn't supported for Windows containers or tasks that use the awsvpc network mode.

  • firelensConfiguration :: Maybe 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.

  • healthCheck :: Maybe HealthCheck

    The container health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.

  • hostname :: Maybe Text

    The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.

    The hostname parameter is not supported if you're using the awsvpc network mode.

  • image :: Maybe Text

    The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

    • When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.
    • Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.
    • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
    • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
    • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
  • interactive :: Maybe Bool

    When this parameter is true, you can deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the --interactive option to docker run.

  • links :: Maybe [Text]

    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.

  • linuxParameters :: Maybe LinuxParameters

    Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.

    This parameter is not supported for Windows containers.

  • logConfiguration :: Maybe LogConfiguration

    The log configuration specification for the container.

    This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container can use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

    Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

    This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

    The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

  • memory :: Maybe Int

    The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

    If using the Fargate launch type, this parameter is optional.

    If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level memory and memoryReservation value, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of memory is used.

    The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.

    The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.

  • memoryReservation :: Maybe Int

    The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.

    If a task-level memory value is not specified, you must specify a non-zero integer for one or both of memory or memoryReservation in a container definition. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of memory is used.

    For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

    The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.

    The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.

  • mountPoints :: Maybe [MountPoint]

    The mount points for data volumes in your container.

    This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

    Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives.

  • name :: Maybe Text

    The name of a container. If you're linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.

  • portMappings :: Maybe [PortMapping]

    The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.

    For task definitions that use the awsvpc network mode, only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

    Port mappings on Windows use the NetNAT gateway address rather than localhost. There's no loopback for port mappings on Windows, so you can't access a container's mapped port from the host itself.

    This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

    After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.

  • privileged :: Maybe Bool

    When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.

    This parameter is not supported for Windows containers or tasks run on Fargate.

  • pseudoTerminal :: Maybe Bool

    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.

  • readonlyRootFilesystem :: Maybe Bool

    When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

    This parameter is not supported for Windows containers.

  • repositoryCredentials :: Maybe RepositoryCredentials

    The private repository authentication credentials to use.

  • resourceRequirements :: Maybe [ResourceRequirement]

    The type and amount of a resource to assign to a container. The only supported resource is a GPU.

  • secrets :: Maybe [Secret]

    The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

  • startTimeout :: Maybe Int

    Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a STOPPED state.

    When the ECS_CONTAINER_START_TIMEOUT container agent configuration variable is used, it's enforced independently from this start timeout value.

    For tasks using the Fargate launch type, the task or service requires the following platforms:

    • Linux platform version 1.3.0 or later.
    • Windows platform version 1.0.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 use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

  • stopTimeout :: Maybe Int

    Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.

    For tasks using the Fargate launch type, the task or service requires the following platforms:

    • Linux platform version 1.3.0 or later.
    • Windows platform version 1.0.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 that use the EC2 launch type, if the stopTimeout parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

  • systemControls :: Maybe [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.

    We don't recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that's started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.

  • ulimits :: Maybe [Ulimit]

    A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type.

    Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and hard limit is 4096.

    This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

    This parameter is not supported for Windows containers.

  • user :: Maybe Text

    The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

    When running tasks using the host network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.

    You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

    • user
    • user:group
    • uid
    • uid:gid
    • user:gid
    • uid:group

    This parameter is not supported for Windows containers.

  • volumesFrom :: Maybe [VolumeFrom]

    Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.

  • workingDirectory :: Maybe Text

    The working directory to run commands inside the container in. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.

Instances

Instances details
FromJSON ContainerDefinition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerDefinition

ToJSON ContainerDefinition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerDefinition

Generic ContainerDefinition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerDefinition

Associated Types

type Rep ContainerDefinition :: Type -> Type #

Read ContainerDefinition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerDefinition

Show ContainerDefinition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerDefinition

NFData ContainerDefinition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerDefinition

Methods

rnf :: ContainerDefinition -> () #

Eq ContainerDefinition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerDefinition

Hashable ContainerDefinition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerDefinition

type Rep ContainerDefinition Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerDefinition

type Rep ContainerDefinition = D1 ('MetaData "ContainerDefinition" "Amazonka.ECS.Types.ContainerDefinition" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ContainerDefinition'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "cpu") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "dependsOn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ContainerDependency])) :*: S1 ('MetaSel ('Just "disableNetworking") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "dnsSearchDomains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "dnsServers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "dockerLabels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "dockerSecurityOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "entryPoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))) :*: (((S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyValuePair])) :*: S1 ('MetaSel ('Just "environmentFiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EnvironmentFile]))) :*: (S1 ('MetaSel ('Just "essential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "extraHosts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HostEntry])) :*: S1 ('MetaSel ('Just "firelensConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FirelensConfiguration))))) :*: ((S1 ('MetaSel ('Just "healthCheck") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HealthCheck)) :*: S1 ('MetaSel ('Just "hostname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "image") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "interactive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "links") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))) :*: ((((S1 ('MetaSel ('Just "linuxParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LinuxParameters)) :*: S1 ('MetaSel ('Just "logConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogConfiguration))) :*: (S1 ('MetaSel ('Just "memory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "memoryReservation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "mountPoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MountPoint]))))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "portMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PortMapping]))) :*: (S1 ('MetaSel ('Just "privileged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "pseudoTerminal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "readonlyRootFilesystem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))) :*: (((S1 ('MetaSel ('Just "repositoryCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RepositoryCredentials)) :*: S1 ('MetaSel ('Just "resourceRequirements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceRequirement]))) :*: (S1 ('MetaSel ('Just "secrets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Secret])) :*: (S1 ('MetaSel ('Just "startTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "stopTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :*: ((S1 ('MetaSel ('Just "systemControls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SystemControl])) :*: S1 ('MetaSel ('Just "ulimits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Ulimit]))) :*: (S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "volumesFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VolumeFrom])) :*: S1 ('MetaSel ('Just "workingDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))))

newContainerDefinition :: ContainerDefinition Source #

Create a value of ContainerDefinition with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ContainerDefinition, containerDefinition_command - The command that's passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array.

$sel:cpu:ContainerDefinition', containerDefinition_cpu - The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.

This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.

You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.

Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.

On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:

  • Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.
  • Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.

On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as 0, which Windows interprets as 1% of one CPU.

$sel:dependsOn:ContainerDefinition', containerDefinition_dependsOn - The dependencies defined for container startup and shutdown. A container can contain multiple dependencies on other containers in a task definition. When a dependency is defined for container startup, for container shutdown it is reversed.

For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks using the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.
  • Windows platform version 1.0.0 or later.

$sel:disableNetworking:ContainerDefinition', containerDefinition_disableNetworking - When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.

This parameter is not supported for Windows containers.

$sel:dnsSearchDomains:ContainerDefinition', containerDefinition_dnsSearchDomains - A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.

This parameter is not supported for Windows containers.

$sel:dnsServers:ContainerDefinition', containerDefinition_dnsServers - A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.

This parameter is not supported for Windows containers.

$sel:dockerLabels:ContainerDefinition', containerDefinition_dockerLabels - A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

$sel:dockerSecurityOptions:ContainerDefinition', containerDefinition_dockerSecurityOptions - A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field isn't valid for containers in tasks using the Fargate launch type.

With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.

This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.

The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

For more information about valid values, see Docker Run Security Configuration.

Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"

$sel:entryPoint:ContainerDefinition', containerDefinition_entryPoint - Early versions of the Amazon ECS container agent don't properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

The entry point that's passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

$sel:environment:ContainerDefinition', containerDefinition_environment - The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.

$sel:environmentFiles:ContainerDefinition', containerDefinition_environmentFiles - A list of files containing the environment variables to pass to a container. This parameter maps to the --env-file option to docker run.

You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file contains an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.

$sel:essential:ContainerDefinition', containerDefinition_essential - If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

$sel:extraHosts:ContainerDefinition', containerDefinition_extraHosts - A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.

This parameter isn't supported for Windows containers or tasks that use the awsvpc network mode.

$sel:firelensConfiguration:ContainerDefinition', containerDefinition_firelensConfiguration - The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

$sel:healthCheck:ContainerDefinition', containerDefinition_healthCheck - The container health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.

ContainerDefinition, containerDefinition_hostname - The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.

The hostname parameter is not supported if you're using the awsvpc network mode.

$sel:image:ContainerDefinition', containerDefinition_image - The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

  • When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.
  • Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.
  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

$sel:interactive:ContainerDefinition', containerDefinition_interactive - When this parameter is true, you can deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the --interactive option to docker run.

$sel:links:ContainerDefinition', containerDefinition_links - The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run.

This parameter is not supported for Windows containers.

Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

$sel:linuxParameters:ContainerDefinition', containerDefinition_linuxParameters - Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.

This parameter is not supported for Windows containers.

$sel:logConfiguration:ContainerDefinition', containerDefinition_logConfiguration - The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container can use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

$sel:memory:ContainerDefinition', containerDefinition_memory - The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If using the Fargate launch type, this parameter is optional.

If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level memory and memoryReservation value, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of memory is used.

The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.

$sel:memoryReservation:ContainerDefinition', containerDefinition_memoryReservation - The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.

If a task-level memory value is not specified, you must specify a non-zero integer for one or both of memory or memoryReservation in a container definition. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of memory is used.

For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.

$sel:mountPoints:ContainerDefinition', containerDefinition_mountPoints - The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives.

ContainerDefinition, containerDefinition_name - The name of a container. If you're linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.

$sel:portMappings:ContainerDefinition', containerDefinition_portMappings - The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.

For task definitions that use the awsvpc network mode, only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Port mappings on Windows use the NetNAT gateway address rather than localhost. There's no loopback for port mappings on Windows, so you can't access a container's mapped port from the host itself.

This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.

$sel:privileged:ContainerDefinition', containerDefinition_privileged - When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.

This parameter is not supported for Windows containers or tasks run on Fargate.

$sel:pseudoTerminal:ContainerDefinition', containerDefinition_pseudoTerminal - When this parameter is true, a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the --tty option to docker run.

$sel:readonlyRootFilesystem:ContainerDefinition', containerDefinition_readonlyRootFilesystem - When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

This parameter is not supported for Windows containers.

$sel:repositoryCredentials:ContainerDefinition', containerDefinition_repositoryCredentials - The private repository authentication credentials to use.

$sel:resourceRequirements:ContainerDefinition', containerDefinition_resourceRequirements - The type and amount of a resource to assign to a container. The only supported resource is a GPU.

$sel:secrets:ContainerDefinition', containerDefinition_secrets - The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

$sel:startTimeout:ContainerDefinition', containerDefinition_startTimeout - Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a STOPPED state.

When the ECS_CONTAINER_START_TIMEOUT container agent configuration variable is used, it's enforced independently from this start timeout value.

For tasks using the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.
  • Windows platform version 1.0.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 use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

$sel:stopTimeout:ContainerDefinition', containerDefinition_stopTimeout - Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.

For tasks using the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.
  • Windows platform version 1.0.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 that use the EC2 launch type, if the stopTimeout parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

$sel:systemControls:ContainerDefinition', containerDefinition_systemControls - A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.

We don't recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that's started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.

$sel:ulimits:ContainerDefinition', containerDefinition_ulimits - A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and hard limit is 4096.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

$sel:user:ContainerDefinition', containerDefinition_user - The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

When running tasks using the host network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

  • user
  • user:group
  • uid
  • uid:gid
  • user:gid
  • uid:group

This parameter is not supported for Windows containers.

$sel:volumesFrom:ContainerDefinition', containerDefinition_volumesFrom - Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.

$sel:workingDirectory:ContainerDefinition', containerDefinition_workingDirectory - The working directory to run commands inside the container in. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.

containerDefinition_command :: Lens' ContainerDefinition (Maybe [Text]) Source #

The command that's passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array.

containerDefinition_cpu :: Lens' ContainerDefinition (Maybe Int) Source #

The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.

This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.

You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.

Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.

On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:

  • Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.
  • Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.

On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as 0, which Windows interprets as 1% of one CPU.

containerDefinition_dependsOn :: Lens' ContainerDefinition (Maybe [ContainerDependency]) Source #

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies on other containers in a task definition. When a dependency is defined for container startup, for container shutdown it is reversed.

For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks using the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.
  • Windows platform version 1.0.0 or later.

containerDefinition_disableNetworking :: Lens' ContainerDefinition (Maybe Bool) Source #

When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.

This parameter is not supported for Windows containers.

containerDefinition_dnsSearchDomains :: Lens' ContainerDefinition (Maybe [Text]) Source #

A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.

This parameter is not supported for Windows containers.

containerDefinition_dnsServers :: Lens' ContainerDefinition (Maybe [Text]) Source #

A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.

This parameter is not supported for Windows containers.

containerDefinition_dockerLabels :: Lens' ContainerDefinition (Maybe (HashMap Text Text)) Source #

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

containerDefinition_dockerSecurityOptions :: Lens' ContainerDefinition (Maybe [Text]) Source #

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field isn't valid for containers in tasks using the Fargate launch type.

With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.

This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.

The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

For more information about valid values, see Docker Run Security Configuration.

Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"

containerDefinition_entryPoint :: Lens' ContainerDefinition (Maybe [Text]) Source #

Early versions of the Amazon ECS container agent don't properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

The entry point that's passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

containerDefinition_environment :: Lens' ContainerDefinition (Maybe [KeyValuePair]) Source #

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.

containerDefinition_environmentFiles :: Lens' ContainerDefinition (Maybe [EnvironmentFile]) Source #

A list of files containing the environment variables to pass to a container. This parameter maps to the --env-file option to docker run.

You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file contains an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.

containerDefinition_essential :: Lens' ContainerDefinition (Maybe Bool) Source #

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

containerDefinition_extraHosts :: Lens' ContainerDefinition (Maybe [HostEntry]) Source #

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.

This parameter isn't supported for Windows containers or tasks that use the awsvpc network mode.

containerDefinition_firelensConfiguration :: Lens' ContainerDefinition (Maybe FirelensConfiguration) Source #

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

containerDefinition_healthCheck :: Lens' ContainerDefinition (Maybe HealthCheck) Source #

The container health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.

containerDefinition_hostname :: Lens' ContainerDefinition (Maybe Text) Source #

The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.

The hostname parameter is not supported if you're using the awsvpc network mode.

containerDefinition_image :: Lens' ContainerDefinition (Maybe Text) Source #

The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

  • When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.
  • Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.
  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

containerDefinition_interactive :: Lens' ContainerDefinition (Maybe Bool) Source #

When this parameter is true, you can deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the --interactive option to docker run.

containerDefinition_links :: Lens' ContainerDefinition (Maybe [Text]) Source #

The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run.

This parameter is not supported for Windows containers.

Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

containerDefinition_linuxParameters :: Lens' ContainerDefinition (Maybe LinuxParameters) Source #

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.

This parameter is not supported for Windows containers.

containerDefinition_logConfiguration :: Lens' ContainerDefinition (Maybe LogConfiguration) Source #

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container can use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

containerDefinition_memory :: Lens' ContainerDefinition (Maybe Int) Source #

The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If using the Fargate launch type, this parameter is optional.

If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level memory and memoryReservation value, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of memory is used.

The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.

containerDefinition_memoryReservation :: Lens' ContainerDefinition (Maybe Int) Source #

The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.

If a task-level memory value is not specified, you must specify a non-zero integer for one or both of memory or memoryReservation in a container definition. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of memory is used.

For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.

containerDefinition_mountPoints :: Lens' ContainerDefinition (Maybe [MountPoint]) Source #

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives.

containerDefinition_name :: Lens' ContainerDefinition (Maybe Text) Source #

The name of a container. If you're linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.

containerDefinition_portMappings :: Lens' ContainerDefinition (Maybe [PortMapping]) Source #

The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.

For task definitions that use the awsvpc network mode, only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Port mappings on Windows use the NetNAT gateway address rather than localhost. There's no loopback for port mappings on Windows, so you can't access a container's mapped port from the host itself.

This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.

containerDefinition_privileged :: Lens' ContainerDefinition (Maybe Bool) Source #

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.

This parameter is not supported for Windows containers or tasks run on Fargate.

containerDefinition_pseudoTerminal :: Lens' ContainerDefinition (Maybe Bool) Source #

When this parameter is true, a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the --tty option to docker run.

containerDefinition_readonlyRootFilesystem :: Lens' ContainerDefinition (Maybe Bool) Source #

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

This parameter is not supported for Windows containers.

containerDefinition_repositoryCredentials :: Lens' ContainerDefinition (Maybe RepositoryCredentials) Source #

The private repository authentication credentials to use.

containerDefinition_resourceRequirements :: Lens' ContainerDefinition (Maybe [ResourceRequirement]) Source #

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

containerDefinition_secrets :: Lens' ContainerDefinition (Maybe [Secret]) Source #

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

containerDefinition_startTimeout :: Lens' ContainerDefinition (Maybe Int) Source #

Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a STOPPED state.

When the ECS_CONTAINER_START_TIMEOUT container agent configuration variable is used, it's enforced independently from this start timeout value.

For tasks using the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.
  • Windows platform version 1.0.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 use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

containerDefinition_stopTimeout :: Lens' ContainerDefinition (Maybe Int) Source #

Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.

For tasks using the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.
  • Windows platform version 1.0.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 that use the EC2 launch type, if the stopTimeout parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

containerDefinition_systemControls :: Lens' ContainerDefinition (Maybe [SystemControl]) Source #

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.

We don't recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that's started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.

containerDefinition_ulimits :: Lens' ContainerDefinition (Maybe [Ulimit]) Source #

A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and hard limit is 4096.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

containerDefinition_user :: Lens' ContainerDefinition (Maybe Text) Source #

The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

When running tasks using the host network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

  • user
  • user:group
  • uid
  • uid:gid
  • user:gid
  • uid:group

This parameter is not supported for Windows containers.

containerDefinition_volumesFrom :: Lens' ContainerDefinition (Maybe [VolumeFrom]) Source #

Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.

containerDefinition_workingDirectory :: Lens' ContainerDefinition (Maybe Text) Source #

The working directory to run commands inside the container in. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.

ContainerDependency

data ContainerDependency Source #

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

Your Amazon ECS container instances require at least version 1.26.0 of the container agent to use container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks that use the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.
  • Windows platform version 1.0.0 or later.

See: newContainerDependency smart constructor.

Constructors

ContainerDependency' 

Fields

  • containerName :: Text

    The name of a container.

  • condition :: ContainerCondition

    The dependency condition of the container. The following are the available conditions and their behavior:

    • START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.
    • COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.
    • SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can't be set on an essential container.
    • HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.

Instances

Instances details
FromJSON ContainerDependency Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerDependency

ToJSON ContainerDependency Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerDependency

Generic ContainerDependency Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerDependency

Associated Types

type Rep ContainerDependency :: Type -> Type #

Read ContainerDependency Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerDependency

Show ContainerDependency Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerDependency

NFData ContainerDependency Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerDependency

Methods

rnf :: ContainerDependency -> () #

Eq ContainerDependency Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerDependency

Hashable ContainerDependency Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerDependency

type Rep ContainerDependency Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerDependency

type Rep ContainerDependency = D1 ('MetaData "ContainerDependency" "Amazonka.ECS.Types.ContainerDependency" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ContainerDependency'" 'PrefixI 'True) (S1 ('MetaSel ('Just "containerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "condition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContainerCondition)))

newContainerDependency Source #

Create a value of ContainerDependency with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containerName:ContainerDependency', containerDependency_containerName - The name of a container.

$sel:condition:ContainerDependency', containerDependency_condition - The dependency condition of the container. The following are the available conditions and their behavior:

  • START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.
  • COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.
  • SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can't be set on an essential container.
  • HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.

containerDependency_condition :: Lens' ContainerDependency ContainerCondition Source #

The dependency condition of the container. The following are the available conditions and their behavior:

  • START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.
  • COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.
  • SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can't be set on an essential container.
  • HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.

ContainerInstance

data ContainerInstance Source #

An Amazon EC2 or External instance that's running the Amazon ECS agent and has been registered with a cluster.

See: newContainerInstance smart constructor.

Constructors

ContainerInstance' 

Fields

  • agentConnected :: Maybe Bool

    This parameter returns true if the agent is connected to Amazon ECS. An instance with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept task placement requests.

  • agentUpdateStatus :: Maybe AgentUpdateStatus

    The status of the most recent agent update. If an update wasn't ever requested, this value is NULL.

  • attachments :: Maybe [Attachment]

    The resources attached to a container instance, such as an elastic network interface.

  • attributes :: Maybe [Attribute]

    The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

  • capacityProviderName :: Maybe Text

    The capacity provider that's associated with the container instance.

  • containerInstanceArn :: Maybe Text

    The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

  • ec2InstanceId :: Maybe Text

    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.

  • healthStatus :: Maybe ContainerInstanceHealthStatus

    An object representing the health status of the container instance.

  • pendingTasksCount :: Maybe Int

    The number of tasks on the container instance that are in the PENDING status.

  • registeredAt :: Maybe POSIX

    The Unix timestamp for the time when the container instance was registered.

  • registeredResources :: Maybe [Resource]

    For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.

  • remainingResources :: Maybe [Resource]

    For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn't already allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that's not specified here is available for new tasks.

  • runningTasksCount :: Maybe Int

    The number of tasks on the container instance that are in the RUNNING status.

  • status :: Maybe Text

    The status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING.

    If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.

    The ACTIVE status indicates that the container instance can accept tasks. The DRAINING indicates that new tasks aren't placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container instance draining in the Amazon Elastic Container Service Developer Guide.

  • statusReason :: Maybe Text

    The reason that the container instance reached its current status.

  • tags :: Maybe [Tag]

    The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

    The following basic restrictions apply to tags:

    • Maximum number of tags per resource - 50
    • For each resource, each tag key must be unique, and each tag key can have only one value.
    • Maximum key length - 128 Unicode characters in UTF-8
    • Maximum value length - 256 Unicode characters in UTF-8
    • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    • Tag keys and values are case-sensitive.
    • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
  • version :: Maybe Integer

    The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you're replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.

  • versionInfo :: Maybe VersionInfo

    The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

Instances

Instances details
FromJSON ContainerInstance Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstance

Generic ContainerInstance Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstance

Associated Types

type Rep ContainerInstance :: Type -> Type #

Read ContainerInstance Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstance

Show ContainerInstance Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstance

NFData ContainerInstance Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstance

Methods

rnf :: ContainerInstance -> () #

Eq ContainerInstance Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstance

Hashable ContainerInstance Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstance

type Rep ContainerInstance Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstance

type Rep ContainerInstance = D1 ('MetaData "ContainerInstance" "Amazonka.ECS.Types.ContainerInstance" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ContainerInstance'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "agentConnected") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "agentUpdateStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AgentUpdateStatus))) :*: (S1 ('MetaSel ('Just "attachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Attachment])) :*: S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Attribute])))) :*: ((S1 ('MetaSel ('Just "capacityProviderName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "containerInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "ec2InstanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "healthStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerInstanceHealthStatus)) :*: S1 ('MetaSel ('Just "pendingTasksCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))) :*: (((S1 ('MetaSel ('Just "registeredAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "registeredResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Resource]))) :*: (S1 ('MetaSel ('Just "remainingResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Resource])) :*: S1 ('MetaSel ('Just "runningTasksCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "versionInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VersionInfo))))))))

newContainerInstance :: ContainerInstance Source #

Create a value of ContainerInstance with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:agentConnected:ContainerInstance', containerInstance_agentConnected - This parameter returns true if the agent is connected to Amazon ECS. An instance with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept task placement requests.

$sel:agentUpdateStatus:ContainerInstance', containerInstance_agentUpdateStatus - The status of the most recent agent update. If an update wasn't ever requested, this value is NULL.

$sel:attachments:ContainerInstance', containerInstance_attachments - The resources attached to a container instance, such as an elastic network interface.

$sel:attributes:ContainerInstance', containerInstance_attributes - The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

$sel:capacityProviderName:ContainerInstance', containerInstance_capacityProviderName - The capacity provider that's associated with the container instance.

$sel:containerInstanceArn:ContainerInstance', containerInstance_containerInstanceArn - The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

$sel:ec2InstanceId:ContainerInstance', containerInstance_ec2InstanceId - The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.

$sel:healthStatus:ContainerInstance', containerInstance_healthStatus - An object representing the health status of the container instance.

$sel:pendingTasksCount:ContainerInstance', containerInstance_pendingTasksCount - The number of tasks on the container instance that are in the PENDING status.

$sel:registeredAt:ContainerInstance', containerInstance_registeredAt - The Unix timestamp for the time when the container instance was registered.

$sel:registeredResources:ContainerInstance', containerInstance_registeredResources - For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.

$sel:remainingResources:ContainerInstance', containerInstance_remainingResources - For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn't already allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that's not specified here is available for new tasks.

$sel:runningTasksCount:ContainerInstance', containerInstance_runningTasksCount - The number of tasks on the container instance that are in the RUNNING status.

ContainerInstance, containerInstance_status - The status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING.

If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.

The ACTIVE status indicates that the container instance can accept tasks. The DRAINING indicates that new tasks aren't placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container instance draining in the Amazon Elastic Container Service Developer Guide.

$sel:statusReason:ContainerInstance', containerInstance_statusReason - The reason that the container instance reached its current status.

$sel:tags:ContainerInstance', containerInstance_tags - The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8
  • Maximum value length - 256 Unicode characters in UTF-8
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case-sensitive.
  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

$sel:version:ContainerInstance', containerInstance_version - The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you're replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.

$sel:versionInfo:ContainerInstance', containerInstance_versionInfo - The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

containerInstance_agentConnected :: Lens' ContainerInstance (Maybe Bool) Source #

This parameter returns true if the agent is connected to Amazon ECS. An instance with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept task placement requests.

containerInstance_agentUpdateStatus :: Lens' ContainerInstance (Maybe AgentUpdateStatus) Source #

The status of the most recent agent update. If an update wasn't ever requested, this value is NULL.

containerInstance_attachments :: Lens' ContainerInstance (Maybe [Attachment]) Source #

The resources attached to a container instance, such as an elastic network interface.

containerInstance_attributes :: Lens' ContainerInstance (Maybe [Attribute]) Source #

The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

containerInstance_capacityProviderName :: Lens' ContainerInstance (Maybe Text) Source #

The capacity provider that's associated with the container instance.

containerInstance_containerInstanceArn :: Lens' ContainerInstance (Maybe Text) Source #

The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

containerInstance_ec2InstanceId :: Lens' ContainerInstance (Maybe Text) Source #

The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.

containerInstance_healthStatus :: Lens' ContainerInstance (Maybe ContainerInstanceHealthStatus) Source #

An object representing the health status of the container instance.

containerInstance_pendingTasksCount :: Lens' ContainerInstance (Maybe Int) Source #

The number of tasks on the container instance that are in the PENDING status.

containerInstance_registeredAt :: Lens' ContainerInstance (Maybe UTCTime) Source #

The Unix timestamp for the time when the container instance was registered.

containerInstance_registeredResources :: Lens' ContainerInstance (Maybe [Resource]) Source #

For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.

containerInstance_remainingResources :: Lens' ContainerInstance (Maybe [Resource]) Source #

For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn't already allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that's not specified here is available for new tasks.

containerInstance_runningTasksCount :: Lens' ContainerInstance (Maybe Int) Source #

The number of tasks on the container instance that are in the RUNNING status.

containerInstance_status :: Lens' ContainerInstance (Maybe Text) Source #

The status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING.

If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.

The ACTIVE status indicates that the container instance can accept tasks. The DRAINING indicates that new tasks aren't placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container instance draining in the Amazon Elastic Container Service Developer Guide.

containerInstance_statusReason :: Lens' ContainerInstance (Maybe Text) Source #

The reason that the container instance reached its current status.

containerInstance_tags :: Lens' ContainerInstance (Maybe [Tag]) Source #

The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8
  • Maximum value length - 256 Unicode characters in UTF-8
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case-sensitive.
  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

containerInstance_version :: Lens' ContainerInstance (Maybe Integer) Source #

The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you're replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.

containerInstance_versionInfo :: Lens' ContainerInstance (Maybe VersionInfo) Source #

The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

ContainerInstanceHealthStatus

data ContainerInstanceHealthStatus Source #

An object representing the health status of the container instance.

See: newContainerInstanceHealthStatus smart constructor.

Constructors

ContainerInstanceHealthStatus' 

Fields

Instances

Instances details
FromJSON ContainerInstanceHealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceHealthStatus

Generic ContainerInstanceHealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceHealthStatus

Associated Types

type Rep ContainerInstanceHealthStatus :: Type -> Type #

Read ContainerInstanceHealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceHealthStatus

Show ContainerInstanceHealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceHealthStatus

NFData ContainerInstanceHealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceHealthStatus

Eq ContainerInstanceHealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceHealthStatus

Hashable ContainerInstanceHealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceHealthStatus

type Rep ContainerInstanceHealthStatus Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerInstanceHealthStatus

type Rep ContainerInstanceHealthStatus = D1 ('MetaData "ContainerInstanceHealthStatus" "Amazonka.ECS.Types.ContainerInstanceHealthStatus" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ContainerInstanceHealthStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InstanceHealthCheckResult])) :*: S1 ('MetaSel ('Just "overallStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceHealthCheckState))))

newContainerInstanceHealthStatus :: ContainerInstanceHealthStatus Source #

Create a value of ContainerInstanceHealthStatus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:details:ContainerInstanceHealthStatus', containerInstanceHealthStatus_details - An array of objects representing the details of the container instance health status.

$sel:overallStatus:ContainerInstanceHealthStatus', containerInstanceHealthStatus_overallStatus - The overall health status of the container instance. This is an aggregate status of all container instance health checks.

containerInstanceHealthStatus_details :: Lens' ContainerInstanceHealthStatus (Maybe [InstanceHealthCheckResult]) Source #

An array of objects representing the details of the container instance health status.

containerInstanceHealthStatus_overallStatus :: Lens' ContainerInstanceHealthStatus (Maybe InstanceHealthCheckState) Source #

The overall health status of the container instance. This is an aggregate status of all container instance health checks.

ContainerOverride

data ContainerOverride Source #

The overrides that are sent to a container. An empty container override can be passed in. An example of an empty container override is {"containerOverrides": [ ] }. If a non-empty container override is specified, the name parameter must be included.

See: newContainerOverride smart constructor.

Constructors

ContainerOverride' 

Fields

  • command :: Maybe [Text]

    The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

  • cpu :: Maybe Int

    The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

  • environment :: Maybe [KeyValuePair]

    The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

  • environmentFiles :: Maybe [EnvironmentFile]

    A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

  • memory :: Maybe Int

    The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

  • memoryReservation :: Maybe Int

    The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

  • name :: Maybe Text

    The name of the container that receives the override. This parameter is required if any override is specified.

  • resourceRequirements :: Maybe [ResourceRequirement]

    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.

Instances

Instances details
FromJSON ContainerOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerOverride

ToJSON ContainerOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerOverride

Generic ContainerOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerOverride

Associated Types

type Rep ContainerOverride :: Type -> Type #

Read ContainerOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerOverride

Show ContainerOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerOverride

NFData ContainerOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerOverride

Methods

rnf :: ContainerOverride -> () #

Eq ContainerOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerOverride

Hashable ContainerOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerOverride

type Rep ContainerOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerOverride

newContainerOverride :: ContainerOverride Source #

Create a value of ContainerOverride with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:command:ContainerOverride', containerOverride_command - The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

$sel:cpu:ContainerOverride', containerOverride_cpu - The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

$sel:environment:ContainerOverride', containerOverride_environment - The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

$sel:environmentFiles:ContainerOverride', containerOverride_environmentFiles - A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

$sel:memory:ContainerOverride', containerOverride_memory - The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

$sel:memoryReservation:ContainerOverride', containerOverride_memoryReservation - The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

ContainerOverride, containerOverride_name - The name of the container that receives the override. This parameter is required if any override is specified.

$sel:resourceRequirements:ContainerOverride', containerOverride_resourceRequirements - The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

containerOverride_command :: Lens' ContainerOverride (Maybe [Text]) Source #

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

containerOverride_cpu :: Lens' ContainerOverride (Maybe Int) Source #

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

containerOverride_environment :: Lens' ContainerOverride (Maybe [KeyValuePair]) Source #

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

containerOverride_environmentFiles :: Lens' ContainerOverride (Maybe [EnvironmentFile]) Source #

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

containerOverride_memory :: Lens' ContainerOverride (Maybe Int) Source #

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

containerOverride_memoryReservation :: Lens' ContainerOverride (Maybe Int) Source #

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

containerOverride_name :: Lens' ContainerOverride (Maybe Text) Source #

The name of the container that receives the override. This parameter is required if any override is specified.

containerOverride_resourceRequirements :: Lens' ContainerOverride (Maybe [ResourceRequirement]) Source #

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

ContainerService

data ContainerService Source #

Details on a service within a cluster

See: newContainerService smart constructor.

Constructors

ContainerService' 

Fields

  • capacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]

    The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.

  • clusterArn :: Maybe Text

    The Amazon Resource Name (ARN) of the cluster that hosts the service.

  • createdAt :: Maybe POSIX

    The Unix timestamp for the time when the service was created.

  • createdBy :: Maybe Text

    The principal that created the service.

  • deploymentConfiguration :: Maybe DeploymentConfiguration

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

  • deploymentController :: Maybe DeploymentController

    The deployment controller type the service is using.

  • deployments :: Maybe [Deployment]

    The current state of deployments for the service.

  • desiredCount :: Maybe Int

    The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

  • enableECSManagedTags :: Maybe Bool

    Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

  • enableExecuteCommand :: Maybe Bool

    Determines whether the execute command functionality is enabled for the service. If true, the execute command functionality is enabled for all containers in tasks as part of the service.

  • events :: Maybe [ServiceEvent]

    The event stream for your service. A maximum of 100 of the latest events are displayed.

  • healthCheckGracePeriodSeconds :: Maybe Int

    The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

  • launchType :: Maybe LaunchType

    The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy.

  • loadBalancers :: Maybe [LoadBalancer]

    A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

  • networkConfiguration :: Maybe NetworkConfiguration

    The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

  • pendingCount :: Maybe Int

    The number of tasks in the cluster that are in the PENDING state.

  • placementConstraints :: Maybe [PlacementConstraint]

    The placement constraints for the tasks in the service.

  • placementStrategy :: Maybe [PlacementStrategy]

    The placement strategy that determines how tasks for the service are placed.

  • platformFamily :: Maybe Text

    The operating system that your tasks in the service run on. A platform family is specified only for tasks using the Fargate launch type.

    All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX).

  • platformVersion :: Maybe Text

    The platform version to run your service on. A platform version is only specified for tasks that are hosted on Fargate. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

  • propagateTags :: Maybe PropagateTags

    Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

  • roleArn :: Maybe Text

    The ARN of the IAM role that's associated with the service. It allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

  • runningCount :: Maybe Int

    The number of tasks in the cluster that are in the RUNNING state.

  • schedulingStrategy :: Maybe SchedulingStrategy

    The scheduling strategy to use for the service. For more information, see Services.

    There are two service scheduler strategies available.

    • REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
    • DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.

      Fargate tasks don't support the DAEMON scheduling strategy.

  • serviceArn :: Maybe Text

    The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

  • serviceName :: Maybe Text

    The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions.

  • serviceRegistries :: Maybe [ServiceRegistry]

    The details for the service discovery registries to assign to this service. For more information, see Service Discovery.

  • status :: Maybe Text

    The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

  • tags :: Maybe [Tag]

    The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.

    The following basic restrictions apply to tags:

    • Maximum number of tags per resource - 50
    • For each resource, each tag key must be unique, and each tag key can have only one value.
    • Maximum key length - 128 Unicode characters in UTF-8
    • Maximum value length - 256 Unicode characters in UTF-8
    • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    • Tag keys and values are case-sensitive.
    • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
  • taskDefinition :: Maybe Text

    The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

  • taskSets :: Maybe [TaskSet]

    Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

Instances

Instances details
FromJSON ContainerService Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerService

Generic ContainerService Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerService

Associated Types

type Rep ContainerService :: Type -> Type #

Read ContainerService Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerService

Show ContainerService Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerService

NFData ContainerService Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerService

Methods

rnf :: ContainerService -> () #

Eq ContainerService Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerService

Hashable ContainerService Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerService

type Rep ContainerService Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerService

type Rep ContainerService = D1 ('MetaData "ContainerService" "Amazonka.ECS.Types.ContainerService" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ContainerService'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "capacityProviderStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CapacityProviderStrategyItem])) :*: (S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "createdBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deploymentConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentConfiguration))) :*: (S1 ('MetaSel ('Just "deploymentController") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentController)) :*: S1 ('MetaSel ('Just "deployments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Deployment]))))) :*: (((S1 ('MetaSel ('Just "desiredCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "enableECSManagedTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "enableExecuteCommand") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ServiceEvent])))) :*: ((S1 ('MetaSel ('Just "healthCheckGracePeriodSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "launchType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchType))) :*: (S1 ('MetaSel ('Just "loadBalancers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LoadBalancer])) :*: S1 ('MetaSel ('Just "networkConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkConfiguration)))))) :*: ((((S1 ('MetaSel ('Just "pendingCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "placementConstraints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PlacementConstraint]))) :*: (S1 ('MetaSel ('Just "placementStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PlacementStrategy])) :*: S1 ('MetaSel ('Just "platformFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "platformVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "propagateTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PropagateTags))) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "runningCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :*: (((S1 ('MetaSel ('Just "schedulingStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SchedulingStrategy)) :*: S1 ('MetaSel ('Just "serviceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "serviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "serviceRegistries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ServiceRegistry])))) :*: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "taskDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "taskSets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TaskSet]))))))))

newContainerService :: ContainerService Source #

Create a value of ContainerService with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ContainerService, containerService_capacityProviderStrategy - The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.

ContainerService, containerService_clusterArn - The Amazon Resource Name (ARN) of the cluster that hosts the service.

ContainerService, containerService_createdAt - The Unix timestamp for the time when the service was created.

$sel:createdBy:ContainerService', containerService_createdBy - The principal that created the service.

$sel:deploymentConfiguration:ContainerService', containerService_deploymentConfiguration - Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

$sel:deploymentController:ContainerService', containerService_deploymentController - The deployment controller type the service is using.

$sel:deployments:ContainerService', containerService_deployments - The current state of deployments for the service.

ContainerService, containerService_desiredCount - The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

$sel:enableECSManagedTags:ContainerService', containerService_enableECSManagedTags - Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

$sel:enableExecuteCommand:ContainerService', containerService_enableExecuteCommand - Determines whether the execute command functionality is enabled for the service. If true, the execute command functionality is enabled for all containers in tasks as part of the service.

$sel:events:ContainerService', containerService_events - The event stream for your service. A maximum of 100 of the latest events are displayed.

$sel:healthCheckGracePeriodSeconds:ContainerService', containerService_healthCheckGracePeriodSeconds - The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

ContainerService, containerService_launchType - The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy.

ContainerService, containerService_loadBalancers - A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

ContainerService, containerService_networkConfiguration - The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

ContainerService, containerService_pendingCount - The number of tasks in the cluster that are in the PENDING state.

$sel:placementConstraints:ContainerService', containerService_placementConstraints - The placement constraints for the tasks in the service.

$sel:placementStrategy:ContainerService', containerService_placementStrategy - The placement strategy that determines how tasks for the service are placed.

ContainerService, containerService_platformFamily - The operating system that your tasks in the service run on. A platform family is specified only for tasks using the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX).

ContainerService, containerService_platformVersion - The platform version to run your service on. A platform version is only specified for tasks that are hosted on Fargate. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

$sel:propagateTags:ContainerService', containerService_propagateTags - Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

$sel:roleArn:ContainerService', containerService_roleArn - The ARN of the IAM role that's associated with the service. It allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

ContainerService, containerService_runningCount - The number of tasks in the cluster that are in the RUNNING state.

$sel:schedulingStrategy:ContainerService', containerService_schedulingStrategy - The scheduling strategy to use for the service. For more information, see Services.

There are two service scheduler strategies available.

  • REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
  • DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.

    Fargate tasks don't support the DAEMON scheduling strategy.

ContainerService, containerService_serviceArn - The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

$sel:serviceName:ContainerService', containerService_serviceName - The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions.

ContainerService, containerService_serviceRegistries - The details for the service discovery registries to assign to this service. For more information, see Service Discovery.

ContainerService, containerService_status - The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

ContainerService, containerService_tags - The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8
  • Maximum value length - 256 Unicode characters in UTF-8
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case-sensitive.
  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

ContainerService, containerService_taskDefinition - The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

$sel:taskSets:ContainerService', containerService_taskSets - Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

containerService_capacityProviderStrategy :: Lens' ContainerService (Maybe [CapacityProviderStrategyItem]) Source #

The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.

containerService_clusterArn :: Lens' ContainerService (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster that hosts the service.

containerService_createdAt :: Lens' ContainerService (Maybe UTCTime) Source #

The Unix timestamp for the time when the service was created.

containerService_createdBy :: Lens' ContainerService (Maybe Text) Source #

The principal that created the service.

containerService_deploymentConfiguration :: Lens' ContainerService (Maybe DeploymentConfiguration) Source #

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

containerService_deploymentController :: Lens' ContainerService (Maybe DeploymentController) Source #

The deployment controller type the service is using.

containerService_deployments :: Lens' ContainerService (Maybe [Deployment]) Source #

The current state of deployments for the service.

containerService_desiredCount :: Lens' ContainerService (Maybe Int) Source #

The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

containerService_enableECSManagedTags :: Lens' ContainerService (Maybe Bool) Source #

Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

containerService_enableExecuteCommand :: Lens' ContainerService (Maybe Bool) Source #

Determines whether the execute command functionality is enabled for the service. If true, the execute command functionality is enabled for all containers in tasks as part of the service.

containerService_events :: Lens' ContainerService (Maybe [ServiceEvent]) Source #

The event stream for your service. A maximum of 100 of the latest events are displayed.

containerService_healthCheckGracePeriodSeconds :: Lens' ContainerService (Maybe Int) Source #

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

containerService_launchType :: Lens' ContainerService (Maybe LaunchType) Source #

The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy.

containerService_loadBalancers :: Lens' ContainerService (Maybe [LoadBalancer]) Source #

A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

containerService_networkConfiguration :: Lens' ContainerService (Maybe NetworkConfiguration) Source #

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

containerService_pendingCount :: Lens' ContainerService (Maybe Int) Source #

The number of tasks in the cluster that are in the PENDING state.

containerService_placementConstraints :: Lens' ContainerService (Maybe [PlacementConstraint]) Source #

The placement constraints for the tasks in the service.

containerService_placementStrategy :: Lens' ContainerService (Maybe [PlacementStrategy]) Source #

The placement strategy that determines how tasks for the service are placed.

containerService_platformFamily :: Lens' ContainerService (Maybe Text) Source #

The operating system that your tasks in the service run on. A platform family is specified only for tasks using the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX).

containerService_platformVersion :: Lens' ContainerService (Maybe Text) Source #

The platform version to run your service on. A platform version is only specified for tasks that are hosted on Fargate. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

containerService_propagateTags :: Lens' ContainerService (Maybe PropagateTags) Source #

Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

containerService_roleArn :: Lens' ContainerService (Maybe Text) Source #

The ARN of the IAM role that's associated with the service. It allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

containerService_runningCount :: Lens' ContainerService (Maybe Int) Source #

The number of tasks in the cluster that are in the RUNNING state.

containerService_schedulingStrategy :: Lens' ContainerService (Maybe SchedulingStrategy) Source #

The scheduling strategy to use for the service. For more information, see Services.

There are two service scheduler strategies available.

  • REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
  • DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.

    Fargate tasks don't support the DAEMON scheduling strategy.

containerService_serviceArn :: Lens' ContainerService (Maybe Text) Source #

The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

containerService_serviceName :: Lens' ContainerService (Maybe Text) Source #

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions.

containerService_serviceRegistries :: Lens' ContainerService (Maybe [ServiceRegistry]) Source #

The details for the service discovery registries to assign to this service. For more information, see Service Discovery.

containerService_status :: Lens' ContainerService (Maybe Text) Source #

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

containerService_tags :: Lens' ContainerService (Maybe [Tag]) Source #

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8
  • Maximum value length - 256 Unicode characters in UTF-8
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case-sensitive.
  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

containerService_taskDefinition :: Lens' ContainerService (Maybe Text) Source #

The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

containerService_taskSets :: Lens' ContainerService (Maybe [TaskSet]) Source #

Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

ContainerStateChange

data ContainerStateChange Source #

An object that represents a change in state for a container.

See: newContainerStateChange smart constructor.

Constructors

ContainerStateChange' 

Fields

Instances

Instances details
ToJSON ContainerStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerStateChange

Generic ContainerStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerStateChange

Associated Types

type Rep ContainerStateChange :: Type -> Type #

Read ContainerStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerStateChange

Show ContainerStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerStateChange

NFData ContainerStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerStateChange

Methods

rnf :: ContainerStateChange -> () #

Eq ContainerStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerStateChange

Hashable ContainerStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerStateChange

type Rep ContainerStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.ContainerStateChange

type Rep ContainerStateChange = D1 ('MetaData "ContainerStateChange" "Amazonka.ECS.Types.ContainerStateChange" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ContainerStateChange'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "containerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "exitCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "imageDigest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "networkBindings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NetworkBinding])) :*: S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "runtimeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newContainerStateChange :: ContainerStateChange Source #

Create a value of ContainerStateChange with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containerName:ContainerStateChange', containerStateChange_containerName - The name of the container.

$sel:exitCode:ContainerStateChange', containerStateChange_exitCode - The exit code for the container, if the state change is a result of the container exiting.

$sel:imageDigest:ContainerStateChange', containerStateChange_imageDigest - The container image SHA 256 digest.

$sel:networkBindings:ContainerStateChange', containerStateChange_networkBindings - Any network bindings that are associated with the container.

$sel:reason:ContainerStateChange', containerStateChange_reason - The reason for the state change.

$sel:runtimeId:ContainerStateChange', containerStateChange_runtimeId - The ID of the Docker container.

$sel:status:ContainerStateChange', containerStateChange_status - The status of the container.

containerStateChange_exitCode :: Lens' ContainerStateChange (Maybe Int) Source #

The exit code for the container, if the state change is a result of the container exiting.

containerStateChange_networkBindings :: Lens' ContainerStateChange (Maybe [NetworkBinding]) Source #

Any network bindings that are associated with the container.

Deployment

data Deployment Source #

The details of an Amazon ECS service deployment. This is used only when a service uses the ECS deployment controller type.

See: newDeployment smart constructor.

Constructors

Deployment' 

Fields

  • capacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]

    The capacity provider strategy that the deployment is using.

  • createdAt :: Maybe POSIX

    The Unix timestamp for the time when the service deployment was created.

  • desiredCount :: Maybe Int

    The most recent desired count of tasks that was specified for the service to deploy or maintain.

  • failedTasks :: Maybe Int

    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.

  • id :: Maybe Text

    The ID of the deployment.

  • launchType :: Maybe LaunchType

    The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

  • networkConfiguration :: Maybe NetworkConfiguration

    The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

  • pendingCount :: Maybe Int

    The number of tasks in the deployment that are in the PENDING status.

  • platformFamily :: Maybe Text

    The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.

    All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX..

  • platformVersion :: Maybe Text

    The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

  • rolloutState :: Maybe DeploymentRolloutState

    The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that aren't behind a Classic Load Balancer.

    The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.

  • rolloutStateReason :: Maybe Text

    A description of the rollout state of a deployment.

  • runningCount :: Maybe Int

    The number of tasks in the deployment that are in the RUNNING status.

  • serviceConnectConfiguration :: Maybe ServiceConnectConfiguration

    The details of the Service Connect configuration that's used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.

    The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

    Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

  • serviceConnectResources :: Maybe [ServiceConnectServiceResource]

    The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.

  • status :: Maybe Text

    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.
  • taskDefinition :: Maybe Text

    The most recent task definition that was specified for the tasks in the service to use.

  • updatedAt :: Maybe POSIX

    The Unix timestamp for the time when the service deployment was last updated.

Instances

Instances details
FromJSON Deployment Source # 
Instance details

Defined in Amazonka.ECS.Types.Deployment

Generic Deployment Source # 
Instance details

Defined in Amazonka.ECS.Types.Deployment

Associated Types

type Rep Deployment :: Type -> Type #

Read Deployment Source # 
Instance details

Defined in Amazonka.ECS.Types.Deployment

Show Deployment Source # 
Instance details

Defined in Amazonka.ECS.Types.Deployment

NFData Deployment Source # 
Instance details

Defined in Amazonka.ECS.Types.Deployment

Methods

rnf :: Deployment -> () #

Eq Deployment Source # 
Instance details

Defined in Amazonka.ECS.Types.Deployment

Hashable Deployment Source # 
Instance details

Defined in Amazonka.ECS.Types.Deployment

type Rep Deployment Source # 
Instance details

Defined in Amazonka.ECS.Types.Deployment

type Rep Deployment = D1 ('MetaData "Deployment" "Amazonka.ECS.Types.Deployment" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Deployment'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "capacityProviderStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CapacityProviderStrategyItem])) :*: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "desiredCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "failedTasks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "launchType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchType))) :*: (S1 ('MetaSel ('Just "networkConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkConfiguration)) :*: (S1 ('MetaSel ('Just "pendingCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "platformFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "platformVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "rolloutState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentRolloutState))) :*: (S1 ('MetaSel ('Just "rolloutStateReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "runningCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "serviceConnectConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceConnectConfiguration)) :*: S1 ('MetaSel ('Just "serviceConnectResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ServiceConnectServiceResource]))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "taskDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))))

newDeployment :: Deployment Source #

Create a value of Deployment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:capacityProviderStrategy:Deployment', deployment_capacityProviderStrategy - The capacity provider strategy that the deployment is using.

$sel:createdAt:Deployment', deployment_createdAt - The Unix timestamp for the time when the service deployment was created.

$sel:desiredCount:Deployment', deployment_desiredCount - The most recent desired count of tasks that was specified for the service to deploy or maintain.

$sel:failedTasks:Deployment', deployment_failedTasks - The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.

Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.

$sel:id:Deployment', deployment_id - The ID of the deployment.

$sel:launchType:Deployment', deployment_launchType - The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

$sel:networkConfiguration:Deployment', deployment_networkConfiguration - The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

$sel:pendingCount:Deployment', deployment_pendingCount - The number of tasks in the deployment that are in the PENDING status.

$sel:platformFamily:Deployment', deployment_platformFamily - The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX..

$sel:platformVersion:Deployment', deployment_platformVersion - The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

$sel:rolloutState:Deployment', deployment_rolloutState - The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that aren't behind a Classic Load Balancer.

The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.

$sel:rolloutStateReason:Deployment', deployment_rolloutStateReason - A description of the rollout state of a deployment.

$sel:runningCount:Deployment', deployment_runningCount - The number of tasks in the deployment that are in the RUNNING status.

$sel:serviceConnectConfiguration:Deployment', deployment_serviceConnectConfiguration - The details of the Service Connect configuration that's used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

$sel:serviceConnectResources:Deployment', deployment_serviceConnectResources - The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.

$sel:status:Deployment', deployment_status - The status of the deployment. The following describes each state.

PRIMARY
The most recent deployment of a service.
ACTIVE
A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.
INACTIVE
A deployment that has been completely replaced.

$sel:taskDefinition:Deployment', deployment_taskDefinition - The most recent task definition that was specified for the tasks in the service to use.

$sel:updatedAt:Deployment', deployment_updatedAt - The Unix timestamp for the time when the service deployment was last updated.

deployment_capacityProviderStrategy :: Lens' Deployment (Maybe [CapacityProviderStrategyItem]) Source #

The capacity provider strategy that the deployment is using.

deployment_createdAt :: Lens' Deployment (Maybe UTCTime) Source #

The Unix timestamp for the time when the service deployment was created.

deployment_desiredCount :: Lens' Deployment (Maybe Int) Source #

The most recent desired count of tasks that was specified for the service to deploy or maintain.

deployment_failedTasks :: Lens' Deployment (Maybe Int) Source #

The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.

Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.

deployment_id :: Lens' Deployment (Maybe Text) Source #

The ID of the deployment.

deployment_launchType :: Lens' Deployment (Maybe LaunchType) Source #

The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

deployment_networkConfiguration :: Lens' Deployment (Maybe NetworkConfiguration) Source #

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

deployment_pendingCount :: Lens' Deployment (Maybe Int) Source #

The number of tasks in the deployment that are in the PENDING status.

deployment_platformFamily :: Lens' Deployment (Maybe Text) Source #

The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX..

deployment_platformVersion :: Lens' Deployment (Maybe Text) Source #

The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

deployment_rolloutState :: Lens' Deployment (Maybe DeploymentRolloutState) Source #

The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that aren't behind a Classic Load Balancer.

The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.

deployment_rolloutStateReason :: Lens' Deployment (Maybe Text) Source #

A description of the rollout state of a deployment.

deployment_runningCount :: Lens' Deployment (Maybe Int) Source #

The number of tasks in the deployment that are in the RUNNING status.

deployment_serviceConnectConfiguration :: Lens' Deployment (Maybe ServiceConnectConfiguration) Source #

The details of the Service Connect configuration that's used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

deployment_serviceConnectResources :: Lens' Deployment (Maybe [ServiceConnectServiceResource]) Source #

The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.

deployment_status :: Lens' Deployment (Maybe Text) Source #

The status of the deployment. The following describes each state.

PRIMARY
The most recent deployment of a service.
ACTIVE
A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.
INACTIVE
A deployment that has been completely replaced.

deployment_taskDefinition :: Lens' Deployment (Maybe Text) Source #

The most recent task definition that was specified for the tasks in the service to use.

deployment_updatedAt :: Lens' Deployment (Maybe UTCTime) Source #

The Unix timestamp for the time when the service deployment was last updated.

DeploymentAlarms

data DeploymentAlarms Source #

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

When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure.

You can only use the DeploymentAlarms method to detect failures when the DeploymentController is set to ECS (rolling update).

For more information, see Rolling update in the /Amazon Elastic Container Service Developer Guide/ .

See: newDeploymentAlarms smart constructor.

Constructors

DeploymentAlarms' 

Fields

  • alarmNames :: [Text]

    One or more CloudWatch alarm names. Use a "," to separate the alarms.

  • enable :: Bool

    Determines whether to use the CloudWatch alarm option in the service deployment process.

  • rollback :: Bool

    Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

Instances

Instances details
FromJSON DeploymentAlarms Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentAlarms

ToJSON DeploymentAlarms Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentAlarms

Generic DeploymentAlarms Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentAlarms

Associated Types

type Rep DeploymentAlarms :: Type -> Type #

Read DeploymentAlarms Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentAlarms

Show DeploymentAlarms Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentAlarms

NFData DeploymentAlarms Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentAlarms

Methods

rnf :: DeploymentAlarms -> () #

Eq DeploymentAlarms Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentAlarms

Hashable DeploymentAlarms Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentAlarms

type Rep DeploymentAlarms Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentAlarms

type Rep DeploymentAlarms = D1 ('MetaData "DeploymentAlarms" "Amazonka.ECS.Types.DeploymentAlarms" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "DeploymentAlarms'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alarmNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: (S1 ('MetaSel ('Just "enable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "rollback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))

newDeploymentAlarms Source #

Create a value of DeploymentAlarms with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:alarmNames:DeploymentAlarms', deploymentAlarms_alarmNames - One or more CloudWatch alarm names. Use a "," to separate the alarms.

$sel:enable:DeploymentAlarms', deploymentAlarms_enable - Determines whether to use the CloudWatch alarm option in the service deployment process.

$sel:rollback:DeploymentAlarms', deploymentAlarms_rollback - Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

deploymentAlarms_alarmNames :: Lens' DeploymentAlarms [Text] Source #

One or more CloudWatch alarm names. Use a "," to separate the alarms.

deploymentAlarms_enable :: Lens' DeploymentAlarms Bool Source #

Determines whether to use the CloudWatch alarm option in the service deployment process.

deploymentAlarms_rollback :: Lens' DeploymentAlarms Bool Source #

Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

DeploymentCircuitBreaker

data DeploymentCircuitBreaker Source #

The deployment circuit breaker can only be used for services using the rolling update (ECS) deployment type that aren't behind a Classic Load Balancer.

The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If enabled, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide.

See: newDeploymentCircuitBreaker smart constructor.

Constructors

DeploymentCircuitBreaker' 

Fields

  • enable :: Bool

    Determines whether to use the deployment circuit breaker logic for the service.

  • rollback :: Bool

    Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

Instances

Instances details
FromJSON DeploymentCircuitBreaker Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentCircuitBreaker

ToJSON DeploymentCircuitBreaker Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentCircuitBreaker

Generic DeploymentCircuitBreaker Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentCircuitBreaker

Associated Types

type Rep DeploymentCircuitBreaker :: Type -> Type #

Read DeploymentCircuitBreaker Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentCircuitBreaker

Show DeploymentCircuitBreaker Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentCircuitBreaker

NFData DeploymentCircuitBreaker Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentCircuitBreaker

Eq DeploymentCircuitBreaker Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentCircuitBreaker

Hashable DeploymentCircuitBreaker Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentCircuitBreaker

type Rep DeploymentCircuitBreaker Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentCircuitBreaker

type Rep DeploymentCircuitBreaker = D1 ('MetaData "DeploymentCircuitBreaker" "Amazonka.ECS.Types.DeploymentCircuitBreaker" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "DeploymentCircuitBreaker'" 'PrefixI 'True) (S1 ('MetaSel ('Just "enable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "rollback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))

newDeploymentCircuitBreaker Source #

Create a value of DeploymentCircuitBreaker with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:enable:DeploymentCircuitBreaker', deploymentCircuitBreaker_enable - Determines whether to use the deployment circuit breaker logic for the service.

$sel:rollback:DeploymentCircuitBreaker', deploymentCircuitBreaker_rollback - Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

deploymentCircuitBreaker_enable :: Lens' DeploymentCircuitBreaker Bool Source #

Determines whether to use the deployment circuit breaker logic for the service.

deploymentCircuitBreaker_rollback :: Lens' DeploymentCircuitBreaker Bool Source #

Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

DeploymentConfiguration

data DeploymentConfiguration Source #

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

See: newDeploymentConfiguration smart constructor.

Constructors

DeploymentConfiguration' 

Fields

  • alarms :: Maybe DeploymentAlarms

    Information about the CloudWatch alarms.

  • deploymentCircuitBreaker :: Maybe DeploymentCircuitBreaker

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

    The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If deployment circuit breaker is enabled, a service deployment will transition to a failed state and stop launching new tasks. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

  • maximumPercent :: Maybe Int

    If a service is using the rolling update (ECS) deployment type, the maximumPercent parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the REPLICA service scheduler and has a desiredCount of four tasks and a maximumPercent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default maximumPercent value for a service using the REPLICA service scheduler is 200%.

    If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.

  • minimumHealthyPercent :: Maybe Int

    If a service is using the rolling update (ECS) deployment type, the minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.

    For services that do not use a load balancer, the following should be noted:

    • A service is considered healthy if all essential containers within the tasks in the service pass their health checks.
    • If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a RUNNING state before the task is counted towards the minimum healthy percent total.
    • If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.

    For services are that do use a load balancer, the following should be noted:

    • If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
    • If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.

    If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.

Instances

Instances details
FromJSON DeploymentConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentConfiguration

ToJSON DeploymentConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentConfiguration

Generic DeploymentConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentConfiguration

Associated Types

type Rep DeploymentConfiguration :: Type -> Type #

Read DeploymentConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentConfiguration

Show DeploymentConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentConfiguration

NFData DeploymentConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentConfiguration

Methods

rnf :: DeploymentConfiguration -> () #

Eq DeploymentConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentConfiguration

Hashable DeploymentConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentConfiguration

type Rep DeploymentConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentConfiguration

type Rep DeploymentConfiguration = D1 ('MetaData "DeploymentConfiguration" "Amazonka.ECS.Types.DeploymentConfiguration" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "DeploymentConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "alarms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentAlarms)) :*: S1 ('MetaSel ('Just "deploymentCircuitBreaker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentCircuitBreaker))) :*: (S1 ('MetaSel ('Just "maximumPercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "minimumHealthyPercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newDeploymentConfiguration :: DeploymentConfiguration Source #

Create a value of DeploymentConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:alarms:DeploymentConfiguration', deploymentConfiguration_alarms - Information about the CloudWatch alarms.

$sel:deploymentCircuitBreaker:DeploymentConfiguration', deploymentConfiguration_deploymentCircuitBreaker - The deployment circuit breaker can only be used for services using the rolling update (ECS) deployment type.

The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If deployment circuit breaker is enabled, a service deployment will transition to a failed state and stop launching new tasks. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

$sel:maximumPercent:DeploymentConfiguration', deploymentConfiguration_maximumPercent - If a service is using the rolling update (ECS) deployment type, the maximumPercent parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the REPLICA service scheduler and has a desiredCount of four tasks and a maximumPercent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default maximumPercent value for a service using the REPLICA service scheduler is 200%.

If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.

$sel:minimumHealthyPercent:DeploymentConfiguration', deploymentConfiguration_minimumHealthyPercent - If a service is using the rolling update (ECS) deployment type, the minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.

For services that do not use a load balancer, the following should be noted:

  • A service is considered healthy if all essential containers within the tasks in the service pass their health checks.
  • If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a RUNNING state before the task is counted towards the minimum healthy percent total.
  • If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.

For services are that do use a load balancer, the following should be noted:

  • If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
  • If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.

If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.

deploymentConfiguration_deploymentCircuitBreaker :: Lens' DeploymentConfiguration (Maybe DeploymentCircuitBreaker) Source #

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

The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If deployment circuit breaker is enabled, a service deployment will transition to a failed state and stop launching new tasks. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

deploymentConfiguration_maximumPercent :: Lens' DeploymentConfiguration (Maybe Int) Source #

If a service is using the rolling update (ECS) deployment type, the maximumPercent parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the REPLICA service scheduler and has a desiredCount of four tasks and a maximumPercent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default maximumPercent value for a service using the REPLICA service scheduler is 200%.

If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.

deploymentConfiguration_minimumHealthyPercent :: Lens' DeploymentConfiguration (Maybe Int) Source #

If a service is using the rolling update (ECS) deployment type, the minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.

For services that do not use a load balancer, the following should be noted:

  • A service is considered healthy if all essential containers within the tasks in the service pass their health checks.
  • If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a RUNNING state before the task is counted towards the minimum healthy percent total.
  • If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.

For services are that do use a load balancer, the following should be noted:

  • If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
  • If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.

If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.

DeploymentController

data DeploymentController Source #

The deployment controller to use for the service. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

See: newDeploymentController smart constructor.

Constructors

DeploymentController' 

Fields

  • type' :: DeploymentControllerType

    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.

Instances

Instances details
FromJSON DeploymentController Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentController

ToJSON DeploymentController Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentController

Generic DeploymentController Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentController

Associated Types

type Rep DeploymentController :: Type -> Type #

Read DeploymentController Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentController

Show DeploymentController Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentController

NFData DeploymentController Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentController

Methods

rnf :: DeploymentController -> () #

Eq DeploymentController Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentController

Hashable DeploymentController Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentController

type Rep DeploymentController Source # 
Instance details

Defined in Amazonka.ECS.Types.DeploymentController

type Rep DeploymentController = D1 ('MetaData "DeploymentController" "Amazonka.ECS.Types.DeploymentController" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "DeploymentController'" 'PrefixI 'True) (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeploymentControllerType)))

newDeploymentController Source #

Create a value of DeploymentController with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:type':DeploymentController', deploymentController_type - The deployment controller type to use.

There are three deployment controller types available:

ECS
The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration.
CODE_DEPLOY
The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it.
EXTERNAL
The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.

deploymentController_type :: Lens' DeploymentController DeploymentControllerType Source #

The deployment controller type to use.

There are three deployment controller types available:

ECS
The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration.
CODE_DEPLOY
The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it.
EXTERNAL
The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.

Device

data Device Source #

An object representing a container instance host device.

See: newDevice smart constructor.

Constructors

Device' 

Fields

  • containerPath :: Maybe Text

    The path inside the container at which to expose the host device.

  • permissions :: Maybe [DeviceCgroupPermission]

    The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.

  • hostPath :: Text

    The path for the device on the host container instance.

Instances

Instances details
FromJSON Device Source # 
Instance details

Defined in Amazonka.ECS.Types.Device

ToJSON Device Source # 
Instance details

Defined in Amazonka.ECS.Types.Device

Generic Device Source # 
Instance details

Defined in Amazonka.ECS.Types.Device

Associated Types

type Rep Device :: Type -> Type #

Methods

from :: Device -> Rep Device x #

to :: Rep Device x -> Device #

Read Device Source # 
Instance details

Defined in Amazonka.ECS.Types.Device

Show Device Source # 
Instance details

Defined in Amazonka.ECS.Types.Device

NFData Device Source # 
Instance details

Defined in Amazonka.ECS.Types.Device

Methods

rnf :: Device -> () #

Eq Device Source # 
Instance details

Defined in Amazonka.ECS.Types.Device

Methods

(==) :: Device -> Device -> Bool #

(/=) :: Device -> Device -> Bool #

Hashable Device Source # 
Instance details

Defined in Amazonka.ECS.Types.Device

Methods

hashWithSalt :: Int -> Device -> Int #

hash :: Device -> Int #

type Rep Device Source # 
Instance details

Defined in Amazonka.ECS.Types.Device

type Rep Device = D1 ('MetaData "Device" "Amazonka.ECS.Types.Device" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Device'" 'PrefixI 'True) (S1 ('MetaSel ('Just "containerPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DeviceCgroupPermission])) :*: S1 ('MetaSel ('Just "hostPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDevice Source #

Create a value of Device with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containerPath:Device', device_containerPath - The path inside the container at which to expose the host device.

$sel:permissions:Device', device_permissions - The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.

$sel:hostPath:Device', device_hostPath - The path for the device on the host container instance.

device_containerPath :: Lens' Device (Maybe Text) Source #

The path inside the container at which to expose the host device.

device_permissions :: Lens' Device (Maybe [DeviceCgroupPermission]) Source #

The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.

device_hostPath :: Lens' Device Text Source #

The path for the device on the host container instance.

DockerVolumeConfiguration

data DockerVolumeConfiguration Source #

This parameter is specified when you're using Docker volumes. Docker volumes are only supported when you're using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.

See: newDockerVolumeConfiguration smart constructor.

Constructors

DockerVolumeConfiguration' 

Fields

  • autoprovision :: Maybe Bool

    If this value is true, the Docker volume is created if it doesn't already exist.

    This field is only used if the scope is shared.

  • driver :: Maybe Text

    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.

  • driverOpts :: Maybe (HashMap Text Text)

    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.

  • labels :: Maybe (HashMap Text Text)

    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.

  • scope :: Maybe Scope

    The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

Instances

Instances details
FromJSON DockerVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.DockerVolumeConfiguration

ToJSON DockerVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.DockerVolumeConfiguration

Generic DockerVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.DockerVolumeConfiguration

Associated Types

type Rep DockerVolumeConfiguration :: Type -> Type #

Read DockerVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.DockerVolumeConfiguration

Show DockerVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.DockerVolumeConfiguration

NFData DockerVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.DockerVolumeConfiguration

Eq DockerVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.DockerVolumeConfiguration

Hashable DockerVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.DockerVolumeConfiguration

type Rep DockerVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.DockerVolumeConfiguration

type Rep DockerVolumeConfiguration = D1 ('MetaData "DockerVolumeConfiguration" "Amazonka.ECS.Types.DockerVolumeConfiguration" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "DockerVolumeConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "autoprovision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "driver") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "driverOpts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "labels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Scope))))))

newDockerVolumeConfiguration :: DockerVolumeConfiguration Source #

Create a value of DockerVolumeConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:autoprovision:DockerVolumeConfiguration', dockerVolumeConfiguration_autoprovision - If this value is true, the Docker volume is created if it doesn't already exist.

This field is only used if the scope is shared.

$sel:driver:DockerVolumeConfiguration', dockerVolumeConfiguration_driver - The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create.

$sel:driverOpts:DockerVolumeConfiguration', dockerVolumeConfiguration_driverOpts - A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.

$sel:labels:DockerVolumeConfiguration', dockerVolumeConfiguration_labels - Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.

$sel:scope:DockerVolumeConfiguration', dockerVolumeConfiguration_scope - The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

dockerVolumeConfiguration_autoprovision :: Lens' DockerVolumeConfiguration (Maybe Bool) Source #

If this value is true, the Docker volume is created if it doesn't already exist.

This field is only used if the scope is shared.

dockerVolumeConfiguration_driver :: Lens' DockerVolumeConfiguration (Maybe Text) Source #

The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create.

dockerVolumeConfiguration_driverOpts :: Lens' DockerVolumeConfiguration (Maybe (HashMap Text Text)) Source #

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.

dockerVolumeConfiguration_labels :: Lens' DockerVolumeConfiguration (Maybe (HashMap Text Text)) Source #

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.

dockerVolumeConfiguration_scope :: Lens' DockerVolumeConfiguration (Maybe Scope) Source #

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

EFSAuthorizationConfig

data EFSAuthorizationConfig Source #

The authorization configuration details for the Amazon EFS file system.

See: newEFSAuthorizationConfig smart constructor.

Constructors

EFSAuthorizationConfig' 

Fields

  • accessPointId :: Maybe Text

    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.

  • iam :: Maybe EFSAuthorizationConfigIAM

    Determines whether to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.

Instances

Instances details
FromJSON EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfig

ToJSON EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfig

Generic EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfig

Associated Types

type Rep EFSAuthorizationConfig :: Type -> Type #

Read EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfig

Show EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfig

NFData EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfig

Methods

rnf :: EFSAuthorizationConfig -> () #

Eq EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfig

Hashable EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfig

type Rep EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSAuthorizationConfig

type Rep EFSAuthorizationConfig = D1 ('MetaData "EFSAuthorizationConfig" "Amazonka.ECS.Types.EFSAuthorizationConfig" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "EFSAuthorizationConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accessPointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "iam") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EFSAuthorizationConfigIAM))))

newEFSAuthorizationConfig :: EFSAuthorizationConfig Source #

Create a value of EFSAuthorizationConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessPointId:EFSAuthorizationConfig', eFSAuthorizationConfig_accessPointId - The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.

$sel:iam:EFSAuthorizationConfig', eFSAuthorizationConfig_iam - Determines whether to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.

eFSAuthorizationConfig_accessPointId :: Lens' EFSAuthorizationConfig (Maybe Text) Source #

The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.

eFSAuthorizationConfig_iam :: Lens' EFSAuthorizationConfig (Maybe EFSAuthorizationConfigIAM) Source #

Determines whether to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.

EFSVolumeConfiguration

data EFSVolumeConfiguration Source #

This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.

See: newEFSVolumeConfiguration smart constructor.

Constructors

EFSVolumeConfiguration' 

Fields

  • authorizationConfig :: Maybe EFSAuthorizationConfig

    The authorization configuration details for the Amazon EFS file system.

  • rootDirectory :: Maybe Text

    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.

  • transitEncryption :: Maybe EFSTransitEncryption

    Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

  • transitEncryptionPort :: Maybe Int

    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.

  • fileSystemId :: Text

    The Amazon EFS file system ID to use.

Instances

Instances details
FromJSON EFSVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSVolumeConfiguration

ToJSON EFSVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSVolumeConfiguration

Generic EFSVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSVolumeConfiguration

Associated Types

type Rep EFSVolumeConfiguration :: Type -> Type #

Read EFSVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSVolumeConfiguration

Show EFSVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSVolumeConfiguration

NFData EFSVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSVolumeConfiguration

Methods

rnf :: EFSVolumeConfiguration -> () #

Eq EFSVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSVolumeConfiguration

Hashable EFSVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSVolumeConfiguration

type Rep EFSVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.EFSVolumeConfiguration

type Rep EFSVolumeConfiguration = D1 ('MetaData "EFSVolumeConfiguration" "Amazonka.ECS.Types.EFSVolumeConfiguration" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "EFSVolumeConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authorizationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EFSAuthorizationConfig)) :*: S1 ('MetaSel ('Just "rootDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "transitEncryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EFSTransitEncryption)) :*: (S1 ('MetaSel ('Just "transitEncryptionPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newEFSVolumeConfiguration Source #

Create a value of EFSVolumeConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authorizationConfig:EFSVolumeConfiguration', eFSVolumeConfiguration_authorizationConfig - The authorization configuration details for the Amazon EFS file system.

$sel:rootDirectory:EFSVolumeConfiguration', eFSVolumeConfiguration_rootDirectory - The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the EFS access point.

$sel:transitEncryption:EFSVolumeConfiguration', eFSVolumeConfiguration_transitEncryption - Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

$sel:transitEncryptionPort:EFSVolumeConfiguration', eFSVolumeConfiguration_transitEncryptionPort - The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.

$sel:fileSystemId:EFSVolumeConfiguration', eFSVolumeConfiguration_fileSystemId - The Amazon EFS file system ID to use.

eFSVolumeConfiguration_authorizationConfig :: Lens' EFSVolumeConfiguration (Maybe EFSAuthorizationConfig) Source #

The authorization configuration details for the Amazon EFS file system.

eFSVolumeConfiguration_rootDirectory :: Lens' EFSVolumeConfiguration (Maybe Text) Source #

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the EFS access point.

eFSVolumeConfiguration_transitEncryption :: Lens' EFSVolumeConfiguration (Maybe EFSTransitEncryption) Source #

Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

eFSVolumeConfiguration_transitEncryptionPort :: Lens' EFSVolumeConfiguration (Maybe Int) Source #

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.

EnvironmentFile

data EnvironmentFile Source #

A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying environment variables in the Amazon Elastic Container Service Developer Guide.

This parameter is only supported for tasks hosted on Fargate using the following platform versions:

  • Linux platform version 1.4.0 or later.
  • Windows platform version 1.0.0 or later.

See: newEnvironmentFile smart constructor.

Constructors

EnvironmentFile' 

Fields

  • value :: Text

    The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.

  • type' :: EnvironmentFileType

    The file type to use. The only supported value is s3.

Instances

Instances details
FromJSON EnvironmentFile Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFile

ToJSON EnvironmentFile Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFile

Generic EnvironmentFile Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFile

Associated Types

type Rep EnvironmentFile :: Type -> Type #

Read EnvironmentFile Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFile

Show EnvironmentFile Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFile

NFData EnvironmentFile Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFile

Methods

rnf :: EnvironmentFile -> () #

Eq EnvironmentFile Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFile

Hashable EnvironmentFile Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFile

type Rep EnvironmentFile Source # 
Instance details

Defined in Amazonka.ECS.Types.EnvironmentFile

type Rep EnvironmentFile = D1 ('MetaData "EnvironmentFile" "Amazonka.ECS.Types.EnvironmentFile" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "EnvironmentFile'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EnvironmentFileType)))

newEnvironmentFile Source #

Create a value of EnvironmentFile with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:value:EnvironmentFile', environmentFile_value - The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.

$sel:type':EnvironmentFile', environmentFile_type - The file type to use. The only supported value is s3.

environmentFile_value :: Lens' EnvironmentFile Text Source #

The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.

environmentFile_type :: Lens' EnvironmentFile EnvironmentFileType Source #

The file type to use. The only supported value is s3.

EphemeralStorage

data EphemeralStorage Source #

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage in the Amazon ECS User Guide for Fargate.

This parameter is only supported for tasks hosted on Fargate using Linux platform version 1.4.0 or later. This parameter is not supported for Windows containers on Fargate.

See: newEphemeralStorage smart constructor.

Constructors

EphemeralStorage' 

Fields

  • sizeInGiB :: Int

    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.

Instances

Instances details
FromJSON EphemeralStorage Source # 
Instance details

Defined in Amazonka.ECS.Types.EphemeralStorage

ToJSON EphemeralStorage Source # 
Instance details

Defined in Amazonka.ECS.Types.EphemeralStorage

Generic EphemeralStorage Source # 
Instance details

Defined in Amazonka.ECS.Types.EphemeralStorage

Associated Types

type Rep EphemeralStorage :: Type -> Type #

Read EphemeralStorage Source # 
Instance details

Defined in Amazonka.ECS.Types.EphemeralStorage

Show EphemeralStorage Source # 
Instance details

Defined in Amazonka.ECS.Types.EphemeralStorage

NFData EphemeralStorage Source # 
Instance details

Defined in Amazonka.ECS.Types.EphemeralStorage

Methods

rnf :: EphemeralStorage -> () #

Eq EphemeralStorage Source # 
Instance details

Defined in Amazonka.ECS.Types.EphemeralStorage

Hashable EphemeralStorage Source # 
Instance details

Defined in Amazonka.ECS.Types.EphemeralStorage

type Rep EphemeralStorage Source # 
Instance details

Defined in Amazonka.ECS.Types.EphemeralStorage

type Rep EphemeralStorage = D1 ('MetaData "EphemeralStorage" "Amazonka.ECS.Types.EphemeralStorage" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "EphemeralStorage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sizeInGiB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newEphemeralStorage Source #

Create a value of EphemeralStorage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sizeInGiB:EphemeralStorage', ephemeralStorage_sizeInGiB - The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

ephemeralStorage_sizeInGiB :: Lens' EphemeralStorage Int Source #

The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

ExecuteCommandConfiguration

data ExecuteCommandConfiguration Source #

The details of the execute command configuration.

See: newExecuteCommandConfiguration smart constructor.

Constructors

ExecuteCommandConfiguration' 

Fields

  • kmsKeyId :: Maybe Text

    Specify an Key Management Service key ID to encrypt the data between the local client and the container.

  • logConfiguration :: Maybe ExecuteCommandLogConfiguration

    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.

  • logging :: Maybe ExecuteCommandLogging

    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: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.
    • OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.

Instances

Instances details
FromJSON ExecuteCommandConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandConfiguration

ToJSON ExecuteCommandConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandConfiguration

Generic ExecuteCommandConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandConfiguration

Associated Types

type Rep ExecuteCommandConfiguration :: Type -> Type #

Read ExecuteCommandConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandConfiguration

Show ExecuteCommandConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandConfiguration

NFData ExecuteCommandConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandConfiguration

Eq ExecuteCommandConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandConfiguration

Hashable ExecuteCommandConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandConfiguration

type Rep ExecuteCommandConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandConfiguration

type Rep ExecuteCommandConfiguration = D1 ('MetaData "ExecuteCommandConfiguration" "Amazonka.ECS.Types.ExecuteCommandConfiguration" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ExecuteCommandConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "logConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecuteCommandLogConfiguration)) :*: S1 ('MetaSel ('Just "logging") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecuteCommandLogging)))))

newExecuteCommandConfiguration :: ExecuteCommandConfiguration Source #

Create a value of ExecuteCommandConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:kmsKeyId:ExecuteCommandConfiguration', executeCommandConfiguration_kmsKeyId - Specify an Key Management Service key ID to encrypt the data between the local client and the container.

$sel:logConfiguration:ExecuteCommandConfiguration', executeCommandConfiguration_logConfiguration - The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.

$sel:logging:ExecuteCommandConfiguration', executeCommandConfiguration_logging - The log setting to use for redirecting logs for your execute command results. The following log settings are available.

  • NONE: The execute command session is not logged.
  • DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.
  • OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.

executeCommandConfiguration_kmsKeyId :: Lens' ExecuteCommandConfiguration (Maybe Text) Source #

Specify an Key Management Service key ID to encrypt the data between the local client and the container.

executeCommandConfiguration_logConfiguration :: Lens' ExecuteCommandConfiguration (Maybe ExecuteCommandLogConfiguration) Source #

The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.

executeCommandConfiguration_logging :: Lens' ExecuteCommandConfiguration (Maybe ExecuteCommandLogging) Source #

The log setting to use for redirecting logs for your execute command results. The following log settings are available.

  • NONE: The execute command session is not logged.
  • DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.
  • OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.

ExecuteCommandLogConfiguration

data ExecuteCommandLogConfiguration Source #

The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.

See: newExecuteCommandLogConfiguration smart constructor.

Constructors

ExecuteCommandLogConfiguration' 

Fields

Instances

Instances details
FromJSON ExecuteCommandLogConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogConfiguration

ToJSON ExecuteCommandLogConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogConfiguration

Generic ExecuteCommandLogConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogConfiguration

Associated Types

type Rep ExecuteCommandLogConfiguration :: Type -> Type #

Read ExecuteCommandLogConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogConfiguration

Show ExecuteCommandLogConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogConfiguration

NFData ExecuteCommandLogConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogConfiguration

Eq ExecuteCommandLogConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogConfiguration

Hashable ExecuteCommandLogConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogConfiguration

type Rep ExecuteCommandLogConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ExecuteCommandLogConfiguration

type Rep ExecuteCommandLogConfiguration = D1 ('MetaData "ExecuteCommandLogConfiguration" "Amazonka.ECS.Types.ExecuteCommandLogConfiguration" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ExecuteCommandLogConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cloudWatchEncryptionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "cloudWatchLogGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "s3BucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "s3EncryptionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "s3KeyPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newExecuteCommandLogConfiguration :: ExecuteCommandLogConfiguration Source #

Create a value of ExecuteCommandLogConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cloudWatchEncryptionEnabled:ExecuteCommandLogConfiguration', executeCommandLogConfiguration_cloudWatchEncryptionEnabled - Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be disabled.

$sel:cloudWatchLogGroupName:ExecuteCommandLogConfiguration', executeCommandLogConfiguration_cloudWatchLogGroupName - The name of the CloudWatch log group to send logs to.

The CloudWatch log group must already be created.

$sel:s3BucketName:ExecuteCommandLogConfiguration', executeCommandLogConfiguration_s3BucketName - The name of the S3 bucket to send logs to.

The S3 bucket must already be created.

$sel:s3EncryptionEnabled:ExecuteCommandLogConfiguration', executeCommandLogConfiguration_s3EncryptionEnabled - Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.

$sel:s3KeyPrefix:ExecuteCommandLogConfiguration', executeCommandLogConfiguration_s3KeyPrefix - An optional folder in the S3 bucket to place logs in.

executeCommandLogConfiguration_cloudWatchEncryptionEnabled :: Lens' ExecuteCommandLogConfiguration (Maybe Bool) Source #

Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be disabled.

executeCommandLogConfiguration_cloudWatchLogGroupName :: Lens' ExecuteCommandLogConfiguration (Maybe Text) Source #

The name of the CloudWatch log group to send logs to.

The CloudWatch log group must already be created.

executeCommandLogConfiguration_s3BucketName :: Lens' ExecuteCommandLogConfiguration (Maybe Text) Source #

The name of the S3 bucket to send logs to.

The S3 bucket must already be created.

executeCommandLogConfiguration_s3EncryptionEnabled :: Lens' ExecuteCommandLogConfiguration (Maybe Bool) Source #

Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.

executeCommandLogConfiguration_s3KeyPrefix :: Lens' ExecuteCommandLogConfiguration (Maybe Text) Source #

An optional folder in the S3 bucket to place logs in.

FSxWindowsFileServerAuthorizationConfig

data FSxWindowsFileServerAuthorizationConfig Source #

The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon ECS API Reference.

For more information and the input format, see Amazon FSx for Windows File Server Volumes in the Amazon Elastic Container Service Developer Guide.

See: newFSxWindowsFileServerAuthorizationConfig smart constructor.

Constructors

FSxWindowsFileServerAuthorizationConfig' 

Fields

  • credentialsParameter :: Text

    The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store parameter. The ARN refers to the stored credentials.

  • domain :: Text

    A fully qualified domain name hosted by an Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.

Instances

Instances details
FromJSON FSxWindowsFileServerAuthorizationConfig Source # 
Instance details

Defined in Amazonka.ECS.Types.FSxWindowsFileServerAuthorizationConfig

ToJSON FSxWindowsFileServerAuthorizationConfig Source # 
Instance details

Defined in Amazonka.ECS.Types.FSxWindowsFileServerAuthorizationConfig

Generic FSxWindowsFileServerAuthorizationConfig Source # 
Instance details

Defined in Amazonka.ECS.Types.FSxWindowsFileServerAuthorizationConfig

Read FSxWindowsFileServerAuthorizationConfig Source # 
Instance details

Defined in Amazonka.ECS.Types.FSxWindowsFileServerAuthorizationConfig

Show FSxWindowsFileServerAuthorizationConfig Source # 
Instance details

Defined in Amazonka.ECS.Types.FSxWindowsFileServerAuthorizationConfig

NFData FSxWindowsFileServerAuthorizationConfig Source # 
Instance details

Defined in Amazonka.ECS.Types.FSxWindowsFileServerAuthorizationConfig

Eq FSxWindowsFileServerAuthorizationConfig Source # 
Instance details

Defined in Amazonka.ECS.Types.FSxWindowsFileServerAuthorizationConfig

Hashable FSxWindowsFileServerAuthorizationConfig Source # 
Instance details

Defined in Amazonka.ECS.Types.FSxWindowsFileServerAuthorizationConfig

type Rep FSxWindowsFileServerAuthorizationConfig Source # 
Instance details

Defined in Amazonka.ECS.Types.FSxWindowsFileServerAuthorizationConfig

type Rep FSxWindowsFileServerAuthorizationConfig = D1 ('MetaData "FSxWindowsFileServerAuthorizationConfig" "Amazonka.ECS.Types.FSxWindowsFileServerAuthorizationConfig" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "FSxWindowsFileServerAuthorizationConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "credentialsParameter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newFSxWindowsFileServerAuthorizationConfig Source #

Create a value of FSxWindowsFileServerAuthorizationConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:credentialsParameter:FSxWindowsFileServerAuthorizationConfig', fSxWindowsFileServerAuthorizationConfig_credentialsParameter - The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store parameter. The ARN refers to the stored credentials.

$sel:domain:FSxWindowsFileServerAuthorizationConfig', fSxWindowsFileServerAuthorizationConfig_domain - A fully qualified domain name hosted by an Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.

fSxWindowsFileServerAuthorizationConfig_credentialsParameter :: Lens' FSxWindowsFileServerAuthorizationConfig Text Source #

The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store parameter. The ARN refers to the stored credentials.

fSxWindowsFileServerAuthorizationConfig_domain :: Lens' FSxWindowsFileServerAuthorizationConfig Text Source #

A fully qualified domain name hosted by an Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.

FSxWindowsFileServerVolumeConfiguration

data FSxWindowsFileServerVolumeConfiguration Source #

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

For more information and the input format, see Amazon FSx for Windows File Server volumes in the Amazon Elastic Container Service Developer Guide.

See: newFSxWindowsFileServerVolumeConfiguration smart constructor.

Constructors

FSxWindowsFileServerVolumeConfiguration' 

Fields

Instances

Instances details
FromJSON FSxWindowsFileServerVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.FSxWindowsFileServerVolumeConfiguration

ToJSON FSxWindowsFileServerVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.FSxWindowsFileServerVolumeConfiguration

Generic FSxWindowsFileServerVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.FSxWindowsFileServerVolumeConfiguration

Read FSxWindowsFileServerVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.FSxWindowsFileServerVolumeConfiguration

Show FSxWindowsFileServerVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.FSxWindowsFileServerVolumeConfiguration

NFData FSxWindowsFileServerVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.FSxWindowsFileServerVolumeConfiguration

Eq FSxWindowsFileServerVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.FSxWindowsFileServerVolumeConfiguration

Hashable FSxWindowsFileServerVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.FSxWindowsFileServerVolumeConfiguration

type Rep FSxWindowsFileServerVolumeConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.FSxWindowsFileServerVolumeConfiguration

type Rep FSxWindowsFileServerVolumeConfiguration = D1 ('MetaData "FSxWindowsFileServerVolumeConfiguration" "Amazonka.ECS.Types.FSxWindowsFileServerVolumeConfiguration" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "FSxWindowsFileServerVolumeConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "rootDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "authorizationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FSxWindowsFileServerAuthorizationConfig))))

newFSxWindowsFileServerVolumeConfiguration Source #

Create a value of FSxWindowsFileServerVolumeConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fileSystemId:FSxWindowsFileServerVolumeConfiguration', fSxWindowsFileServerVolumeConfiguration_fileSystemId - The Amazon FSx for Windows File Server file system ID to use.

$sel:rootDirectory:FSxWindowsFileServerVolumeConfiguration', fSxWindowsFileServerVolumeConfiguration_rootDirectory - The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.

$sel:authorizationConfig:FSxWindowsFileServerVolumeConfiguration', fSxWindowsFileServerVolumeConfiguration_authorizationConfig - The authorization configuration details for the Amazon FSx for Windows File Server file system.

fSxWindowsFileServerVolumeConfiguration_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

data Failure Source #

A failed resource. For a list of common causes, see API failure reasons in the Amazon Elastic Container Service Developer Guide.

See: newFailure smart constructor.

Constructors

Failure' 

Fields

Instances

Instances details
FromJSON Failure Source # 
Instance details

Defined in Amazonka.ECS.Types.Failure

Generic Failure Source # 
Instance details

Defined in Amazonka.ECS.Types.Failure

Associated Types

type Rep Failure :: Type -> Type #

Methods

from :: Failure -> Rep Failure x #

to :: Rep Failure x -> Failure #

Read Failure Source # 
Instance details

Defined in Amazonka.ECS.Types.Failure

Show Failure Source # 
Instance details

Defined in Amazonka.ECS.Types.Failure

NFData Failure Source # 
Instance details

Defined in Amazonka.ECS.Types.Failure

Methods

rnf :: Failure -> () #

Eq Failure Source # 
Instance details

Defined in Amazonka.ECS.Types.Failure

Methods

(==) :: Failure -> Failure -> Bool #

(/=) :: Failure -> Failure -> Bool #

Hashable Failure Source # 
Instance details

Defined in Amazonka.ECS.Types.Failure

Methods

hashWithSalt :: Int -> Failure -> Int #

hash :: Failure -> Int #

type Rep Failure Source # 
Instance details

Defined in Amazonka.ECS.Types.Failure

type Rep Failure = D1 ('MetaData "Failure" "Amazonka.ECS.Types.Failure" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Failure'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "detail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newFailure :: Failure Source #

Create a value of Failure with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:Failure', failure_arn - The Amazon Resource Name (ARN) of the failed resource.

$sel:detail:Failure', failure_detail - The details of the failure.

$sel:reason:Failure', failure_reason - The reason for the failure.

failure_arn :: Lens' Failure (Maybe Text) Source #

The Amazon Resource Name (ARN) of the failed resource.

failure_detail :: Lens' Failure (Maybe Text) Source #

The details of the failure.

failure_reason :: Lens' Failure (Maybe Text) Source #

The reason for the failure.

FirelensConfiguration

data FirelensConfiguration Source #

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

See: newFirelensConfiguration smart constructor.

Constructors

FirelensConfiguration' 

Fields

  • options :: Maybe (HashMap Text Text)

    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.

  • type' :: FirelensConfigurationType

    The log router to use. The valid values are fluentd or fluentbit.

Instances

Instances details
FromJSON FirelensConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfiguration

ToJSON FirelensConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfiguration

Generic FirelensConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfiguration

Associated Types

type Rep FirelensConfiguration :: Type -> Type #

Read FirelensConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfiguration

Show FirelensConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfiguration

NFData FirelensConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfiguration

Methods

rnf :: FirelensConfiguration -> () #

Eq FirelensConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfiguration

Hashable FirelensConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfiguration

type Rep FirelensConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.FirelensConfiguration

type Rep FirelensConfiguration = D1 ('MetaData "FirelensConfiguration" "Amazonka.ECS.Types.FirelensConfiguration" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "FirelensConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FirelensConfigurationType)))

newFirelensConfiguration Source #

Create a value of FirelensConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:options:FirelensConfiguration', firelensConfiguration_options - The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a task definition that uses a FireLens configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

$sel:type':FirelensConfiguration', firelensConfiguration_type - The log router to use. The valid values are fluentd or fluentbit.

firelensConfiguration_options :: Lens' FirelensConfiguration (Maybe (HashMap Text Text)) Source #

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a task definition that uses a FireLens configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

firelensConfiguration_type :: Lens' FirelensConfiguration FirelensConfigurationType Source #

The log router to use. The valid values are fluentd or fluentbit.

HealthCheck

data HealthCheck Source #

An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).

The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.

You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console.

The following describes the possible healthStatus values for a container:

  • HEALTHY-The container health check has passed successfully.
  • UNHEALTHY-The container health check has failed.
  • UNKNOWN-The container health check is being evaluated or there's no container health check defined.

The following describes the possible healthStatus values for a task. The container health check status of nonessential containers only affects the health status of a task if no essential containers have health checks defined.

  • HEALTHY-All essential containers within the task have passed their health checks.
  • UNHEALTHY-One or more essential containers have failed their health check.
  • UNKNOWN-The essential containers within the task are still having their health checks evaluated or there are only nonessential containers with health checks defined.

If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.

For tasks that are a part of a service and the service uses the ECS rolling deployment type, the deployment is paused while the new tasks have the UNKNOWN task health check status. For example, tasks that define health checks for nonessential containers when no essential containers have health checks will have the UNKNOWN health check status indefinitely which prevents the deployment from completing.

The following are notes about container health check support:

  • Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS container agent.
  • Container health checks are supported for Fargate tasks if you're using platform version 1.1.0 or greater. For more information, see Fargate platform versions.
  • Container health checks aren't supported for tasks that are part of a service that's configured to use a Classic Load Balancer.

See: newHealthCheck smart constructor.

Constructors

HealthCheck' 

Fields

  • interval :: Maybe Int

    The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.

  • retries :: Maybe Int

    The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.

  • startPeriod :: Maybe Int

    The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the startPeriod is disabled.

    If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.

  • timeout :: Maybe Int

    The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.

  • command :: [Text]

    A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to run the command arguments directly, or CMD-SHELL to run the command with the container's default shell.

    When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in brackets.

    [ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]

    You don't need to include the brackets when you use the Amazon Web Services Management Console.

     "CMD-SHELL", "curl -f http://localhost/ || exit 1"

    An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.

Instances

Instances details
FromJSON HealthCheck Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthCheck

ToJSON HealthCheck Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthCheck

Generic HealthCheck Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthCheck

Associated Types

type Rep HealthCheck :: Type -> Type #

Read HealthCheck Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthCheck

Show HealthCheck Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthCheck

NFData HealthCheck Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthCheck

Methods

rnf :: HealthCheck -> () #

Eq HealthCheck Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthCheck

Hashable HealthCheck Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthCheck

type Rep HealthCheck Source # 
Instance details

Defined in Amazonka.ECS.Types.HealthCheck

type Rep HealthCheck = D1 ('MetaData "HealthCheck" "Amazonka.ECS.Types.HealthCheck" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "HealthCheck'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "interval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "retries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "startPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))))

newHealthCheck :: HealthCheck Source #

Create a value of HealthCheck with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:interval:HealthCheck', healthCheck_interval - The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.

$sel:retries:HealthCheck', healthCheck_retries - The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.

$sel:startPeriod:HealthCheck', healthCheck_startPeriod - The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the startPeriod is disabled.

If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.

$sel:timeout:HealthCheck', healthCheck_timeout - The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.

$sel:command:HealthCheck', healthCheck_command - A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to run the command arguments directly, or CMD-SHELL to run the command with the container's default shell.

When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in brackets.

[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]

You don't need to include the brackets when you use the Amazon Web Services Management Console.

 "CMD-SHELL", "curl -f http://localhost/ || exit 1"

An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.

healthCheck_interval :: Lens' HealthCheck (Maybe Int) Source #

The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.

healthCheck_retries :: Lens' HealthCheck (Maybe Int) Source #

The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.

healthCheck_startPeriod :: Lens' HealthCheck (Maybe Int) Source #

The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the startPeriod is disabled.

If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.

healthCheck_timeout :: Lens' HealthCheck (Maybe Int) Source #

The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.

healthCheck_command :: Lens' HealthCheck [Text] Source #

A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to run the command arguments directly, or CMD-SHELL to run the command with the container's default shell.

When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in brackets.

[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]

You don't need to include the brackets when you use the Amazon Web Services Management Console.

 "CMD-SHELL", "curl -f http://localhost/ || exit 1"

An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.

HostEntry

data HostEntry Source #

Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition.

See: newHostEntry smart constructor.

Constructors

HostEntry' 

Fields

Instances

Instances details
FromJSON HostEntry Source # 
Instance details

Defined in Amazonka.ECS.Types.HostEntry

ToJSON HostEntry Source # 
Instance details

Defined in Amazonka.ECS.Types.HostEntry

Generic HostEntry Source # 
Instance details

Defined in Amazonka.ECS.Types.HostEntry

Associated Types

type Rep HostEntry :: Type -> Type #

Read HostEntry Source # 
Instance details

Defined in Amazonka.ECS.Types.HostEntry

Show HostEntry Source # 
Instance details

Defined in Amazonka.ECS.Types.HostEntry

NFData HostEntry Source # 
Instance details

Defined in Amazonka.ECS.Types.HostEntry

Methods

rnf :: HostEntry -> () #

Eq HostEntry Source # 
Instance details

Defined in Amazonka.ECS.Types.HostEntry

Hashable HostEntry Source # 
Instance details

Defined in Amazonka.ECS.Types.HostEntry

type Rep HostEntry Source # 
Instance details

Defined in Amazonka.ECS.Types.HostEntry

type Rep HostEntry = D1 ('MetaData "HostEntry" "Amazonka.ECS.Types.HostEntry" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "HostEntry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hostname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "ipAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newHostEntry Source #

Create a value of HostEntry with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:hostname:HostEntry', hostEntry_hostname - The hostname to use in the /etc/hosts entry.

$sel:ipAddress:HostEntry', hostEntry_ipAddress - The IP address to use in the /etc/hosts entry.

hostEntry_hostname :: Lens' HostEntry Text Source #

The hostname to use in the /etc/hosts entry.

hostEntry_ipAddress :: Lens' HostEntry Text Source #

The IP address to use in the /etc/hosts entry.

HostVolumeProperties

data HostVolumeProperties Source #

Details on a container instance bind mount host volume.

See: newHostVolumeProperties smart constructor.

Constructors

HostVolumeProperties' 

Fields

  • sourcePath :: Maybe Text

    When the host parameter is used, specify a sourcePath to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

    If you're using the Fargate launch type, the sourcePath parameter is not supported.

Instances

Instances details
FromJSON HostVolumeProperties Source # 
Instance details

Defined in Amazonka.ECS.Types.HostVolumeProperties

ToJSON HostVolumeProperties Source # 
Instance details

Defined in Amazonka.ECS.Types.HostVolumeProperties

Generic HostVolumeProperties Source # 
Instance details

Defined in Amazonka.ECS.Types.HostVolumeProperties

Associated Types

type Rep HostVolumeProperties :: Type -> Type #

Read HostVolumeProperties Source # 
Instance details

Defined in Amazonka.ECS.Types.HostVolumeProperties

Show HostVolumeProperties Source # 
Instance details

Defined in Amazonka.ECS.Types.HostVolumeProperties

NFData HostVolumeProperties Source # 
Instance details

Defined in Amazonka.ECS.Types.HostVolumeProperties

Methods

rnf :: HostVolumeProperties -> () #

Eq HostVolumeProperties Source # 
Instance details

Defined in Amazonka.ECS.Types.HostVolumeProperties

Hashable HostVolumeProperties Source # 
Instance details

Defined in Amazonka.ECS.Types.HostVolumeProperties

type Rep HostVolumeProperties Source # 
Instance details

Defined in Amazonka.ECS.Types.HostVolumeProperties

type Rep HostVolumeProperties = D1 ('MetaData "HostVolumeProperties" "Amazonka.ECS.Types.HostVolumeProperties" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "HostVolumeProperties'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sourcePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newHostVolumeProperties :: HostVolumeProperties Source #

Create a value of HostVolumeProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sourcePath:HostVolumeProperties', hostVolumeProperties_sourcePath - When the host parameter is used, specify a sourcePath to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you're using the Fargate launch type, the sourcePath parameter is not supported.

hostVolumeProperties_sourcePath :: Lens' HostVolumeProperties (Maybe Text) Source #

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you're using the Fargate launch type, the sourcePath parameter is not supported.

InferenceAccelerator

data InferenceAccelerator Source #

Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

See: newInferenceAccelerator smart constructor.

Constructors

InferenceAccelerator' 

Fields

  • deviceName :: Text

    The Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.

  • deviceType :: Text

    The Elastic Inference accelerator type to use.

Instances

Instances details
FromJSON InferenceAccelerator Source # 
Instance details

Defined in Amazonka.ECS.Types.InferenceAccelerator

ToJSON InferenceAccelerator Source # 
Instance details

Defined in Amazonka.ECS.Types.InferenceAccelerator

Generic InferenceAccelerator Source # 
Instance details

Defined in Amazonka.ECS.Types.InferenceAccelerator

Associated Types

type Rep InferenceAccelerator :: Type -> Type #

Read InferenceAccelerator Source # 
Instance details

Defined in Amazonka.ECS.Types.InferenceAccelerator

Show InferenceAccelerator Source # 
Instance details

Defined in Amazonka.ECS.Types.InferenceAccelerator

NFData InferenceAccelerator Source # 
Instance details

Defined in Amazonka.ECS.Types.InferenceAccelerator

Methods

rnf :: InferenceAccelerator -> () #

Eq InferenceAccelerator Source # 
Instance details

Defined in Amazonka.ECS.Types.InferenceAccelerator

Hashable InferenceAccelerator Source # 
Instance details

Defined in Amazonka.ECS.Types.InferenceAccelerator

type Rep InferenceAccelerator Source # 
Instance details

Defined in Amazonka.ECS.Types.InferenceAccelerator

type Rep InferenceAccelerator = D1 ('MetaData "InferenceAccelerator" "Amazonka.ECS.Types.InferenceAccelerator" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "InferenceAccelerator'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "deviceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newInferenceAccelerator Source #

Create a value of InferenceAccelerator with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:deviceName:InferenceAccelerator', inferenceAccelerator_deviceName - The Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.

$sel:deviceType:InferenceAccelerator', inferenceAccelerator_deviceType - The Elastic Inference accelerator type to use.

inferenceAccelerator_deviceName :: Lens' InferenceAccelerator Text Source #

The Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.

inferenceAccelerator_deviceType :: Lens' InferenceAccelerator Text Source #

The Elastic Inference accelerator type to use.

InferenceAcceleratorOverride

data InferenceAcceleratorOverride Source #

Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

See: newInferenceAcceleratorOverride smart constructor.

Constructors

InferenceAcceleratorOverride' 

Fields

  • deviceName :: Maybe Text

    The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.

  • deviceType :: Maybe Text

    The Elastic Inference accelerator type to use.

Instances

Instances details
FromJSON InferenceAcceleratorOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.InferenceAcceleratorOverride

ToJSON InferenceAcceleratorOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.InferenceAcceleratorOverride

Generic InferenceAcceleratorOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.InferenceAcceleratorOverride

Associated Types

type Rep InferenceAcceleratorOverride :: Type -> Type #

Read InferenceAcceleratorOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.InferenceAcceleratorOverride

Show InferenceAcceleratorOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.InferenceAcceleratorOverride

NFData InferenceAcceleratorOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.InferenceAcceleratorOverride

Eq InferenceAcceleratorOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.InferenceAcceleratorOverride

Hashable InferenceAcceleratorOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.InferenceAcceleratorOverride

type Rep InferenceAcceleratorOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.InferenceAcceleratorOverride

type Rep InferenceAcceleratorOverride = D1 ('MetaData "InferenceAcceleratorOverride" "Amazonka.ECS.Types.InferenceAcceleratorOverride" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "InferenceAcceleratorOverride'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deviceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newInferenceAcceleratorOverride :: InferenceAcceleratorOverride Source #

Create a value of InferenceAcceleratorOverride with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:deviceName:InferenceAcceleratorOverride', inferenceAcceleratorOverride_deviceName - The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.

$sel:deviceType:InferenceAcceleratorOverride', inferenceAcceleratorOverride_deviceType - The Elastic Inference accelerator type to use.

inferenceAcceleratorOverride_deviceName :: Lens' InferenceAcceleratorOverride (Maybe Text) Source #

The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.

InstanceHealthCheckResult

data InstanceHealthCheckResult Source #

An object representing the result of a container instance health status check.

See: newInstanceHealthCheckResult smart constructor.

Constructors

InstanceHealthCheckResult' 

Fields

Instances

Instances details
FromJSON InstanceHealthCheckResult Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckResult

Generic InstanceHealthCheckResult Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckResult

Associated Types

type Rep InstanceHealthCheckResult :: Type -> Type #

Read InstanceHealthCheckResult Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckResult

Show InstanceHealthCheckResult Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckResult

NFData InstanceHealthCheckResult Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckResult

Eq InstanceHealthCheckResult Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckResult

Hashable InstanceHealthCheckResult Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckResult

type Rep InstanceHealthCheckResult Source # 
Instance details

Defined in Amazonka.ECS.Types.InstanceHealthCheckResult

type Rep InstanceHealthCheckResult = D1 ('MetaData "InstanceHealthCheckResult" "Amazonka.ECS.Types.InstanceHealthCheckResult" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "InstanceHealthCheckResult'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lastStatusChange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "lastUpdated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceHealthCheckState)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceHealthCheckType)))))

newInstanceHealthCheckResult :: InstanceHealthCheckResult Source #

Create a value of InstanceHealthCheckResult with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:lastStatusChange:InstanceHealthCheckResult', instanceHealthCheckResult_lastStatusChange - The Unix timestamp for when the container instance health status last changed.

$sel:lastUpdated:InstanceHealthCheckResult', instanceHealthCheckResult_lastUpdated - The Unix timestamp for when the container instance health status was last updated.

$sel:status:InstanceHealthCheckResult', instanceHealthCheckResult_status - The container instance health status.

$sel:type':InstanceHealthCheckResult', instanceHealthCheckResult_type - The type of container instance health status that was verified.

instanceHealthCheckResult_lastStatusChange :: Lens' InstanceHealthCheckResult (Maybe UTCTime) Source #

The Unix timestamp for when the container instance health status last changed.

instanceHealthCheckResult_lastUpdated :: Lens' InstanceHealthCheckResult (Maybe UTCTime) Source #

The Unix timestamp for when the container instance health status was last updated.

instanceHealthCheckResult_type :: Lens' InstanceHealthCheckResult (Maybe InstanceHealthCheckType) Source #

The type of container instance health status that was verified.

KernelCapabilities

data KernelCapabilities Source #

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page.

See: newKernelCapabilities smart constructor.

Constructors

KernelCapabilities' 

Fields

  • add :: Maybe [Text]

    The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run.

    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"

  • drop :: Maybe [Text]

    The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run.

    Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"

Instances

Instances details
FromJSON KernelCapabilities Source # 
Instance details

Defined in Amazonka.ECS.Types.KernelCapabilities

ToJSON KernelCapabilities Source # 
Instance details

Defined in Amazonka.ECS.Types.KernelCapabilities

Generic KernelCapabilities Source # 
Instance details

Defined in Amazonka.ECS.Types.KernelCapabilities

Associated Types

type Rep KernelCapabilities :: Type -> Type #

Read KernelCapabilities Source # 
Instance details

Defined in Amazonka.ECS.Types.KernelCapabilities

Show KernelCapabilities Source # 
Instance details

Defined in Amazonka.ECS.Types.KernelCapabilities

NFData KernelCapabilities Source # 
Instance details

Defined in Amazonka.ECS.Types.KernelCapabilities

Methods

rnf :: KernelCapabilities -> () #

Eq KernelCapabilities Source # 
Instance details

Defined in Amazonka.ECS.Types.KernelCapabilities

Hashable KernelCapabilities Source # 
Instance details

Defined in Amazonka.ECS.Types.KernelCapabilities

type Rep KernelCapabilities Source # 
Instance details

Defined in Amazonka.ECS.Types.KernelCapabilities

type Rep KernelCapabilities = D1 ('MetaData "KernelCapabilities" "Amazonka.ECS.Types.KernelCapabilities" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "KernelCapabilities'" 'PrefixI 'True) (S1 ('MetaSel ('Just "add") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "drop") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))

newKernelCapabilities :: KernelCapabilities Source #

Create a value of KernelCapabilities with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:add:KernelCapabilities', kernelCapabilities_add - The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run.

Tasks launched on Fargate only support adding the SYS_PTRACE kernel capability.

Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"

$sel:drop:KernelCapabilities', kernelCapabilities_drop - The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run.

Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"

kernelCapabilities_add :: Lens' KernelCapabilities (Maybe [Text]) Source #

The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run.

Tasks launched on Fargate only support adding the SYS_PTRACE kernel capability.

Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"

kernelCapabilities_drop :: Lens' KernelCapabilities (Maybe [Text]) Source #

The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run.

Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"

KeyValuePair

data KeyValuePair Source #

A key-value pair object.

See: newKeyValuePair smart constructor.

Constructors

KeyValuePair' 

Fields

  • name :: Maybe Text

    The name of the key-value pair. For environment variables, this is the name of the environment variable.

  • value :: Maybe Text

    The value of the key-value pair. For environment variables, this is the value of the environment variable.

Instances

Instances details
FromJSON KeyValuePair Source # 
Instance details

Defined in Amazonka.ECS.Types.KeyValuePair

ToJSON KeyValuePair Source # 
Instance details

Defined in Amazonka.ECS.Types.KeyValuePair

Generic KeyValuePair Source # 
Instance details

Defined in Amazonka.ECS.Types.KeyValuePair

Associated Types

type Rep KeyValuePair :: Type -> Type #

Read KeyValuePair Source # 
Instance details

Defined in Amazonka.ECS.Types.KeyValuePair

Show KeyValuePair Source # 
Instance details

Defined in Amazonka.ECS.Types.KeyValuePair

NFData KeyValuePair Source # 
Instance details

Defined in Amazonka.ECS.Types.KeyValuePair

Methods

rnf :: KeyValuePair -> () #

Eq KeyValuePair Source # 
Instance details

Defined in Amazonka.ECS.Types.KeyValuePair

Hashable KeyValuePair Source # 
Instance details

Defined in Amazonka.ECS.Types.KeyValuePair

type Rep KeyValuePair Source # 
Instance details

Defined in Amazonka.ECS.Types.KeyValuePair

type Rep KeyValuePair = D1 ('MetaData "KeyValuePair" "Amazonka.ECS.Types.KeyValuePair" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "KeyValuePair'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newKeyValuePair :: KeyValuePair Source #

Create a value of KeyValuePair with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:KeyValuePair', keyValuePair_name - The name of the key-value pair. For environment variables, this is the name of the environment variable.

$sel:value:KeyValuePair', keyValuePair_value - The value of the key-value pair. For environment variables, this is the value of the environment variable.

keyValuePair_name :: Lens' KeyValuePair (Maybe Text) Source #

The name of the key-value pair. For environment variables, this is the name of the environment variable.

keyValuePair_value :: Lens' KeyValuePair (Maybe Text) Source #

The value of the key-value pair. For environment variables, this is the value of the environment variable.

LinuxParameters

data LinuxParameters Source #

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

See: newLinuxParameters smart constructor.

Constructors

LinuxParameters' 

Fields

  • capabilities :: Maybe KernelCapabilities

    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.

  • devices :: Maybe [Device]

    Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.

    If you're using tasks that use the Fargate launch type, the devices parameter isn't supported.

  • initProcessEnabled :: Maybe Bool

    Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

  • maxSwap :: Maybe Int

    The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value.

    If a maxSwap value of 0 is specified, the container will not use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container will use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.

    If you're using tasks that use the Fargate launch type, the maxSwap parameter isn't supported.

  • sharedMemorySize :: Maybe Int

    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.

  • swappiness :: Maybe Int

    This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.

    If you're using tasks that use the Fargate launch type, the swappiness parameter isn't supported.

  • tmpfs :: Maybe [Tmpfs]

    The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

    If you're using tasks that use the Fargate launch type, the tmpfs parameter isn't supported.

Instances

Instances details
FromJSON LinuxParameters Source # 
Instance details

Defined in Amazonka.ECS.Types.LinuxParameters

ToJSON LinuxParameters Source # 
Instance details

Defined in Amazonka.ECS.Types.LinuxParameters

Generic LinuxParameters Source # 
Instance details

Defined in Amazonka.ECS.Types.LinuxParameters

Associated Types

type Rep LinuxParameters :: Type -> Type #

Read LinuxParameters Source # 
Instance details

Defined in Amazonka.ECS.Types.LinuxParameters

Show LinuxParameters Source # 
Instance details

Defined in Amazonka.ECS.Types.LinuxParameters

NFData LinuxParameters Source # 
Instance details

Defined in Amazonka.ECS.Types.LinuxParameters

Methods

rnf :: LinuxParameters -> () #

Eq LinuxParameters Source # 
Instance details

Defined in Amazonka.ECS.Types.LinuxParameters

Hashable LinuxParameters Source # 
Instance details

Defined in Amazonka.ECS.Types.LinuxParameters

type Rep LinuxParameters Source # 
Instance details

Defined in Amazonka.ECS.Types.LinuxParameters

newLinuxParameters :: LinuxParameters Source #

Create a value of LinuxParameters with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:capabilities:LinuxParameters', linuxParameters_capabilities - The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

For tasks that use the Fargate launch type, capabilities is supported for all platform versions but the add parameter is only supported if using platform version 1.4.0 or later.

$sel:devices:LinuxParameters', linuxParameters_devices - Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.

If you're using tasks that use the Fargate launch type, the devices parameter isn't supported.

$sel:initProcessEnabled:LinuxParameters', linuxParameters_initProcessEnabled - Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

$sel:maxSwap:LinuxParameters', linuxParameters_maxSwap - The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value.

If a maxSwap value of 0 is specified, the container will not use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container will use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.

If you're using tasks that use the Fargate launch type, the maxSwap parameter isn't supported.

$sel:sharedMemorySize:LinuxParameters', linuxParameters_sharedMemorySize - The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.

If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.

$sel:swappiness:LinuxParameters', linuxParameters_swappiness - This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.

If you're using tasks that use the Fargate launch type, the swappiness parameter isn't supported.

$sel:tmpfs:LinuxParameters', linuxParameters_tmpfs - The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

If you're using tasks that use the Fargate launch type, the tmpfs parameter isn't supported.

linuxParameters_capabilities :: Lens' LinuxParameters (Maybe KernelCapabilities) Source #

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

For tasks that use the Fargate launch type, capabilities is supported for all platform versions but the add parameter is only supported if using platform version 1.4.0 or later.

linuxParameters_devices :: Lens' LinuxParameters (Maybe [Device]) Source #

Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.

If you're using tasks that use the Fargate launch type, the devices parameter isn't supported.

linuxParameters_initProcessEnabled :: Lens' LinuxParameters (Maybe Bool) Source #

Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

linuxParameters_maxSwap :: Lens' LinuxParameters (Maybe Int) Source #

The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value.

If a maxSwap value of 0 is specified, the container will not use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container will use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.

If you're using tasks that use the Fargate launch type, the maxSwap parameter isn't supported.

linuxParameters_sharedMemorySize :: Lens' LinuxParameters (Maybe Int) Source #

The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.

If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.

linuxParameters_swappiness :: Lens' LinuxParameters (Maybe Int) Source #

This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.

If you're using tasks that use the Fargate launch type, the swappiness parameter isn't supported.

linuxParameters_tmpfs :: Lens' LinuxParameters (Maybe [Tmpfs]) Source #

The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

If you're using tasks that use the Fargate launch type, the tmpfs parameter isn't supported.

LoadBalancer

data LoadBalancer Source #

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

For specific notes and restrictions regarding the use of load balancers with services and task sets, see the CreateService and CreateTaskSet actions.

When you add, update, or remove a load balancer configuration, Amazon ECS starts a new deployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and deregister from load balancers.

We recommend that you verify this on a test environment before you update the Elastic Load Balancing configuration.

A service-linked role is required for services that use multiple target groups. For more information, see Using service-linked roles in the Amazon Elastic Container Service Developer Guide.

See: newLoadBalancer smart constructor.

Constructors

LoadBalancer' 

Fields

  • containerName :: Maybe Text

    The name of the container (as it appears in a container definition) to associate with the load balancer.

  • containerPort :: Maybe Int

    The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the hostPort of the port mapping.

  • loadBalancerName :: Maybe Text

    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.

  • targetGroupArn :: Maybe Text

    The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

    A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you're using a Classic Load Balancer, omit the target group ARN.

    For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

    For services using the CODE_DEPLOY deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

    If your service's task definition uses the awsvpc network mode, you must choose ip as the target type, not instance. Do this when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.

Instances

Instances details
FromJSON LoadBalancer Source # 
Instance details

Defined in Amazonka.ECS.Types.LoadBalancer

ToJSON LoadBalancer Source # 
Instance details

Defined in Amazonka.ECS.Types.LoadBalancer

Generic LoadBalancer Source # 
Instance details

Defined in Amazonka.ECS.Types.LoadBalancer

Associated Types

type Rep LoadBalancer :: Type -> Type #

Read LoadBalancer Source # 
Instance details

Defined in Amazonka.ECS.Types.LoadBalancer

Show LoadBalancer Source # 
Instance details

Defined in Amazonka.ECS.Types.LoadBalancer

NFData LoadBalancer Source # 
Instance details

Defined in Amazonka.ECS.Types.LoadBalancer

Methods

rnf :: LoadBalancer -> () #

Eq LoadBalancer Source # 
Instance details

Defined in Amazonka.ECS.Types.LoadBalancer

Hashable LoadBalancer Source # 
Instance details

Defined in Amazonka.ECS.Types.LoadBalancer

type Rep LoadBalancer Source # 
Instance details

Defined in Amazonka.ECS.Types.LoadBalancer

type Rep LoadBalancer = D1 ('MetaData "LoadBalancer" "Amazonka.ECS.Types.LoadBalancer" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "LoadBalancer'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "containerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "containerPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "loadBalancerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "targetGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newLoadBalancer :: LoadBalancer Source #

Create a value of LoadBalancer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containerName:LoadBalancer', loadBalancer_containerName - The name of the container (as it appears in a container definition) to associate with the load balancer.

$sel:containerPort:LoadBalancer', loadBalancer_containerPort - The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the hostPort of the port mapping.

$sel:loadBalancerName:LoadBalancer', loadBalancer_loadBalancerName - The name of the load balancer to associate with the Amazon ECS service or task set.

A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

$sel:targetGroupArn:LoadBalancer', loadBalancer_targetGroupArn - The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you're using a Classic Load Balancer, omit the target group ARN.

For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

For services using the CODE_DEPLOY deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

If your service's task definition uses the awsvpc network mode, you must choose ip as the target type, not instance. Do this when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.

loadBalancer_containerName :: Lens' LoadBalancer (Maybe Text) Source #

The name of the container (as it appears in a container definition) to associate with the load balancer.

loadBalancer_containerPort :: Lens' LoadBalancer (Maybe Int) Source #

The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the hostPort of the port mapping.

loadBalancer_loadBalancerName :: Lens' LoadBalancer (Maybe Text) Source #

The name of the load balancer to associate with the Amazon ECS service or task set.

A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

loadBalancer_targetGroupArn :: Lens' LoadBalancer (Maybe Text) Source #

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you're using a Classic Load Balancer, omit the target group ARN.

For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

For services using the CODE_DEPLOY deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

If your service's task definition uses the awsvpc network mode, you must choose ip as the target type, not instance. Do this when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.

LogConfiguration

data LogConfiguration Source #

The log configuration for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run .

By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Understand the following when specifying a log configuration for your containers.

  • Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the valid values below). Additional log drivers may be available in future releases of the Amazon ECS container agent.
  • This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
  • For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ECS_AVAILABLE_LOGGING_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.
  • For tasks that are on Fargate, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.

See: newLogConfiguration smart constructor.

Constructors

LogConfiguration' 

Fields

  • options :: Maybe (HashMap Text Text)

    The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

  • secretOptions :: Maybe [Secret]

    The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.

  • logDriver :: LogDriver

    The log driver to use for the container.

    For tasks on Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

    For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.

    For more information about using the awslogs log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide.

    For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

    If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.

Instances

Instances details
FromJSON LogConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.LogConfiguration

ToJSON LogConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.LogConfiguration

Generic LogConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.LogConfiguration

Associated Types

type Rep LogConfiguration :: Type -> Type #

Read LogConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.LogConfiguration

Show LogConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.LogConfiguration

NFData LogConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.LogConfiguration

Methods

rnf :: LogConfiguration -> () #

Eq LogConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.LogConfiguration

Hashable LogConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.LogConfiguration

type Rep LogConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.LogConfiguration

type Rep LogConfiguration = D1 ('MetaData "LogConfiguration" "Amazonka.ECS.Types.LogConfiguration" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "LogConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "secretOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Secret])) :*: S1 ('MetaSel ('Just "logDriver") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LogDriver))))

newLogConfiguration Source #

Create a value of LogConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:options:LogConfiguration', logConfiguration_options - The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

$sel:secretOptions:LogConfiguration', logConfiguration_secretOptions - The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.

$sel:logDriver:LogConfiguration', logConfiguration_logDriver - The log driver to use for the container.

For tasks on Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.

For more information about using the awslogs log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide.

For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.

logConfiguration_options :: Lens' LogConfiguration (Maybe (HashMap Text Text)) Source #

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

logConfiguration_secretOptions :: Lens' LogConfiguration (Maybe [Secret]) Source #

The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.

logConfiguration_logDriver :: Lens' LogConfiguration LogDriver Source #

The log driver to use for the container.

For tasks on Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.

For more information about using the awslogs log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide.

For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.

ManagedAgent

data ManagedAgent Source #

Details about the managed agent status for the container.

See: newManagedAgent smart constructor.

Constructors

ManagedAgent' 

Fields

Instances

Instances details
FromJSON ManagedAgent Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgent

Generic ManagedAgent Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgent

Associated Types

type Rep ManagedAgent :: Type -> Type #

Read ManagedAgent Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgent

Show ManagedAgent Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgent

NFData ManagedAgent Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgent

Methods

rnf :: ManagedAgent -> () #

Eq ManagedAgent Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgent

Hashable ManagedAgent Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgent

type Rep ManagedAgent Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgent

type Rep ManagedAgent = D1 ('MetaData "ManagedAgent" "Amazonka.ECS.Types.ManagedAgent" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ManagedAgent'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lastStartedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "lastStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ManagedAgentName)) :*: S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newManagedAgent :: ManagedAgent Source #

Create a value of ManagedAgent with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:lastStartedAt:ManagedAgent', managedAgent_lastStartedAt - The Unix timestamp for the time when the managed agent was last started.

$sel:lastStatus:ManagedAgent', managedAgent_lastStatus - The last known status of the managed agent.

$sel:name:ManagedAgent', managedAgent_name - The name of the managed agent. When the execute command feature is enabled, the managed agent name is ExecuteCommandAgent.

$sel:reason:ManagedAgent', managedAgent_reason - The reason for why the managed agent is in the state it is in.

managedAgent_lastStartedAt :: Lens' ManagedAgent (Maybe UTCTime) Source #

The Unix timestamp for the time when the managed agent was last started.

managedAgent_lastStatus :: Lens' ManagedAgent (Maybe Text) Source #

The last known status of the managed agent.

managedAgent_name :: Lens' ManagedAgent (Maybe ManagedAgentName) Source #

The name of the managed agent. When the execute command feature is enabled, the managed agent name is ExecuteCommandAgent.

managedAgent_reason :: Lens' ManagedAgent (Maybe Text) Source #

The reason for why the managed agent is in the state it is in.

ManagedAgentStateChange

data ManagedAgentStateChange Source #

An object representing a change in state for a managed agent.

See: newManagedAgentStateChange smart constructor.

Constructors

ManagedAgentStateChange' 

Fields

Instances

Instances details
ToJSON ManagedAgentStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentStateChange

Generic ManagedAgentStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentStateChange

Associated Types

type Rep ManagedAgentStateChange :: Type -> Type #

Read ManagedAgentStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentStateChange

Show ManagedAgentStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentStateChange

NFData ManagedAgentStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentStateChange

Methods

rnf :: ManagedAgentStateChange -> () #

Eq ManagedAgentStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentStateChange

Hashable ManagedAgentStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentStateChange

type Rep ManagedAgentStateChange Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedAgentStateChange

type Rep ManagedAgentStateChange = D1 ('MetaData "ManagedAgentStateChange" "Amazonka.ECS.Types.ManagedAgentStateChange" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ManagedAgentStateChange'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "containerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "managedAgentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ManagedAgentName) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newManagedAgentStateChange Source #

Create a value of ManagedAgentStateChange with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:reason:ManagedAgentStateChange', managedAgentStateChange_reason - The reason for the status of the managed agent.

$sel:containerName:ManagedAgentStateChange', managedAgentStateChange_containerName - The name of the container that's associated with the managed agent.

$sel:managedAgentName:ManagedAgentStateChange', managedAgentStateChange_managedAgentName - The name of the managed agent.

$sel:status:ManagedAgentStateChange', managedAgentStateChange_status - The status of the managed agent.

managedAgentStateChange_reason :: Lens' ManagedAgentStateChange (Maybe Text) Source #

The reason for the status of the managed agent.

managedAgentStateChange_containerName :: Lens' ManagedAgentStateChange Text Source #

The name of the container that's associated with the managed agent.

ManagedScaling

data ManagedScaling Source #

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

When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS managed CloudWatch metric with the specified targetCapacity value as the target value for the metric. For more information, see Using managed scaling in the Amazon Elastic Container Service Developer Guide.

If managed scaling is disabled, the user must manage the scaling of the Auto Scaling group.

See: newManagedScaling smart constructor.

Constructors

ManagedScaling' 

Fields

  • instanceWarmupPeriod :: Maybe Natural

    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.

  • maximumScalingStepSize :: Maybe Natural

    The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter. If this parameter is omitted, the default value of 1 is used.

  • minimumScalingStepSize :: Maybe Natural

    The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of 1 is used.

    When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.

    If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.

  • status :: Maybe ManagedScalingStatus

    Determines whether to use managed scaling for the capacity provider.

  • targetCapacity :: Maybe Natural

    The target capacity value for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. A value of 100 results in the Amazon EC2 instances in your Auto Scaling group being completely used.

Instances

Instances details
FromJSON ManagedScaling Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScaling

ToJSON ManagedScaling Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScaling

Generic ManagedScaling Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScaling

Associated Types

type Rep ManagedScaling :: Type -> Type #

Read ManagedScaling Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScaling

Show ManagedScaling Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScaling

NFData ManagedScaling Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScaling

Methods

rnf :: ManagedScaling -> () #

Eq ManagedScaling Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScaling

Hashable ManagedScaling Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScaling

type Rep ManagedScaling Source # 
Instance details

Defined in Amazonka.ECS.Types.ManagedScaling

type Rep ManagedScaling = D1 ('MetaData "ManagedScaling" "Amazonka.ECS.Types.ManagedScaling" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ManagedScaling'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "instanceWarmupPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "maximumScalingStepSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "minimumScalingStepSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ManagedScalingStatus)) :*: S1 ('MetaSel ('Just "targetCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))

newManagedScaling :: ManagedScaling Source #

Create a value of ManagedScaling with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:instanceWarmupPeriod:ManagedScaling', managedScaling_instanceWarmupPeriod - The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of 300 seconds is used.

$sel:maximumScalingStepSize:ManagedScaling', managedScaling_maximumScalingStepSize - The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter. If this parameter is omitted, the default value of 1 is used.

$sel:minimumScalingStepSize:ManagedScaling', managedScaling_minimumScalingStepSize - The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of 1 is used.

When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.

If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.

$sel:status:ManagedScaling', managedScaling_status - Determines whether to use managed scaling for the capacity provider.

$sel:targetCapacity:ManagedScaling', managedScaling_targetCapacity - The target capacity value for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. A value of 100 results in the Amazon EC2 instances in your Auto Scaling group being completely used.

managedScaling_instanceWarmupPeriod :: Lens' ManagedScaling (Maybe Natural) Source #

The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of 300 seconds is used.

managedScaling_maximumScalingStepSize :: Lens' ManagedScaling (Maybe Natural) Source #

The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter. If this parameter is omitted, the default value of 1 is used.

managedScaling_minimumScalingStepSize :: Lens' ManagedScaling (Maybe Natural) Source #

The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of 1 is used.

When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.

If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.

managedScaling_status :: Lens' ManagedScaling (Maybe ManagedScalingStatus) Source #

Determines whether to use managed scaling for the capacity provider.

managedScaling_targetCapacity :: Lens' ManagedScaling (Maybe Natural) Source #

The target capacity value for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. A value of 100 results in the Amazon EC2 instances in your Auto Scaling group being completely used.

MountPoint

data MountPoint Source #

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

See: newMountPoint smart constructor.

Constructors

MountPoint' 

Fields

  • containerPath :: Maybe Text

    The path on the container to mount the host volume at.

  • readOnly :: Maybe Bool

    If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

  • sourceVolume :: Maybe Text

    The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume.

Instances

Instances details
FromJSON MountPoint Source # 
Instance details

Defined in Amazonka.ECS.Types.MountPoint

ToJSON MountPoint Source # 
Instance details

Defined in Amazonka.ECS.Types.MountPoint

Generic MountPoint Source # 
Instance details

Defined in Amazonka.ECS.Types.MountPoint

Associated Types

type Rep MountPoint :: Type -> Type #

Read MountPoint Source # 
Instance details

Defined in Amazonka.ECS.Types.MountPoint

Show MountPoint Source # 
Instance details

Defined in Amazonka.ECS.Types.MountPoint

NFData MountPoint Source # 
Instance details

Defined in Amazonka.ECS.Types.MountPoint

Methods

rnf :: MountPoint -> () #

Eq MountPoint Source # 
Instance details

Defined in Amazonka.ECS.Types.MountPoint

Hashable MountPoint Source # 
Instance details

Defined in Amazonka.ECS.Types.MountPoint

type Rep MountPoint Source # 
Instance details

Defined in Amazonka.ECS.Types.MountPoint

type Rep MountPoint = D1 ('MetaData "MountPoint" "Amazonka.ECS.Types.MountPoint" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "MountPoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "containerPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "readOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sourceVolume") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newMountPoint :: MountPoint Source #

Create a value of MountPoint with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containerPath:MountPoint', mountPoint_containerPath - The path on the container to mount the host volume at.

$sel:readOnly:MountPoint', mountPoint_readOnly - If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

$sel:sourceVolume:MountPoint', mountPoint_sourceVolume - The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume.

mountPoint_containerPath :: Lens' MountPoint (Maybe Text) Source #

The path on the container to mount the host volume at.

mountPoint_readOnly :: Lens' MountPoint (Maybe Bool) Source #

If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

mountPoint_sourceVolume :: Lens' MountPoint (Maybe Text) Source #

The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume.

NetworkBinding

data NetworkBinding Source #

Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.

See: newNetworkBinding smart constructor.

Constructors

NetworkBinding' 

Fields

  • bindIP :: Maybe Text

    The IP address that the container is bound to on the container instance.

  • containerPort :: Maybe Int

    The port number on the container that's used with the network binding.

  • containerPortRange :: Maybe Text

    The port number range on the container that's bound to the dynamically mapped host port range.

    The following rules apply when you specify a containerPortRange:

    • You must use either the bridge network mode or the awsvpc network mode.
    • This parameter is available for both the EC2 and Fargate launch types.
    • This parameter is available for both the Linux and Windows operating systems.
    • The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ecs-init package
    • You can specify a maximum of 100 port ranges per container.
    • You do not specify a hostPortRange. The value of the hostPortRange is set as follows:

      • For containers in a task with the awsvpc network mode, the hostPort is set to the same value as the containerPort. This is a static mapping strategy.
      • For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
    • The containerPortRange valid values are between 1 and 65535.
    • A port can only be included in one port mapping per container.
    • You cannot specify overlapping port ranges.
    • The first port in the range must be less than last port in the range.
    • Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.

      For more information, see Issue #11185 on the Github website.

      For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.

    You can call DescribeTasks to view the hostPortRange which are the host ports that are bound to the container ports.

  • hostPort :: Maybe Int

    The port number on the host that's used with the network binding.

  • hostPortRange :: Maybe Text

    The port number range on the host that's used with the network binding. This is assigned is assigned by Docker and delivered by the Amazon ECS agent.

  • protocol :: Maybe TransportProtocol

    The protocol used for the network binding.

Instances

Instances details
FromJSON NetworkBinding Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkBinding

ToJSON NetworkBinding Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkBinding

Generic NetworkBinding Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkBinding

Associated Types

type Rep NetworkBinding :: Type -> Type #

Read NetworkBinding Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkBinding

Show NetworkBinding Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkBinding

NFData NetworkBinding Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkBinding

Methods

rnf :: NetworkBinding -> () #

Eq NetworkBinding Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkBinding

Hashable NetworkBinding Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkBinding

type Rep NetworkBinding Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkBinding

type Rep NetworkBinding = D1 ('MetaData "NetworkBinding" "Amazonka.ECS.Types.NetworkBinding" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "NetworkBinding'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bindIP") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "containerPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "containerPortRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "hostPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "hostPortRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "protocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TransportProtocol))))))

newNetworkBinding :: NetworkBinding Source #

Create a value of NetworkBinding with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:bindIP:NetworkBinding', networkBinding_bindIP - The IP address that the container is bound to on the container instance.

$sel:containerPort:NetworkBinding', networkBinding_containerPort - The port number on the container that's used with the network binding.

$sel:containerPortRange:NetworkBinding', networkBinding_containerPortRange - The port number range on the container that's bound to the dynamically mapped host port range.

The following rules apply when you specify a containerPortRange:

  • You must use either the bridge network mode or the awsvpc network mode.
  • This parameter is available for both the EC2 and Fargate launch types.
  • This parameter is available for both the Linux and Windows operating systems.
  • The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ecs-init package
  • You can specify a maximum of 100 port ranges per container.
  • You do not specify a hostPortRange. The value of the hostPortRange is set as follows:

    • For containers in a task with the awsvpc network mode, the hostPort is set to the same value as the containerPort. This is a static mapping strategy.
    • For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
  • The containerPortRange valid values are between 1 and 65535.
  • A port can only be included in one port mapping per container.
  • You cannot specify overlapping port ranges.
  • The first port in the range must be less than last port in the range.
  • Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.

    For more information, see Issue #11185 on the Github website.

    For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.

You can call DescribeTasks to view the hostPortRange which are the host ports that are bound to the container ports.

$sel:hostPort:NetworkBinding', networkBinding_hostPort - The port number on the host that's used with the network binding.

$sel:hostPortRange:NetworkBinding', networkBinding_hostPortRange - The port number range on the host that's used with the network binding. This is assigned is assigned by Docker and delivered by the Amazon ECS agent.

$sel:protocol:NetworkBinding', networkBinding_protocol - The protocol used for the network binding.

networkBinding_bindIP :: Lens' NetworkBinding (Maybe Text) Source #

The IP address that the container is bound to on the container instance.

networkBinding_containerPort :: Lens' NetworkBinding (Maybe Int) Source #

The port number on the container that's used with the network binding.

networkBinding_containerPortRange :: Lens' NetworkBinding (Maybe Text) Source #

The port number range on the container that's bound to the dynamically mapped host port range.

The following rules apply when you specify a containerPortRange:

  • You must use either the bridge network mode or the awsvpc network mode.
  • This parameter is available for both the EC2 and Fargate launch types.
  • This parameter is available for both the Linux and Windows operating systems.
  • The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ecs-init package
  • You can specify a maximum of 100 port ranges per container.
  • You do not specify a hostPortRange. The value of the hostPortRange is set as follows:

    • For containers in a task with the awsvpc network mode, the hostPort is set to the same value as the containerPort. This is a static mapping strategy.
    • For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
  • The containerPortRange valid values are between 1 and 65535.
  • A port can only be included in one port mapping per container.
  • You cannot specify overlapping port ranges.
  • The first port in the range must be less than last port in the range.
  • Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.

    For more information, see Issue #11185 on the Github website.

    For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.

You can call DescribeTasks to view the hostPortRange which are the host ports that are bound to the container ports.

networkBinding_hostPort :: Lens' NetworkBinding (Maybe Int) Source #

The port number on the host that's used with the network binding.

networkBinding_hostPortRange :: Lens' NetworkBinding (Maybe Text) Source #

The port number range on the host that's used with the network binding. This is assigned is assigned by Docker and delivered by the Amazon ECS agent.

networkBinding_protocol :: Lens' NetworkBinding (Maybe TransportProtocol) Source #

The protocol used for the network binding.

NetworkConfiguration

data NetworkConfiguration Source #

An object representing the network configuration for a task or service.

See: newNetworkConfiguration smart constructor.

Constructors

NetworkConfiguration' 

Fields

Instances

Instances details
FromJSON NetworkConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkConfiguration

ToJSON NetworkConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkConfiguration

Generic NetworkConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkConfiguration

Associated Types

type Rep NetworkConfiguration :: Type -> Type #

Read NetworkConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkConfiguration

Show NetworkConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkConfiguration

NFData NetworkConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkConfiguration

Methods

rnf :: NetworkConfiguration -> () #

Eq NetworkConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkConfiguration

Hashable NetworkConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkConfiguration

type Rep NetworkConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkConfiguration

type Rep NetworkConfiguration = D1 ('MetaData "NetworkConfiguration" "Amazonka.ECS.Types.NetworkConfiguration" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "NetworkConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "awsvpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AwsVpcConfiguration))))

newNetworkConfiguration :: NetworkConfiguration Source #

Create a value of NetworkConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:awsvpcConfiguration:NetworkConfiguration', networkConfiguration_awsvpcConfiguration - The VPC subnets and security groups that are associated with a task.

All specified subnets and security groups must be from the same VPC.

networkConfiguration_awsvpcConfiguration :: Lens' NetworkConfiguration (Maybe AwsVpcConfiguration) Source #

The VPC subnets and security groups that are associated with a task.

All specified subnets and security groups must be from the same VPC.

NetworkInterface

data NetworkInterface Source #

An object representing the elastic network interface for tasks that use the awsvpc network mode.

See: newNetworkInterface smart constructor.

Constructors

NetworkInterface' 

Fields

Instances

Instances details
FromJSON NetworkInterface Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkInterface

Generic NetworkInterface Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkInterface

Associated Types

type Rep NetworkInterface :: Type -> Type #

Read NetworkInterface Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkInterface

Show NetworkInterface Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkInterface

NFData NetworkInterface Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkInterface

Methods

rnf :: NetworkInterface -> () #

Eq NetworkInterface Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkInterface

Hashable NetworkInterface Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkInterface

type Rep NetworkInterface Source # 
Instance details

Defined in Amazonka.ECS.Types.NetworkInterface

type Rep NetworkInterface = D1 ('MetaData "NetworkInterface" "Amazonka.ECS.Types.NetworkInterface" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "NetworkInterface'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attachmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "ipv6Address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "privateIpv4Address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newNetworkInterface :: NetworkInterface Source #

Create a value of NetworkInterface with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attachmentId:NetworkInterface', networkInterface_attachmentId - The attachment ID for the network interface.

$sel:ipv6Address:NetworkInterface', networkInterface_ipv6Address - The private IPv6 address for the network interface.

$sel:privateIpv4Address:NetworkInterface', networkInterface_privateIpv4Address - The private IPv4 address for the network interface.

networkInterface_attachmentId :: Lens' NetworkInterface (Maybe Text) Source #

The attachment ID for the network interface.

networkInterface_ipv6Address :: Lens' NetworkInterface (Maybe Text) Source #

The private IPv6 address for the network interface.

networkInterface_privateIpv4Address :: Lens' NetworkInterface (Maybe Text) Source #

The private IPv4 address for the network interface.

PlacementConstraint

data PlacementConstraint Source #

An object representing a constraint on task placement. For more information, see Task placement constraints in the Amazon Elastic Container Service Developer Guide.

If you're using the Fargate launch type, task placement constraints aren't supported.

See: newPlacementConstraint smart constructor.

Constructors

PlacementConstraint' 

Fields

  • expression :: Maybe Text

    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.

  • type' :: Maybe PlacementConstraintType

    The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.

Instances

Instances details
FromJSON PlacementConstraint Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraint

ToJSON PlacementConstraint Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraint

Generic PlacementConstraint Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraint

Associated Types

type Rep PlacementConstraint :: Type -> Type #

Read PlacementConstraint Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraint

Show PlacementConstraint Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraint

NFData PlacementConstraint Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraint

Methods

rnf :: PlacementConstraint -> () #

Eq PlacementConstraint Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraint

Hashable PlacementConstraint Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraint

type Rep PlacementConstraint Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementConstraint

type Rep PlacementConstraint = D1 ('MetaData "PlacementConstraint" "Amazonka.ECS.Types.PlacementConstraint" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "PlacementConstraint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "expression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PlacementConstraintType))))

newPlacementConstraint :: PlacementConstraint Source #

Create a value of PlacementConstraint with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:expression:PlacementConstraint', placementConstraint_expression - A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is distinctInstance. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.

$sel:type':PlacementConstraint', placementConstraint_type - The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.

placementConstraint_expression :: Lens' PlacementConstraint (Maybe Text) Source #

A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is distinctInstance. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.

placementConstraint_type :: Lens' PlacementConstraint (Maybe PlacementConstraintType) Source #

The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.

PlacementStrategy

data PlacementStrategy Source #

The task placement strategy for a task or service. For more information, see Task placement strategies in the Amazon Elastic Container Service Developer Guide.

See: newPlacementStrategy smart constructor.

Constructors

PlacementStrategy' 

Fields

  • field :: Maybe Text

    The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that's applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

  • type' :: Maybe PlacementStrategyType

    The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that's specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.

Instances

Instances details
FromJSON PlacementStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategy

ToJSON PlacementStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategy

Generic PlacementStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategy

Associated Types

type Rep PlacementStrategy :: Type -> Type #

Read PlacementStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategy

Show PlacementStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategy

NFData PlacementStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategy

Methods

rnf :: PlacementStrategy -> () #

Eq PlacementStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategy

Hashable PlacementStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategy

type Rep PlacementStrategy Source # 
Instance details

Defined in Amazonka.ECS.Types.PlacementStrategy

type Rep PlacementStrategy = D1 ('MetaData "PlacementStrategy" "Amazonka.ECS.Types.PlacementStrategy" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "PlacementStrategy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "field") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PlacementStrategyType))))

newPlacementStrategy :: PlacementStrategy Source #

Create a value of PlacementStrategy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:field:PlacementStrategy', placementStrategy_field - The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that's applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

$sel:type':PlacementStrategy', placementStrategy_type - The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that's specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.

placementStrategy_field :: Lens' PlacementStrategy (Maybe Text) Source #

The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that's applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

placementStrategy_type :: Lens' PlacementStrategy (Maybe PlacementStrategyType) Source #

The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that's specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.

PlatformDevice

data PlatformDevice Source #

The devices that are available on the container instance. The only supported device type is a GPU.

See: newPlatformDevice smart constructor.

Constructors

PlatformDevice' 

Fields

  • id :: Text

    The ID for the GPUs on the container instance. The available GPU IDs can also be obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file.

  • type' :: PlatformDeviceType

    The type of device that's available on the container instance. The only supported value is GPU.

Instances

Instances details
ToJSON PlatformDevice Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDevice

Generic PlatformDevice Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDevice

Associated Types

type Rep PlatformDevice :: Type -> Type #

Read PlatformDevice Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDevice

Show PlatformDevice Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDevice

NFData PlatformDevice Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDevice

Methods

rnf :: PlatformDevice -> () #

Eq PlatformDevice Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDevice

Hashable PlatformDevice Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDevice

type Rep PlatformDevice Source # 
Instance details

Defined in Amazonka.ECS.Types.PlatformDevice

type Rep PlatformDevice = D1 ('MetaData "PlatformDevice" "Amazonka.ECS.Types.PlatformDevice" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "PlatformDevice'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PlatformDeviceType)))

newPlatformDevice Source #

Create a value of PlatformDevice with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:PlatformDevice', platformDevice_id - The ID for the GPUs on the container instance. The available GPU IDs can also be obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file.

$sel:type':PlatformDevice', platformDevice_type - The type of device that's available on the container instance. The only supported value is GPU.

platformDevice_id :: Lens' PlatformDevice Text Source #

The ID for the GPUs on the container instance. The available GPU IDs can also be obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file.

platformDevice_type :: Lens' PlatformDevice PlatformDeviceType Source #

The type of device that's available on the container instance. The only supported value is GPU.

PortMapping

data PortMapping Source #

Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.

If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

You can't expose the same container port for multiple protocols. If you attempt this, an error is returned.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.

See: newPortMapping smart constructor.

Constructors

PortMapping' 

Fields

  • appProtocol :: Maybe ApplicationProtocol

    The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.

    If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.

    Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

  • containerPort :: Maybe Int

    The port number on the container that's bound to the user-specified or automatically assigned host port.

    If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort.

    If you use containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.

  • containerPortRange :: Maybe Text

    The port number range on the container that's bound to the dynamically mapped host port range.

    The following rules apply when you specify a containerPortRange:

    • You must use either the bridge network mode or the awsvpc network mode.
    • This parameter is available for both the EC2 and Fargate launch types.
    • This parameter is available for both the Linux and Windows operating systems.
    • The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ecs-init package
    • You can specify a maximum of 100 port ranges per container.
    • You do not specify a hostPortRange. The value of the hostPortRange is set as follows:

      • For containers in a task with the awsvpc network mode, the hostPort is set to the same value as the containerPort. This is a static mapping strategy.
      • For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
    • The containerPortRange valid values are between 1 and 65535.
    • A port can only be included in one port mapping per container.
    • You cannot specify overlapping port ranges.
    • The first port in the range must be less than last port in the range.
    • Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.

      For more information, see Issue #11185 on the Github website.

      For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.

    You can call DescribeTasks to view the hostPortRange which are the host ports that are bound to the container ports.

  • hostPort :: Maybe Int

    The port number on the container instance to reserve for your container.

    If you specify a containerPortRange, leave this field empty and the value of the hostPort is set as follows:

    • For containers in a task with the awsvpc network mode, the hostPort is set to the same value as the containerPort. This is a static mapping strategy.
    • For containers in a task with the bridge network mode, the Amazon ECS agent finds open ports on the host and automaticaly binds them to the container ports. This is a dynamic mapping strategy.

    If you use containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort.

    If you use containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.

    The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

    The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota.

  • name :: Maybe Text

    The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the serviceConnectConfiguration of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

    For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

  • protocol :: Maybe TransportProtocol

    The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

Instances

Instances details
FromJSON PortMapping Source # 
Instance details

Defined in Amazonka.ECS.Types.PortMapping

ToJSON PortMapping Source # 
Instance details

Defined in Amazonka.ECS.Types.PortMapping

Generic PortMapping Source # 
Instance details

Defined in Amazonka.ECS.Types.PortMapping

Associated Types

type Rep PortMapping :: Type -> Type #

Read PortMapping Source # 
Instance details

Defined in Amazonka.ECS.Types.PortMapping

Show PortMapping Source # 
Instance details

Defined in Amazonka.ECS.Types.PortMapping

NFData PortMapping Source # 
Instance details

Defined in Amazonka.ECS.Types.PortMapping

Methods

rnf :: PortMapping -> () #

Eq PortMapping Source # 
Instance details

Defined in Amazonka.ECS.Types.PortMapping

Hashable PortMapping Source # 
Instance details

Defined in Amazonka.ECS.Types.PortMapping

type Rep PortMapping Source # 
Instance details

Defined in Amazonka.ECS.Types.PortMapping

newPortMapping :: PortMapping Source #

Create a value of PortMapping with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:appProtocol:PortMapping', portMapping_appProtocol - The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.

If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

$sel:containerPort:PortMapping', portMapping_containerPort - The port number on the container that's bound to the user-specified or automatically assigned host port.

If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort.

If you use containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.

$sel:containerPortRange:PortMapping', portMapping_containerPortRange - The port number range on the container that's bound to the dynamically mapped host port range.

The following rules apply when you specify a containerPortRange:

  • You must use either the bridge network mode or the awsvpc network mode.
  • This parameter is available for both the EC2 and Fargate launch types.
  • This parameter is available for both the Linux and Windows operating systems.
  • The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ecs-init package
  • You can specify a maximum of 100 port ranges per container.
  • You do not specify a hostPortRange. The value of the hostPortRange is set as follows:

    • For containers in a task with the awsvpc network mode, the hostPort is set to the same value as the containerPort. This is a static mapping strategy.
    • For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
  • The containerPortRange valid values are between 1 and 65535.
  • A port can only be included in one port mapping per container.
  • You cannot specify overlapping port ranges.
  • The first port in the range must be less than last port in the range.
  • Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.

    For more information, see Issue #11185 on the Github website.

    For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.

You can call DescribeTasks to view the hostPortRange which are the host ports that are bound to the container ports.

$sel:hostPort:PortMapping', portMapping_hostPort - The port number on the container instance to reserve for your container.

If you specify a containerPortRange, leave this field empty and the value of the hostPort is set as follows:

  • For containers in a task with the awsvpc network mode, the hostPort is set to the same value as the containerPort. This is a static mapping strategy.
  • For containers in a task with the bridge network mode, the Amazon ECS agent finds open ports on the host and automaticaly binds them to the container ports. This is a dynamic mapping strategy.

If you use containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort.

If you use containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.

The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota.

$sel:name:PortMapping', portMapping_name - The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the serviceConnectConfiguration of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

$sel:protocol:PortMapping', portMapping_protocol - The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

portMapping_appProtocol :: Lens' PortMapping (Maybe ApplicationProtocol) Source #

The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.

If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

portMapping_containerPort :: Lens' PortMapping (Maybe Int) Source #

The port number on the container that's bound to the user-specified or automatically assigned host port.

If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort.

If you use containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.

portMapping_containerPortRange :: Lens' PortMapping (Maybe Text) Source #

The port number range on the container that's bound to the dynamically mapped host port range.

The following rules apply when you specify a containerPortRange:

  • You must use either the bridge network mode or the awsvpc network mode.
  • This parameter is available for both the EC2 and Fargate launch types.
  • This parameter is available for both the Linux and Windows operating systems.
  • The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ecs-init package
  • You can specify a maximum of 100 port ranges per container.
  • You do not specify a hostPortRange. The value of the hostPortRange is set as follows:

    • For containers in a task with the awsvpc network mode, the hostPort is set to the same value as the containerPort. This is a static mapping strategy.
    • For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
  • The containerPortRange valid values are between 1 and 65535.
  • A port can only be included in one port mapping per container.
  • You cannot specify overlapping port ranges.
  • The first port in the range must be less than last port in the range.
  • Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.

    For more information, see Issue #11185 on the Github website.

    For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.

You can call DescribeTasks to view the hostPortRange which are the host ports that are bound to the container ports.

portMapping_hostPort :: Lens' PortMapping (Maybe Int) Source #

The port number on the container instance to reserve for your container.

If you specify a containerPortRange, leave this field empty and the value of the hostPort is set as follows:

  • For containers in a task with the awsvpc network mode, the hostPort is set to the same value as the containerPort. This is a static mapping strategy.
  • For containers in a task with the bridge network mode, the Amazon ECS agent finds open ports on the host and automaticaly binds them to the container ports. This is a dynamic mapping strategy.

If you use containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort.

If you use containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.

The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota.

portMapping_name :: Lens' PortMapping (Maybe Text) Source #

The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the serviceConnectConfiguration of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

portMapping_protocol :: Lens' PortMapping (Maybe TransportProtocol) Source #

The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

ProtectedTask

data ProtectedTask Source #

An object representing the protection status details for a task. You can set the protection status with the UpdateTaskProtection API and get the status of tasks with the GetTaskProtection API.

See: newProtectedTask smart constructor.

Constructors

ProtectedTask' 

Fields

Instances

Instances details
FromJSON ProtectedTask Source # 
Instance details

Defined in Amazonka.ECS.Types.ProtectedTask

Generic ProtectedTask Source # 
Instance details

Defined in Amazonka.ECS.Types.ProtectedTask

Associated Types

type Rep ProtectedTask :: Type -> Type #

Read ProtectedTask Source # 
Instance details

Defined in Amazonka.ECS.Types.ProtectedTask

Show ProtectedTask Source # 
Instance details

Defined in Amazonka.ECS.Types.ProtectedTask

NFData ProtectedTask Source # 
Instance details

Defined in Amazonka.ECS.Types.ProtectedTask

Methods

rnf :: ProtectedTask -> () #

Eq ProtectedTask Source # 
Instance details

Defined in Amazonka.ECS.Types.ProtectedTask

Hashable ProtectedTask Source # 
Instance details

Defined in Amazonka.ECS.Types.ProtectedTask

type Rep ProtectedTask Source # 
Instance details

Defined in Amazonka.ECS.Types.ProtectedTask

type Rep ProtectedTask = D1 ('MetaData "ProtectedTask" "Amazonka.ECS.Types.ProtectedTask" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ProtectedTask'" 'PrefixI 'True) (S1 ('MetaSel ('Just "expirationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "protectionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "taskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newProtectedTask :: ProtectedTask Source #

Create a value of ProtectedTask with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:expirationDate:ProtectedTask', protectedTask_expirationDate - The epoch time when protection for the task will expire.

$sel:protectionEnabled:ProtectedTask', protectedTask_protectionEnabled - The protection status of the task. If scale-in protection is enabled for a task, the value is true. Otherwise, it is false.

$sel:taskArn:ProtectedTask', protectedTask_taskArn - The task ARN.

protectedTask_expirationDate :: Lens' ProtectedTask (Maybe UTCTime) Source #

The epoch time when protection for the task will expire.

protectedTask_protectionEnabled :: Lens' ProtectedTask (Maybe Bool) Source #

The protection status of the task. If scale-in protection is enabled for a task, the value is true. Otherwise, it is false.

ProxyConfiguration

data ProxyConfiguration Source #

The configuration details for the App Mesh proxy.

For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI

See: newProxyConfiguration smart constructor.

Constructors

ProxyConfiguration' 

Fields

  • properties :: Maybe [KeyValuePair]

    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 the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredGID is specified, this field can be empty.
    • IgnoredGID - (Required) The group ID (GID) of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredUID 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 the ProxyIngressPort and ProxyEgressPort.
    • ProxyIngressPort - (Required) Specifies the port that incoming traffic to the AppPorts is directed to.
    • ProxyEgressPort - (Required) Specifies the port that outgoing traffic from the AppPorts is directed to.
    • EgressIgnoredPorts - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ProxyEgressPort. It can be an empty list.
    • EgressIgnoredIPs - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ProxyEgressPort. It can be an empty list.
  • type' :: Maybe ProxyConfigurationType

    The proxy type. The only supported value is APPMESH.

  • containerName :: Text

    The name of the container that will serve as the App Mesh proxy.

Instances

Instances details
FromJSON ProxyConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfiguration

ToJSON ProxyConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfiguration

Generic ProxyConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfiguration

Associated Types

type Rep ProxyConfiguration :: Type -> Type #

Read ProxyConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfiguration

Show ProxyConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfiguration

NFData ProxyConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfiguration

Methods

rnf :: ProxyConfiguration -> () #

Eq ProxyConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfiguration

Hashable ProxyConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfiguration

type Rep ProxyConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ProxyConfiguration

type Rep ProxyConfiguration = D1 ('MetaData "ProxyConfiguration" "Amazonka.ECS.Types.ProxyConfiguration" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ProxyConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyValuePair])) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProxyConfigurationType)) :*: S1 ('MetaSel ('Just "containerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newProxyConfiguration Source #

Create a value of ProxyConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:properties:ProxyConfiguration', proxyConfiguration_properties - The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.

  • IgnoredUID - (Required) The user ID (UID) of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredGID is specified, this field can be empty.
  • IgnoredGID - (Required) The group ID (GID) of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredUID 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 the ProxyIngressPort and ProxyEgressPort.
  • ProxyIngressPort - (Required) Specifies the port that incoming traffic to the AppPorts is directed to.
  • ProxyEgressPort - (Required) Specifies the port that outgoing traffic from the AppPorts is directed to.
  • EgressIgnoredPorts - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ProxyEgressPort. It can be an empty list.
  • EgressIgnoredIPs - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ProxyEgressPort. It can be an empty list.

$sel:type':ProxyConfiguration', proxyConfiguration_type - The proxy type. The only supported value is APPMESH.

$sel:containerName:ProxyConfiguration', proxyConfiguration_containerName - The name of the container that will serve as the App Mesh proxy.

proxyConfiguration_properties :: Lens' ProxyConfiguration (Maybe [KeyValuePair]) Source #

The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.

  • IgnoredUID - (Required) The user ID (UID) of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredGID is specified, this field can be empty.
  • IgnoredGID - (Required) The group ID (GID) of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredUID 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 the ProxyIngressPort and ProxyEgressPort.
  • ProxyIngressPort - (Required) Specifies the port that incoming traffic to the AppPorts is directed to.
  • ProxyEgressPort - (Required) Specifies the port that outgoing traffic from the AppPorts is directed to.
  • EgressIgnoredPorts - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ProxyEgressPort. It can be an empty list.
  • EgressIgnoredIPs - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ProxyEgressPort. It can be an empty list.

proxyConfiguration_type :: Lens' ProxyConfiguration (Maybe ProxyConfigurationType) Source #

The proxy type. The only supported value is APPMESH.

proxyConfiguration_containerName :: Lens' ProxyConfiguration Text Source #

The name of the container that will serve as the App Mesh proxy.

RepositoryCredentials

data RepositoryCredentials Source #

The repository credentials for private registry authentication.

See: newRepositoryCredentials smart constructor.

Constructors

RepositoryCredentials' 

Fields

  • credentialsParameter :: Text

    The Amazon Resource Name (ARN) of the secret containing the private repository credentials.

    When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN of the secret.

Instances

Instances details
FromJSON RepositoryCredentials Source # 
Instance details

Defined in Amazonka.ECS.Types.RepositoryCredentials

ToJSON RepositoryCredentials Source # 
Instance details

Defined in Amazonka.ECS.Types.RepositoryCredentials

Generic RepositoryCredentials Source # 
Instance details

Defined in Amazonka.ECS.Types.RepositoryCredentials

Associated Types

type Rep RepositoryCredentials :: Type -> Type #

Read RepositoryCredentials Source # 
Instance details

Defined in Amazonka.ECS.Types.RepositoryCredentials

Show RepositoryCredentials Source # 
Instance details

Defined in Amazonka.ECS.Types.RepositoryCredentials

NFData RepositoryCredentials Source # 
Instance details

Defined in Amazonka.ECS.Types.RepositoryCredentials

Methods

rnf :: RepositoryCredentials -> () #

Eq RepositoryCredentials Source # 
Instance details

Defined in Amazonka.ECS.Types.RepositoryCredentials

Hashable RepositoryCredentials Source # 
Instance details

Defined in Amazonka.ECS.Types.RepositoryCredentials

type Rep RepositoryCredentials Source # 
Instance details

Defined in Amazonka.ECS.Types.RepositoryCredentials

type Rep RepositoryCredentials = D1 ('MetaData "RepositoryCredentials" "Amazonka.ECS.Types.RepositoryCredentials" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "RepositoryCredentials'" 'PrefixI 'True) (S1 ('MetaSel ('Just "credentialsParameter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newRepositoryCredentials Source #

Create a value of RepositoryCredentials with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:credentialsParameter:RepositoryCredentials', repositoryCredentials_credentialsParameter - The Amazon Resource Name (ARN) of the secret containing the private repository credentials.

When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN of the secret.

repositoryCredentials_credentialsParameter :: Lens' RepositoryCredentials Text Source #

The Amazon Resource Name (ARN) of the secret containing the private repository credentials.

When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN of the secret.

Resource

data Resource Source #

Describes the resources available for a container instance.

See: newResource smart constructor.

Constructors

Resource' 

Fields

  • doubleValue :: Maybe Double

    When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

  • integerValue :: Maybe Int

    When the integerValue type is set, the value of the resource must be an integer.

  • longValue :: Maybe Integer

    When the longValue type is set, the value of the resource must be an extended precision floating-point type.

  • name :: Maybe Text

    The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP, or a user-defined resource.

  • stringSetValue :: Maybe [Text]

    When the stringSetValue type is set, the value of the resource must be a string type.

  • type' :: Maybe Text

    The type of the resource. Valid values: INTEGER, DOUBLE, LONG, or STRINGSET.

Instances

Instances details
FromJSON Resource Source # 
Instance details

Defined in Amazonka.ECS.Types.Resource

ToJSON Resource Source # 
Instance details

Defined in Amazonka.ECS.Types.Resource

Generic Resource Source # 
Instance details

Defined in Amazonka.ECS.Types.Resource

Associated Types

type Rep Resource :: Type -> Type #

Methods

from :: Resource -> Rep Resource x #

to :: Rep Resource x -> Resource #

Read Resource Source # 
Instance details

Defined in Amazonka.ECS.Types.Resource

Show Resource Source # 
Instance details

Defined in Amazonka.ECS.Types.Resource

NFData Resource Source # 
Instance details

Defined in Amazonka.ECS.Types.Resource

Methods

rnf :: Resource -> () #

Eq Resource Source # 
Instance details

Defined in Amazonka.ECS.Types.Resource

Hashable Resource Source # 
Instance details

Defined in Amazonka.ECS.Types.Resource

Methods

hashWithSalt :: Int -> Resource -> Int #

hash :: Resource -> Int #

type Rep Resource Source # 
Instance details

Defined in Amazonka.ECS.Types.Resource

newResource :: Resource Source #

Create a value of Resource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:doubleValue:Resource', resource_doubleValue - When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

$sel:integerValue:Resource', resource_integerValue - When the integerValue type is set, the value of the resource must be an integer.

$sel:longValue:Resource', resource_longValue - When the longValue type is set, the value of the resource must be an extended precision floating-point type.

$sel:name:Resource', resource_name - The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP, or a user-defined resource.

$sel:stringSetValue:Resource', resource_stringSetValue - When the stringSetValue type is set, the value of the resource must be a string type.

$sel:type':Resource', resource_type - The type of the resource. Valid values: INTEGER, DOUBLE, LONG, or STRINGSET.

resource_doubleValue :: Lens' Resource (Maybe Double) Source #

When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

resource_integerValue :: Lens' Resource (Maybe Int) Source #

When the integerValue type is set, the value of the resource must be an integer.

resource_longValue :: Lens' Resource (Maybe Integer) Source #

When the longValue type is set, the value of the resource must be an extended precision floating-point type.

resource_name :: Lens' Resource (Maybe Text) Source #

The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP, or a user-defined resource.

resource_stringSetValue :: Lens' Resource (Maybe [Text]) Source #

When the stringSetValue type is set, the value of the resource must be a string type.

resource_type :: Lens' Resource (Maybe Text) Source #

The type of the resource. Valid values: INTEGER, DOUBLE, LONG, or STRINGSET.

ResourceRequirement

data ResourceRequirement Source #

The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide

See: newResourceRequirement smart constructor.

Constructors

ResourceRequirement' 

Fields

  • value :: Text

    The value for the specified resource type.

    If the GPU type is used, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.

    If the InferenceAccelerator type is used, the value matches the deviceName for an InferenceAccelerator specified in a task definition.

  • type' :: ResourceType

    The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator.

Instances

Instances details
FromJSON ResourceRequirement Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceRequirement

ToJSON ResourceRequirement Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceRequirement

Generic ResourceRequirement Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceRequirement

Associated Types

type Rep ResourceRequirement :: Type -> Type #

Read ResourceRequirement Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceRequirement

Show ResourceRequirement Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceRequirement

NFData ResourceRequirement Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceRequirement

Methods

rnf :: ResourceRequirement -> () #

Eq ResourceRequirement Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceRequirement

Hashable ResourceRequirement Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceRequirement

type Rep ResourceRequirement Source # 
Instance details

Defined in Amazonka.ECS.Types.ResourceRequirement

type Rep ResourceRequirement = D1 ('MetaData "ResourceRequirement" "Amazonka.ECS.Types.ResourceRequirement" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ResourceRequirement'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceType)))

newResourceRequirement Source #

Create a value of ResourceRequirement with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:value:ResourceRequirement', resourceRequirement_value - The value for the specified resource type.

If the GPU type is used, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.

If the InferenceAccelerator type is used, the value matches the deviceName for an InferenceAccelerator specified in a task definition.

$sel:type':ResourceRequirement', resourceRequirement_type - The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator.

resourceRequirement_value :: Lens' ResourceRequirement Text Source #

The value for the specified resource type.

If the GPU type is used, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.

If the InferenceAccelerator type is used, the value matches the deviceName for an InferenceAccelerator specified in a task definition.

resourceRequirement_type :: Lens' ResourceRequirement ResourceType Source #

The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator.

RuntimePlatform

data RuntimePlatform Source #

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

For more information about RuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide.

See: newRuntimePlatform smart constructor.

Constructors

RuntimePlatform' 

Fields

Instances

Instances details
FromJSON RuntimePlatform Source # 
Instance details

Defined in Amazonka.ECS.Types.RuntimePlatform

ToJSON RuntimePlatform Source # 
Instance details

Defined in Amazonka.ECS.Types.RuntimePlatform

Generic RuntimePlatform Source # 
Instance details

Defined in Amazonka.ECS.Types.RuntimePlatform

Associated Types

type Rep RuntimePlatform :: Type -> Type #

Read RuntimePlatform Source # 
Instance details

Defined in Amazonka.ECS.Types.RuntimePlatform

Show RuntimePlatform Source # 
Instance details

Defined in Amazonka.ECS.Types.RuntimePlatform

NFData RuntimePlatform Source # 
Instance details

Defined in Amazonka.ECS.Types.RuntimePlatform

Methods

rnf :: RuntimePlatform -> () #

Eq RuntimePlatform Source # 
Instance details

Defined in Amazonka.ECS.Types.RuntimePlatform

Hashable RuntimePlatform Source # 
Instance details

Defined in Amazonka.ECS.Types.RuntimePlatform

type Rep RuntimePlatform Source # 
Instance details

Defined in Amazonka.ECS.Types.RuntimePlatform

type Rep RuntimePlatform = D1 ('MetaData "RuntimePlatform" "Amazonka.ECS.Types.RuntimePlatform" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "RuntimePlatform'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cpuArchitecture") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CPUArchitecture)) :*: S1 ('MetaSel ('Just "operatingSystemFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OSFamily))))

newRuntimePlatform :: RuntimePlatform Source #

Create a value of RuntimePlatform with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cpuArchitecture:RuntimePlatform', runtimePlatform_cpuArchitecture - The CPU architecture.

You can run your Linux tasks on an ARM-based platform by setting the value to ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate.

$sel:operatingSystemFamily:RuntimePlatform', runtimePlatform_operatingSystemFamily - The operating system.

runtimePlatform_cpuArchitecture :: Lens' RuntimePlatform (Maybe CPUArchitecture) Source #

The CPU architecture.

You can run your Linux tasks on an ARM-based platform by setting the value to ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate.

Scale

data Scale Source #

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

See: newScale smart constructor.

Constructors

Scale' 

Fields

  • unit :: Maybe ScaleUnit

    The unit of measure for the scale value.

  • value :: Maybe Double

    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.

Instances

Instances details
FromJSON Scale Source # 
Instance details

Defined in Amazonka.ECS.Types.Scale

ToJSON Scale Source # 
Instance details

Defined in Amazonka.ECS.Types.Scale

Generic Scale Source # 
Instance details

Defined in Amazonka.ECS.Types.Scale

Associated Types

type Rep Scale :: Type -> Type #

Methods

from :: Scale -> Rep Scale x #

to :: Rep Scale x -> Scale #

Read Scale Source # 
Instance details

Defined in Amazonka.ECS.Types.Scale

Show Scale Source # 
Instance details

Defined in Amazonka.ECS.Types.Scale

Methods

showsPrec :: Int -> Scale -> ShowS #

show :: Scale -> String #

showList :: [Scale] -> ShowS #

NFData Scale Source # 
Instance details

Defined in Amazonka.ECS.Types.Scale

Methods

rnf :: Scale -> () #

Eq Scale Source # 
Instance details

Defined in Amazonka.ECS.Types.Scale

Methods

(==) :: Scale -> Scale -> Bool #

(/=) :: Scale -> Scale -> Bool #

Hashable Scale Source # 
Instance details

Defined in Amazonka.ECS.Types.Scale

Methods

hashWithSalt :: Int -> Scale -> Int #

hash :: Scale -> Int #

type Rep Scale Source # 
Instance details

Defined in Amazonka.ECS.Types.Scale

type Rep Scale = D1 ('MetaData "Scale" "Amazonka.ECS.Types.Scale" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Scale'" 'PrefixI 'True) (S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScaleUnit)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))

newScale :: Scale Source #

Create a value of Scale with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:unit:Scale', scale_unit - The unit of measure for the scale value.

$sel:value:Scale', scale_value - The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100.

scale_unit :: Lens' Scale (Maybe ScaleUnit) Source #

The unit of measure for the scale value.

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

data Secret Source #

An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:

  • To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
  • To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.

For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.

See: newSecret smart constructor.

Constructors

Secret' 

Fields

  • name :: Text

    The name of the secret.

  • valueFrom :: Text

    The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.

    For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the /Amazon Elastic Container Service Developer Guide/.

    If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

Instances

Instances details
FromJSON Secret Source # 
Instance details

Defined in Amazonka.ECS.Types.Secret

ToJSON Secret Source # 
Instance details

Defined in Amazonka.ECS.Types.Secret

Generic Secret Source # 
Instance details

Defined in Amazonka.ECS.Types.Secret

Associated Types

type Rep Secret :: Type -> Type #

Methods

from :: Secret -> Rep Secret x #

to :: Rep Secret x -> Secret #

Read Secret Source # 
Instance details

Defined in Amazonka.ECS.Types.Secret

Show Secret Source # 
Instance details

Defined in Amazonka.ECS.Types.Secret

NFData Secret Source # 
Instance details

Defined in Amazonka.ECS.Types.Secret

Methods

rnf :: Secret -> () #

Eq Secret Source # 
Instance details

Defined in Amazonka.ECS.Types.Secret

Methods

(==) :: Secret -> Secret -> Bool #

(/=) :: Secret -> Secret -> Bool #

Hashable Secret Source # 
Instance details

Defined in Amazonka.ECS.Types.Secret

Methods

hashWithSalt :: Int -> Secret -> Int #

hash :: Secret -> Int #

type Rep Secret Source # 
Instance details

Defined in Amazonka.ECS.Types.Secret

type Rep Secret = D1 ('MetaData "Secret" "Amazonka.ECS.Types.Secret" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Secret'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "valueFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSecret Source #

Create a value of Secret with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:Secret', secret_name - The name of the secret.

$sel:valueFrom:Secret', secret_valueFrom - The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.

For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the /Amazon Elastic Container Service Developer Guide/.

If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

secret_name :: Lens' Secret Text Source #

The name of the 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.

For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the /Amazon Elastic Container Service Developer Guide/.

If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

ServiceConnectClientAlias

data ServiceConnectClientAlias Source #

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

Each name and port mapping must be unique within the namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

See: newServiceConnectClientAlias smart constructor.

Constructors

ServiceConnectClientAlias' 

Fields

  • dnsName :: Maybe Text

    The dnsName is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.

    If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

    To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are database, db, or the lowercase name of a database, such as mysql or redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

  • port :: Natural

    The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.

    To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

Instances

Instances details
FromJSON ServiceConnectClientAlias Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectClientAlias

ToJSON ServiceConnectClientAlias Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectClientAlias

Generic ServiceConnectClientAlias Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectClientAlias

Associated Types

type Rep ServiceConnectClientAlias :: Type -> Type #

Read ServiceConnectClientAlias Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectClientAlias

Show ServiceConnectClientAlias Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectClientAlias

NFData ServiceConnectClientAlias Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectClientAlias

Eq ServiceConnectClientAlias Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectClientAlias

Hashable ServiceConnectClientAlias Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectClientAlias

type Rep ServiceConnectClientAlias Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectClientAlias

type Rep ServiceConnectClientAlias = D1 ('MetaData "ServiceConnectClientAlias" "Amazonka.ECS.Types.ServiceConnectClientAlias" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ServiceConnectClientAlias'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dnsName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))

newServiceConnectClientAlias Source #

Create a value of ServiceConnectClientAlias with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dnsName:ServiceConnectClientAlias', serviceConnectClientAlias_dnsName - The dnsName is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.

If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are database, db, or the lowercase name of a database, such as mysql or redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

$sel:port:ServiceConnectClientAlias', serviceConnectClientAlias_port - The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.

To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

serviceConnectClientAlias_dnsName :: Lens' ServiceConnectClientAlias (Maybe Text) Source #

The dnsName is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.

If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are database, db, or the lowercase name of a database, such as mysql or redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

serviceConnectClientAlias_port :: Lens' ServiceConnectClientAlias Natural Source #

The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.

To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

ServiceConnectConfiguration

data ServiceConnectConfiguration Source #

The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

See: newServiceConnectConfiguration smart constructor.

Constructors

ServiceConnectConfiguration' 

Fields

  • logConfiguration :: Maybe LogConfiguration
     
  • namespace :: Maybe Text

    The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the /Cloud Map Developer Guide/.

  • services :: Maybe [ServiceConnectService]

    The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.

    This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.

    An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.

  • enabled :: Bool

    Specifies whether to use Service Connect with this service.

Instances

Instances details
FromJSON ServiceConnectConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectConfiguration

ToJSON ServiceConnectConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectConfiguration

Generic ServiceConnectConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectConfiguration

Associated Types

type Rep ServiceConnectConfiguration :: Type -> Type #

Read ServiceConnectConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectConfiguration

Show ServiceConnectConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectConfiguration

NFData ServiceConnectConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectConfiguration

Eq ServiceConnectConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectConfiguration

Hashable ServiceConnectConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectConfiguration

type Rep ServiceConnectConfiguration Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectConfiguration

type Rep ServiceConnectConfiguration = D1 ('MetaData "ServiceConnectConfiguration" "Amazonka.ECS.Types.ServiceConnectConfiguration" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ServiceConnectConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "logConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogConfiguration)) :*: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "services") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ServiceConnectService])) :*: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))

newServiceConnectConfiguration Source #

Create a value of ServiceConnectConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:logConfiguration:ServiceConnectConfiguration', serviceConnectConfiguration_logConfiguration - Undocumented member.

$sel:namespace:ServiceConnectConfiguration', serviceConnectConfiguration_namespace - The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the /Cloud Map Developer Guide/.

$sel:services:ServiceConnectConfiguration', serviceConnectConfiguration_services - The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.

This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.

An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.

$sel:enabled:ServiceConnectConfiguration', serviceConnectConfiguration_enabled - Specifies whether to use Service Connect with this service.

serviceConnectConfiguration_namespace :: Lens' ServiceConnectConfiguration (Maybe Text) Source #

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the /Cloud Map Developer Guide/.

serviceConnectConfiguration_services :: Lens' ServiceConnectConfiguration (Maybe [ServiceConnectService]) Source #

The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.

This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.

An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.

serviceConnectConfiguration_enabled :: Lens' ServiceConnectConfiguration Bool Source #

Specifies whether to use Service Connect with this service.

ServiceConnectService

data ServiceConnectService Source #

The Service Connect service object configuration. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

See: newServiceConnectService smart constructor.

Constructors

ServiceConnectService' 

Fields

  • clientAliases :: Maybe [ServiceConnectClientAlias]

    The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.

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

    Each name and port mapping must be unique within the namespace.

    For each ServiceConnectService, you must provide at least one clientAlias with one port.

  • discoveryName :: Maybe Text

    The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

    If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

  • ingressPortOverride :: Maybe Natural

    The port number for the Service Connect proxy to listen on.

    Use the value of this field to bypass the proxy for traffic on the port number specified in the named portMapping in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.

    In awsvpc mode and Fargate, the default value is the container port number. The container port number is in the portMapping in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.

  • portName :: Text

    The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.

Instances

Instances details
FromJSON ServiceConnectService Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectService

ToJSON ServiceConnectService Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectService

Generic ServiceConnectService Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectService

Associated Types

type Rep ServiceConnectService :: Type -> Type #

Read ServiceConnectService Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectService

Show ServiceConnectService Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectService

NFData ServiceConnectService Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectService

Methods

rnf :: ServiceConnectService -> () #

Eq ServiceConnectService Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectService

Hashable ServiceConnectService Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectService

type Rep ServiceConnectService Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectService

type Rep ServiceConnectService = D1 ('MetaData "ServiceConnectService" "Amazonka.ECS.Types.ServiceConnectService" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ServiceConnectService'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientAliases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ServiceConnectClientAlias])) :*: S1 ('MetaSel ('Just "discoveryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "ingressPortOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "portName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newServiceConnectService Source #

Create a value of ServiceConnectService with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientAliases:ServiceConnectService', serviceConnectService_clientAliases - The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.

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

Each name and port mapping must be unique within the namespace.

For each ServiceConnectService, you must provide at least one clientAlias with one port.

$sel:discoveryName:ServiceConnectService', serviceConnectService_discoveryName - The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

$sel:ingressPortOverride:ServiceConnectService', serviceConnectService_ingressPortOverride - The port number for the Service Connect proxy to listen on.

Use the value of this field to bypass the proxy for traffic on the port number specified in the named portMapping in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.

In awsvpc mode and Fargate, the default value is the container port number. The container port number is in the portMapping in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.

$sel:portName:ServiceConnectService', serviceConnectService_portName - The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.

serviceConnectService_clientAliases :: Lens' ServiceConnectService (Maybe [ServiceConnectClientAlias]) Source #

The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.

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

Each name and port mapping must be unique within the namespace.

For each ServiceConnectService, you must provide at least one clientAlias with one port.

serviceConnectService_discoveryName :: Lens' ServiceConnectService (Maybe Text) Source #

The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

serviceConnectService_ingressPortOverride :: Lens' ServiceConnectService (Maybe Natural) Source #

The port number for the Service Connect proxy to listen on.

Use the value of this field to bypass the proxy for traffic on the port number specified in the named portMapping in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.

In awsvpc mode and Fargate, the default value is the container port number. The container port number is in the portMapping in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.

serviceConnectService_portName :: Lens' ServiceConnectService Text Source #

The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.

ServiceConnectServiceResource

data ServiceConnectServiceResource Source #

The Service Connect resource. Each configuration maps a discovery name to a Cloud Map service name. The data is stored in Cloud Map as part of the Service Connect configuration for each discovery name of this Amazon ECS service.

A task can resolve the dnsName for each of the clientAliases of a service. However a task can't resolve the discovery names. If you want to connect to a service, refer to the ServiceConnectConfiguration of that service for the list of clientAliases that you can use.

See: newServiceConnectServiceResource smart constructor.

Constructors

ServiceConnectServiceResource' 

Fields

  • discoveryArn :: Maybe Text

    The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name for this Service Connect resource. You can use this ARN in other integrations with Cloud Map. However, Service Connect can't ensure connectivity outside of Amazon ECS.

  • discoveryName :: Maybe Text

    The discovery name of this Service Connect resource.

    The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

    If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

Instances

Instances details
FromJSON ServiceConnectServiceResource Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectServiceResource

Generic ServiceConnectServiceResource Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectServiceResource

Associated Types

type Rep ServiceConnectServiceResource :: Type -> Type #

Read ServiceConnectServiceResource Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectServiceResource

Show ServiceConnectServiceResource Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectServiceResource

NFData ServiceConnectServiceResource Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectServiceResource

Eq ServiceConnectServiceResource Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectServiceResource

Hashable ServiceConnectServiceResource Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectServiceResource

type Rep ServiceConnectServiceResource Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceConnectServiceResource

type Rep ServiceConnectServiceResource = D1 ('MetaData "ServiceConnectServiceResource" "Amazonka.ECS.Types.ServiceConnectServiceResource" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ServiceConnectServiceResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "discoveryArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "discoveryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newServiceConnectServiceResource :: ServiceConnectServiceResource Source #

Create a value of ServiceConnectServiceResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:discoveryArn:ServiceConnectServiceResource', serviceConnectServiceResource_discoveryArn - The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name for this Service Connect resource. You can use this ARN in other integrations with Cloud Map. However, Service Connect can't ensure connectivity outside of Amazon ECS.

$sel:discoveryName:ServiceConnectServiceResource', serviceConnectServiceResource_discoveryName - The discovery name of this Service Connect resource.

The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

serviceConnectServiceResource_discoveryArn :: Lens' ServiceConnectServiceResource (Maybe Text) Source #

The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name for this Service Connect resource. You can use this ARN in other integrations with Cloud Map. However, Service Connect can't ensure connectivity outside of Amazon ECS.

serviceConnectServiceResource_discoveryName :: Lens' ServiceConnectServiceResource (Maybe Text) Source #

The discovery name of this Service Connect resource.

The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

ServiceEvent

data ServiceEvent Source #

The details for an event that's associated with a service.

See: newServiceEvent smart constructor.

Constructors

ServiceEvent' 

Fields

Instances

Instances details
FromJSON ServiceEvent Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceEvent

Generic ServiceEvent Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceEvent

Associated Types

type Rep ServiceEvent :: Type -> Type #

Read ServiceEvent Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceEvent

Show ServiceEvent Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceEvent

NFData ServiceEvent Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceEvent

Methods

rnf :: ServiceEvent -> () #

Eq ServiceEvent Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceEvent

Hashable ServiceEvent Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceEvent

type Rep ServiceEvent Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceEvent

type Rep ServiceEvent = D1 ('MetaData "ServiceEvent" "Amazonka.ECS.Types.ServiceEvent" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ServiceEvent'" 'PrefixI 'True) (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newServiceEvent :: ServiceEvent Source #

Create a value of ServiceEvent with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createdAt:ServiceEvent', serviceEvent_createdAt - The Unix timestamp for the time when the event was triggered.

$sel:id:ServiceEvent', serviceEvent_id - The ID string for the event.

$sel:message:ServiceEvent', serviceEvent_message - The event message.

serviceEvent_createdAt :: Lens' ServiceEvent (Maybe UTCTime) Source #

The Unix timestamp for the time when the event was triggered.

serviceEvent_id :: Lens' ServiceEvent (Maybe Text) Source #

The ID string for the event.

ServiceRegistry

data ServiceRegistry Source #

The details for the service registry.

Each service may be associated with one service registry. Multiple service registries for each service are not supported.

When you add, update, or remove the service registries configuration, Amazon ECS starts a new deployment. New tasks are registered and deregistered to the updated service registry configuration.

See: newServiceRegistry smart constructor.

Constructors

ServiceRegistry' 

Fields

  • containerName :: Maybe Text

    The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

  • containerPort :: Maybe Int

    The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

  • port :: Maybe Int

    The port value used if your service discovery service specified an SRV record. This field might be used if both the awsvpc network mode and SRV records are used.

  • registryArn :: Maybe Text

    The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.

Instances

Instances details
FromJSON ServiceRegistry Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceRegistry

ToJSON ServiceRegistry Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceRegistry

Generic ServiceRegistry Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceRegistry

Associated Types

type Rep ServiceRegistry :: Type -> Type #

Read ServiceRegistry Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceRegistry

Show ServiceRegistry Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceRegistry

NFData ServiceRegistry Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceRegistry

Methods

rnf :: ServiceRegistry -> () #

Eq ServiceRegistry Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceRegistry

Hashable ServiceRegistry Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceRegistry

type Rep ServiceRegistry Source # 
Instance details

Defined in Amazonka.ECS.Types.ServiceRegistry

type Rep ServiceRegistry = D1 ('MetaData "ServiceRegistry" "Amazonka.ECS.Types.ServiceRegistry" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ServiceRegistry'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "containerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "containerPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "registryArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newServiceRegistry :: ServiceRegistry Source #

Create a value of ServiceRegistry with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containerName:ServiceRegistry', serviceRegistry_containerName - The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

$sel:containerPort:ServiceRegistry', serviceRegistry_containerPort - The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

$sel:port:ServiceRegistry', serviceRegistry_port - The port value used if your service discovery service specified an SRV record. This field might be used if both the awsvpc network mode and SRV records are used.

$sel:registryArn:ServiceRegistry', serviceRegistry_registryArn - The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.

serviceRegistry_containerName :: Lens' ServiceRegistry (Maybe Text) Source #

The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

serviceRegistry_containerPort :: Lens' ServiceRegistry (Maybe Int) Source #

The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

serviceRegistry_port :: Lens' ServiceRegistry (Maybe Int) Source #

The port value used if your service discovery service specified an SRV record. This field might be used if both the awsvpc network mode and SRV records are used.

serviceRegistry_registryArn :: Lens' ServiceRegistry (Maybe Text) Source #

The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.

Session

data Session Source #

The details for the execute command session.

See: newSession smart constructor.

Constructors

Session' 

Fields

  • sessionId :: Maybe Text

    The ID of the execute command session.

  • streamUrl :: Maybe Text

    A URL to the managed agent on the container that the SSM Session Manager client uses to send commands and receive output from the container.

  • tokenValue :: Maybe (Sensitive Text)

    An encrypted token value containing session and caller information. It's used to authenticate the connection to the container.

Instances

Instances details
FromJSON Session Source # 
Instance details

Defined in Amazonka.ECS.Types.Session

Generic Session Source # 
Instance details

Defined in Amazonka.ECS.Types.Session

Associated Types

type Rep Session :: Type -> Type #

Methods

from :: Session -> Rep Session x #

to :: Rep Session x -> Session #

Show Session Source # 
Instance details

Defined in Amazonka.ECS.Types.Session

NFData Session Source # 
Instance details

Defined in Amazonka.ECS.Types.Session

Methods

rnf :: Session -> () #

Eq Session Source # 
Instance details

Defined in Amazonka.ECS.Types.Session

Methods

(==) :: Session -> Session -> Bool #

(/=) :: Session -> Session -> Bool #

Hashable Session Source # 
Instance details

Defined in Amazonka.ECS.Types.Session

Methods

hashWithSalt :: Int -> Session -> Int #

hash :: Session -> Int #

type Rep Session Source # 
Instance details

Defined in Amazonka.ECS.Types.Session

type Rep Session = D1 ('MetaData "Session" "Amazonka.ECS.Types.Session" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Session'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "streamUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tokenValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))))

newSession :: Session Source #

Create a value of Session with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sessionId:Session', session_sessionId - The ID of the execute command session.

$sel:streamUrl:Session', session_streamUrl - A URL to the managed agent on the container that the SSM Session Manager client uses to send commands and receive output from the container.

$sel:tokenValue:Session', session_tokenValue - An encrypted token value containing session and caller information. It's used to authenticate the connection to the container.

session_sessionId :: Lens' Session (Maybe Text) Source #

The ID of the execute command session.

session_streamUrl :: Lens' Session (Maybe Text) Source #

A URL to the managed agent on the container that the SSM Session Manager client uses to send commands and receive output from the container.

session_tokenValue :: Lens' Session (Maybe Text) Source #

An encrypted token value containing session and caller information. It's used to authenticate the connection to the container.

Setting

data Setting Source #

The current account setting for a resource.

See: newSetting smart constructor.

Constructors

Setting' 

Fields

  • name :: Maybe SettingName

    The Amazon ECS resource name.

  • principalArn :: Maybe Text

    The ARN of the principal. It can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.

  • value :: Maybe Text

    Determines whether the account setting is enabled or disabled for the specified resource.

Instances

Instances details
FromJSON Setting Source # 
Instance details

Defined in Amazonka.ECS.Types.Setting

Generic Setting Source # 
Instance details

Defined in Amazonka.ECS.Types.Setting

Associated Types

type Rep Setting :: Type -> Type #

Methods

from :: Setting -> Rep Setting x #

to :: Rep Setting x -> Setting #

Read Setting Source # 
Instance details

Defined in Amazonka.ECS.Types.Setting

Show Setting Source # 
Instance details

Defined in Amazonka.ECS.Types.Setting

NFData Setting Source # 
Instance details

Defined in Amazonka.ECS.Types.Setting

Methods

rnf :: Setting -> () #

Eq Setting Source # 
Instance details

Defined in Amazonka.ECS.Types.Setting

Methods

(==) :: Setting -> Setting -> Bool #

(/=) :: Setting -> Setting -> Bool #

Hashable Setting Source # 
Instance details

Defined in Amazonka.ECS.Types.Setting

Methods

hashWithSalt :: Int -> Setting -> Int #

hash :: Setting -> Int #

type Rep Setting Source # 
Instance details

Defined in Amazonka.ECS.Types.Setting

type Rep Setting = D1 ('MetaData "Setting" "Amazonka.ECS.Types.Setting" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Setting'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SettingName)) :*: (S1 ('MetaSel ('Just "principalArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newSetting :: Setting Source #

Create a value of Setting with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:Setting', setting_name - The Amazon ECS resource name.

$sel:principalArn:Setting', setting_principalArn - The ARN of the principal. It can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.

$sel:value:Setting', setting_value - Determines whether the account setting is enabled or disabled for the specified resource.

setting_name :: Lens' Setting (Maybe SettingName) Source #

The Amazon ECS resource name.

setting_principalArn :: Lens' Setting (Maybe Text) Source #

The ARN of the principal. It can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.

setting_value :: Lens' Setting (Maybe Text) Source #

Determines whether the account setting is enabled or disabled for the specified resource.

SystemControl

data SystemControl Source #

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.

We don't recommend that you specify network-related systemControls parameters for multiple containers in a single task. This task also uses either the awsvpc or host network mode. It does it for the following reasons.

  • For tasks that use the awsvpc network mode, if you set systemControls for any container, it applies to all containers in the task. If you set different systemControls for multiple containers in a single task, the container that's started last determines which systemControls take effect.
  • For tasks that use the host network mode, the systemControls parameter applies to the container instance's kernel parameter and that of all containers of any tasks running on that container instance.

See: newSystemControl smart constructor.

Constructors

SystemControl' 

Fields

  • namespace :: Maybe Text

    The namespaced kernel parameter to set a value for.

  • value :: Maybe Text

    The value for the namespaced kernel parameter that's specified in namespace.

Instances

Instances details
FromJSON SystemControl Source # 
Instance details

Defined in Amazonka.ECS.Types.SystemControl

ToJSON SystemControl Source # 
Instance details

Defined in Amazonka.ECS.Types.SystemControl

Generic SystemControl Source # 
Instance details

Defined in Amazonka.ECS.Types.SystemControl

Associated Types

type Rep SystemControl :: Type -> Type #

Read SystemControl Source # 
Instance details

Defined in Amazonka.ECS.Types.SystemControl

Show SystemControl Source # 
Instance details

Defined in Amazonka.ECS.Types.SystemControl

NFData SystemControl Source # 
Instance details

Defined in Amazonka.ECS.Types.SystemControl

Methods

rnf :: SystemControl -> () #

Eq SystemControl Source # 
Instance details

Defined in Amazonka.ECS.Types.SystemControl

Hashable SystemControl Source # 
Instance details

Defined in Amazonka.ECS.Types.SystemControl

type Rep SystemControl Source # 
Instance details

Defined in Amazonka.ECS.Types.SystemControl

type Rep SystemControl = D1 ('MetaData "SystemControl" "Amazonka.ECS.Types.SystemControl" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "SystemControl'" 'PrefixI 'True) (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newSystemControl :: SystemControl Source #

Create a value of SystemControl with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:namespace:SystemControl', systemControl_namespace - The namespaced kernel parameter to set a value for.

$sel:value:SystemControl', systemControl_value - The value for the namespaced kernel parameter that's specified in namespace.

systemControl_namespace :: Lens' SystemControl (Maybe Text) Source #

The namespaced kernel parameter to set a value for.

systemControl_value :: Lens' SystemControl (Maybe Text) Source #

The value for the namespaced kernel parameter that's specified in namespace.

Tag

data Tag Source #

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8
  • Maximum value length - 256 Unicode characters in UTF-8
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case-sensitive.
  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

See: newTag smart constructor.

Constructors

Tag' 

Fields

  • key :: Maybe Text

    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.

  • value :: Maybe Text

    The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Instances

Instances details
FromJSON Tag Source # 
Instance details

Defined in Amazonka.ECS.Types.Tag

ToJSON Tag Source # 
Instance details

Defined in Amazonka.ECS.Types.Tag

Generic Tag Source # 
Instance details

Defined in Amazonka.ECS.Types.Tag

Associated Types

type Rep Tag :: Type -> Type #

Methods

from :: Tag -> Rep Tag x #

to :: Rep Tag x -> Tag #

Read Tag Source # 
Instance details

Defined in Amazonka.ECS.Types.Tag

Show Tag Source # 
Instance details

Defined in Amazonka.ECS.Types.Tag

Methods

showsPrec :: Int -> Tag -> ShowS #

show :: Tag -> String #

showList :: [Tag] -> ShowS #

NFData Tag Source # 
Instance details

Defined in Amazonka.ECS.Types.Tag

Methods

rnf :: Tag -> () #

Eq Tag Source # 
Instance details

Defined in Amazonka.ECS.Types.Tag

Methods

(==) :: Tag -> Tag -> Bool #

(/=) :: Tag -> Tag -> Bool #

Hashable Tag Source # 
Instance details

Defined in Amazonka.ECS.Types.Tag

Methods

hashWithSalt :: Int -> Tag -> Int #

hash :: Tag -> Int #

type Rep Tag Source # 
Instance details

Defined in Amazonka.ECS.Types.Tag

type Rep Tag = D1 ('MetaData "Tag" "Amazonka.ECS.Types.Tag" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newTag :: Tag Source #

Create a value of Tag with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:key:Tag', tag_key - One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

$sel:value:Tag', tag_value - The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

tag_key :: Lens' Tag (Maybe Text) Source #

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

tag_value :: Lens' Tag (Maybe Text) Source #

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Task

data Task Source #

Details on a task in a cluster.

See: newTask smart constructor.

Constructors

Task' 

Fields

  • attachments :: Maybe [Attachment]

    The Elastic Network Adapter that's associated with the task if the task uses the awsvpc network mode.

  • attributes :: Maybe [Attribute]

    The attributes of the task

  • availabilityZone :: Maybe Text

    The Availability Zone for the task.

  • capacityProviderName :: Maybe Text

    The capacity provider that's associated with the task.

  • clusterArn :: Maybe Text

    The ARN of the cluster that hosts the task.

  • connectivity :: Maybe Connectivity

    The connectivity status of a task.

  • connectivityAt :: Maybe POSIX

    The Unix timestamp for the time when the task last went into CONNECTED status.

  • containerInstanceArn :: Maybe Text

    The ARN of the container instances that host the task.

  • containers :: Maybe [Container]

    The containers that's associated with the task.

  • cpu :: Maybe Text

    The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units (for example, 1024). It can also be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu). String values are converted to an integer that indicates the CPU units when the task definition is registered.

    If you use the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).

    If you use the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported values for the memory parameter:

    The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

    • 256 (.25 vCPU) - Available 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: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
    • 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
    • 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments

      This option requires Linux platform 1.4.0 or later.

    • 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments

      This option requires Linux platform 1.4.0 or later.

  • createdAt :: Maybe POSIX

    The Unix timestamp for the time when the task was created. More specifically, it's for the time when the task entered the PENDING state.

  • desiredStatus :: Maybe Text

    The desired status of the task. For more information, see Task Lifecycle.

  • enableExecuteCommand :: Maybe Bool

    Determines whether execute command functionality is enabled for this task. If true, execute command functionality is enabled on all the containers in the task.

  • ephemeralStorage :: Maybe EphemeralStorage

    The ephemeral storage settings for the task.

  • executionStoppedAt :: Maybe POSIX

    The Unix timestamp for the time when the task execution stopped.

  • group' :: Maybe Text

    The name of the task group that's associated with the task.

  • healthStatus :: Maybe HealthStatus

    The health status for the task. It's determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, the task status also reports as UNHEALTHY or UNKNOWN.

    The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.

  • inferenceAccelerators :: Maybe [InferenceAccelerator]

    The Elastic Inference accelerator that's associated with the task.

  • lastStatus :: Maybe Text

    The last known status for the task. For more information, see Task Lifecycle.

  • launchType :: Maybe LaunchType

    The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

  • memory :: Maybe Text

    The amount of memory (in MiB) that the task uses as expressed in a task definition. It can be expressed as an integer using MiB (for example, 1024). If it's expressed as a string using GB (for example, 1GB or 1 GB), it's converted to an integer indicating the MiB when the task definition is registered.

    If you use the EC2 launch type, this field is optional.

    If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines the range of supported values for the cpu parameter.

    • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available 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)
    • Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

      This option requires Linux platform 1.4.0 or later.

    • Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

      This option requires Linux platform 1.4.0 or later.

  • overrides :: Maybe TaskOverride

    One or more container overrides.

  • platformFamily :: Maybe Text

    The operating system that your tasks are running on. A platform family is specified only for tasks that use the Fargate launch type.

    All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX.).

  • platformVersion :: Maybe Text

    The platform version where your task runs on. A platform version is only specified for tasks that use the Fargate launch type. If you didn't specify one, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

  • pullStartedAt :: Maybe POSIX

    The Unix timestamp for the time when the container image pull began.

  • pullStoppedAt :: Maybe POSIX

    The Unix timestamp for the time when the container image pull completed.

  • startedAt :: Maybe POSIX

    The Unix timestamp for the time when the task started. More specifically, it's for the time when the task transitioned from the PENDING state to the RUNNING state.

  • startedBy :: Maybe Text

    The tag specified when a task is started. If an Amazon ECS service started the task, the startedBy parameter contains the deployment ID of that service.

  • stopCode :: Maybe TaskStopCode

    The stop code indicating why a task was stopped. The stoppedReason might contain additional details.

    The following are valid values:

    • TaskFailedToStart
    • EssentialContainerExited
    • UserInitiated
    • TerminationNotice
    • ServiceSchedulerInitiated
    • SpotInterruption
  • stoppedAt :: Maybe POSIX

    The Unix timestamp for the time when the task was stopped. More specifically, it's for the time when the task transitioned from the RUNNING state to the STOPPED state.

  • stoppedReason :: Maybe Text

    The reason that the task was stopped.

  • stoppingAt :: Maybe POSIX

    The Unix timestamp for the time when the task stops. More specifically, it's for the time when the task transitions from the RUNNING state to STOPPED.

  • tags :: Maybe [Tag]

    The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.

    The following basic restrictions apply to tags:

    • Maximum number of tags per resource - 50
    • For each resource, each tag key must be unique, and each tag key can have only one value.
    • Maximum key length - 128 Unicode characters in UTF-8
    • Maximum value length - 256 Unicode characters in UTF-8
    • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    • Tag keys and values are case-sensitive.
    • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
  • taskArn :: Maybe Text

    The Amazon Resource Name (ARN) of the task.

  • taskDefinitionArn :: Maybe Text

    The ARN of the task definition that creates the task.

  • version :: Maybe Integer

    The version counter for the task. Every time a task experiences a change that starts a CloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.

Instances

Instances details
FromJSON Task Source # 
Instance details

Defined in Amazonka.ECS.Types.Task

Generic Task Source # 
Instance details

Defined in Amazonka.ECS.Types.Task

Associated Types

type Rep Task :: Type -> Type #

Methods

from :: Task -> Rep Task x #

to :: Rep Task x -> Task #

Read Task Source # 
Instance details

Defined in Amazonka.ECS.Types.Task

Show Task Source # 
Instance details

Defined in Amazonka.ECS.Types.Task

Methods

showsPrec :: Int -> Task -> ShowS #

show :: Task -> String #

showList :: [Task] -> ShowS #

NFData Task Source # 
Instance details

Defined in Amazonka.ECS.Types.Task

Methods

rnf :: Task -> () #

Eq Task Source # 
Instance details

Defined in Amazonka.ECS.Types.Task

Methods

(==) :: Task -> Task -> Bool #

(/=) :: Task -> Task -> Bool #

Hashable Task Source # 
Instance details

Defined in Amazonka.ECS.Types.Task

Methods

hashWithSalt :: Int -> Task -> Int #

hash :: Task -> Int #

type Rep Task Source # 
Instance details

Defined in Amazonka.ECS.Types.Task

type Rep Task = D1 ('MetaData "Task" "Amazonka.ECS.Types.Task" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Task'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "attachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Attachment])) :*: S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Attribute]))) :*: (S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "capacityProviderName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "connectivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Connectivity))) :*: (S1 ('MetaSel ('Just "connectivityAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "containerInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "containers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Container])))))) :*: (((S1 ('MetaSel ('Just "cpu") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "desiredStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "enableExecuteCommand") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "ephemeralStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EphemeralStorage)) :*: S1 ('MetaSel ('Just "executionStoppedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "group'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "healthStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HealthStatus)) :*: S1 ('MetaSel ('Just "inferenceAccelerators") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InferenceAccelerator]))))))) :*: ((((S1 ('MetaSel ('Just "lastStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "launchType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchType))) :*: (S1 ('MetaSel ('Just "memory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "overrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskOverride)))) :*: ((S1 ('MetaSel ('Just "platformFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "platformVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "pullStartedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "pullStoppedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))) :*: (((S1 ('MetaSel ('Just "startedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stopCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskStopCode))) :*: (S1 ('MetaSel ('Just "stoppedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "stoppedReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "stoppingAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "taskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "taskDefinitionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))))))

newTask :: Task Source #

Create a value of Task with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attachments:Task', task_attachments - The Elastic Network Adapter that's associated with the task if the task uses the awsvpc network mode.

$sel:attributes:Task', task_attributes - The attributes of the task

$sel:availabilityZone:Task', task_availabilityZone - The Availability Zone for the task.

$sel:capacityProviderName:Task', task_capacityProviderName - The capacity provider that's associated with the task.

$sel:clusterArn:Task', task_clusterArn - The ARN of the cluster that hosts the task.

$sel:connectivity:Task', task_connectivity - The connectivity status of a task.

$sel:connectivityAt:Task', task_connectivityAt - The Unix timestamp for the time when the task last went into CONNECTED status.

$sel:containerInstanceArn:Task', task_containerInstanceArn - The ARN of the container instances that host the task.

$sel:containers:Task', task_containers - The containers that's associated with the task.

Task, task_cpu - The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units (for example, 1024). It can also be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu). String values are converted to an integer that indicates the CPU units when the task definition is registered.

If you use the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).

If you use the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported values for the memory parameter:

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

  • 256 (.25 vCPU) - Available 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: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
  • 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
  • 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments

    This option requires Linux platform 1.4.0 or later.

  • 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments

    This option requires Linux platform 1.4.0 or later.

$sel:createdAt:Task', task_createdAt - The Unix timestamp for the time when the task was created. More specifically, it's for the time when the task entered the PENDING state.

$sel:desiredStatus:Task', task_desiredStatus - The desired status of the task. For more information, see Task Lifecycle.

$sel:enableExecuteCommand:Task', task_enableExecuteCommand - Determines whether execute command functionality is enabled for this task. If true, execute command functionality is enabled on all the containers in the task.

Task, task_ephemeralStorage - The ephemeral storage settings for the task.

$sel:executionStoppedAt:Task', task_executionStoppedAt - The Unix timestamp for the time when the task execution stopped.

$sel:group':Task', task_group - The name of the task group that's associated with the task.

Task, task_healthStatus - The health status for the task. It's determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, the task status also reports as UNHEALTHY or UNKNOWN.

The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.

$sel:inferenceAccelerators:Task', task_inferenceAccelerators - The Elastic Inference accelerator that's associated with the task.

Task, task_lastStatus - The last known status for the task. For more information, see Task Lifecycle.

$sel:launchType:Task', task_launchType - The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

Task, task_memory - The amount of memory (in MiB) that the task uses as expressed in a task definition. It can be expressed as an integer using MiB (for example, 1024). If it's expressed as a string using GB (for example, 1GB or 1 GB), it's converted to an integer indicating the MiB when the task definition is registered.

If you use the EC2 launch type, this field is optional.

If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines the range of supported values for the cpu parameter.

  • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available 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)
  • Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

    This option requires Linux platform 1.4.0 or later.

  • Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

    This option requires Linux platform 1.4.0 or later.

$sel:overrides:Task', task_overrides - One or more container overrides.

$sel:platformFamily:Task', task_platformFamily - The operating system that your tasks are running on. A platform family is specified only for tasks that use the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX.).

$sel:platformVersion:Task', task_platformVersion - The platform version where your task runs on. A platform version is only specified for tasks that use the Fargate launch type. If you didn't specify one, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

$sel:pullStartedAt:Task', task_pullStartedAt - The Unix timestamp for the time when the container image pull began.

$sel:pullStoppedAt:Task', task_pullStoppedAt - The Unix timestamp for the time when the container image pull completed.

$sel:startedAt:Task', task_startedAt - The Unix timestamp for the time when the task started. More specifically, it's for the time when the task transitioned from the PENDING state to the RUNNING state.

$sel:startedBy:Task', task_startedBy - The tag specified when a task is started. If an Amazon ECS service started the task, the startedBy parameter contains the deployment ID of that service.

$sel:stopCode:Task', task_stopCode - The stop code indicating why a task was stopped. The stoppedReason might contain additional details.

The following are valid values:

  • TaskFailedToStart
  • EssentialContainerExited
  • UserInitiated
  • TerminationNotice
  • ServiceSchedulerInitiated
  • SpotInterruption

$sel:stoppedAt:Task', task_stoppedAt - The Unix timestamp for the time when the task was stopped. More specifically, it's for the time when the task transitioned from the RUNNING state to the STOPPED state.

$sel:stoppedReason:Task', task_stoppedReason - The reason that the task was stopped.

$sel:stoppingAt:Task', task_stoppingAt - The Unix timestamp for the time when the task stops. More specifically, it's for the time when the task transitions from the RUNNING state to STOPPED.

$sel:tags:Task', task_tags - The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8
  • Maximum value length - 256 Unicode characters in UTF-8
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case-sensitive.
  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Task, task_taskArn - The Amazon Resource Name (ARN) of the task.

$sel:taskDefinitionArn:Task', task_taskDefinitionArn - The ARN of the task definition that creates the task.

$sel:version:Task', task_version - The version counter for the task. Every time a task experiences a change that starts a CloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.

task_attachments :: Lens' Task (Maybe [Attachment]) Source #

The Elastic Network Adapter that's associated with the task if the task uses the awsvpc network mode.

task_attributes :: Lens' Task (Maybe [Attribute]) Source #

The attributes of the task

task_availabilityZone :: Lens' Task (Maybe Text) Source #

The Availability Zone for the task.

task_capacityProviderName :: Lens' Task (Maybe Text) Source #

The capacity provider that's associated with the task.

task_clusterArn :: Lens' Task (Maybe Text) Source #

The ARN of the cluster that hosts the task.

task_connectivity :: Lens' Task (Maybe Connectivity) Source #

The connectivity status of a task.

task_connectivityAt :: Lens' Task (Maybe UTCTime) Source #

The Unix timestamp for the time when the task last went into CONNECTED status.

task_containerInstanceArn :: Lens' Task (Maybe Text) Source #

The ARN of the container instances that host the task.

task_containers :: Lens' Task (Maybe [Container]) Source #

The containers that's associated with the task.

task_cpu :: Lens' Task (Maybe Text) Source #

The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units (for example, 1024). It can also be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu). String values are converted to an integer that indicates the CPU units when the task definition is registered.

If you use the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).

If you use the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported values for the memory parameter:

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

  • 256 (.25 vCPU) - Available 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: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
  • 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
  • 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments

    This option requires Linux platform 1.4.0 or later.

  • 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments

    This option requires Linux platform 1.4.0 or later.

task_createdAt :: Lens' Task (Maybe UTCTime) Source #

The Unix timestamp for the time when the task was created. More specifically, it's for the time when the task entered the PENDING state.

task_desiredStatus :: Lens' Task (Maybe Text) Source #

The desired status of the task. For more information, see Task Lifecycle.

task_enableExecuteCommand :: Lens' Task (Maybe Bool) Source #

Determines whether execute command functionality is enabled for this task. If true, execute command functionality is enabled on all the containers in the task.

task_ephemeralStorage :: Lens' Task (Maybe EphemeralStorage) Source #

The ephemeral storage settings for the task.

task_executionStoppedAt :: Lens' Task (Maybe UTCTime) Source #

The Unix timestamp for the time when the task execution stopped.

task_group :: Lens' Task (Maybe Text) Source #

The name of the task group that's associated with the task.

task_healthStatus :: Lens' Task (Maybe HealthStatus) Source #

The health status for the task. It's determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, the task status also reports as UNHEALTHY or UNKNOWN.

The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.

task_inferenceAccelerators :: Lens' Task (Maybe [InferenceAccelerator]) Source #

The Elastic Inference accelerator that's associated with the task.

task_lastStatus :: Lens' Task (Maybe Text) Source #

The last known status for the task. For more information, see Task Lifecycle.

task_launchType :: Lens' Task (Maybe LaunchType) Source #

The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

task_memory :: Lens' Task (Maybe Text) Source #

The amount of memory (in MiB) that the task uses as expressed in a task definition. It can be expressed as an integer using MiB (for example, 1024). If it's expressed as a string using GB (for example, 1GB or 1 GB), it's converted to an integer indicating the MiB when the task definition is registered.

If you use the EC2 launch type, this field is optional.

If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines the range of supported values for the cpu parameter.

  • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available 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)
  • Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

    This option requires Linux platform 1.4.0 or later.

  • Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

    This option requires Linux platform 1.4.0 or later.

task_overrides :: Lens' Task (Maybe TaskOverride) Source #

One or more container overrides.

task_platformFamily :: Lens' Task (Maybe Text) Source #

The operating system that your tasks are running on. A platform family is specified only for tasks that use the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX.).

task_platformVersion :: Lens' Task (Maybe Text) Source #

The platform version where your task runs on. A platform version is only specified for tasks that use the Fargate launch type. If you didn't specify one, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

task_pullStartedAt :: Lens' Task (Maybe UTCTime) Source #

The Unix timestamp for the time when the container image pull began.

task_pullStoppedAt :: Lens' Task (Maybe UTCTime) Source #

The Unix timestamp for the time when the container image pull completed.

task_startedAt :: Lens' Task (Maybe UTCTime) Source #

The Unix timestamp for the time when the task started. More specifically, it's for the time when the task transitioned from the PENDING state to the RUNNING state.

task_startedBy :: Lens' Task (Maybe Text) Source #

The tag specified when a task is started. If an Amazon ECS service started the task, the startedBy parameter contains the deployment ID of that service.

task_stopCode :: Lens' Task (Maybe TaskStopCode) Source #

The stop code indicating why a task was stopped. The stoppedReason might contain additional details.

The following are valid values:

  • TaskFailedToStart
  • EssentialContainerExited
  • UserInitiated
  • TerminationNotice
  • ServiceSchedulerInitiated
  • SpotInterruption

task_stoppedAt :: Lens' Task (Maybe UTCTime) Source #

The Unix timestamp for the time when the task was stopped. More specifically, it's for the time when the task transitioned from the RUNNING state to the STOPPED state.

task_stoppedReason :: Lens' Task (Maybe Text) Source #

The reason that the task was stopped.

task_stoppingAt :: Lens' Task (Maybe UTCTime) Source #

The Unix timestamp for the time when the task stops. More specifically, it's for the time when the task transitions from the RUNNING state to STOPPED.

task_tags :: Lens' Task (Maybe [Tag]) Source #

The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8
  • Maximum value length - 256 Unicode characters in UTF-8
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case-sensitive.
  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

task_taskArn :: Lens' Task (Maybe Text) Source #

The Amazon Resource Name (ARN) of the task.

task_taskDefinitionArn :: Lens' Task (Maybe Text) Source #

The ARN of the task definition that creates the task.

task_version :: Lens' Task (Maybe Integer) Source #

The version counter for the task. Every time a task experiences a change that starts a CloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.

TaskDefinition

data TaskDefinition Source #

The details of a task definition which describes the container and volume definitions of an Amazon Elastic Container Service task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.

See: newTaskDefinition smart constructor.

Constructors

TaskDefinition' 

Fields

  • compatibilities :: Maybe [Compatibility]

    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.

  • containerDefinitions :: Maybe [ContainerDefinition]

    A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

  • cpu :: Maybe Text

    The number of cpu units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the memory parameter.

    The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

    • 256 (.25 vCPU) - Available 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: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
    • 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
    • 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments

      This option requires Linux platform 1.4.0 or later.

    • 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments

      This option requires Linux platform 1.4.0 or later.

  • deregisteredAt :: Maybe POSIX

    The Unix timestamp for the time when the task definition was deregistered.

  • ephemeralStorage :: Maybe EphemeralStorage

    The ephemeral storage settings to use for tasks run with the task definition.

  • executionRoleArn :: Maybe Text

    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.

  • family :: Maybe Text

    The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and underscores (_) are allowed.

    A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.

  • inferenceAccelerators :: Maybe [InferenceAccelerator]

    The Elastic Inference accelerator that's associated with the task.

  • ipcMode :: Maybe IpcMode

    The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

    If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

    If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

    • For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
    • For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

    This parameter is not supported for Windows containers or tasks run on Fargate.

  • memory :: Maybe Text

    The amount (in MiB) of memory used by the task.

    If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.

    If your tasks runs on Fargate, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the cpu parameter.

    • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available 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)
    • Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

      This option requires Linux platform 1.4.0 or later.

    • Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

      This option requires Linux platform 1.4.0 or later.

  • networkMode :: Maybe NetworkMode

    The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.

    For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

    With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

    When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

    If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

    If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

    For more information, see Network settings in the Docker run reference.

  • pidMode :: Maybe PidMode

    The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.

    If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.

    This parameter is not supported for Windows containers or tasks run on Fargate.

  • placementConstraints :: Maybe [TaskDefinitionPlacementConstraint]

    An array of placement constraint objects to use for tasks.

    This parameter isn't supported for tasks run on Fargate.

  • proxyConfiguration :: Maybe ProxyConfiguration

    The configuration details for the App Mesh proxy.

    Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version 20190301 or later, they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

  • registeredAt :: Maybe POSIX

    The Unix timestamp for the time when the task definition was registered.

  • registeredBy :: Maybe Text

    The principal that registered the task definition.

  • requiresAttributes :: Maybe [Attribute]

    The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

    This parameter isn't supported for tasks run on Fargate.

  • requiresCompatibilities :: Maybe [Compatibility]

    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.

  • revision :: Maybe Int

    The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one. This is even if you deregistered previous revisions in this family.

  • runtimePlatform :: Maybe RuntimePlatform

    The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.

    When you specify a task in a service, this value must match the runtimePlatform value of the service.

  • status :: Maybe TaskDefinitionStatus

    The status of the task definition.

  • taskDefinitionArn :: Maybe Text

    The full Amazon Resource Name (ARN) of the task definition.

  • taskRoleArn :: Maybe Text

    The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide.

    IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see Windows IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

  • volumes :: Maybe [Volume]

    The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.

    The host and sourcePath parameters aren't supported for tasks run on Fargate.

Instances

Instances details
FromJSON TaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinition

Generic TaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinition

Associated Types

type Rep TaskDefinition :: Type -> Type #

Read TaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinition

Show TaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinition

NFData TaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinition

Methods

rnf :: TaskDefinition -> () #

Eq TaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinition

Hashable TaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinition

type Rep TaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinition

type Rep TaskDefinition = D1 ('MetaData "TaskDefinition" "Amazonka.ECS.Types.TaskDefinition" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "TaskDefinition'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "compatibilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Compatibility])) :*: (S1 ('MetaSel ('Just "containerDefinitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ContainerDefinition])) :*: S1 ('MetaSel ('Just "cpu") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "deregisteredAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "ephemeralStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EphemeralStorage)) :*: S1 ('MetaSel ('Just "executionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "family") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "inferenceAccelerators") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InferenceAccelerator])) :*: S1 ('MetaSel ('Just "ipcMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpcMode)))) :*: (S1 ('MetaSel ('Just "memory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "networkMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkMode)) :*: S1 ('MetaSel ('Just "pidMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PidMode)))))) :*: (((S1 ('MetaSel ('Just "placementConstraints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TaskDefinitionPlacementConstraint])) :*: (S1 ('MetaSel ('Just "proxyConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProxyConfiguration)) :*: S1 ('MetaSel ('Just "registeredAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "registeredBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "requiresAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Attribute])) :*: S1 ('MetaSel ('Just "requiresCompatibilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Compatibility]))))) :*: ((S1 ('MetaSel ('Just "revision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "runtimePlatform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuntimePlatform)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskDefinitionStatus)))) :*: (S1 ('MetaSel ('Just "taskDefinitionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "taskRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "volumes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Volume]))))))))

newTaskDefinition :: TaskDefinition Source #

Create a value of TaskDefinition with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:compatibilities:TaskDefinition', taskDefinition_compatibilities - The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

$sel:containerDefinitions:TaskDefinition', taskDefinition_containerDefinitions - A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

TaskDefinition, taskDefinition_cpu - The number of cpu units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the memory parameter.

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

  • 256 (.25 vCPU) - Available 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: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
  • 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
  • 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments

    This option requires Linux platform 1.4.0 or later.

  • 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments

    This option requires Linux platform 1.4.0 or later.

$sel:deregisteredAt:TaskDefinition', taskDefinition_deregisteredAt - The Unix timestamp for the time when the task definition was deregistered.

$sel:ephemeralStorage:TaskDefinition', taskDefinition_ephemeralStorage - The ephemeral storage settings to use for tasks run with the task definition.

$sel:executionRoleArn:TaskDefinition', taskDefinition_executionRoleArn - The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

$sel:family:TaskDefinition', taskDefinition_family - The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and underscores (_) are allowed.

A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.

$sel:inferenceAccelerators:TaskDefinition', taskDefinition_inferenceAccelerators - The Elastic Inference accelerator that's associated with the task.

$sel:ipcMode:TaskDefinition', taskDefinition_ipcMode - The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

  • For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
  • For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

This parameter is not supported for Windows containers or tasks run on Fargate.

TaskDefinition, taskDefinition_memory - The amount (in MiB) of memory used by the task.

If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.

If your tasks runs on Fargate, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the cpu parameter.

  • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available 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)
  • Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

    This option requires Linux platform 1.4.0 or later.

  • Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

    This option requires Linux platform 1.4.0 or later.

$sel:networkMode:TaskDefinition', taskDefinition_networkMode - The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.

For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

For more information, see Network settings in the Docker run reference.

$sel:pidMode:TaskDefinition', taskDefinition_pidMode - The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.

If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.

This parameter is not supported for Windows containers or tasks run on Fargate.

$sel:placementConstraints:TaskDefinition', taskDefinition_placementConstraints - An array of placement constraint objects to use for tasks.

This parameter isn't supported for tasks run on Fargate.

$sel:proxyConfiguration:TaskDefinition', taskDefinition_proxyConfiguration - The configuration details for the App Mesh proxy.

Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version 20190301 or later, they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

$sel:registeredAt:TaskDefinition', taskDefinition_registeredAt - The Unix timestamp for the time when the task definition was registered.

$sel:registeredBy:TaskDefinition', taskDefinition_registeredBy - The principal that registered the task definition.

$sel:requiresAttributes:TaskDefinition', taskDefinition_requiresAttributes - The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

This parameter isn't supported for tasks run on Fargate.

$sel:requiresCompatibilities:TaskDefinition', taskDefinition_requiresCompatibilities - The task launch types the task definition was validated against. To determine which task launch types the task definition is validated for, see the TaskDefinition$compatibilities parameter.

$sel:revision:TaskDefinition', taskDefinition_revision - The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one. This is even if you deregistered previous revisions in this family.

$sel:runtimePlatform:TaskDefinition', taskDefinition_runtimePlatform - The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.

When you specify a task in a service, this value must match the runtimePlatform value of the service.

$sel:status:TaskDefinition', taskDefinition_status - The status of the task definition.

$sel:taskDefinitionArn:TaskDefinition', taskDefinition_taskDefinitionArn - The full Amazon Resource Name (ARN) of the task definition.

$sel:taskRoleArn:TaskDefinition', taskDefinition_taskRoleArn - The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide.

IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see Windows IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

$sel:volumes:TaskDefinition', taskDefinition_volumes - The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.

The host and sourcePath parameters aren't supported for tasks run on Fargate.

taskDefinition_compatibilities :: Lens' TaskDefinition (Maybe [Compatibility]) Source #

The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

taskDefinition_containerDefinitions :: Lens' TaskDefinition (Maybe [ContainerDefinition]) Source #

A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

taskDefinition_cpu :: Lens' TaskDefinition (Maybe Text) Source #

The number of cpu units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the memory parameter.

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

  • 256 (.25 vCPU) - Available 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: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
  • 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
  • 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments

    This option requires Linux platform 1.4.0 or later.

  • 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments

    This option requires Linux platform 1.4.0 or later.

taskDefinition_deregisteredAt :: Lens' TaskDefinition (Maybe UTCTime) Source #

The Unix timestamp for the time when the task definition was deregistered.

taskDefinition_ephemeralStorage :: Lens' TaskDefinition (Maybe EphemeralStorage) Source #

The ephemeral storage settings to use for tasks run with the task definition.

taskDefinition_executionRoleArn :: Lens' TaskDefinition (Maybe Text) Source #

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

taskDefinition_family :: Lens' TaskDefinition (Maybe Text) Source #

The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and underscores (_) are allowed.

A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.

taskDefinition_inferenceAccelerators :: Lens' TaskDefinition (Maybe [InferenceAccelerator]) Source #

The Elastic Inference accelerator that's associated with the task.

taskDefinition_ipcMode :: Lens' TaskDefinition (Maybe IpcMode) Source #

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

  • For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
  • For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

This parameter is not supported for Windows containers or tasks run on Fargate.

taskDefinition_memory :: Lens' TaskDefinition (Maybe Text) Source #

The amount (in MiB) of memory used by the task.

If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.

If your tasks runs on Fargate, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the cpu parameter.

  • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available 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)
  • Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

    This option requires Linux platform 1.4.0 or later.

  • Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

    This option requires Linux platform 1.4.0 or later.

taskDefinition_networkMode :: Lens' TaskDefinition (Maybe NetworkMode) Source #

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.

For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

For more information, see Network settings in the Docker run reference.

taskDefinition_pidMode :: Lens' TaskDefinition (Maybe PidMode) Source #

The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.

If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.

This parameter is not supported for Windows containers or tasks run on Fargate.

taskDefinition_placementConstraints :: Lens' TaskDefinition (Maybe [TaskDefinitionPlacementConstraint]) Source #

An array of placement constraint objects to use for tasks.

This parameter isn't supported for tasks run on Fargate.

taskDefinition_proxyConfiguration :: Lens' TaskDefinition (Maybe ProxyConfiguration) Source #

The configuration details for the App Mesh proxy.

Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version 20190301 or later, they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

taskDefinition_registeredAt :: Lens' TaskDefinition (Maybe UTCTime) Source #

The Unix timestamp for the time when the task definition was registered.

taskDefinition_registeredBy :: Lens' TaskDefinition (Maybe Text) Source #

The principal that registered the task definition.

taskDefinition_requiresAttributes :: Lens' TaskDefinition (Maybe [Attribute]) Source #

The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

This parameter isn't supported for tasks run on Fargate.

taskDefinition_requiresCompatibilities :: Lens' TaskDefinition (Maybe [Compatibility]) Source #

The task launch types the task definition was validated against. To determine which task launch types the task definition is validated for, see the TaskDefinition$compatibilities parameter.

taskDefinition_revision :: Lens' TaskDefinition (Maybe Int) Source #

The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one. This is even if you deregistered previous revisions in this family.

taskDefinition_runtimePlatform :: Lens' TaskDefinition (Maybe RuntimePlatform) Source #

The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.

When you specify a task in a service, this value must match the runtimePlatform value of the service.

taskDefinition_taskDefinitionArn :: Lens' TaskDefinition (Maybe Text) Source #

The full Amazon Resource Name (ARN) of the task definition.

taskDefinition_taskRoleArn :: Lens' TaskDefinition (Maybe Text) Source #

The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide.

IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see Windows IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

taskDefinition_volumes :: Lens' TaskDefinition (Maybe [Volume]) Source #

The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.

The host and sourcePath parameters aren't supported for tasks run on Fargate.

TaskDefinitionPlacementConstraint

data TaskDefinitionPlacementConstraint Source #

An object representing a constraint on task placement in the task definition. For more information, see Task placement constraints in the Amazon Elastic Container Service Developer Guide.

Task placement constraints aren't supported for tasks run on Fargate.

See: newTaskDefinitionPlacementConstraint smart constructor.

Constructors

TaskDefinitionPlacementConstraint' 

Fields

Instances

Instances details
FromJSON TaskDefinitionPlacementConstraint Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraint

ToJSON TaskDefinitionPlacementConstraint Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraint

Generic TaskDefinitionPlacementConstraint Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraint

Associated Types

type Rep TaskDefinitionPlacementConstraint :: Type -> Type #

Read TaskDefinitionPlacementConstraint Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraint

Show TaskDefinitionPlacementConstraint Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraint

NFData TaskDefinitionPlacementConstraint Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraint

Eq TaskDefinitionPlacementConstraint Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraint

Hashable TaskDefinitionPlacementConstraint Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraint

type Rep TaskDefinitionPlacementConstraint Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskDefinitionPlacementConstraint

type Rep TaskDefinitionPlacementConstraint = D1 ('MetaData "TaskDefinitionPlacementConstraint" "Amazonka.ECS.Types.TaskDefinitionPlacementConstraint" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "TaskDefinitionPlacementConstraint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "expression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskDefinitionPlacementConstraintType))))

newTaskDefinitionPlacementConstraint :: TaskDefinitionPlacementConstraint Source #

Create a value of TaskDefinitionPlacementConstraint with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:expression:TaskDefinitionPlacementConstraint', taskDefinitionPlacementConstraint_expression - A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.

$sel:type':TaskDefinitionPlacementConstraint', taskDefinitionPlacementConstraint_type - The type of constraint. The MemberOf constraint restricts selection to be from a group of valid candidates.

taskDefinitionPlacementConstraint_expression :: Lens' TaskDefinitionPlacementConstraint (Maybe Text) Source #

A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.

taskDefinitionPlacementConstraint_type :: Lens' TaskDefinitionPlacementConstraint (Maybe TaskDefinitionPlacementConstraintType) Source #

The type of constraint. The MemberOf constraint restricts selection to be from a group of valid candidates.

TaskOverride

data TaskOverride Source #

The overrides that are associated with a task.

See: newTaskOverride smart constructor.

Constructors

TaskOverride' 

Fields

Instances

Instances details
FromJSON TaskOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskOverride

ToJSON TaskOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskOverride

Generic TaskOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskOverride

Associated Types

type Rep TaskOverride :: Type -> Type #

Read TaskOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskOverride

Show TaskOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskOverride

NFData TaskOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskOverride

Methods

rnf :: TaskOverride -> () #

Eq TaskOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskOverride

Hashable TaskOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskOverride

type Rep TaskOverride Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskOverride

newTaskOverride :: TaskOverride Source #

Create a value of TaskOverride with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containerOverrides:TaskOverride', taskOverride_containerOverrides - One or more container overrides that are sent to a task.

TaskOverride, taskOverride_cpu - The CPU override for the task.

$sel:ephemeralStorage:TaskOverride', taskOverride_ephemeralStorage - The ephemeral storage setting override for the task.

This parameter is only supported for tasks hosted on Fargate that use the following platform versions:

  • Linux platform version 1.4.0 or later.
  • Windows platform version 1.0.0 or later.

$sel:executionRoleArn:TaskOverride', taskOverride_executionRoleArn - The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

$sel:inferenceAcceleratorOverrides:TaskOverride', taskOverride_inferenceAcceleratorOverrides - The Elastic Inference accelerator override for the task.

TaskOverride, taskOverride_memory - The memory override for the task.

$sel:taskRoleArn:TaskOverride', taskOverride_taskRoleArn - The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Role for Tasks in the Amazon Elastic Container Service Developer Guide.

taskOverride_containerOverrides :: Lens' TaskOverride (Maybe [ContainerOverride]) Source #

One or more container overrides that are sent to a task.

taskOverride_cpu :: Lens' TaskOverride (Maybe Text) Source #

The CPU override for the task.

taskOverride_ephemeralStorage :: Lens' TaskOverride (Maybe EphemeralStorage) Source #

The ephemeral storage setting override for the task.

This parameter is only supported for tasks hosted on Fargate that use the following platform versions:

  • Linux platform version 1.4.0 or later.
  • Windows platform version 1.0.0 or later.

taskOverride_executionRoleArn :: Lens' TaskOverride (Maybe Text) Source #

The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

taskOverride_inferenceAcceleratorOverrides :: Lens' TaskOverride (Maybe [InferenceAcceleratorOverride]) Source #

The Elastic Inference accelerator override for the task.

taskOverride_memory :: Lens' TaskOverride (Maybe Text) Source #

The memory override for the task.

taskOverride_taskRoleArn :: Lens' TaskOverride (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Role for Tasks in the Amazon Elastic Container Service Developer Guide.

TaskSet

data 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.

See: newTaskSet smart constructor.

Constructors

TaskSet' 

Fields

  • capacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]

    The capacity provider strategy that are associated with the task set.

  • clusterArn :: Maybe Text

    The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

  • computedDesiredCount :: Maybe Int

    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.

  • createdAt :: Maybe POSIX

    The Unix timestamp for the time when the task set was created.

  • externalId :: Maybe Text

    The external ID associated with the task set.

    If an CodeDeploy deployment created a task set, the externalId parameter contains the CodeDeploy deployment ID.

    If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.

  • id :: Maybe Text

    The ID of the task set.

  • launchType :: Maybe LaunchType

    The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

  • loadBalancers :: Maybe [LoadBalancer]

    Details on a load balancer that are used with a task set.

  • networkConfiguration :: Maybe NetworkConfiguration

    The network configuration for the task set.

  • pendingCount :: Maybe Int

    The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time or when it's restarted after being in the STOPPED state.

  • platformFamily :: Maybe Text

    The operating system that your tasks in the set are running on. A platform family is specified only for tasks that use the Fargate launch type.

    All tasks in the set must have the same value.

  • platformVersion :: Maybe Text

    The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

  • runningCount :: Maybe Int

    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.

  • scale :: Maybe Scale

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

  • serviceArn :: Maybe Text

    The Amazon Resource Name (ARN) of the service the task set exists in.

  • serviceRegistries :: Maybe [ServiceRegistry]

    The details for the service discovery registries to assign to this task set. For more information, see Service discovery.

  • stabilityStatus :: Maybe StabilityStatus

    The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in STEADY_STATE:

    • The task runningCount is equal to the computedDesiredCount.
    • The pendingCount is 0.
    • There are no tasks that are 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 aren't met, the stability status returns STABILIZING.

  • stabilityStatusAt :: Maybe POSIX

    The Unix timestamp for the time when the task set stability status was retrieved.

  • startedBy :: Maybe Text

    The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the startedBy parameter is CODE_DEPLOY. If an external deployment created the task set, the startedBy field isn't used.

  • status :: Maybe Text

    The status of the task set. The following describes each state.

    PRIMARY
    The task set is serving production traffic.
    ACTIVE
    The task set isn't serving production traffic.
    DRAINING
    The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.
  • tags :: Maybe [Tag]

    The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

    The following basic restrictions apply to tags:

    • Maximum number of tags per resource - 50
    • For each resource, each tag key must be unique, and each tag key can have only one value.
    • Maximum key length - 128 Unicode characters in UTF-8
    • Maximum value length - 256 Unicode characters in UTF-8
    • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    • Tag keys and values are case-sensitive.
    • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
  • taskDefinition :: Maybe Text

    The task definition that the task set is using.

  • taskSetArn :: Maybe Text

    The Amazon Resource Name (ARN) of the task set.

  • updatedAt :: Maybe POSIX

    The Unix timestamp for the time when the task set was last updated.

Instances

Instances details
FromJSON TaskSet Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSet

Generic TaskSet Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSet

Associated Types

type Rep TaskSet :: Type -> Type #

Methods

from :: TaskSet -> Rep TaskSet x #

to :: Rep TaskSet x -> TaskSet #

Read TaskSet Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSet

Show TaskSet Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSet

NFData TaskSet Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSet

Methods

rnf :: TaskSet -> () #

Eq TaskSet Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSet

Methods

(==) :: TaskSet -> TaskSet -> Bool #

(/=) :: TaskSet -> TaskSet -> Bool #

Hashable TaskSet Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSet

Methods

hashWithSalt :: Int -> TaskSet -> Int #

hash :: TaskSet -> Int #

type Rep TaskSet Source # 
Instance details

Defined in Amazonka.ECS.Types.TaskSet

type Rep TaskSet = D1 ('MetaData "TaskSet" "Amazonka.ECS.Types.TaskSet" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "TaskSet'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "capacityProviderStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CapacityProviderStrategyItem])) :*: (S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "computedDesiredCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "launchType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchType)) :*: (S1 ('MetaSel ('Just "loadBalancers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LoadBalancer])) :*: S1 ('MetaSel ('Just "networkConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkConfiguration)))) :*: (S1 ('MetaSel ('Just "pendingCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "platformFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "platformVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "runningCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "scale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Scale)) :*: S1 ('MetaSel ('Just "serviceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "serviceRegistries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ServiceRegistry])) :*: (S1 ('MetaSel ('Just "stabilityStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StabilityStatus)) :*: S1 ('MetaSel ('Just "stabilityStatusAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "startedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: (S1 ('MetaSel ('Just "taskDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "taskSetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))))

newTaskSet :: TaskSet Source #

Create a value of TaskSet with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:capacityProviderStrategy:TaskSet', taskSet_capacityProviderStrategy - The capacity provider strategy that are associated with the task set.

$sel:clusterArn:TaskSet', taskSet_clusterArn - The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

$sel:computedDesiredCount:TaskSet', taskSet_computedDesiredCount - The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.

$sel:createdAt:TaskSet', taskSet_createdAt - The Unix timestamp for the time when the task set was created.

$sel:externalId:TaskSet', taskSet_externalId - The external ID associated with the task set.

If an CodeDeploy deployment created a task set, the externalId parameter contains the CodeDeploy deployment ID.

If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.

$sel:id:TaskSet', taskSet_id - The ID of the task set.

$sel:launchType:TaskSet', taskSet_launchType - The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

$sel:loadBalancers:TaskSet', taskSet_loadBalancers - Details on a load balancer that are used with a task set.

$sel:networkConfiguration:TaskSet', taskSet_networkConfiguration - The network configuration for the task set.

$sel:pendingCount:TaskSet', taskSet_pendingCount - The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time or when it's restarted after being in the STOPPED state.

$sel:platformFamily:TaskSet', taskSet_platformFamily - The operating system that your tasks in the set are running on. A platform family is specified only for tasks that use the Fargate launch type.

All tasks in the set must have the same value.

$sel:platformVersion:TaskSet', taskSet_platformVersion - The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

$sel:runningCount:TaskSet', taskSet_runningCount - The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.

$sel:scale:TaskSet', taskSet_scale - A floating-point percentage of your desired number of tasks to place and keep running in the task set.

$sel:serviceArn:TaskSet', taskSet_serviceArn - The Amazon Resource Name (ARN) of the service the task set exists in.

$sel:serviceRegistries:TaskSet', taskSet_serviceRegistries - The details for the service discovery registries to assign to this task set. For more information, see Service discovery.

$sel:stabilityStatus:TaskSet', taskSet_stabilityStatus - The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in STEADY_STATE:

  • The task runningCount is equal to the computedDesiredCount.
  • The pendingCount is 0.
  • There are no tasks that are 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 aren't met, the stability status returns STABILIZING.

$sel:stabilityStatusAt:TaskSet', taskSet_stabilityStatusAt - The Unix timestamp for the time when the task set stability status was retrieved.

$sel:startedBy:TaskSet', taskSet_startedBy - The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the startedBy parameter is CODE_DEPLOY. If an external deployment created the task set, the startedBy field isn't used.

$sel:status:TaskSet', taskSet_status - The status of the task set. The following describes each state.

PRIMARY
The task set is serving production traffic.
ACTIVE
The task set isn't serving production traffic.
DRAINING
The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.

$sel:tags:TaskSet', taskSet_tags - The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8
  • Maximum value length - 256 Unicode characters in UTF-8
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case-sensitive.
  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

$sel:taskDefinition:TaskSet', taskSet_taskDefinition - The task definition that the task set is using.

$sel:taskSetArn:TaskSet', taskSet_taskSetArn - The Amazon Resource Name (ARN) of the task set.

$sel:updatedAt:TaskSet', taskSet_updatedAt - The Unix timestamp for the time when the task set was last updated.

taskSet_capacityProviderStrategy :: Lens' TaskSet (Maybe [CapacityProviderStrategyItem]) Source #

The capacity provider strategy that are associated with the task set.

taskSet_clusterArn :: Lens' TaskSet (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

taskSet_computedDesiredCount :: Lens' TaskSet (Maybe Int) Source #

The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.

taskSet_createdAt :: Lens' TaskSet (Maybe UTCTime) Source #

The Unix timestamp for the time when the task set was created.

taskSet_externalId :: Lens' TaskSet (Maybe Text) Source #

The external ID associated with the task set.

If an CodeDeploy deployment created a task set, the externalId parameter contains the CodeDeploy deployment ID.

If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.

taskSet_id :: Lens' TaskSet (Maybe Text) Source #

The ID of the task set.

taskSet_launchType :: Lens' TaskSet (Maybe LaunchType) Source #

The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

taskSet_loadBalancers :: Lens' TaskSet (Maybe [LoadBalancer]) Source #

Details on a load balancer that are used with a task set.

taskSet_networkConfiguration :: Lens' TaskSet (Maybe NetworkConfiguration) Source #

The network configuration for the task set.

taskSet_pendingCount :: Lens' TaskSet (Maybe Int) Source #

The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time or when it's restarted after being in the STOPPED state.

taskSet_platformFamily :: Lens' TaskSet (Maybe Text) Source #

The operating system that your tasks in the set are running on. A platform family is specified only for tasks that use the Fargate launch type.

All tasks in the set must have the same value.

taskSet_platformVersion :: Lens' TaskSet (Maybe Text) Source #

The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

taskSet_runningCount :: Lens' TaskSet (Maybe Int) Source #

The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.

taskSet_scale :: Lens' TaskSet (Maybe Scale) Source #

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

taskSet_serviceArn :: Lens' TaskSet (Maybe Text) Source #

The Amazon Resource Name (ARN) of the service the task set exists in.

taskSet_serviceRegistries :: Lens' TaskSet (Maybe [ServiceRegistry]) Source #

The details for the service discovery registries to assign to this task set. For more information, see Service discovery.

taskSet_stabilityStatus :: Lens' TaskSet (Maybe StabilityStatus) Source #

The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in STEADY_STATE:

  • The task runningCount is equal to the computedDesiredCount.
  • The pendingCount is 0.
  • There are no tasks that are 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 aren't met, the stability status returns STABILIZING.

taskSet_stabilityStatusAt :: Lens' TaskSet (Maybe UTCTime) Source #

The Unix timestamp for the time when the task set stability status was retrieved.

taskSet_startedBy :: Lens' TaskSet (Maybe Text) Source #

The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the startedBy parameter is CODE_DEPLOY. If an external deployment created the task set, the startedBy field isn't used.

taskSet_status :: Lens' TaskSet (Maybe Text) Source #

The status of the task set. The following describes each state.

PRIMARY
The task set is serving production traffic.
ACTIVE
The task set isn't serving production traffic.
DRAINING
The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.

taskSet_tags :: Lens' TaskSet (Maybe [Tag]) Source #

The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8
  • Maximum value length - 256 Unicode characters in UTF-8
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case-sensitive.
  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

taskSet_taskDefinition :: Lens' TaskSet (Maybe Text) Source #

The task definition that the task set is using.

taskSet_taskSetArn :: Lens' TaskSet (Maybe Text) Source #

The Amazon Resource Name (ARN) of the task set.

taskSet_updatedAt :: Lens' TaskSet (Maybe UTCTime) Source #

The Unix timestamp for the time when the task set was last updated.

Tmpfs

data Tmpfs Source #

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

See: newTmpfs smart constructor.

Constructors

Tmpfs' 

Fields

  • mountOptions :: Maybe [Text]

    The list of tmpfs volume mount options.

    Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"

  • containerPath :: Text

    The absolute file path where the tmpfs volume is to be mounted.

  • size :: Int

    The maximum size (in MiB) of the tmpfs volume.

Instances

Instances details
FromJSON Tmpfs Source # 
Instance details

Defined in Amazonka.ECS.Types.Tmpfs

ToJSON Tmpfs Source # 
Instance details

Defined in Amazonka.ECS.Types.Tmpfs

Generic Tmpfs Source # 
Instance details

Defined in Amazonka.ECS.Types.Tmpfs

Associated Types

type Rep Tmpfs :: Type -> Type #

Methods

from :: Tmpfs -> Rep Tmpfs x #

to :: Rep Tmpfs x -> Tmpfs #

Read Tmpfs Source # 
Instance details

Defined in Amazonka.ECS.Types.Tmpfs

Show Tmpfs Source # 
Instance details

Defined in Amazonka.ECS.Types.Tmpfs

Methods

showsPrec :: Int -> Tmpfs -> ShowS #

show :: Tmpfs -> String #

showList :: [Tmpfs] -> ShowS #

NFData Tmpfs Source # 
Instance details

Defined in Amazonka.ECS.Types.Tmpfs

Methods

rnf :: Tmpfs -> () #

Eq Tmpfs Source # 
Instance details

Defined in Amazonka.ECS.Types.Tmpfs

Methods

(==) :: Tmpfs -> Tmpfs -> Bool #

(/=) :: Tmpfs -> Tmpfs -> Bool #

Hashable Tmpfs Source # 
Instance details

Defined in Amazonka.ECS.Types.Tmpfs

Methods

hashWithSalt :: Int -> Tmpfs -> Int #

hash :: Tmpfs -> Int #

type Rep Tmpfs Source # 
Instance details

Defined in Amazonka.ECS.Types.Tmpfs

type Rep Tmpfs = D1 ('MetaData "Tmpfs" "Amazonka.ECS.Types.Tmpfs" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Tmpfs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "mountOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "containerPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newTmpfs Source #

Create a value of Tmpfs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:mountOptions:Tmpfs', tmpfs_mountOptions - The list of tmpfs volume mount options.

Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"

$sel:containerPath:Tmpfs', tmpfs_containerPath - The absolute file path where the tmpfs volume is to be mounted.

$sel:size:Tmpfs', tmpfs_size - The maximum size (in MiB) of the tmpfs volume.

tmpfs_mountOptions :: Lens' Tmpfs (Maybe [Text]) Source #

The list of tmpfs volume mount options.

Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"

tmpfs_containerPath :: Lens' Tmpfs Text Source #

The absolute file path where the tmpfs volume is to be mounted.

tmpfs_size :: Lens' Tmpfs Int Source #

The maximum size (in MiB) of the tmpfs volume.

Ulimit

data Ulimit Source #

The ulimit settings to pass to the container.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and hard limit is 4096.

See: newUlimit smart constructor.

Constructors

Ulimit' 

Fields

Instances

Instances details
FromJSON Ulimit Source # 
Instance details

Defined in Amazonka.ECS.Types.Ulimit

ToJSON Ulimit Source # 
Instance details

Defined in Amazonka.ECS.Types.Ulimit

Generic Ulimit Source # 
Instance details

Defined in Amazonka.ECS.Types.Ulimit

Associated Types

type Rep Ulimit :: Type -> Type #

Methods

from :: Ulimit -> Rep Ulimit x #

to :: Rep Ulimit x -> Ulimit #

Read Ulimit Source # 
Instance details

Defined in Amazonka.ECS.Types.Ulimit

Show Ulimit Source # 
Instance details

Defined in Amazonka.ECS.Types.Ulimit

NFData Ulimit Source # 
Instance details

Defined in Amazonka.ECS.Types.Ulimit

Methods

rnf :: Ulimit -> () #

Eq Ulimit Source # 
Instance details

Defined in Amazonka.ECS.Types.Ulimit

Methods

(==) :: Ulimit -> Ulimit -> Bool #

(/=) :: Ulimit -> Ulimit -> Bool #

Hashable Ulimit Source # 
Instance details

Defined in Amazonka.ECS.Types.Ulimit

Methods

hashWithSalt :: Int -> Ulimit -> Int #

hash :: Ulimit -> Int #

type Rep Ulimit Source # 
Instance details

Defined in Amazonka.ECS.Types.Ulimit

type Rep Ulimit = D1 ('MetaData "Ulimit" "Amazonka.ECS.Types.Ulimit" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Ulimit'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UlimitName) :*: (S1 ('MetaSel ('Just "softLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "hardLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUlimit Source #

Create a value of Ulimit with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:Ulimit', ulimit_name - The type of the ulimit.

$sel:softLimit:Ulimit', ulimit_softLimit - The soft limit for the ulimit type.

$sel:hardLimit:Ulimit', ulimit_hardLimit - The hard limit for the ulimit type.

ulimit_name :: Lens' Ulimit UlimitName Source #

The type of the ulimit.

ulimit_softLimit :: Lens' Ulimit Int Source #

The soft limit for the ulimit type.

ulimit_hardLimit :: Lens' Ulimit Int Source #

The hard limit for the ulimit type.

VersionInfo

data VersionInfo Source #

The Docker and Amazon ECS container agent version information about a container instance.

See: newVersionInfo smart constructor.

Constructors

VersionInfo' 

Fields

Instances

Instances details
FromJSON VersionInfo Source # 
Instance details

Defined in Amazonka.ECS.Types.VersionInfo

ToJSON VersionInfo Source # 
Instance details

Defined in Amazonka.ECS.Types.VersionInfo

Generic VersionInfo Source # 
Instance details

Defined in Amazonka.ECS.Types.VersionInfo

Associated Types

type Rep VersionInfo :: Type -> Type #

Read VersionInfo Source # 
Instance details

Defined in Amazonka.ECS.Types.VersionInfo

Show VersionInfo Source # 
Instance details

Defined in Amazonka.ECS.Types.VersionInfo

NFData VersionInfo Source # 
Instance details

Defined in Amazonka.ECS.Types.VersionInfo

Methods

rnf :: VersionInfo -> () #

Eq VersionInfo Source # 
Instance details

Defined in Amazonka.ECS.Types.VersionInfo

Hashable VersionInfo Source # 
Instance details

Defined in Amazonka.ECS.Types.VersionInfo

type Rep VersionInfo Source # 
Instance details

Defined in Amazonka.ECS.Types.VersionInfo

type Rep VersionInfo = D1 ('MetaData "VersionInfo" "Amazonka.ECS.Types.VersionInfo" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "VersionInfo'" 'PrefixI 'True) (S1 ('MetaSel ('Just "agentHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "agentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dockerVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newVersionInfo :: VersionInfo Source #

Create a value of VersionInfo with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:agentHash:VersionInfo', versionInfo_agentHash - The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.

$sel:agentVersion:VersionInfo', versionInfo_agentVersion - The version number of the Amazon ECS container agent.

$sel:dockerVersion:VersionInfo', versionInfo_dockerVersion - The Docker version that's running on the container instance.

versionInfo_agentHash :: Lens' VersionInfo (Maybe Text) Source #

The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.

versionInfo_agentVersion :: Lens' VersionInfo (Maybe Text) Source #

The version number of the Amazon ECS container agent.

versionInfo_dockerVersion :: Lens' VersionInfo (Maybe Text) Source #

The Docker version that's running on the container instance.

Volume

data Volume Source #

A data volume that's used in a task definition. For tasks that use the Amazon Elastic File System (Amazon EFS), specify an efsVolumeConfiguration. For Windows tasks that use Amazon FSx for Windows File Server file system, specify a fsxWindowsFileServerVolumeConfiguration. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information, see Using Data Volumes in Tasks.

See: newVolume smart constructor.

Constructors

Volume' 

Fields

  • dockerVolumeConfiguration :: Maybe DockerVolumeConfiguration

    This parameter is specified when you use Docker volumes.

    Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead.

    Docker volumes aren't supported by tasks run on Fargate.

  • efsVolumeConfiguration :: Maybe EFSVolumeConfiguration

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

  • fsxWindowsFileServerVolumeConfiguration :: Maybe FSxWindowsFileServerVolumeConfiguration

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

  • host :: Maybe HostVolumeProperties

    This parameter is specified when you use bind mount host volumes. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

    Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.

  • name :: Maybe Text

    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.

Instances

Instances details
FromJSON Volume Source # 
Instance details

Defined in Amazonka.ECS.Types.Volume

ToJSON Volume Source # 
Instance details

Defined in Amazonka.ECS.Types.Volume

Generic Volume Source # 
Instance details

Defined in Amazonka.ECS.Types.Volume

Associated Types

type Rep Volume :: Type -> Type #

Methods

from :: Volume -> Rep Volume x #

to :: Rep Volume x -> Volume #

Read Volume Source # 
Instance details

Defined in Amazonka.ECS.Types.Volume

Show Volume Source # 
Instance details

Defined in Amazonka.ECS.Types.Volume

NFData Volume Source # 
Instance details

Defined in Amazonka.ECS.Types.Volume

Methods

rnf :: Volume -> () #

Eq Volume Source # 
Instance details

Defined in Amazonka.ECS.Types.Volume

Methods

(==) :: Volume -> Volume -> Bool #

(/=) :: Volume -> Volume -> Bool #

Hashable Volume Source # 
Instance details

Defined in Amazonka.ECS.Types.Volume

Methods

hashWithSalt :: Int -> Volume -> Int #

hash :: Volume -> Int #

type Rep Volume Source # 
Instance details

Defined in Amazonka.ECS.Types.Volume

newVolume :: Volume Source #

Create a value of Volume with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dockerVolumeConfiguration:Volume', volume_dockerVolumeConfiguration - This parameter is specified when you use Docker volumes.

Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead.

Docker volumes aren't supported by tasks run on Fargate.

$sel:efsVolumeConfiguration:Volume', volume_efsVolumeConfiguration - This parameter is specified when you use an Amazon Elastic File System file system for task storage.

$sel:fsxWindowsFileServerVolumeConfiguration:Volume', volume_fsxWindowsFileServerVolumeConfiguration - This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.

$sel:host:Volume', volume_host - This parameter is specified when you use bind mount host volumes. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.

$sel:name:Volume', volume_name - The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

volume_dockerVolumeConfiguration :: Lens' Volume (Maybe DockerVolumeConfiguration) Source #

This parameter is specified when you use Docker volumes.

Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead.

Docker volumes aren't supported by tasks run on Fargate.

volume_efsVolumeConfiguration :: Lens' Volume (Maybe EFSVolumeConfiguration) Source #

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

volume_fsxWindowsFileServerVolumeConfiguration :: Lens' Volume (Maybe FSxWindowsFileServerVolumeConfiguration) Source #

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

volume_host :: Lens' Volume (Maybe HostVolumeProperties) Source #

This parameter is specified when you use bind mount host volumes. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.

volume_name :: Lens' Volume (Maybe Text) Source #

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

VolumeFrom

data VolumeFrom Source #

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

See: newVolumeFrom smart constructor.

Constructors

VolumeFrom' 

Fields

  • readOnly :: Maybe Bool

    If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

  • sourceContainer :: Maybe Text

    The name of another container within the same task definition to mount volumes from.

Instances

Instances details
FromJSON VolumeFrom Source # 
Instance details

Defined in Amazonka.ECS.Types.VolumeFrom

ToJSON VolumeFrom Source # 
Instance details

Defined in Amazonka.ECS.Types.VolumeFrom

Generic VolumeFrom Source # 
Instance details

Defined in Amazonka.ECS.Types.VolumeFrom

Associated Types

type Rep VolumeFrom :: Type -> Type #

Read VolumeFrom Source # 
Instance details

Defined in Amazonka.ECS.Types.VolumeFrom

Show VolumeFrom Source # 
Instance details

Defined in Amazonka.ECS.Types.VolumeFrom

NFData VolumeFrom Source # 
Instance details

Defined in Amazonka.ECS.Types.VolumeFrom

Methods

rnf :: VolumeFrom -> () #

Eq VolumeFrom Source # 
Instance details

Defined in Amazonka.ECS.Types.VolumeFrom

Hashable VolumeFrom Source # 
Instance details

Defined in Amazonka.ECS.Types.VolumeFrom

type Rep VolumeFrom Source # 
Instance details

Defined in Amazonka.ECS.Types.VolumeFrom

type Rep VolumeFrom = D1 ('MetaData "VolumeFrom" "Amazonka.ECS.Types.VolumeFrom" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "VolumeFrom'" 'PrefixI 'True) (S1 ('MetaSel ('Just "readOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sourceContainer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newVolumeFrom :: VolumeFrom Source #

Create a value of VolumeFrom with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:readOnly:VolumeFrom', volumeFrom_readOnly - If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

$sel:sourceContainer:VolumeFrom', volumeFrom_sourceContainer - The name of another container within the same task definition to mount volumes from.

volumeFrom_readOnly :: Lens' VolumeFrom (Maybe Bool) Source #

If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

volumeFrom_sourceContainer :: Lens' VolumeFrom (Maybe Text) Source #

The name of another container within the same task definition to mount volumes from.