Skip to content

Latest commit

 

History

History
350 lines (190 loc) · 14.8 KB

API.md

File metadata and controls

350 lines (190 loc) · 14.8 KB

API Reference

Classes

Name Description
DummyTaskDefinition No description
EcsDeploymentGroup No description
EcsService No description
PushImageProject No description

Structs

Name Description
DummyTaskDefinitionProps No description
EcsDeploymentGroupProps No description
EcsServiceProps No description
PushImageProjectProps No description
TrafficListener No description

Interfaces

Name Description
IDummyTaskDefinition No description
IEcsService No description

Enums

Name Description
RollbackEvent No description
SchedulingStrategy No description

class DummyTaskDefinition

Implements: IConstruct, IConstruct, IConstruct, IDependable, IDummyTaskDefinition Extends: Construct

Initializer

new DummyTaskDefinition(scope: Construct, id: string, props: DummyTaskDefinitionProps)
  • scope (Construct) No description
  • id (string) No description
  • props (DummyTaskDefinitionProps) No description
    • image (string) No description
    • containerPort (number) No description Optional
    • family (string) No description Optional

Properties

Name Type Description
executionRole IRole
family string
taskDefinitionArn string

Methods

addToExecutionRolePolicy(statement)

Adds a policy statement to the task execution IAM role.

addToExecutionRolePolicy(statement: PolicyStatement): void

class EcsDeploymentGroup

Implements: IConstruct, IConstruct, IConstruct, IDependable, IResource, IConstruct, IDependable, IConstruct, IEcsDeploymentGroup, IConstruct, IDependable, IConstruct, IResource Extends: Resource

Initializer

new EcsDeploymentGroup(scope: Construct, id: string, props: EcsDeploymentGroupProps)
  • scope (Construct) No description
  • id (string) No description
  • props (EcsDeploymentGroupProps) No description
    • deploymentGroupName (string) No description
    • ecsServices (Array<IEcsService>) No description
    • prodTrafficListener (TrafficListener) No description
    • targetGroupNames (Array) No description
    • testTrafficListener (TrafficListener) No description
    • applicationName (string) No description Optional
    • autoRollbackOnEvents (Array<RollbackEvent>) The event type or types that trigger a rollback. Optional
    • deploymentConfig (IEcsDeploymentConfig) No description Optional
    • terminationWaitTimeInMinutes (number) the number of minutes before deleting the original (blue) task set. Default: 60

Properties

Name Type Description
application IEcsApplication The reference to the CodeDeploy ECS Application that this Deployment Group belongs to.
deploymentConfig IEcsDeploymentConfig The Deployment Configuration this Group uses.
deploymentGroupArn string The ARN of this Deployment Group.
deploymentGroupName string The physical name of the CodeDeploy Deployment Group.

class EcsService

Implements: IConstruct, IConstruct, IConstruct, IDependable, IConnectable, IEcsService Extends: Construct

Initializer

new EcsService(scope: Construct, id: string, props: EcsServiceProps)
  • scope (Construct) No description
  • id (string) No description
  • props (EcsServiceProps) No description
    • cluster (ICluster) No description
    • prodTargetGroup (ITargetGroup) No description
    • serviceName (string) No description
    • taskDefinition (DummyTaskDefinition) No description
    • containerPort (number) No description Optional
    • desiredCount (number) No description Optional
    • launchType (LaunchType) No description Optional
    • platformVersion (string) No description Optional
    • securityGroups (Array<SecurityGroup>) No description Optional

Properties

Name Type Description
clusterName string
connections Connections
serviceName string

class PushImageProject

Implements: IConstruct, IConstruct, IConstruct, IDependable, IResource, IConstruct, IDependable, IConstruct, IProject, IConstruct, IDependable, IConstruct, IResource, IGrantable, IConnectable Extends: PipelineProject

Initializer

new PushImageProject(scope: Construct, id: string, props: PushImageProjectProps)

struct DummyTaskDefinitionProps

Name Type Description
image string
containerPort? number Optional
family? string Optional

struct EcsDeploymentGroupProps

Name Type Description
deploymentGroupName string
ecsServices Array<IEcsService>
prodTrafficListener TrafficListener
targetGroupNames Array
testTrafficListener TrafficListener
applicationName? string Optional
autoRollbackOnEvents? Array<RollbackEvent> The event type or types that trigger a rollback.
Optional
deploymentConfig? IEcsDeploymentConfig Optional
terminationWaitTimeInMinutes? number the number of minutes before deleting the original (blue) task set.
Default: 60

struct EcsServiceProps

Name Type Description
cluster ICluster
prodTargetGroup ITargetGroup
serviceName string
taskDefinition DummyTaskDefinition
containerPort? number Optional
desiredCount? number Optional
launchType? LaunchType Optional
platformVersion? string Optional
securityGroups? Array<SecurityGroup> Optional

interface IDummyTaskDefinition

Implemented by: DummyTaskDefinition

Properties

Name Type Description
executionRole IRole
family string
taskDefinitionArn string

interface IEcsService

Implemented by: EcsService

Properties

Name Type Description
clusterName string
serviceName string

struct PushImageProjectProps

Name Type Description
imageRepository IRepository
taskDefinition IDummyTaskDefinition
buildSpec? BuildSpec Optional
cache? Cache Optional
computeType? ComputeType Optional
environmentVariables? Map<string, BuildEnvironmentVariable> Optional
projectName? string Optional

struct TrafficListener

Name Type Description
listenerArn string ARN of the listener.

enum RollbackEvent

Name Description
DEPLOYMENT_FAILURE
DEPLOYMENT_STOP_ON_ALARM
DEPLOYMENT_STOP_ON_REQUEST

enum SchedulingStrategy

Name Description
REPLICA
DAEMON