ECS-ComposeX
0.11.0

ECS ComposeX

  • ECS ComposeX
  • Requirements
  • Installation
  • Contributing

Compose compatibility matrix

  • services
  • secrets
    • Syntax
      • Name
      • LinksTo
      • JsonKeys
        • SecretKey
        • VarName
        • Transform
    • Examples
  • networks

Services-level Extension Fields

  • deploy
    • resources
      • replicas
      • labels
        • ecs.task.family
        • ecs.depends.condition
  • x-scaling
    • Range
    • TargetScaling
      • CpuTarget / RamTarget
      • ScaleInCooldown / ScaleOutCooldown
      • DisableScaleIn
  • x-iam
    • PermissionsBoundary
    • Policies
    • ManagedPolicies
  • x-network
    • UseCloudmap
    • Ingress definition
      • Syntax reference
    • Map VPC subnets to docker-compose networks
  • x-logging
    • RetentionInDays
    • CreateLogGroup
  • x-xray
    • Syntax reference
    • Example
    • IAM permissions
  • x-codeguru-profiler
    • Syntax reference / Examples
    • Code Example

ComposeX syntax

  • Common syntax for x-resources
    • Properties
    • Settings
      • EnvNames
      • Subnets
    • Services
    • Lookup
  • x-dynamodb
    • Properties
    • Services
    • Settings
    • Lookup
    • Examples
  • x-rds
    • Syntax
    • Properties
      • Using properties
    • MacroParameters
    • Services
      • Access types
    • Settings
    • Lookup
    • Defaults
      • Credentials
    • Examples
  • x-docdb
    • Syntax
    • Properties
    • MacroParameters
      • Instances
      • DBClusterParameterGroup
    • Services
      • Access types
    • Settings
    • Lookup
    • IAM Permissions
    • Credentials
    • Examples
  • x-elastic_cache
    • Properties
    • MacroParameters
      • ParameterGroup
    • Settings
    • Services
    • Lookup
    • Examples
  • x-s3
    • Properties
    • Settings
      • ExpandRegionToBucket
      • ExpandAccountIdToBucket
      • NameSeparator
      • EnableEncryption
    • Services
    • Lookup
    • IAM Permissions
    • Examples
  • x-appmesh
    • Syntax
    • Properties
      • MeshName
      • MeshOwner
      • EgressPolicy
    • Settings
      • nodes
        • Syntax
        • Example
      • routers
        • Definition
        • Syntax
        • matches
        • Example
      • services
        • Syntax
    • AWS AppMesh & AWS Cloud Map for services mesh & discovery
    • Nodes
    • Routers
  • x-dns
    • Syntax
    • Examples
  • x-elbv2
    • Syntax
    • Properties
    • MacroParameters
      • Ingress
    • Settings
    • Services
      • name
      • protocol
        • port
      • healthcheck
    • Listeners
    • ECS ComposeX custom properties
      • Targets
    • Examples
  • x-acm
    • Syntax
    • Properties
    • MacroParameters
      • DomainNames
      • HostedZoneId
    • Services
    • Example
  • x-kinesis
    • Syntax reference
    • Properties
    • MacroParameters
    • Settings
      • EnvNames
    • Services
    • IAM permissions
  • x-sqs
    • Syntax
    • Properties
      • Mandatory Properties
      • Special properties
    • Settings
    • Services
    • IAM Permissions
    • Lookup
    • Scaling
    • ComposeX Features
      • Redrive policy
    • Examples
  • x-sns
    • Syntax
    • Properties
    • Lookup
    • Examples
  • x-events
    • Properties
    • MacroParameters
    • Settings
    • Services
      • name
      • TaskCount
      • DeleteDefaultService
  • x-kms
    • Syntax
    • Properties
    • Settings
      • Alias
    • Examples
    • Services
    • IAM Permissions
  • x-vpc
    • Syntax
    • Create
      • SingleNat
      • VpcCidr
      • Endpoints
      • EnableFlowLogs
      • FlowLogsRoleBoundary
    • Use
    • Lookup
    • Usage tips
      • Using an existing VPC
      • Default VPC Network design
      • Default range
  • x-cluster
    • Properties
    • Lookup
    • Use
  • spot_config
    • Define settings in the configs section

Additional content

  • History
    • 0.11.0 (2021-01-14)
      • New features
      • Improvements
      • Fixes
    • 0.10.0 (2020-12-13)
      • New features
      • Improvements
      • Fixes
      • Other updates and corrections
    • 0.9.0 (2020-11-26)
      • New features
      • Fixes
      • Syntax changes from previous version
    • 0.8.0 (2020-10-09)
      • New features:
      • Closed reported issues:
    • 0.7.0 (2020-08-12)
    • 0.6.0 (2020-08-03)
    • 0.5.3 (2020-07-30)
    • 0.5.2 (2020-07-30)
    • 0.5.1 (2020-07-28)
    • 0.5.0 (2020-07-27)
      • New features
    • 0.4.0 (2020-07-20)
    • 0.3.0 (2020-06-21)
    • 0.2.3 (2020-04-16)
      • New features
    • 0.2.2 (2020-04-10)
    • 0.2.1 (2020-05-03)
      • New features
    • 0.1.3 (2020-04-13)
      • Issues closed
    • 0.1.2 (2020-04-04)
      • Issues closed
    • 0.1.1 (2020-04-02)
    • 0.1.0 (2020-03-24)
  • Extras
    • Docker ECS-Plugin x-aws-keys support
    • AWS AppMesh integration
    • Services autoscaling integration
    • Fargate CPU/RAM auto configuration
    • Multiple services, one microservice
  • The Why & The How
    • Introduction
      • Translate Docker services into AWS ECS
      • Provision other AWS resources your services need
    • What does ECS ComposeX do differently?
    • How does it work?
    • Why did I create ECS ComposeX?
    • Why am I not using AWS CDK?
    • Why not stick to AWS CFN Templates and CFN macros ?
    • Implementing least privileges at the heart of ECS ComposeX
    • I want to use EKS. How can I use ECS ComposeX?

Thanks & Credits

  • Contributors
  • Credits

Library Modules

  • ecs_composex
    • ecs_composex package
      • Subpackages
        • ecs_composex.acm package
        • ecs_composex.appmesh package
        • ecs_composex.common package
        • ecs_composex.compute package
        • ecs_composex.dns package
        • ecs_composex.docdb package
        • ecs_composex.dynamodb package
        • ecs_composex.ecs package
        • ecs_composex.elasticache package
        • ecs_composex.elbv2 package
        • ecs_composex.events package
        • ecs_composex.iam package
        • ecs_composex.kinesis package
        • ecs_composex.kms package
        • ecs_composex.rds package
        • ecs_composex.s3 package
        • ecs_composex.secrets package
        • ecs_composex.sns package
        • ecs_composex.sqs package
        • ecs_composex.utils package
        • ecs_composex.vpc package
      • Submodules
      • ecs_composex.cli module
      • ecs_composex.ecs_composex module
      • ecs_composex.ingress_settings module
      • ecs_composex.resource_settings module
      • ecs_composex.resources_import module
      • ecs_composex.tcp_resources_settings module
      • Module contents
ECS-ComposeX
  • »
  • Welcome to ECS-ComposeX’s documentation!
  • View page source

Welcome to ECS-ComposeX’s documentation!¶

ECS ComposeX

  • ECS ComposeX
  • Requirements
  • Installation
  • Contributing

Compose compatibility matrix

  • services
  • secrets
  • networks

Services-level Extension Fields

  • deploy
  • x-scaling
  • x-iam
  • x-network
  • x-logging
  • x-xray
  • x-codeguru-profiler

ComposeX syntax

  • Common syntax for x-resources
  • x-dynamodb
  • x-rds
  • x-docdb
  • x-elastic_cache
  • x-s3
  • x-appmesh
  • x-dns
  • x-elbv2
  • x-acm
  • x-kinesis
  • x-sqs
  • x-sns
  • x-events
  • x-kms
  • x-vpc
  • x-cluster
  • spot_config

Additional content

  • History
    • 0.11.0 (2021-01-14)
    • 0.10.0 (2020-12-13)
    • 0.9.0 (2020-11-26)
    • 0.8.0 (2020-10-09)
    • 0.7.0 (2020-08-12)
    • 0.6.0 (2020-08-03)
    • 0.5.3 (2020-07-30)
    • 0.5.2 (2020-07-30)
    • 0.5.1 (2020-07-28)
    • 0.5.0 (2020-07-27)
    • 0.4.0 (2020-07-20)
    • 0.3.0 (2020-06-21)
    • 0.2.3 (2020-04-16)
    • 0.2.2 (2020-04-10)
    • 0.2.1 (2020-05-03)
    • 0.1.3 (2020-04-13)
    • 0.1.2 (2020-04-04)
    • 0.1.1 (2020-04-02)
    • 0.1.0 (2020-03-24)
  • Extras
    • Docker ECS-Plugin x-aws-keys support
    • AWS AppMesh integration
    • Services autoscaling integration
    • Fargate CPU/RAM auto configuration
    • Multiple services, one microservice
  • The Why & The How
    • Introduction
    • What does ECS ComposeX do differently?
    • How does it work?
    • Why did I create ECS ComposeX?
    • Why am I not using AWS CDK?
    • Why not stick to AWS CFN Templates and CFN macros ?
    • Implementing least privileges at the heart of ECS ComposeX
    • I want to use EKS. How can I use ECS ComposeX?

Thanks & Credits

  • Contributors
  • Credits

Library Modules

  • ecs_composex
    • ecs_composex package

Indices and tables¶

  • Index

  • Module Index

  • Search Page

Next

© Copyright 2020, John Mille

Built with Sphinx using a theme provided by Read the Docs.