Skip to main content

EcsTaskDefinitionSchema

The EcsTaskDefinitionSchema class is the schema for the EcsTaskDefinition resource, which represents the AWS Elastic Container Service (ECS) Task Definition resource. This resource can create a ecs task definition in AWS using the AWS JavaScript SDK V3 API. See official sdk docs.

@group

Resources/EcsTaskDefinition

@overrideProperty

parents - This resource has parents.

@overrideProperty

resourceId - The resource id is of format ecs-task-definition-<execution-id>

Hierarchy

  • BaseResourceSchema
    • EcsTaskDefinitionSchema

Index

Properties

Properties

inheritedparents

parents: IResourceReference[]

properties

properties: { awsAccountId: string; awsRegionId: string; cpu: number; deploymentTag: string; environmentVariables: EcsTaskDefinitionEnvironmentVariableSchema[]; family: string; images: EcsTaskDefinitionImageSchema[]; memory: number } = ...

Input properties.

  • properties.awsAccountId - The AWS account ID.
  • properties.awsRegionId - The AWS region ID.
  • properties.cpu - The number of CPU units to reserve for the containers.
  • properties.deploymentTag - The deployment tag, generally mapped to the deployment model deploymentTag property. This is usually defined in conjunction with the family (server key). Both the properties together specify the server and the code currently referenced in the task definition. E.g. deploymentTag = v0 might mean the tag in GitHub, or a specific branch, or commit.
  • properties.environmentVariables - The list of environment variables to pass to the container. See EcsTaskDefinitionEnvironmentVariableSchema for options.
  • properties.family - The family of the task definition, generally mapped to the server model serverKey property. This is usually defined in conjunction with the deploymentTag. Both the properties together specify the server and the code currently referenced in the task definition. E.g. family = backend indicates that this task definition is for the backend server.
  • properties.images - The containers to run as part of the task definition. See EcsTaskDefinitionImageSchema for options.
  • properties.memory - The amount of memory to reserve for the containers.

Type declaration

inheritedresourceId

resourceId: string

response

response: { revision?: number; taskDefinitionArn?: string } = ...

Saved response.

  • response.revision - The current revision of the task definition.
  • response.taskDefinitionArn - The ARN of the task definition.

Type declaration

  • optionalrevision?: number
  • optionaltaskDefinitionArn?: string

inheritedtags

tags: {}

Type declaration

  • [key string]: string
Page Options