From 126dfc750d073ae9d2700be8fafc2ee2aab2abb7 Mon Sep 17 00:00:00 2001 From: kaizen3031593 Date: Tue, 12 Apr 2022 18:53:39 -0400 Subject: [PATCH] update api.md --- API.md | 1778 ++++++++++++++++++++++++++++---------------------------- 1 file changed, 889 insertions(+), 889 deletions(-) diff --git a/API.md b/API.md index 93ba25c2..4ec3dae6 100644 --- a/API.md +++ b/API.md @@ -2,9 +2,9 @@ ## Constructs -### Environment +### Environment -- *Implements:* IEnvironment +- *Implements:* IEnvironment An environment into which to deploy a service. @@ -13,37 +13,37 @@ can either be instantiated with a pre-existing AWS VPC and ECS cluster, or it can create its own VPC and cluster. By default, it will create a cluster with Fargate capacity. -#### Initializers +#### Initializers ```typescript -import { Environment } from 'cdk-ecs-service-extensions' +import { Environment } from '@aws-cdk-containers/ecs-service-extensions' new Environment(scope: Construct, id: string, props?: EnvironmentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | *No description.* | -| id | string | *No description.* | -| props | EnvironmentProps | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | EnvironmentProps | *No description.* | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct --- -##### `id`Required +##### `id`Required - *Type:* string --- -##### `props`Optional +##### `props`Optional -- *Type:* EnvironmentProps +- *Type:* EnvironmentProps --- @@ -51,12 +51,12 @@ new Environment(scope: Construct, id: string, props?: EnvironmentProps) | **Name** | **Description** | | --- | --- | -| toString | Returns a string representation of this construct. | -| addDefaultCloudMapNamespace | Add a default cloudmap namespace to the environment's cluster. | +| toString | Returns a string representation of this construct. | +| addDefaultCloudMapNamespace | Add a default cloudmap namespace to the environment's cluster. | --- -##### `toString` +##### `toString` ```typescript public toString(): string @@ -64,7 +64,7 @@ public toString(): string Returns a string representation of this construct. -##### `addDefaultCloudMapNamespace` +##### `addDefaultCloudMapNamespace` ```typescript public addDefaultCloudMapNamespace(options: CloudMapNamespaceOptions): void @@ -74,7 +74,7 @@ Add a default cloudmap namespace to the environment's cluster. The environment's cluster must not be imported. -###### `options`Required +###### `options`Required - *Type:* aws-cdk-lib.aws_ecs.CloudMapNamespaceOptions @@ -84,15 +84,15 @@ The environment's cluster must not be imported. | **Name** | **Description** | | --- | --- | -| isConstruct | Checks if `x` is a construct. | -| fromEnvironmentAttributes | Import an existing environment from its attributes. | +| isConstruct | Checks if `x` is a construct. | +| fromEnvironmentAttributes | Import an existing environment from its attributes. | --- -##### `isConstruct` +##### `isConstruct` ```typescript -import { Environment } from 'cdk-ecs-service-extensions' +import { Environment } from '@aws-cdk-containers/ecs-service-extensions' Environment.isConstruct(x: any) ``` @@ -113,7 +113,7 @@ library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. -###### `x`Required +###### `x`Required - *Type:* any @@ -121,31 +121,31 @@ Any object. --- -##### `fromEnvironmentAttributes` +##### `fromEnvironmentAttributes` ```typescript -import { Environment } from 'cdk-ecs-service-extensions' +import { Environment } from '@aws-cdk-containers/ecs-service-extensions' Environment.fromEnvironmentAttributes(scope: Construct, id: string, attrs: EnvironmentAttributes) ``` Import an existing environment from its attributes. -###### `scope`Required +###### `scope`Required - *Type:* constructs.Construct --- -###### `id`Required +###### `id`Required - *Type:* string --- -###### `attrs`Required +###### `attrs`Required -- *Type:* EnvironmentAttributes +- *Type:* EnvironmentAttributes --- @@ -153,15 +153,15 @@ Import an existing environment from its attributes. | **Name** | **Type** | **Description** | | --- | --- | --- | -| node | constructs.Node | The tree node. | -| capacityType | EnvironmentCapacityType | The capacity type used by the service's cluster. | -| cluster | aws-cdk-lib.aws_ecs.ICluster | The cluster that is providing capacity for this service. | -| id | string | The name of this environment. | -| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC where environment services should be placed. | +| node | constructs.Node | The tree node. | +| capacityType | EnvironmentCapacityType | The capacity type used by the service's cluster. | +| cluster | aws-cdk-lib.aws_ecs.ICluster | The cluster that is providing capacity for this service. | +| id | string | The name of this environment. | +| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC where environment services should be placed. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -173,19 +173,19 @@ The tree node. --- -##### `capacityType`Required +##### `capacityType`Required ```typescript public readonly capacityType: EnvironmentCapacityType; ``` -- *Type:* EnvironmentCapacityType +- *Type:* EnvironmentCapacityType The capacity type used by the service's cluster. --- -##### `cluster`Required +##### `cluster`Required ```typescript public readonly cluster: ICluster; @@ -197,7 +197,7 @@ The cluster that is providing capacity for this service. --- -##### `id`Required +##### `id`Required ```typescript public readonly id: string; @@ -209,7 +209,7 @@ The name of this environment. --- -##### `vpc`Required +##### `vpc`Required ```typescript public readonly vpc: IVpc; @@ -222,41 +222,41 @@ The VPC where environment services should be placed. --- -### ImportedEnvironment +### ImportedEnvironment -- *Implements:* IEnvironment +- *Implements:* IEnvironment -#### Initializers +#### Initializers ```typescript -import { ImportedEnvironment } from 'cdk-ecs-service-extensions' +import { ImportedEnvironment } from '@aws-cdk-containers/ecs-service-extensions' new ImportedEnvironment(scope: Construct, id: string, props: EnvironmentAttributes) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | *No description.* | -| id | string | *No description.* | -| props | EnvironmentAttributes | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | EnvironmentAttributes | *No description.* | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct --- -##### `id`Required +##### `id`Required - *Type:* string --- -##### `props`Required +##### `props`Required -- *Type:* EnvironmentAttributes +- *Type:* EnvironmentAttributes --- @@ -264,12 +264,12 @@ new ImportedEnvironment(scope: Construct, id: string, props: EnvironmentAttribut | **Name** | **Description** | | --- | --- | -| toString | Returns a string representation of this construct. | -| addDefaultCloudMapNamespace | Adding a default cloudmap namespace to the cluster will throw an error, as we don't own it. | +| toString | Returns a string representation of this construct. | +| addDefaultCloudMapNamespace | Adding a default cloudmap namespace to the cluster will throw an error, as we don't own it. | --- -##### `toString` +##### `toString` ```typescript public toString(): string @@ -277,7 +277,7 @@ public toString(): string Returns a string representation of this construct. -##### `addDefaultCloudMapNamespace` +##### `addDefaultCloudMapNamespace` ```typescript public addDefaultCloudMapNamespace(_options: CloudMapNamespaceOptions): void @@ -285,7 +285,7 @@ public addDefaultCloudMapNamespace(_options: CloudMapNamespaceOptions): void Adding a default cloudmap namespace to the cluster will throw an error, as we don't own it. -###### `_options`Required +###### `_options`Required - *Type:* aws-cdk-lib.aws_ecs.CloudMapNamespaceOptions @@ -295,14 +295,14 @@ Adding a default cloudmap namespace to the cluster will throw an error, as we do | **Name** | **Description** | | --- | --- | -| isConstruct | Checks if `x` is a construct. | +| isConstruct | Checks if `x` is a construct. | --- -##### `isConstruct` +##### `isConstruct` ```typescript -import { ImportedEnvironment } from 'cdk-ecs-service-extensions' +import { ImportedEnvironment } from '@aws-cdk-containers/ecs-service-extensions' ImportedEnvironment.isConstruct(x: any) ``` @@ -323,7 +323,7 @@ library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. -###### `x`Required +###### `x`Required - *Type:* any @@ -335,15 +335,15 @@ Any object. | **Name** | **Type** | **Description** | | --- | --- | --- | -| node | constructs.Node | The tree node. | -| capacityType | EnvironmentCapacityType | The capacity type used by the service's cluster. | -| cluster | aws-cdk-lib.aws_ecs.ICluster | The cluster that is providing capacity for this service. | -| id | string | The name of this environment. | -| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC into which environment services should be placed. | +| node | constructs.Node | The tree node. | +| capacityType | EnvironmentCapacityType | The capacity type used by the service's cluster. | +| cluster | aws-cdk-lib.aws_ecs.ICluster | The cluster that is providing capacity for this service. | +| id | string | The name of this environment. | +| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC into which environment services should be placed. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -355,19 +355,19 @@ The tree node. --- -##### `capacityType`Required +##### `capacityType`Required ```typescript public readonly capacityType: EnvironmentCapacityType; ``` -- *Type:* EnvironmentCapacityType +- *Type:* EnvironmentCapacityType The capacity type used by the service's cluster. --- -##### `cluster`Required +##### `cluster`Required ```typescript public readonly cluster: ICluster; @@ -379,7 +379,7 @@ The cluster that is providing capacity for this service. --- -##### `id`Required +##### `id`Required ```typescript public readonly id: string; @@ -391,7 +391,7 @@ The name of this environment. --- -##### `vpc`Required +##### `vpc`Required ```typescript public readonly vpc: IVpc; @@ -404,7 +404,7 @@ The VPC into which environment services should be placed. --- -### Service +### Service This Service construct serves as a Builder class for an ECS service. @@ -412,37 +412,37 @@ It supports various extensions and keeps track of any mutating state, allowing it to build up an ECS service progressively. -#### Initializers +#### Initializers ```typescript -import { Service } from 'cdk-ecs-service-extensions' +import { Service } from '@aws-cdk-containers/ecs-service-extensions' new Service(scope: Construct, id: string, props: ServiceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | *No description.* | -| id | string | *No description.* | -| props | ServiceProps | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | ServiceProps | *No description.* | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct --- -##### `id`Required +##### `id`Required - *Type:* string --- -##### `props`Required +##### `props`Required -- *Type:* ServiceProps +- *Type:* ServiceProps --- @@ -450,15 +450,15 @@ new Service(scope: Construct, id: string, props: ServiceProps) | **Name** | **Description** | | --- | --- | -| toString | Returns a string representation of this construct. | -| addURL | This method adds a new URL for the service. | -| connectTo | Tell extensions from one service to connect to extensions from another sevice if they have implemented a hook for it. | -| enableAutoScalingPolicy | This helper method is used to set the `autoScalingPoliciesEnabled` attribute whenever an auto scaling policy is configured for the service. | -| getURL | Retrieve a URL for the service. | +| toString | Returns a string representation of this construct. | +| addURL | This method adds a new URL for the service. | +| connectTo | Tell extensions from one service to connect to extensions from another sevice if they have implemented a hook for it. | +| enableAutoScalingPolicy | This helper method is used to set the `autoScalingPoliciesEnabled` attribute whenever an auto scaling policy is configured for the service. | +| getURL | Retrieve a URL for the service. | --- -##### `toString` +##### `toString` ```typescript public toString(): string @@ -466,7 +466,7 @@ public toString(): string Returns a string representation of this construct. -##### `addURL` +##### `addURL` ```typescript public addURL(urlName: string, url: string): void @@ -478,7 +478,7 @@ This allows extensions to submit a URL for the service. For example, a load balancer might add its URL, or App Mesh can add its DNS name for the service. -###### `urlName`Required +###### `urlName`Required - *Type:* string @@ -486,7 +486,7 @@ The identifier name for this URL. --- -###### `url`Required +###### `url`Required - *Type:* string @@ -494,7 +494,7 @@ The URL itself. --- -##### `connectTo` +##### `connectTo` ```typescript public connectTo(service: Service, connectToProps?: ConnectToProps): void @@ -502,19 +502,19 @@ public connectTo(service: Service, connectToProps?: ConnectToProps): void Tell extensions from one service to connect to extensions from another sevice if they have implemented a hook for it. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service --- -###### `connectToProps`Optional +###### `connectToProps`Optional -- *Type:* ConnectToProps +- *Type:* ConnectToProps --- -##### `enableAutoScalingPolicy` +##### `enableAutoScalingPolicy` ```typescript public enableAutoScalingPolicy(): void @@ -522,7 +522,7 @@ public enableAutoScalingPolicy(): void This helper method is used to set the `autoScalingPoliciesEnabled` attribute whenever an auto scaling policy is configured for the service. -##### `getURL` +##### `getURL` ```typescript public getURL(urlName: string): string @@ -533,7 +533,7 @@ Retrieve a URL for the service. The URL must have previously been stored by one of the URL providing extensions. -###### `urlName`Required +###### `urlName`Required - *Type:* string @@ -545,14 +545,14 @@ The URL to look up. | **Name** | **Description** | | --- | --- | -| isConstruct | Checks if `x` is a construct. | +| isConstruct | Checks if `x` is a construct. | --- -##### `isConstruct` +##### `isConstruct` ```typescript -import { Service } from 'cdk-ecs-service-extensions' +import { Service } from '@aws-cdk-containers/ecs-service-extensions' Service.isConstruct(x: any) ``` @@ -573,7 +573,7 @@ library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. -###### `x`Required +###### `x`Required - *Type:* any @@ -585,19 +585,19 @@ Any object. | **Name** | **Type** | **Description** | | --- | --- | --- | -| node | constructs.Node | The tree node. | -| capacityType | EnvironmentCapacityType | The capacity type that this service will use. | -| cluster | aws-cdk-lib.aws_ecs.ICluster | The cluster that is providing capacity for this service. | -| environment | IEnvironment | The environment where this service was launched. | -| id | string | The name of the service. | -| serviceDescription | ServiceDescription | The ServiceDescription used to build this service. | -| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC where this service should be placed. | -| scalableTaskCount | aws-cdk-lib.aws_ecs.ScalableTaskCount | The scalable attribute representing task count. | -| ecsService | aws-cdk-lib.aws_ecs.Ec2Service \| aws-cdk-lib.aws_ecs.FargateService | The underlying ECS service that was created. | +| node | constructs.Node | The tree node. | +| capacityType | EnvironmentCapacityType | The capacity type that this service will use. | +| cluster | aws-cdk-lib.aws_ecs.ICluster | The cluster that is providing capacity for this service. | +| environment | IEnvironment | The environment where this service was launched. | +| id | string | The name of the service. | +| serviceDescription | ServiceDescription | The ServiceDescription used to build this service. | +| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC where this service should be placed. | +| scalableTaskCount | aws-cdk-lib.aws_ecs.ScalableTaskCount | The scalable attribute representing task count. | +| ecsService | aws-cdk-lib.aws_ecs.Ec2Service \| aws-cdk-lib.aws_ecs.FargateService | The underlying ECS service that was created. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -609,13 +609,13 @@ The tree node. --- -##### `capacityType`Required +##### `capacityType`Required ```typescript public readonly capacityType: EnvironmentCapacityType; ``` -- *Type:* EnvironmentCapacityType +- *Type:* EnvironmentCapacityType The capacity type that this service will use. @@ -623,7 +623,7 @@ Valid values are EC2 or FARGATE. --- -##### `cluster`Required +##### `cluster`Required ```typescript public readonly cluster: ICluster; @@ -637,19 +637,19 @@ The cluster that is providing capacity for this service. --- -##### `environment`Required +##### `environment`Required ```typescript public readonly environment: IEnvironment; ``` -- *Type:* IEnvironment +- *Type:* IEnvironment The environment where this service was launched. --- -##### `id`Required +##### `id`Required ```typescript public readonly id: string; @@ -661,19 +661,19 @@ The name of the service. --- -##### `serviceDescription`Required +##### `serviceDescription`Required ```typescript public readonly serviceDescription: ServiceDescription; ``` -- *Type:* ServiceDescription +- *Type:* ServiceDescription The ServiceDescription used to build this service. --- -##### `vpc`Required +##### `vpc`Required ```typescript public readonly vpc: IVpc; @@ -685,7 +685,7 @@ The VPC where this service should be placed. --- -##### `scalableTaskCount`Optional +##### `scalableTaskCount`Optional ```typescript public readonly scalableTaskCount: ScalableTaskCount; @@ -697,7 +697,7 @@ The scalable attribute representing task count. --- -##### `ecsService`Required +##### `ecsService`Required ```typescript public readonly ecsService: Ec2Service | FargateService; @@ -712,12 +712,12 @@ The underlying ECS service that was created. ## Structs -### AssignPublicIpDnsOptions +### AssignPublicIpDnsOptions -#### Initializer +#### Initializer ```typescript -import { AssignPublicIpDnsOptions } from 'cdk-ecs-service-extensions' +import { AssignPublicIpDnsOptions } from '@aws-cdk-containers/ecs-service-extensions' const assignPublicIpDnsOptions: AssignPublicIpDnsOptions = { ... } ``` @@ -726,12 +726,12 @@ const assignPublicIpDnsOptions: AssignPublicIpDnsOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| recordName | string | Name of the record to add to the zone and in which to add the task IP addresses to. | -| zone | aws-cdk-lib.aws_route53.IHostedZone | A DNS Zone to expose task IPs in. | +| recordName | string | Name of the record to add to the zone and in which to add the task IP addresses to. | +| zone | aws-cdk-lib.aws_route53.IHostedZone | A DNS Zone to expose task IPs in. | --- -##### `recordName`Required +##### `recordName`Required ```typescript public readonly recordName: string; @@ -750,7 +750,7 @@ Name of the record to add to the zone and in which to add the task IP addresses ``` -##### `zone`Required +##### `zone`Required ```typescript public readonly zone: IHostedZone; @@ -762,12 +762,12 @@ A DNS Zone to expose task IPs in. --- -### AssignPublicIpExtensionOptions +### AssignPublicIpExtensionOptions -#### Initializer +#### Initializer ```typescript -import { AssignPublicIpExtensionOptions } from 'cdk-ecs-service-extensions' +import { AssignPublicIpExtensionOptions } from '@aws-cdk-containers/ecs-service-extensions' const assignPublicIpExtensionOptions: AssignPublicIpExtensionOptions = { ... } ``` @@ -776,17 +776,17 @@ const assignPublicIpExtensionOptions: AssignPublicIpExtensionOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| dns | AssignPublicIpDnsOptions | Enable publishing task public IPs to a recordset in a Route 53 hosted zone. | +| dns | AssignPublicIpDnsOptions | Enable publishing task public IPs to a recordset in a Route 53 hosted zone. | --- -##### `dns`Optional +##### `dns`Optional ```typescript public readonly dns: AssignPublicIpDnsOptions; ``` -- *Type:* AssignPublicIpDnsOptions +- *Type:* AssignPublicIpDnsOptions Enable publishing task public IPs to a recordset in a Route 53 hosted zone. @@ -795,12 +795,12 @@ remove this extension completely and then re-add it. --- -### AutoScalingOptions +### AutoScalingOptions -#### Initializer +#### Initializer ```typescript -import { AutoScalingOptions } from 'cdk-ecs-service-extensions' +import { AutoScalingOptions } from '@aws-cdk-containers/ecs-service-extensions' const autoScalingOptions: AutoScalingOptions = { ... } ``` @@ -809,14 +809,14 @@ const autoScalingOptions: AutoScalingOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| maxTaskCount | number | The maximum number of tasks when scaling out. | -| minTaskCount | number | The minimum number of tasks when scaling in. | -| targetCpuUtilization | number | The target value for CPU utilization across all tasks in the service. | -| targetMemoryUtilization | number | The target value for memory utilization across all tasks in the service. | +| maxTaskCount | number | The maximum number of tasks when scaling out. | +| minTaskCount | number | The minimum number of tasks when scaling in. | +| targetCpuUtilization | number | The target value for CPU utilization across all tasks in the service. | +| targetMemoryUtilization | number | The target value for memory utilization across all tasks in the service. | --- -##### `maxTaskCount`Required +##### `maxTaskCount`Required ```typescript public readonly maxTaskCount: number; @@ -828,7 +828,7 @@ The maximum number of tasks when scaling out. --- -##### `minTaskCount`Optional +##### `minTaskCount`Optional ```typescript public readonly minTaskCount: number; @@ -841,7 +841,7 @@ The minimum number of tasks when scaling in. --- -##### `targetCpuUtilization`Optional +##### `targetCpuUtilization`Optional ```typescript public readonly targetCpuUtilization: number; @@ -853,7 +853,7 @@ The target value for CPU utilization across all tasks in the service. --- -##### `targetMemoryUtilization`Optional +##### `targetMemoryUtilization`Optional ```typescript public readonly targetMemoryUtilization: number; @@ -865,14 +865,14 @@ The target value for memory utilization across all tasks in the service. --- -### ConnectToProps +### ConnectToProps connectToProps will have all the extra parameters which are required for connecting services. -#### Initializer +#### Initializer ```typescript -import { ConnectToProps } from 'cdk-ecs-service-extensions' +import { ConnectToProps } from '@aws-cdk-containers/ecs-service-extensions' const connectToProps: ConnectToProps = { ... } ``` @@ -881,11 +881,11 @@ const connectToProps: ConnectToProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| localBindPort | number | localBindPort is the local port that this application should use when calling the upstream service in ECS Consul Mesh Extension Currently, this parameter will only be used in the ECSConsulMeshExtension https://github.com/aws-ia/ecs-consul-mesh-extension. | +| localBindPort | number | localBindPort is the local port that this application should use when calling the upstream service in ECS Consul Mesh Extension Currently, this parameter will only be used in the ECSConsulMeshExtension https://github.com/aws-ia/ecs-consul-mesh-extension. | --- -##### `localBindPort`Optional +##### `localBindPort`Optional ```typescript public readonly localBindPort: number; @@ -897,14 +897,14 @@ localBindPort is the local port that this application should use when calling th --- -### ContainerExtensionProps +### ContainerExtensionProps Setting for the main application container of a service. -#### Initializer +#### Initializer ```typescript -import { ContainerExtensionProps } from 'cdk-ecs-service-extensions' +import { ContainerExtensionProps } from '@aws-cdk-containers/ecs-service-extensions' const containerExtensionProps: ContainerExtensionProps = { ... } ``` @@ -913,16 +913,16 @@ const containerExtensionProps: ContainerExtensionProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| cpu | number | How much CPU the container requires. | -| image | aws-cdk-lib.aws_ecs.ContainerImage | The image to run. | -| memoryMiB | number | How much memory in megabytes the container requires. | -| trafficPort | number | What port the image listen for traffic on. | -| environment | {[ key: string ]: string} | Environment variables to pass into the container. | -| logGroup | aws-cdk-lib.aws_logs.ILogGroup | The log group into which application container logs should be routed. | +| cpu | number | How much CPU the container requires. | +| image | aws-cdk-lib.aws_ecs.ContainerImage | The image to run. | +| memoryMiB | number | How much memory in megabytes the container requires. | +| trafficPort | number | What port the image listen for traffic on. | +| environment | {[ key: string ]: string} | Environment variables to pass into the container. | +| logGroup | aws-cdk-lib.aws_logs.ILogGroup | The log group into which application container logs should be routed. | --- -##### `cpu`Required +##### `cpu`Required ```typescript public readonly cpu: number; @@ -934,7 +934,7 @@ How much CPU the container requires. --- -##### `image`Required +##### `image`Required ```typescript public readonly image: ContainerImage; @@ -946,7 +946,7 @@ The image to run. --- -##### `memoryMiB`Required +##### `memoryMiB`Required ```typescript public readonly memoryMiB: number; @@ -958,7 +958,7 @@ How much memory in megabytes the container requires. --- -##### `trafficPort`Required +##### `trafficPort`Required ```typescript public readonly trafficPort: number; @@ -970,7 +970,7 @@ What port the image listen for traffic on. --- -##### `environment`Optional +##### `environment`Optional ```typescript public readonly environment: {[ key: string ]: string}; @@ -983,7 +983,7 @@ Environment variables to pass into the container. --- -##### `logGroup`Optional +##### `logGroup`Optional ```typescript public readonly logGroup: ILogGroup; @@ -996,14 +996,14 @@ The log group into which application container logs should be routed. --- -### CpuScalingProps +### CpuScalingProps The autoscaling settings. -#### Initializer +#### Initializer ```typescript -import { CpuScalingProps } from 'cdk-ecs-service-extensions' +import { CpuScalingProps } from '@aws-cdk-containers/ecs-service-extensions' const cpuScalingProps: CpuScalingProps = { ... } ``` @@ -1012,16 +1012,16 @@ const cpuScalingProps: CpuScalingProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| initialTaskCount | number | How many tasks to launch initially. | -| maxTaskCount | number | The maximum number of tasks when scaling out. | -| minTaskCount | number | The minimum number of tasks when scaling in. | -| scaleInCooldown | aws-cdk-lib.Duration | How long to wait between scale in actions. | -| scaleOutCooldown | aws-cdk-lib.Duration | How long to wait between scale out actions. | -| targetCpuUtilization | number | The CPU utilization to try ot maintain. | +| initialTaskCount | number | How many tasks to launch initially. | +| maxTaskCount | number | The maximum number of tasks when scaling out. | +| minTaskCount | number | The minimum number of tasks when scaling in. | +| scaleInCooldown | aws-cdk-lib.Duration | How long to wait between scale in actions. | +| scaleOutCooldown | aws-cdk-lib.Duration | How long to wait between scale out actions. | +| targetCpuUtilization | number | The CPU utilization to try ot maintain. | --- -##### ~~`initialTaskCount`~~Optional +##### ~~`initialTaskCount`~~Optional - *Deprecated:* use the `minTaskCount` and `maxTaskCount` properties of `autoScaleTaskCount` in the `Service` construct to configure the auto scaling target for the service. For more information, please refer @@ -1038,7 +1038,7 @@ How many tasks to launch initially. --- -##### ~~`maxTaskCount`~~Optional +##### ~~`maxTaskCount`~~Optional - *Deprecated:* use the `minTaskCount` and `maxTaskCount` properties of `autoScaleTaskCount` in the `Service` construct to configure the auto scaling target for the service. For more information, please refer @@ -1055,7 +1055,7 @@ The maximum number of tasks when scaling out. --- -##### ~~`minTaskCount`~~Optional +##### ~~`minTaskCount`~~Optional - *Deprecated:* use the `minTaskCount` and `maxTaskCount` properties of `autoScaleTaskCount` in the `Service` construct to configure the auto scaling target for the service. For more information, please refer @@ -1072,7 +1072,7 @@ The minimum number of tasks when scaling in. --- -##### ~~`scaleInCooldown`~~Optional +##### ~~`scaleInCooldown`~~Optional - *Deprecated:* use the `minTaskCount` and `maxTaskCount` properties of `autoScaleTaskCount` in the `Service` construct to configure the auto scaling target for the service. For more information, please refer @@ -1089,7 +1089,7 @@ How long to wait between scale in actions. --- -##### ~~`scaleOutCooldown`~~Optional +##### ~~`scaleOutCooldown`~~Optional - *Deprecated:* use the `minTaskCount` and `maxTaskCount` properties of `autoScaleTaskCount` in the `Service` construct to configure the auto scaling target for the service. For more information, please refer @@ -1106,7 +1106,7 @@ How long to wait between scale out actions. --- -##### ~~`targetCpuUtilization`~~Optional +##### ~~`targetCpuUtilization`~~Optional - *Deprecated:* use the `minTaskCount` and `maxTaskCount` properties of `autoScaleTaskCount` in the `Service` construct to configure the auto scaling target for the service. For more information, please refer @@ -1123,12 +1123,12 @@ The CPU utilization to try ot maintain. --- -### EnvironmentAttributes +### EnvironmentAttributes -#### Initializer +#### Initializer ```typescript -import { EnvironmentAttributes } from 'cdk-ecs-service-extensions' +import { EnvironmentAttributes } from '@aws-cdk-containers/ecs-service-extensions' const environmentAttributes: EnvironmentAttributes = { ... } ``` @@ -1137,24 +1137,24 @@ const environmentAttributes: EnvironmentAttributes = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| capacityType | EnvironmentCapacityType | The capacity type used by the service's cluster. | -| cluster | aws-cdk-lib.aws_ecs.ICluster | The cluster that is providing capacity for this service. | +| capacityType | EnvironmentCapacityType | The capacity type used by the service's cluster. | +| cluster | aws-cdk-lib.aws_ecs.ICluster | The cluster that is providing capacity for this service. | --- -##### `capacityType`Required +##### `capacityType`Required ```typescript public readonly capacityType: EnvironmentCapacityType; ``` -- *Type:* EnvironmentCapacityType +- *Type:* EnvironmentCapacityType The capacity type used by the service's cluster. --- -##### `cluster`Required +##### `cluster`Required ```typescript public readonly cluster: ICluster; @@ -1166,14 +1166,14 @@ The cluster that is providing capacity for this service. --- -### EnvironmentProps +### EnvironmentProps Settings for the environment where you want to deploy your services. -#### Initializer +#### Initializer ```typescript -import { EnvironmentProps } from 'cdk-ecs-service-extensions' +import { EnvironmentProps } from '@aws-cdk-containers/ecs-service-extensions' const environmentProps: EnvironmentProps = { ... } ``` @@ -1182,26 +1182,26 @@ const environmentProps: EnvironmentProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| capacityType | EnvironmentCapacityType | The type of capacity to use for this environment. | -| cluster | aws-cdk-lib.aws_ecs.Cluster | The ECS cluster which provides compute capacity to this service. | -| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC used by the service for networking. | +| capacityType | EnvironmentCapacityType | The type of capacity to use for this environment. | +| cluster | aws-cdk-lib.aws_ecs.Cluster | The ECS cluster which provides compute capacity to this service. | +| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC used by the service for networking. | --- -##### `capacityType`Optional +##### `capacityType`Optional ```typescript public readonly capacityType: EnvironmentCapacityType; ``` -- *Type:* EnvironmentCapacityType +- *Type:* EnvironmentCapacityType - *Default:* EnvironmentCapacityType.FARGATE The type of capacity to use for this environment. --- -##### `cluster`Optional +##### `cluster`Optional ```typescript public readonly cluster: Cluster; @@ -1216,7 +1216,7 @@ The ECS cluster which provides compute capacity to this service. --- -##### `vpc`Optional +##### `vpc`Optional ```typescript public readonly vpc: IVpc; @@ -1229,14 +1229,14 @@ The VPC used by the service for networking. --- -### FirelensProps +### FirelensProps Settings for the hook which mutates the application container to route logs through FireLens. -#### Initializer +#### Initializer ```typescript -import { FirelensProps } from 'cdk-ecs-service-extensions' +import { FirelensProps } from '@aws-cdk-containers/ecs-service-extensions' const firelensProps: FirelensProps = { ... } ``` @@ -1245,12 +1245,12 @@ const firelensProps: FirelensProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| logGroup | aws-cdk-lib.aws_logs.LogGroup | The log group into which logs should be routed. | -| parentService | Service | The parent service that is being mutated. | +| logGroup | aws-cdk-lib.aws_logs.LogGroup | The log group into which logs should be routed. | +| parentService | Service | The parent service that is being mutated. | --- -##### `logGroup`Required +##### `logGroup`Required ```typescript public readonly logGroup: LogGroup; @@ -1262,24 +1262,24 @@ The log group into which logs should be routed. --- -##### `parentService`Required +##### `parentService`Required ```typescript public readonly parentService: Service; ``` -- *Type:* Service +- *Type:* Service The parent service that is being mutated. --- -### HttpLoadBalancerProps +### HttpLoadBalancerProps -#### Initializer +#### Initializer ```typescript -import { HttpLoadBalancerProps } from 'cdk-ecs-service-extensions' +import { HttpLoadBalancerProps } from '@aws-cdk-containers/ecs-service-extensions' const httpLoadBalancerProps: HttpLoadBalancerProps = { ... } ``` @@ -1288,11 +1288,11 @@ const httpLoadBalancerProps: HttpLoadBalancerProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| requestsPerTarget | number | The number of ALB requests per target. | +| requestsPerTarget | number | The number of ALB requests per target. | --- -##### `requestsPerTarget`Optional +##### `requestsPerTarget`Optional ```typescript public readonly requestsPerTarget: number; @@ -1304,14 +1304,14 @@ The number of ALB requests per target. --- -### InjectableTopicProps +### InjectableTopicProps The settings for the `InjectableTopic` class. -#### Initializer +#### Initializer ```typescript -import { InjectableTopicProps } from 'cdk-ecs-service-extensions' +import { InjectableTopicProps } from '@aws-cdk-containers/ecs-service-extensions' const injectableTopicProps: InjectableTopicProps = { ... } ``` @@ -1320,11 +1320,11 @@ const injectableTopicProps: InjectableTopicProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| topic | aws-cdk-lib.aws_sns.ITopic | The SNS Topic to publish events to. | +| topic | aws-cdk-lib.aws_sns.ITopic | The SNS Topic to publish events to. | --- -##### `topic`Required +##### `topic`Required ```typescript public readonly topic: ITopic; @@ -1336,14 +1336,14 @@ The SNS Topic to publish events to. --- -### InjecterExtensionProps +### InjecterExtensionProps The settings for the Injecter extension. -#### Initializer +#### Initializer ```typescript -import { InjecterExtensionProps } from 'cdk-ecs-service-extensions' +import { InjecterExtensionProps } from '@aws-cdk-containers/ecs-service-extensions' const injecterExtensionProps: InjecterExtensionProps = { ... } ``` @@ -1352,30 +1352,30 @@ const injecterExtensionProps: InjecterExtensionProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| injectables | IInjectable[] | The list of injectable resources for this service. | +| injectables | IInjectable[] | The list of injectable resources for this service. | --- -##### `injectables`Required +##### `injectables`Required ```typescript public readonly injectables: IInjectable[]; ``` -- *Type:* IInjectable[] +- *Type:* IInjectable[] The list of injectable resources for this service. --- -### MeshProps +### MeshProps The settings for the App Mesh extension. -#### Initializer +#### Initializer ```typescript -import { MeshProps } from 'cdk-ecs-service-extensions' +import { MeshProps } from '@aws-cdk-containers/ecs-service-extensions' const meshProps: MeshProps = { ... } ``` @@ -1384,12 +1384,12 @@ const meshProps: MeshProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| mesh | aws-cdk-lib.aws_appmesh.Mesh | The service mesh into which to register the service. | -| protocol | Protocol | The protocol of the service. | +| mesh | aws-cdk-lib.aws_appmesh.Mesh | The service mesh into which to register the service. | +| protocol | Protocol | The protocol of the service. | --- -##### `mesh`Required +##### `mesh`Required ```typescript public readonly mesh: Mesh; @@ -1401,13 +1401,13 @@ The service mesh into which to register the service. --- -##### `protocol`Optional +##### `protocol`Optional ```typescript public readonly protocol: Protocol; ``` -- *Type:* Protocol +- *Type:* Protocol - *Default:* Protocol.HTTP The protocol of the service. @@ -1416,14 +1416,14 @@ Valid values are Protocol.HTTP, Protocol.HTTP2, Protocol.TCP, Protocol.GRPC --- -### QueueAutoScalingOptions +### QueueAutoScalingOptions Options for configuring SQS Queue auto scaling. -#### Initializer +#### Initializer ```typescript -import { QueueAutoScalingOptions } from 'cdk-ecs-service-extensions' +import { QueueAutoScalingOptions } from '@aws-cdk-containers/ecs-service-extensions' const queueAutoScalingOptions: QueueAutoScalingOptions = { ... } ``` @@ -1432,12 +1432,12 @@ const queueAutoScalingOptions: QueueAutoScalingOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| acceptableLatency | aws-cdk-lib.Duration | Acceptable amount of time a message can sit in the queue (including the time required to process it). | -| messageProcessingTime | aws-cdk-lib.Duration | Average amount of time for processing a single message in the queue. | +| acceptableLatency | aws-cdk-lib.Duration | Acceptable amount of time a message can sit in the queue (including the time required to process it). | +| messageProcessingTime | aws-cdk-lib.Duration | Average amount of time for processing a single message in the queue. | --- -##### `acceptableLatency`Required +##### `acceptableLatency`Required ```typescript public readonly acceptableLatency: Duration; @@ -1449,7 +1449,7 @@ Acceptable amount of time a message can sit in the queue (including the time req --- -##### `messageProcessingTime`Required +##### `messageProcessingTime`Required ```typescript public readonly messageProcessingTime: Duration; @@ -1461,14 +1461,14 @@ Average amount of time for processing a single message in the queue. --- -### QueueExtensionProps +### QueueExtensionProps The settings for the Queue extension. -#### Initializer +#### Initializer ```typescript -import { QueueExtensionProps } from 'cdk-ecs-service-extensions' +import { QueueExtensionProps } from '@aws-cdk-containers/ecs-service-extensions' const queueExtensionProps: QueueExtensionProps = { ... } ``` @@ -1477,13 +1477,13 @@ const queueExtensionProps: QueueExtensionProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| eventsQueue | aws-cdk-lib.aws_sqs.IQueue | The user-provided default queue for this service. | -| scaleOnLatency | QueueAutoScalingOptions | The user-provided queue delay fields to configure auto scaling for the default queue. | -| subscriptions | ISubscribable[] | The list of subscriptions for this service. | +| eventsQueue | aws-cdk-lib.aws_sqs.IQueue | The user-provided default queue for this service. | +| scaleOnLatency | QueueAutoScalingOptions | The user-provided queue delay fields to configure auto scaling for the default queue. | +| subscriptions | ISubscribable[] | The list of subscriptions for this service. | --- -##### `eventsQueue`Optional +##### `eventsQueue`Optional ```typescript public readonly eventsQueue: IQueue; @@ -1498,33 +1498,33 @@ If the `eventsQueue` is not provided, a default SQS Queue is created for the ser --- -##### `scaleOnLatency`Optional +##### `scaleOnLatency`Optional ```typescript public readonly scaleOnLatency: QueueAutoScalingOptions; ``` -- *Type:* QueueAutoScalingOptions +- *Type:* QueueAutoScalingOptions - *Default:* none The user-provided queue delay fields to configure auto scaling for the default queue. --- -##### `subscriptions`Optional +##### `subscriptions`Optional ```typescript public readonly subscriptions: ISubscribable[]; ``` -- *Type:* ISubscribable[] +- *Type:* ISubscribable[] - *Default:* none The list of subscriptions for this service. --- -### ServiceBuild +### ServiceBuild A set of mutable service props in the process of being assembled using a builder pattern. @@ -1532,10 +1532,10 @@ They will eventually to be translated into an ecs.Ec2ServiceProps or ecs.FargateServiceProps interface, depending on the environment's capacity type. -#### Initializer +#### Initializer ```typescript -import { ServiceBuild } from 'cdk-ecs-service-extensions' +import { ServiceBuild } from '@aws-cdk-containers/ecs-service-extensions' const serviceBuild: ServiceBuild = { ... } ``` @@ -1544,18 +1544,18 @@ const serviceBuild: ServiceBuild = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| cluster | aws-cdk-lib.aws_ecs.ICluster | The cluster in which to launch the service. | -| taskDefinition | aws-cdk-lib.aws_ecs.TaskDefinition | The task definition registered to this service. | -| assignPublicIp | boolean | Specifies whether the task's elastic network interface receives a public IP address. | -| cloudMapOptions | aws-cdk-lib.aws_ecs.CloudMapOptions | Configuration for how to register the service in service discovery. | -| desiredCount | number | How many tasks to run. | -| healthCheckGracePeriod | aws-cdk-lib.Duration | How long the healthcheck can fail during initial task startup before the task is considered unhealthy. | -| maxHealthyPercent | number | Maximum percentage of tasks that can be launched. | -| minHealthyPercent | number | Minimum healthy task percentage. | +| cluster | aws-cdk-lib.aws_ecs.ICluster | The cluster in which to launch the service. | +| taskDefinition | aws-cdk-lib.aws_ecs.TaskDefinition | The task definition registered to this service. | +| assignPublicIp | boolean | Specifies whether the task's elastic network interface receives a public IP address. | +| cloudMapOptions | aws-cdk-lib.aws_ecs.CloudMapOptions | Configuration for how to register the service in service discovery. | +| desiredCount | number | How many tasks to run. | +| healthCheckGracePeriod | aws-cdk-lib.Duration | How long the healthcheck can fail during initial task startup before the task is considered unhealthy. | +| maxHealthyPercent | number | Maximum percentage of tasks that can be launched. | +| minHealthyPercent | number | Minimum healthy task percentage. | --- -##### `cluster`Required +##### `cluster`Required ```typescript public readonly cluster: ICluster; @@ -1567,7 +1567,7 @@ The cluster in which to launch the service. --- -##### `taskDefinition`Required +##### `taskDefinition`Required ```typescript public readonly taskDefinition: TaskDefinition; @@ -1579,7 +1579,7 @@ The task definition registered to this service. --- -##### `assignPublicIp`Optional +##### `assignPublicIp`Optional ```typescript public readonly assignPublicIp: boolean; @@ -1594,7 +1594,7 @@ If true, each task will receive a public IP address. --- -##### `cloudMapOptions`Optional +##### `cloudMapOptions`Optional ```typescript public readonly cloudMapOptions: CloudMapOptions; @@ -1607,7 +1607,7 @@ Configuration for how to register the service in service discovery. --- -##### `desiredCount`Optional +##### `desiredCount`Optional ```typescript public readonly desiredCount: number; @@ -1620,7 +1620,7 @@ How many tasks to run. --- -##### `healthCheckGracePeriod`Optional +##### `healthCheckGracePeriod`Optional ```typescript public readonly healthCheckGracePeriod: Duration; @@ -1636,7 +1636,7 @@ time to start passing healthchecks. --- -##### `maxHealthyPercent`Optional +##### `maxHealthyPercent`Optional ```typescript public readonly maxHealthyPercent: number; @@ -1649,7 +1649,7 @@ Maximum percentage of tasks that can be launched. --- -##### `minHealthyPercent`Optional +##### `minHealthyPercent`Optional ```typescript public readonly minHealthyPercent: number; @@ -1662,14 +1662,14 @@ Minimum healthy task percentage. --- -### ServiceProps +### ServiceProps The settings for an ECS Service. -#### Initializer +#### Initializer ```typescript -import { ServiceProps } from 'cdk-ecs-service-extensions' +import { ServiceProps } from '@aws-cdk-containers/ecs-service-extensions' const serviceProps: ServiceProps = { ... } ``` @@ -1678,52 +1678,52 @@ const serviceProps: ServiceProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| environment | IEnvironment | The environment to launch the service in. | -| serviceDescription | ServiceDescription | The ServiceDescription used to build the service. | -| autoScaleTaskCount | AutoScalingOptions | The options for configuring the auto scaling target. | -| desiredCount | number | The desired number of instantiations of the task definition to keep running on the service. | -| taskRole | aws-cdk-lib.aws_iam.IRole | The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf. | +| environment | IEnvironment | The environment to launch the service in. | +| serviceDescription | ServiceDescription | The ServiceDescription used to build the service. | +| autoScaleTaskCount | AutoScalingOptions | The options for configuring the auto scaling target. | +| desiredCount | number | The desired number of instantiations of the task definition to keep running on the service. | +| taskRole | aws-cdk-lib.aws_iam.IRole | The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf. | --- -##### `environment`Required +##### `environment`Required ```typescript public readonly environment: IEnvironment; ``` -- *Type:* IEnvironment +- *Type:* IEnvironment The environment to launch the service in. --- -##### `serviceDescription`Required +##### `serviceDescription`Required ```typescript public readonly serviceDescription: ServiceDescription; ``` -- *Type:* ServiceDescription +- *Type:* ServiceDescription The ServiceDescription used to build the service. --- -##### `autoScaleTaskCount`Optional +##### `autoScaleTaskCount`Optional ```typescript public readonly autoScaleTaskCount: AutoScalingOptions; ``` -- *Type:* AutoScalingOptions +- *Type:* AutoScalingOptions - *Default:* none The options for configuring the auto scaling target. --- -##### `desiredCount`Optional +##### `desiredCount`Optional ```typescript public readonly desiredCount: number; @@ -1736,7 +1736,7 @@ The desired number of instantiations of the task definition to keep running on t --- -##### `taskRole`Optional +##### `taskRole`Optional ```typescript public readonly taskRole: IRole; @@ -1749,14 +1749,14 @@ The name of the IAM role that grants containers in the task permission to call A --- -### SubscriptionQueue +### SubscriptionQueue `SubscriptionQueue` represents the subscription queue object which includes the topic-specific queue and its corresponding auto scaling fields. -#### Initializer +#### Initializer ```typescript -import { SubscriptionQueue } from 'cdk-ecs-service-extensions' +import { SubscriptionQueue } from '@aws-cdk-containers/ecs-service-extensions' const subscriptionQueue: SubscriptionQueue = { ... } ``` @@ -1765,12 +1765,12 @@ const subscriptionQueue: SubscriptionQueue = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| queue | aws-cdk-lib.aws_sqs.IQueue | The user-provided queue to subscribe to the given topic. | -| scaleOnLatency | QueueAutoScalingOptions | The user-provided queue delay fields to configure auto scaling for the topic-specific queue. | +| queue | aws-cdk-lib.aws_sqs.IQueue | The user-provided queue to subscribe to the given topic. | +| scaleOnLatency | QueueAutoScalingOptions | The user-provided queue delay fields to configure auto scaling for the topic-specific queue. | --- -##### `queue`Required +##### `queue`Required ```typescript public readonly queue: IQueue; @@ -1782,27 +1782,27 @@ The user-provided queue to subscribe to the given topic. --- -##### `scaleOnLatency`Optional +##### `scaleOnLatency`Optional ```typescript public readonly scaleOnLatency: QueueAutoScalingOptions; ``` -- *Type:* QueueAutoScalingOptions +- *Type:* QueueAutoScalingOptions - *Default:* none The user-provided queue delay fields to configure auto scaling for the topic-specific queue. --- -### TopicSubscriptionProps +### TopicSubscriptionProps The topic-specific settings for creating the queue subscriptions. -#### Initializer +#### Initializer ```typescript -import { TopicSubscriptionProps } from 'cdk-ecs-service-extensions' +import { TopicSubscriptionProps } from '@aws-cdk-containers/ecs-service-extensions' const topicSubscriptionProps: TopicSubscriptionProps = { ... } ``` @@ -1811,13 +1811,13 @@ const topicSubscriptionProps: TopicSubscriptionProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| topic | aws-cdk-lib.aws_sns.ITopic | The SNS Topic to subscribe to. | -| queue | aws-cdk-lib.aws_sqs.IQueue | The user-provided queue to subscribe to the given topic. | -| topicSubscriptionQueue | SubscriptionQueue | The object representing topic-specific queue and corresponding queue delay fields to configure auto scaling. | +| topic | aws-cdk-lib.aws_sns.ITopic | The SNS Topic to subscribe to. | +| queue | aws-cdk-lib.aws_sqs.IQueue | The user-provided queue to subscribe to the given topic. | +| topicSubscriptionQueue | SubscriptionQueue | The object representing topic-specific queue and corresponding queue delay fields to configure auto scaling. | --- -##### `topic`Required +##### `topic`Required ```typescript public readonly topic: ITopic; @@ -1829,7 +1829,7 @@ The SNS Topic to subscribe to. --- -##### ~~`queue`~~Optional +##### ~~`queue`~~Optional - *Deprecated:* use `topicSubscriptionQueue` @@ -1844,13 +1844,13 @@ The user-provided queue to subscribe to the given topic. --- -##### `topicSubscriptionQueue`Optional +##### `topicSubscriptionQueue`Optional ```typescript public readonly topicSubscriptionQueue: SubscriptionQueue; ``` -- *Type:* SubscriptionQueue +- *Type:* SubscriptionQueue - *Default:* none The object representing topic-specific queue and corresponding queue delay fields to configure auto scaling. @@ -1861,7 +1861,7 @@ If not provided, the default `eventsQueue` will subscribe to the given topic. ## Classes -### AppMeshExtension +### AppMeshExtension This extension adds an Envoy sidecar to the task definition and creates the App Mesh resources required to route network traffic to the container in a service mesh. @@ -1870,23 +1870,23 @@ address `.`. For example, a service called `orders` deploying in an environment called `production` would be accessible to other App Mesh enabled services at the address `http://orders.production`. -#### Initializers +#### Initializers ```typescript -import { AppMeshExtension } from 'cdk-ecs-service-extensions' +import { AppMeshExtension } from '@aws-cdk-containers/ecs-service-extensions' new AppMeshExtension(props: MeshProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| props | MeshProps | *No description.* | +| props | MeshProps | *No description.* | --- -##### `props`Required +##### `props`Required -- *Type:* MeshProps +- *Type:* MeshProps --- @@ -1894,19 +1894,19 @@ new AppMeshExtension(props: MeshProps) | **Name** | **Description** | | --- | --- | -| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | -| addHooks | A hook that allows the extension to add hooks to other extensions that are registered. | -| connectToService | This hook allows the extension to establish a connection to extensions from another service. | -| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | -| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | -| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | -| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | -| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | -| useTaskDefinition | Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. | +| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | +| addHooks | A hook that allows the extension to add hooks to other extensions that are registered. | +| connectToService | This hook allows the extension to establish a connection to extensions from another service. | +| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | +| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | +| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | +| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | +| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | +| useTaskDefinition | Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. | --- -##### `addContainerMutatingHook` +##### `addContainerMutatingHook` ```typescript public addContainerMutatingHook(hook: ContainerMutatingHook): void @@ -1919,13 +1919,13 @@ for the application extension. For example, the Firelens extension wants to be able to modify the settings of the application container to route logs through Firelens. -###### `hook`Required +###### `hook`Required -- *Type:* ContainerMutatingHook +- *Type:* ContainerMutatingHook --- -##### `addHooks` +##### `addHooks` ```typescript public addHooks(): void @@ -1933,7 +1933,7 @@ public addHooks(): void A hook that allows the extension to add hooks to other extensions that are registered. -##### `connectToService` +##### `connectToService` ```typescript public connectToService(otherService: Service, _connectToProps?: ConnectToProps): void @@ -1945,19 +1945,19 @@ Usually used for things like allowing one service to talk to the load balancer or service mesh proxy for another service. -###### `otherService`Required +###### `otherService`Required -- *Type:* Service +- *Type:* Service --- -###### `_connectToProps`Optional +###### `_connectToProps`Optional -- *Type:* ConnectToProps +- *Type:* ConnectToProps --- -##### `modifyServiceProps` +##### `modifyServiceProps` ```typescript public modifyServiceProps(props: ServiceBuild): ServiceBuild @@ -1965,13 +1965,13 @@ public modifyServiceProps(props: ServiceBuild): ServiceBuild Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. -###### `props`Required +###### `props`Required -- *Type:* ServiceBuild +- *Type:* ServiceBuild --- -##### `modifyTaskDefinitionProps` +##### `modifyTaskDefinitionProps` ```typescript public modifyTaskDefinitionProps(props: TaskDefinitionProps): TaskDefinitionProps @@ -1984,13 +1984,13 @@ extension needs to configure an Envoy proxy in the task definition, or the Application extension wants to set the overall resource for the task. -###### `props`Required +###### `props`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinitionProps --- -##### `prehook` +##### `prehook` ```typescript public prehook(service: Service, scope: Construct): void @@ -1998,19 +1998,19 @@ public prehook(service: Service, scope: Construct): void A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service --- -###### `scope`Required +###### `scope`Required - *Type:* constructs.Construct --- -##### `resolveContainerDependencies` +##### `resolveContainerDependencies` ```typescript public resolveContainerDependencies(): void @@ -2018,7 +2018,7 @@ public resolveContainerDependencies(): void Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. -##### `useService` +##### `useService` ```typescript public useService(service: Ec2Service | FargateService): void @@ -2029,13 +2029,13 @@ When this hook is implemented by extension, it allows the extension to use the s It is generally used to create any final resources which might depend on the service itself. -###### `service`Required +###### `service`Required - *Type:* aws-cdk-lib.aws_ecs.Ec2Service | aws-cdk-lib.aws_ecs.FargateService --- -##### `useTaskDefinition` +##### `useTaskDefinition` ```typescript public useTaskDefinition(taskDefinition: TaskDefinition): void @@ -2043,7 +2043,7 @@ public useTaskDefinition(taskDefinition: TaskDefinition): void Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. -###### `taskDefinition`Required +###### `taskDefinition`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinition @@ -2054,13 +2054,13 @@ Once the task definition is created, this hook is called for each extension to g | **Name** | **Type** | **Description** | | --- | --- | --- | -| name | string | The name of the extension. | -| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | -| protocol | Protocol | The protocol used for AppMesh routing. | +| name | string | The name of the extension. | +| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | +| protocol | Protocol | The protocol used for AppMesh routing. | --- -##### `name`Required +##### `name`Required ```typescript public readonly name: string; @@ -2072,7 +2072,7 @@ The name of the extension. --- -##### `container`Optional +##### `container`Optional ```typescript public readonly container: ContainerDefinition; @@ -2089,13 +2089,13 @@ connected to the service. --- -##### `protocol`Required +##### `protocol`Required ```typescript public readonly protocol: Protocol; ``` -- *Type:* Protocol +- *Type:* Protocol The protocol used for AppMesh routing. @@ -2104,30 +2104,30 @@ default - Protocol.HTTP --- -### AssignPublicIpExtension +### AssignPublicIpExtension Modifies the service to assign a public ip to each task and optionally exposes public IPs in a Route 53 record set. Note: If you want to change the DNS zone or record name, you will need to remove this extension completely and then re-add it. -#### Initializers +#### Initializers ```typescript -import { AssignPublicIpExtension } from 'cdk-ecs-service-extensions' +import { AssignPublicIpExtension } from '@aws-cdk-containers/ecs-service-extensions' new AssignPublicIpExtension(options?: AssignPublicIpExtensionOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| options | AssignPublicIpExtensionOptions | *No description.* | +| options | AssignPublicIpExtensionOptions | *No description.* | --- -##### `options`Optional +##### `options`Optional -- *Type:* AssignPublicIpExtensionOptions +- *Type:* AssignPublicIpExtensionOptions --- @@ -2135,19 +2135,19 @@ new AssignPublicIpExtension(options?: AssignPublicIpExtensionOptions) | **Name** | **Description** | | --- | --- | -| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | -| addHooks | A hook that allows the extension to add hooks to other extensions that are registered. | -| connectToService | This hook allows the extension to establish a connection to extensions from another service. | -| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | -| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | -| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | -| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | -| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | -| useTaskDefinition | Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. | +| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | +| addHooks | A hook that allows the extension to add hooks to other extensions that are registered. | +| connectToService | This hook allows the extension to establish a connection to extensions from another service. | +| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | +| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | +| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | +| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | +| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | +| useTaskDefinition | Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. | --- -##### `addContainerMutatingHook` +##### `addContainerMutatingHook` ```typescript public addContainerMutatingHook(hook: ContainerMutatingHook): void @@ -2160,13 +2160,13 @@ for the application extension. For example, the Firelens extension wants to be able to modify the settings of the application container to route logs through Firelens. -###### `hook`Required +###### `hook`Required -- *Type:* ContainerMutatingHook +- *Type:* ContainerMutatingHook --- -##### `addHooks` +##### `addHooks` ```typescript public addHooks(): void @@ -2174,7 +2174,7 @@ public addHooks(): void A hook that allows the extension to add hooks to other extensions that are registered. -##### `connectToService` +##### `connectToService` ```typescript public connectToService(service: Service, connectToProps?: ConnectToProps): void @@ -2186,21 +2186,21 @@ Usually used for things like allowing one service to talk to the load balancer or service mesh proxy for another service. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service The other service to connect to. --- -###### `connectToProps`Optional +###### `connectToProps`Optional -- *Type:* ConnectToProps +- *Type:* ConnectToProps --- -##### `modifyServiceProps` +##### `modifyServiceProps` ```typescript public modifyServiceProps(props: ServiceBuild): ServiceBuild @@ -2208,13 +2208,13 @@ public modifyServiceProps(props: ServiceBuild): ServiceBuild Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. -###### `props`Required +###### `props`Required -- *Type:* ServiceBuild +- *Type:* ServiceBuild --- -##### `modifyTaskDefinitionProps` +##### `modifyTaskDefinitionProps` ```typescript public modifyTaskDefinitionProps(props: TaskDefinitionProps): TaskDefinitionProps @@ -2227,7 +2227,7 @@ extension needs to configure an Envoy proxy in the task definition, or the Application extension wants to set the overall resource for the task. -###### `props`Required +###### `props`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinitionProps @@ -2235,7 +2235,7 @@ Properties of the task definition to be created. --- -##### `prehook` +##### `prehook` ```typescript public prehook(service: Service, _scope: Construct): void @@ -2243,19 +2243,19 @@ public prehook(service: Service, _scope: Construct): void A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service --- -###### `_scope`Required +###### `_scope`Required - *Type:* constructs.Construct --- -##### `resolveContainerDependencies` +##### `resolveContainerDependencies` ```typescript public resolveContainerDependencies(): void @@ -2263,7 +2263,7 @@ public resolveContainerDependencies(): void Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. -##### `useService` +##### `useService` ```typescript public useService(service: Ec2Service | FargateService): void @@ -2274,13 +2274,13 @@ When this hook is implemented by extension, it allows the extension to use the s It is generally used to create any final resources which might depend on the service itself. -###### `service`Required +###### `service`Required - *Type:* aws-cdk-lib.aws_ecs.Ec2Service | aws-cdk-lib.aws_ecs.FargateService --- -##### `useTaskDefinition` +##### `useTaskDefinition` ```typescript public useTaskDefinition(taskDefinition: TaskDefinition): void @@ -2288,7 +2288,7 @@ public useTaskDefinition(taskDefinition: TaskDefinition): void Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. -###### `taskDefinition`Required +###### `taskDefinition`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinition @@ -2301,13 +2301,13 @@ The created task definition to add containers to. | **Name** | **Type** | **Description** | | --- | --- | --- | -| name | string | The name of the extension. | -| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | -| dns | AssignPublicIpDnsOptions | *No description.* | +| name | string | The name of the extension. | +| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | +| dns | AssignPublicIpDnsOptions | *No description.* | --- -##### `name`Required +##### `name`Required ```typescript public readonly name: string; @@ -2319,7 +2319,7 @@ The name of the extension. --- -##### `container`Optional +##### `container`Optional ```typescript public readonly container: ContainerDefinition; @@ -2336,25 +2336,25 @@ connected to the service. --- -##### `dns`Optional +##### `dns`Optional ```typescript public readonly dns: AssignPublicIpDnsOptions; ``` -- *Type:* AssignPublicIpDnsOptions +- *Type:* AssignPublicIpDnsOptions --- -### CloudwatchAgentExtension +### CloudwatchAgentExtension This extension adds a CloudWatch agent to the task definition and configures the task to be able to publish metrics to CloudWatch. -#### Initializers +#### Initializers ```typescript -import { CloudwatchAgentExtension } from 'cdk-ecs-service-extensions' +import { CloudwatchAgentExtension } from '@aws-cdk-containers/ecs-service-extensions' new CloudwatchAgentExtension() ``` @@ -2368,19 +2368,19 @@ new CloudwatchAgentExtension() | **Name** | **Description** | | --- | --- | -| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | -| addHooks | A hook that allows the extension to add hooks to other extensions that are registered. | -| connectToService | This hook allows the extension to establish a connection to extensions from another service. | -| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | -| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | -| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | -| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | -| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | -| useTaskDefinition | Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. | +| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | +| addHooks | A hook that allows the extension to add hooks to other extensions that are registered. | +| connectToService | This hook allows the extension to establish a connection to extensions from another service. | +| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | +| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | +| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | +| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | +| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | +| useTaskDefinition | Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. | --- -##### `addContainerMutatingHook` +##### `addContainerMutatingHook` ```typescript public addContainerMutatingHook(hook: ContainerMutatingHook): void @@ -2393,13 +2393,13 @@ for the application extension. For example, the Firelens extension wants to be able to modify the settings of the application container to route logs through Firelens. -###### `hook`Required +###### `hook`Required -- *Type:* ContainerMutatingHook +- *Type:* ContainerMutatingHook --- -##### `addHooks` +##### `addHooks` ```typescript public addHooks(): void @@ -2407,7 +2407,7 @@ public addHooks(): void A hook that allows the extension to add hooks to other extensions that are registered. -##### `connectToService` +##### `connectToService` ```typescript public connectToService(service: Service, connectToProps?: ConnectToProps): void @@ -2419,21 +2419,21 @@ Usually used for things like allowing one service to talk to the load balancer or service mesh proxy for another service. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service The other service to connect to. --- -###### `connectToProps`Optional +###### `connectToProps`Optional -- *Type:* ConnectToProps +- *Type:* ConnectToProps --- -##### `modifyServiceProps` +##### `modifyServiceProps` ```typescript public modifyServiceProps(props: ServiceBuild): ServiceBuild @@ -2441,15 +2441,15 @@ public modifyServiceProps(props: ServiceBuild): ServiceBuild Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. -###### `props`Required +###### `props`Required -- *Type:* ServiceBuild +- *Type:* ServiceBuild The service properties to mutate. --- -##### `modifyTaskDefinitionProps` +##### `modifyTaskDefinitionProps` ```typescript public modifyTaskDefinitionProps(props: TaskDefinitionProps): TaskDefinitionProps @@ -2462,7 +2462,7 @@ extension needs to configure an Envoy proxy in the task definition, or the Application extension wants to set the overall resource for the task. -###### `props`Required +###### `props`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinitionProps @@ -2470,7 +2470,7 @@ Properties of the task definition to be created. --- -##### `prehook` +##### `prehook` ```typescript public prehook(service: Service, scope: Construct): void @@ -2478,19 +2478,19 @@ public prehook(service: Service, scope: Construct): void A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service --- -###### `scope`Required +###### `scope`Required - *Type:* constructs.Construct --- -##### `resolveContainerDependencies` +##### `resolveContainerDependencies` ```typescript public resolveContainerDependencies(): void @@ -2498,7 +2498,7 @@ public resolveContainerDependencies(): void Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. -##### `useService` +##### `useService` ```typescript public useService(service: Ec2Service | FargateService): void @@ -2509,7 +2509,7 @@ When this hook is implemented by extension, it allows the extension to use the s It is generally used to create any final resources which might depend on the service itself. -###### `service`Required +###### `service`Required - *Type:* aws-cdk-lib.aws_ecs.Ec2Service | aws-cdk-lib.aws_ecs.FargateService @@ -2517,7 +2517,7 @@ The generated service. --- -##### `useTaskDefinition` +##### `useTaskDefinition` ```typescript public useTaskDefinition(taskDefinition: TaskDefinition): void @@ -2525,7 +2525,7 @@ public useTaskDefinition(taskDefinition: TaskDefinition): void Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. -###### `taskDefinition`Required +###### `taskDefinition`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinition @@ -2536,12 +2536,12 @@ Once the task definition is created, this hook is called for each extension to g | **Name** | **Type** | **Description** | | --- | --- | --- | -| name | string | The name of the extension. | -| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | +| name | string | The name of the extension. | +| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | --- -##### `name`Required +##### `name`Required ```typescript public readonly name: string; @@ -2553,7 +2553,7 @@ The name of the extension. --- -##### `container`Optional +##### `container`Optional ```typescript public readonly container: ContainerDefinition; @@ -2571,7 +2571,7 @@ connected to the service. --- -### Container +### Container The main container of a service. @@ -2579,23 +2579,23 @@ This is generally the container which runs your application business logic. Other extensions will attach sidecars alongside this main container. -#### Initializers +#### Initializers ```typescript -import { Container } from 'cdk-ecs-service-extensions' +import { Container } from '@aws-cdk-containers/ecs-service-extensions' new Container(props: ContainerExtensionProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| props | ContainerExtensionProps | *No description.* | +| props | ContainerExtensionProps | *No description.* | --- -##### `props`Required +##### `props`Required -- *Type:* ContainerExtensionProps +- *Type:* ContainerExtensionProps --- @@ -2603,19 +2603,19 @@ new Container(props: ContainerExtensionProps) | **Name** | **Description** | | --- | --- | -| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | -| addHooks | A hook that allows the extension to add hooks to other extensions that are registered. | -| connectToService | This hook allows the extension to establish a connection to extensions from another service. | -| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | -| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | -| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | -| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | -| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | -| useTaskDefinition | Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. | +| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | +| addHooks | A hook that allows the extension to add hooks to other extensions that are registered. | +| connectToService | This hook allows the extension to establish a connection to extensions from another service. | +| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | +| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | +| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | +| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | +| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | +| useTaskDefinition | Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. | --- -##### `addContainerMutatingHook` +##### `addContainerMutatingHook` ```typescript public addContainerMutatingHook(hook: ContainerMutatingHook): void @@ -2628,13 +2628,13 @@ for the application extension. For example, the Firelens extension wants to be able to modify the settings of the application container to route logs through Firelens. -###### `hook`Required +###### `hook`Required -- *Type:* ContainerMutatingHook +- *Type:* ContainerMutatingHook --- -##### `addHooks` +##### `addHooks` ```typescript public addHooks(): void @@ -2642,7 +2642,7 @@ public addHooks(): void A hook that allows the extension to add hooks to other extensions that are registered. -##### `connectToService` +##### `connectToService` ```typescript public connectToService(service: Service, connectToProps?: ConnectToProps): void @@ -2654,21 +2654,21 @@ Usually used for things like allowing one service to talk to the load balancer or service mesh proxy for another service. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service The other service to connect to. --- -###### `connectToProps`Optional +###### `connectToProps`Optional -- *Type:* ConnectToProps +- *Type:* ConnectToProps --- -##### `modifyServiceProps` +##### `modifyServiceProps` ```typescript public modifyServiceProps(props: ServiceBuild): ServiceBuild @@ -2676,15 +2676,15 @@ public modifyServiceProps(props: ServiceBuild): ServiceBuild Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. -###### `props`Required +###### `props`Required -- *Type:* ServiceBuild +- *Type:* ServiceBuild The service properties to mutate. --- -##### `modifyTaskDefinitionProps` +##### `modifyTaskDefinitionProps` ```typescript public modifyTaskDefinitionProps(props: TaskDefinitionProps): TaskDefinitionProps @@ -2697,13 +2697,13 @@ extension needs to configure an Envoy proxy in the task definition, or the Application extension wants to set the overall resource for the task. -###### `props`Required +###### `props`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinitionProps --- -##### `prehook` +##### `prehook` ```typescript public prehook(service: Service, scope: Construct): void @@ -2711,19 +2711,19 @@ public prehook(service: Service, scope: Construct): void A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service --- -###### `scope`Required +###### `scope`Required - *Type:* constructs.Construct --- -##### `resolveContainerDependencies` +##### `resolveContainerDependencies` ```typescript public resolveContainerDependencies(): void @@ -2731,7 +2731,7 @@ public resolveContainerDependencies(): void Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. -##### `useService` +##### `useService` ```typescript public useService(service: Ec2Service | FargateService): void @@ -2742,7 +2742,7 @@ When this hook is implemented by extension, it allows the extension to use the s It is generally used to create any final resources which might depend on the service itself. -###### `service`Required +###### `service`Required - *Type:* aws-cdk-lib.aws_ecs.Ec2Service | aws-cdk-lib.aws_ecs.FargateService @@ -2750,7 +2750,7 @@ The generated service. --- -##### `useTaskDefinition` +##### `useTaskDefinition` ```typescript public useTaskDefinition(taskDefinition: TaskDefinition): void @@ -2758,7 +2758,7 @@ public useTaskDefinition(taskDefinition: TaskDefinition): void Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. -###### `taskDefinition`Required +###### `taskDefinition`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinition @@ -2769,14 +2769,14 @@ Once the task definition is created, this hook is called for each extension to g | **Name** | **Type** | **Description** | | --- | --- | --- | -| name | string | The name of the extension. | -| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | -| trafficPort | number | The port on which the container expects to receive network traffic. | -| logGroup | aws-cdk-lib.aws_logs.ILogGroup | The log group into which application container logs should be routed. | +| name | string | The name of the extension. | +| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | +| trafficPort | number | The port on which the container expects to receive network traffic. | +| logGroup | aws-cdk-lib.aws_logs.ILogGroup | The log group into which application container logs should be routed. | --- -##### `name`Required +##### `name`Required ```typescript public readonly name: string; @@ -2788,7 +2788,7 @@ The name of the extension. --- -##### `container`Optional +##### `container`Optional ```typescript public readonly container: ContainerDefinition; @@ -2805,7 +2805,7 @@ connected to the service. --- -##### `trafficPort`Required +##### `trafficPort`Required ```typescript public readonly trafficPort: number; @@ -2817,7 +2817,7 @@ The port on which the container expects to receive network traffic. --- -##### `logGroup`Optional +##### `logGroup`Optional ```typescript public readonly logGroup: ILogGroup; @@ -2830,17 +2830,17 @@ The log group into which application container logs should be routed. --- -### ContainerMutatingHook +### ContainerMutatingHook This is an abstract class wrapper for a mutating hook. It is extended by any extension which wants to mutate other extension's containers. -#### Initializers +#### Initializers ```typescript -import { ContainerMutatingHook } from 'cdk-ecs-service-extensions' +import { ContainerMutatingHook } from '@aws-cdk-containers/ecs-service-extensions' new ContainerMutatingHook() ``` @@ -2854,11 +2854,11 @@ new ContainerMutatingHook() | **Name** | **Description** | | --- | --- | -| mutateContainerDefinition | This is a hook for modifying the container definition of any upstream containers. | +| mutateContainerDefinition | This is a hook for modifying the container definition of any upstream containers. | --- -##### `mutateContainerDefinition` +##### `mutateContainerDefinition` ```typescript public mutateContainerDefinition(props: ContainerDefinitionOptions): ContainerDefinitionOptions @@ -2870,7 +2870,7 @@ This is primarily used for the main application container. For example, the Firelens extension wants to be able to modify the logging settings of the application container. -###### `props`Required +###### `props`Required - *Type:* aws-cdk-lib.aws_ecs.ContainerDefinitionOptions @@ -2881,14 +2881,14 @@ The container definition to mutate. -### FireLensExtension +### FireLensExtension This extension adds a FluentBit log router to the task definition and does all the configuration necessarily to enable log routing for the task using FireLens. -#### Initializers +#### Initializers ```typescript -import { FireLensExtension } from 'cdk-ecs-service-extensions' +import { FireLensExtension } from '@aws-cdk-containers/ecs-service-extensions' new FireLensExtension() ``` @@ -2902,19 +2902,19 @@ new FireLensExtension() | **Name** | **Description** | | --- | --- | -| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | -| addHooks | A hook that allows the extension to add hooks to other extensions that are registered. | -| connectToService | This hook allows the extension to establish a connection to extensions from another service. | -| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | -| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | -| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | -| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | -| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | -| useTaskDefinition | Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. | +| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | +| addHooks | A hook that allows the extension to add hooks to other extensions that are registered. | +| connectToService | This hook allows the extension to establish a connection to extensions from another service. | +| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | +| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | +| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | +| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | +| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | +| useTaskDefinition | Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. | --- -##### `addContainerMutatingHook` +##### `addContainerMutatingHook` ```typescript public addContainerMutatingHook(hook: ContainerMutatingHook): void @@ -2927,13 +2927,13 @@ for the application extension. For example, the Firelens extension wants to be able to modify the settings of the application container to route logs through Firelens. -###### `hook`Required +###### `hook`Required -- *Type:* ContainerMutatingHook +- *Type:* ContainerMutatingHook --- -##### `addHooks` +##### `addHooks` ```typescript public addHooks(): void @@ -2941,7 +2941,7 @@ public addHooks(): void A hook that allows the extension to add hooks to other extensions that are registered. -##### `connectToService` +##### `connectToService` ```typescript public connectToService(service: Service, connectToProps?: ConnectToProps): void @@ -2953,21 +2953,21 @@ Usually used for things like allowing one service to talk to the load balancer or service mesh proxy for another service. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service The other service to connect to. --- -###### `connectToProps`Optional +###### `connectToProps`Optional -- *Type:* ConnectToProps +- *Type:* ConnectToProps --- -##### `modifyServiceProps` +##### `modifyServiceProps` ```typescript public modifyServiceProps(props: ServiceBuild): ServiceBuild @@ -2975,15 +2975,15 @@ public modifyServiceProps(props: ServiceBuild): ServiceBuild Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. -###### `props`Required +###### `props`Required -- *Type:* ServiceBuild +- *Type:* ServiceBuild The service properties to mutate. --- -##### `modifyTaskDefinitionProps` +##### `modifyTaskDefinitionProps` ```typescript public modifyTaskDefinitionProps(props: TaskDefinitionProps): TaskDefinitionProps @@ -2996,7 +2996,7 @@ extension needs to configure an Envoy proxy in the task definition, or the Application extension wants to set the overall resource for the task. -###### `props`Required +###### `props`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinitionProps @@ -3004,7 +3004,7 @@ Properties of the task definition to be created. --- -##### `prehook` +##### `prehook` ```typescript public prehook(service: Service, scope: Construct): void @@ -3012,19 +3012,19 @@ public prehook(service: Service, scope: Construct): void A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service --- -###### `scope`Required +###### `scope`Required - *Type:* constructs.Construct --- -##### `resolveContainerDependencies` +##### `resolveContainerDependencies` ```typescript public resolveContainerDependencies(): void @@ -3032,7 +3032,7 @@ public resolveContainerDependencies(): void Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. -##### `useService` +##### `useService` ```typescript public useService(service: Ec2Service | FargateService): void @@ -3043,7 +3043,7 @@ When this hook is implemented by extension, it allows the extension to use the s It is generally used to create any final resources which might depend on the service itself. -###### `service`Required +###### `service`Required - *Type:* aws-cdk-lib.aws_ecs.Ec2Service | aws-cdk-lib.aws_ecs.FargateService @@ -3051,7 +3051,7 @@ The generated service. --- -##### `useTaskDefinition` +##### `useTaskDefinition` ```typescript public useTaskDefinition(taskDefinition: TaskDefinition): void @@ -3059,7 +3059,7 @@ public useTaskDefinition(taskDefinition: TaskDefinition): void Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. -###### `taskDefinition`Required +###### `taskDefinition`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinition @@ -3070,12 +3070,12 @@ Once the task definition is created, this hook is called for each extension to g | **Name** | **Type** | **Description** | | --- | --- | --- | -| name | string | The name of the extension. | -| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | +| name | string | The name of the extension. | +| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | --- -##### `name`Required +##### `name`Required ```typescript public readonly name: string; @@ -3087,7 +3087,7 @@ The name of the extension. --- -##### `container`Optional +##### `container`Optional ```typescript public readonly container: ContainerDefinition; @@ -3105,27 +3105,27 @@ connected to the service. --- -### FirelensMutatingHook +### FirelensMutatingHook This hook modifies the application container's settings so that it routes logs using FireLens. -#### Initializers +#### Initializers ```typescript -import { FirelensMutatingHook } from 'cdk-ecs-service-extensions' +import { FirelensMutatingHook } from '@aws-cdk-containers/ecs-service-extensions' new FirelensMutatingHook(props: FirelensProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| props | FirelensProps | *No description.* | +| props | FirelensProps | *No description.* | --- -##### `props`Required +##### `props`Required -- *Type:* FirelensProps +- *Type:* FirelensProps --- @@ -3133,11 +3133,11 @@ new FirelensMutatingHook(props: FirelensProps) | **Name** | **Description** | | --- | --- | -| mutateContainerDefinition | This is a hook for modifying the container definition of any upstream containers. | +| mutateContainerDefinition | This is a hook for modifying the container definition of any upstream containers. | --- -##### `mutateContainerDefinition` +##### `mutateContainerDefinition` ```typescript public mutateContainerDefinition(props: ContainerDefinitionOptions): ContainerDefinitionOptions @@ -3149,7 +3149,7 @@ This is primarily used for the main application container. For example, the Firelens extension wants to be able to modify the logging settings of the application container. -###### `props`Required +###### `props`Required - *Type:* aws-cdk-lib.aws_ecs.ContainerDefinitionOptions @@ -3158,27 +3158,27 @@ settings of the application container. -### HttpLoadBalancerExtension +### HttpLoadBalancerExtension This extension add a public facing load balancer for sending traffic to one or more replicas of the application container. -#### Initializers +#### Initializers ```typescript -import { HttpLoadBalancerExtension } from 'cdk-ecs-service-extensions' +import { HttpLoadBalancerExtension } from '@aws-cdk-containers/ecs-service-extensions' new HttpLoadBalancerExtension(props?: HttpLoadBalancerProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| props | HttpLoadBalancerProps | *No description.* | +| props | HttpLoadBalancerProps | *No description.* | --- -##### `props`Optional +##### `props`Optional -- *Type:* HttpLoadBalancerProps +- *Type:* HttpLoadBalancerProps --- @@ -3186,19 +3186,19 @@ new HttpLoadBalancerExtension(props?: HttpLoadBalancerProps) | **Name** | **Description** | | --- | --- | -| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | -| addHooks | A hook that allows the extension to add hooks to other extensions that are registered. | -| connectToService | This hook allows the extension to establish a connection to extensions from another service. | -| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | -| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | -| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | -| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | -| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | -| useTaskDefinition | Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. | +| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | +| addHooks | A hook that allows the extension to add hooks to other extensions that are registered. | +| connectToService | This hook allows the extension to establish a connection to extensions from another service. | +| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | +| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | +| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | +| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | +| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | +| useTaskDefinition | Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. | --- -##### `addContainerMutatingHook` +##### `addContainerMutatingHook` ```typescript public addContainerMutatingHook(hook: ContainerMutatingHook): void @@ -3211,13 +3211,13 @@ for the application extension. For example, the Firelens extension wants to be able to modify the settings of the application container to route logs through Firelens. -###### `hook`Required +###### `hook`Required -- *Type:* ContainerMutatingHook +- *Type:* ContainerMutatingHook --- -##### `addHooks` +##### `addHooks` ```typescript public addHooks(): void @@ -3225,7 +3225,7 @@ public addHooks(): void A hook that allows the extension to add hooks to other extensions that are registered. -##### `connectToService` +##### `connectToService` ```typescript public connectToService(service: Service, connectToProps?: ConnectToProps): void @@ -3237,21 +3237,21 @@ Usually used for things like allowing one service to talk to the load balancer or service mesh proxy for another service. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service The other service to connect to. --- -###### `connectToProps`Optional +###### `connectToProps`Optional -- *Type:* ConnectToProps +- *Type:* ConnectToProps --- -##### `modifyServiceProps` +##### `modifyServiceProps` ```typescript public modifyServiceProps(props: ServiceBuild): ServiceBuild @@ -3259,13 +3259,13 @@ public modifyServiceProps(props: ServiceBuild): ServiceBuild Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. -###### `props`Required +###### `props`Required -- *Type:* ServiceBuild +- *Type:* ServiceBuild --- -##### `modifyTaskDefinitionProps` +##### `modifyTaskDefinitionProps` ```typescript public modifyTaskDefinitionProps(props: TaskDefinitionProps): TaskDefinitionProps @@ -3278,7 +3278,7 @@ extension needs to configure an Envoy proxy in the task definition, or the Application extension wants to set the overall resource for the task. -###### `props`Required +###### `props`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinitionProps @@ -3286,7 +3286,7 @@ Properties of the task definition to be created. --- -##### `prehook` +##### `prehook` ```typescript public prehook(service: Service, scope: Construct): void @@ -3294,19 +3294,19 @@ public prehook(service: Service, scope: Construct): void A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service --- -###### `scope`Required +###### `scope`Required - *Type:* constructs.Construct --- -##### `resolveContainerDependencies` +##### `resolveContainerDependencies` ```typescript public resolveContainerDependencies(): void @@ -3314,7 +3314,7 @@ public resolveContainerDependencies(): void Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. -##### `useService` +##### `useService` ```typescript public useService(service: Ec2Service | FargateService): void @@ -3325,13 +3325,13 @@ When this hook is implemented by extension, it allows the extension to use the s It is generally used to create any final resources which might depend on the service itself. -###### `service`Required +###### `service`Required - *Type:* aws-cdk-lib.aws_ecs.Ec2Service | aws-cdk-lib.aws_ecs.FargateService --- -##### `useTaskDefinition` +##### `useTaskDefinition` ```typescript public useTaskDefinition(taskDefinition: TaskDefinition): void @@ -3339,7 +3339,7 @@ public useTaskDefinition(taskDefinition: TaskDefinition): void Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. -###### `taskDefinition`Required +###### `taskDefinition`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinition @@ -3352,12 +3352,12 @@ The created task definition to add containers to. | **Name** | **Type** | **Description** | | --- | --- | --- | -| name | string | The name of the extension. | -| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | +| name | string | The name of the extension. | +| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | --- -##### `name`Required +##### `name`Required ```typescript public readonly name: string; @@ -3369,7 +3369,7 @@ The name of the extension. --- -##### `container`Optional +##### `container`Optional ```typescript public readonly container: ContainerDefinition; @@ -3387,29 +3387,29 @@ connected to the service. --- -### InjectableTopic +### InjectableTopic -- *Implements:* IGrantInjectable +- *Implements:* IGrantInjectable The `InjectableTopic` class represents SNS Topic resource that can be published events to by the parent service. -#### Initializers +#### Initializers ```typescript -import { InjectableTopic } from 'cdk-ecs-service-extensions' +import { InjectableTopic } from '@aws-cdk-containers/ecs-service-extensions' new InjectableTopic(props: InjectableTopicProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| props | InjectableTopicProps | *No description.* | +| props | InjectableTopicProps | *No description.* | --- -##### `props`Required +##### `props`Required -- *Type:* InjectableTopicProps +- *Type:* InjectableTopicProps --- @@ -3417,24 +3417,24 @@ new InjectableTopic(props: InjectableTopicProps) | **Name** | **Description** | | --- | --- | -| environmentVariables | *No description.* | -| grant | *No description.* | +| environmentVariables | *No description.* | +| grant | *No description.* | --- -##### `environmentVariables` +##### `environmentVariables` ```typescript public environmentVariables(): {[ key: string ]: string} ``` -##### `grant` +##### `grant` ```typescript public grant(taskDefinition: TaskDefinition): void ``` -###### `taskDefinition`Required +###### `taskDefinition`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinition @@ -3445,11 +3445,11 @@ public grant(taskDefinition: TaskDefinition): void | **Name** | **Type** | **Description** | | --- | --- | --- | -| topic | aws-cdk-lib.aws_sns.ITopic | *No description.* | +| topic | aws-cdk-lib.aws_sns.ITopic | *No description.* | --- -##### `topic`Required +##### `topic`Required ```typescript public readonly topic: ITopic; @@ -3460,29 +3460,29 @@ public readonly topic: ITopic; --- -### InjecterExtension +### InjecterExtension This extension accepts a list of `Injectable` resources that the parent service can publish events or write data to. It sets up the corresponding permissions for the task role of the parent service. -#### Initializers +#### Initializers ```typescript -import { InjecterExtension } from 'cdk-ecs-service-extensions' +import { InjecterExtension } from '@aws-cdk-containers/ecs-service-extensions' new InjecterExtension(props: InjecterExtensionProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| props | InjecterExtensionProps | *No description.* | +| props | InjecterExtensionProps | *No description.* | --- -##### `props`Required +##### `props`Required -- *Type:* InjecterExtensionProps +- *Type:* InjecterExtensionProps --- @@ -3490,19 +3490,19 @@ new InjecterExtension(props: InjecterExtensionProps) | **Name** | **Description** | | --- | --- | -| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | -| addHooks | Add hooks to the main application extension so that it is modified to add the injectable resource environment variables to the container environment. | -| connectToService | This hook allows the extension to establish a connection to extensions from another service. | -| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | -| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | -| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | -| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | -| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | -| useTaskDefinition | After the task definition has been created, this hook grants the required permissions to the task role for the parent service. | +| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | +| addHooks | Add hooks to the main application extension so that it is modified to add the injectable resource environment variables to the container environment. | +| connectToService | This hook allows the extension to establish a connection to extensions from another service. | +| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | +| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | +| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | +| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | +| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | +| useTaskDefinition | After the task definition has been created, this hook grants the required permissions to the task role for the parent service. | --- -##### `addContainerMutatingHook` +##### `addContainerMutatingHook` ```typescript public addContainerMutatingHook(hook: ContainerMutatingHook): void @@ -3515,13 +3515,13 @@ for the application extension. For example, the Firelens extension wants to be able to modify the settings of the application container to route logs through Firelens. -###### `hook`Required +###### `hook`Required -- *Type:* ContainerMutatingHook +- *Type:* ContainerMutatingHook --- -##### `addHooks` +##### `addHooks` ```typescript public addHooks(): void @@ -3529,7 +3529,7 @@ public addHooks(): void Add hooks to the main application extension so that it is modified to add the injectable resource environment variables to the container environment. -##### `connectToService` +##### `connectToService` ```typescript public connectToService(service: Service, connectToProps?: ConnectToProps): void @@ -3541,21 +3541,21 @@ Usually used for things like allowing one service to talk to the load balancer or service mesh proxy for another service. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service The other service to connect to. --- -###### `connectToProps`Optional +###### `connectToProps`Optional -- *Type:* ConnectToProps +- *Type:* ConnectToProps --- -##### `modifyServiceProps` +##### `modifyServiceProps` ```typescript public modifyServiceProps(props: ServiceBuild): ServiceBuild @@ -3563,15 +3563,15 @@ public modifyServiceProps(props: ServiceBuild): ServiceBuild Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. -###### `props`Required +###### `props`Required -- *Type:* ServiceBuild +- *Type:* ServiceBuild The service properties to mutate. --- -##### `modifyTaskDefinitionProps` +##### `modifyTaskDefinitionProps` ```typescript public modifyTaskDefinitionProps(props: TaskDefinitionProps): TaskDefinitionProps @@ -3584,7 +3584,7 @@ extension needs to configure an Envoy proxy in the task definition, or the Application extension wants to set the overall resource for the task. -###### `props`Required +###### `props`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinitionProps @@ -3592,7 +3592,7 @@ Properties of the task definition to be created. --- -##### `prehook` +##### `prehook` ```typescript public prehook(service: Service, scope: Construct): void @@ -3600,19 +3600,19 @@ public prehook(service: Service, scope: Construct): void A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service --- -###### `scope`Required +###### `scope`Required - *Type:* constructs.Construct --- -##### `resolveContainerDependencies` +##### `resolveContainerDependencies` ```typescript public resolveContainerDependencies(): void @@ -3620,7 +3620,7 @@ public resolveContainerDependencies(): void Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. -##### `useService` +##### `useService` ```typescript public useService(service: Ec2Service | FargateService): void @@ -3631,7 +3631,7 @@ When this hook is implemented by extension, it allows the extension to use the s It is generally used to create any final resources which might depend on the service itself. -###### `service`Required +###### `service`Required - *Type:* aws-cdk-lib.aws_ecs.Ec2Service | aws-cdk-lib.aws_ecs.FargateService @@ -3639,7 +3639,7 @@ The generated service. --- -##### `useTaskDefinition` +##### `useTaskDefinition` ```typescript public useTaskDefinition(taskDefinition: TaskDefinition): void @@ -3647,7 +3647,7 @@ public useTaskDefinition(taskDefinition: TaskDefinition): void After the task definition has been created, this hook grants the required permissions to the task role for the parent service. -###### `taskDefinition`Required +###### `taskDefinition`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinition @@ -3660,12 +3660,12 @@ The created task definition. | **Name** | **Type** | **Description** | | --- | --- | --- | -| name | string | The name of the extension. | -| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | +| name | string | The name of the extension. | +| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | --- -##### `name`Required +##### `name`Required ```typescript public readonly name: string; @@ -3677,7 +3677,7 @@ The name of the extension. --- -##### `container`Optional +##### `container`Optional ```typescript public readonly container: ContainerDefinition; @@ -3695,7 +3695,7 @@ connected to the service. --- -### QueueExtension +### QueueExtension This extension creates a default `eventsQueue` for the service (if not provided) and accepts a list of objects of type `ISubscribable` that the `eventsQueue` subscribes to. @@ -3707,23 +3707,23 @@ the backlog per task. For more information, please refer: https://docs.aws.amazo The default queue for this service can be accessed using the getter `.eventsQueue`. -#### Initializers +#### Initializers ```typescript -import { QueueExtension } from 'cdk-ecs-service-extensions' +import { QueueExtension } from '@aws-cdk-containers/ecs-service-extensions' new QueueExtension(props?: QueueExtensionProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| props | QueueExtensionProps | *No description.* | +| props | QueueExtensionProps | *No description.* | --- -##### `props`Optional +##### `props`Optional -- *Type:* QueueExtensionProps +- *Type:* QueueExtensionProps --- @@ -3731,19 +3731,19 @@ new QueueExtension(props?: QueueExtensionProps) | **Name** | **Description** | | --- | --- | -| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | -| addHooks | Add hooks to the main application extension so that it is modified to add the events queue URL to the container environment. | -| connectToService | This hook allows the extension to establish a connection to extensions from another service. | -| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | -| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | -| prehook | This hook creates (if required) and sets the default queue `eventsQueue`. | -| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | -| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | -| useTaskDefinition | After the task definition has been created, this hook grants SQS permissions to the task role. | +| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | +| addHooks | Add hooks to the main application extension so that it is modified to add the events queue URL to the container environment. | +| connectToService | This hook allows the extension to establish a connection to extensions from another service. | +| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | +| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | +| prehook | This hook creates (if required) and sets the default queue `eventsQueue`. | +| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | +| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | +| useTaskDefinition | After the task definition has been created, this hook grants SQS permissions to the task role. | --- -##### `addContainerMutatingHook` +##### `addContainerMutatingHook` ```typescript public addContainerMutatingHook(hook: ContainerMutatingHook): void @@ -3756,13 +3756,13 @@ for the application extension. For example, the Firelens extension wants to be able to modify the settings of the application container to route logs through Firelens. -###### `hook`Required +###### `hook`Required -- *Type:* ContainerMutatingHook +- *Type:* ContainerMutatingHook --- -##### `addHooks` +##### `addHooks` ```typescript public addHooks(): void @@ -3770,7 +3770,7 @@ public addHooks(): void Add hooks to the main application extension so that it is modified to add the events queue URL to the container environment. -##### `connectToService` +##### `connectToService` ```typescript public connectToService(service: Service, connectToProps?: ConnectToProps): void @@ -3782,21 +3782,21 @@ Usually used for things like allowing one service to talk to the load balancer or service mesh proxy for another service. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service The other service to connect to. --- -###### `connectToProps`Optional +###### `connectToProps`Optional -- *Type:* ConnectToProps +- *Type:* ConnectToProps --- -##### `modifyServiceProps` +##### `modifyServiceProps` ```typescript public modifyServiceProps(props: ServiceBuild): ServiceBuild @@ -3804,15 +3804,15 @@ public modifyServiceProps(props: ServiceBuild): ServiceBuild Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. -###### `props`Required +###### `props`Required -- *Type:* ServiceBuild +- *Type:* ServiceBuild The service properties to mutate. --- -##### `modifyTaskDefinitionProps` +##### `modifyTaskDefinitionProps` ```typescript public modifyTaskDefinitionProps(props: TaskDefinitionProps): TaskDefinitionProps @@ -3825,7 +3825,7 @@ extension needs to configure an Envoy proxy in the task definition, or the Application extension wants to set the overall resource for the task. -###### `props`Required +###### `props`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinitionProps @@ -3833,7 +3833,7 @@ Properties of the task definition to be created. --- -##### `prehook` +##### `prehook` ```typescript public prehook(service: Service, scope: Construct): void @@ -3844,15 +3844,15 @@ This hook creates (if required) and sets the default queue `eventsQueue`. It also sets up the subscriptions for the provided `ISubscribable` objects. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service The parent service which this extension has been added to. --- -###### `scope`Required +###### `scope`Required - *Type:* constructs.Construct @@ -3860,7 +3860,7 @@ The scope that this extension should create resources in. --- -##### `resolveContainerDependencies` +##### `resolveContainerDependencies` ```typescript public resolveContainerDependencies(): void @@ -3868,7 +3868,7 @@ public resolveContainerDependencies(): void Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. -##### `useService` +##### `useService` ```typescript public useService(service: Ec2Service | FargateService): void @@ -3880,7 +3880,7 @@ It is used to add target tracking scaling policies for the SQS Queues of the service. It also creates an AWS Lambda Function for calculating the backlog per task metric. -###### `service`Required +###### `service`Required - *Type:* aws-cdk-lib.aws_ecs.Ec2Service | aws-cdk-lib.aws_ecs.FargateService @@ -3888,7 +3888,7 @@ The generated service. --- -##### `useTaskDefinition` +##### `useTaskDefinition` ```typescript public useTaskDefinition(taskDefinition: TaskDefinition): void @@ -3896,7 +3896,7 @@ public useTaskDefinition(taskDefinition: TaskDefinition): void After the task definition has been created, this hook grants SQS permissions to the task role. -###### `taskDefinition`Required +###### `taskDefinition`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinition @@ -3909,15 +3909,15 @@ The created task definition. | **Name** | **Type** | **Description** | | --- | --- | --- | -| name | string | The name of the extension. | -| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | -| eventsQueue | aws-cdk-lib.aws_sqs.IQueue | *No description.* | -| autoscalingOptions | QueueAutoScalingOptions | *No description.* | -| logGroup | aws-cdk-lib.aws_logs.ILogGroup | The log group created by the extension where the AWS Lambda function logs are stored. | +| name | string | The name of the extension. | +| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | +| eventsQueue | aws-cdk-lib.aws_sqs.IQueue | *No description.* | +| autoscalingOptions | QueueAutoScalingOptions | *No description.* | +| logGroup | aws-cdk-lib.aws_logs.ILogGroup | The log group created by the extension where the AWS Lambda function logs are stored. | --- -##### `name`Required +##### `name`Required ```typescript public readonly name: string; @@ -3929,7 +3929,7 @@ The name of the extension. --- -##### `container`Optional +##### `container`Optional ```typescript public readonly container: ContainerDefinition; @@ -3946,7 +3946,7 @@ connected to the service. --- -##### `eventsQueue`Required +##### `eventsQueue`Required ```typescript public readonly eventsQueue: IQueue; @@ -3956,17 +3956,17 @@ public readonly eventsQueue: IQueue; --- -##### `autoscalingOptions`Optional +##### `autoscalingOptions`Optional ```typescript public readonly autoscalingOptions: QueueAutoScalingOptions; ``` -- *Type:* QueueAutoScalingOptions +- *Type:* QueueAutoScalingOptions --- -##### `logGroup`Optional +##### `logGroup`Optional ```typescript public readonly logGroup: ILogGroup; @@ -3979,27 +3979,27 @@ The log group created by the extension where the AWS Lambda function logs are st --- -### ScaleOnCpuUtilization +### ScaleOnCpuUtilization This extension helps you scale your service according to CPU utilization. -#### Initializers +#### Initializers ```typescript -import { ScaleOnCpuUtilization } from 'cdk-ecs-service-extensions' +import { ScaleOnCpuUtilization } from '@aws-cdk-containers/ecs-service-extensions' new ScaleOnCpuUtilization(props?: CpuScalingProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| props | CpuScalingProps | *No description.* | +| props | CpuScalingProps | *No description.* | --- -##### `props`Optional +##### `props`Optional -- *Type:* CpuScalingProps +- *Type:* CpuScalingProps --- @@ -4007,19 +4007,19 @@ new ScaleOnCpuUtilization(props?: CpuScalingProps) | **Name** | **Description** | | --- | --- | -| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | -| addHooks | A hook that allows the extension to add hooks to other extensions that are registered. | -| connectToService | This hook allows the extension to establish a connection to extensions from another service. | -| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | -| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | -| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | -| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | -| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | -| useTaskDefinition | Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. | +| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | +| addHooks | A hook that allows the extension to add hooks to other extensions that are registered. | +| connectToService | This hook allows the extension to establish a connection to extensions from another service. | +| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | +| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | +| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | +| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | +| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | +| useTaskDefinition | Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. | --- -##### ~~`addContainerMutatingHook`~~ +##### ~~`addContainerMutatingHook`~~ ```typescript public addContainerMutatingHook(hook: ContainerMutatingHook): void @@ -4032,13 +4032,13 @@ for the application extension. For example, the Firelens extension wants to be able to modify the settings of the application container to route logs through Firelens. -###### `hook`Required +###### `hook`Required -- *Type:* ContainerMutatingHook +- *Type:* ContainerMutatingHook --- -##### ~~`addHooks`~~ +##### ~~`addHooks`~~ ```typescript public addHooks(): void @@ -4046,7 +4046,7 @@ public addHooks(): void A hook that allows the extension to add hooks to other extensions that are registered. -##### ~~`connectToService`~~ +##### ~~`connectToService`~~ ```typescript public connectToService(service: Service, connectToProps?: ConnectToProps): void @@ -4058,21 +4058,21 @@ Usually used for things like allowing one service to talk to the load balancer or service mesh proxy for another service. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service The other service to connect to. --- -###### `connectToProps`Optional +###### `connectToProps`Optional -- *Type:* ConnectToProps +- *Type:* ConnectToProps --- -##### ~~`modifyServiceProps`~~ +##### ~~`modifyServiceProps`~~ ```typescript public modifyServiceProps(props: ServiceBuild): ServiceBuild @@ -4080,13 +4080,13 @@ public modifyServiceProps(props: ServiceBuild): ServiceBuild Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. -###### `props`Required +###### `props`Required -- *Type:* ServiceBuild +- *Type:* ServiceBuild --- -##### ~~`modifyTaskDefinitionProps`~~ +##### ~~`modifyTaskDefinitionProps`~~ ```typescript public modifyTaskDefinitionProps(props: TaskDefinitionProps): TaskDefinitionProps @@ -4099,7 +4099,7 @@ extension needs to configure an Envoy proxy in the task definition, or the Application extension wants to set the overall resource for the task. -###### `props`Required +###### `props`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinitionProps @@ -4107,7 +4107,7 @@ Properties of the task definition to be created. --- -##### ~~`prehook`~~ +##### ~~`prehook`~~ ```typescript public prehook(parent: Service, scope: Construct): void @@ -4115,15 +4115,15 @@ public prehook(parent: Service, scope: Construct): void A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. -###### `parent`Required +###### `parent`Required -- *Type:* Service +- *Type:* Service The parent service which this extension has been added to. --- -###### `scope`Required +###### `scope`Required - *Type:* constructs.Construct @@ -4131,7 +4131,7 @@ The scope that this extension should create resources in. --- -##### ~~`resolveContainerDependencies`~~ +##### ~~`resolveContainerDependencies`~~ ```typescript public resolveContainerDependencies(): void @@ -4139,7 +4139,7 @@ public resolveContainerDependencies(): void Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. -##### ~~`useService`~~ +##### ~~`useService`~~ ```typescript public useService(service: Ec2Service | FargateService): void @@ -4150,13 +4150,13 @@ When this hook is implemented by extension, it allows the extension to use the s It is generally used to create any final resources which might depend on the service itself. -###### `service`Required +###### `service`Required - *Type:* aws-cdk-lib.aws_ecs.Ec2Service | aws-cdk-lib.aws_ecs.FargateService --- -##### ~~`useTaskDefinition`~~ +##### ~~`useTaskDefinition`~~ ```typescript public useTaskDefinition(taskDefinition: TaskDefinition): void @@ -4164,7 +4164,7 @@ public useTaskDefinition(taskDefinition: TaskDefinition): void Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. -###### `taskDefinition`Required +###### `taskDefinition`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinition @@ -4177,18 +4177,18 @@ The created task definition to add containers to. | **Name** | **Type** | **Description** | | --- | --- | --- | -| name | string | The name of the extension. | -| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | -| initialTaskCount | number | How many tasks to launch initially. | -| maxTaskCount | number | The maximum number of tasks when scaling out. | -| minTaskCount | number | The minimum number of tasks when scaling in. | -| scaleInCooldown | aws-cdk-lib.Duration | How long to wait between scale in actions. | -| scaleOutCooldown | aws-cdk-lib.Duration | How long to wait between scale out actions. | -| targetCpuUtilization | number | The CPU utilization to try ot maintain. | +| name | string | The name of the extension. | +| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | +| initialTaskCount | number | How many tasks to launch initially. | +| maxTaskCount | number | The maximum number of tasks when scaling out. | +| minTaskCount | number | The minimum number of tasks when scaling in. | +| scaleInCooldown | aws-cdk-lib.Duration | How long to wait between scale in actions. | +| scaleOutCooldown | aws-cdk-lib.Duration | How long to wait between scale out actions. | +| targetCpuUtilization | number | The CPU utilization to try ot maintain. | --- -##### ~~`name`~~Required +##### ~~`name`~~Required - *Deprecated:* To enable target tracking based on CPU utilization, use the `targetCpuUtilization` property of `autoScaleTaskCount` in the `Service` construct. For more information, please refer https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk-containers/ecs-service-extensions/README.md#task-auto-scaling . @@ -4203,7 +4203,7 @@ The name of the extension. --- -##### ~~`container`~~Optional +##### ~~`container`~~Optional - *Deprecated:* To enable target tracking based on CPU utilization, use the `targetCpuUtilization` property of `autoScaleTaskCount` in the `Service` construct. For more information, please refer https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk-containers/ecs-service-extensions/README.md#task-auto-scaling . @@ -4223,7 +4223,7 @@ connected to the service. --- -##### ~~`initialTaskCount`~~Required +##### ~~`initialTaskCount`~~Required - *Deprecated:* To enable target tracking based on CPU utilization, use the `targetCpuUtilization` property of `autoScaleTaskCount` in the `Service` construct. For more information, please refer https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk-containers/ecs-service-extensions/README.md#task-auto-scaling . @@ -4238,7 +4238,7 @@ How many tasks to launch initially. --- -##### ~~`maxTaskCount`~~Required +##### ~~`maxTaskCount`~~Required - *Deprecated:* To enable target tracking based on CPU utilization, use the `targetCpuUtilization` property of `autoScaleTaskCount` in the `Service` construct. For more information, please refer https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk-containers/ecs-service-extensions/README.md#task-auto-scaling . @@ -4253,7 +4253,7 @@ The maximum number of tasks when scaling out. --- -##### ~~`minTaskCount`~~Required +##### ~~`minTaskCount`~~Required - *Deprecated:* To enable target tracking based on CPU utilization, use the `targetCpuUtilization` property of `autoScaleTaskCount` in the `Service` construct. For more information, please refer https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk-containers/ecs-service-extensions/README.md#task-auto-scaling . @@ -4268,7 +4268,7 @@ The minimum number of tasks when scaling in. --- -##### ~~`scaleInCooldown`~~Required +##### ~~`scaleInCooldown`~~Required - *Deprecated:* To enable target tracking based on CPU utilization, use the `targetCpuUtilization` property of `autoScaleTaskCount` in the `Service` construct. For more information, please refer https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk-containers/ecs-service-extensions/README.md#task-auto-scaling . @@ -4283,7 +4283,7 @@ How long to wait between scale in actions. --- -##### ~~`scaleOutCooldown`~~Required +##### ~~`scaleOutCooldown`~~Required - *Deprecated:* To enable target tracking based on CPU utilization, use the `targetCpuUtilization` property of `autoScaleTaskCount` in the `Service` construct. For more information, please refer https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk-containers/ecs-service-extensions/README.md#task-auto-scaling . @@ -4298,7 +4298,7 @@ How long to wait between scale out actions. --- -##### ~~`targetCpuUtilization`~~Required +##### ~~`targetCpuUtilization`~~Required - *Deprecated:* To enable target tracking based on CPU utilization, use the `targetCpuUtilization` property of `autoScaleTaskCount` in the `Service` construct. For more information, please refer https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk-containers/ecs-service-extensions/README.md#task-auto-scaling . @@ -4314,7 +4314,7 @@ The CPU utilization to try ot maintain. --- -### ServiceDescription +### ServiceDescription A ServiceDescription is a wrapper for all of the extensions that a user wants to add to an ECS Service. @@ -4322,10 +4322,10 @@ It collects all of the extensions that are added to a service, allowing each extension to query the full list of extensions added to a service to determine information about how to self-configure. -#### Initializers +#### Initializers ```typescript -import { ServiceDescription } from 'cdk-ecs-service-extensions' +import { ServiceDescription } from '@aws-cdk-containers/ecs-service-extensions' new ServiceDescription() ``` @@ -4339,12 +4339,12 @@ new ServiceDescription() | **Name** | **Description** | | --- | --- | -| add | Adds a new extension to the service. | -| get | Get the extension with a specific name. | +| add | Adds a new extension to the service. | +| get | Get the extension with a specific name. | --- -##### `add` +##### `add` ```typescript public add(extension: ServiceExtension): ServiceDescription @@ -4355,15 +4355,15 @@ Adds a new extension to the service. The extensions mutate a service to add resources to or configure properties for the service. -###### `extension`Required +###### `extension`Required -- *Type:* ServiceExtension +- *Type:* ServiceExtension The extension that you wish to add. --- -##### `get` +##### `get` ```typescript public get(name: string): ServiceExtension @@ -4374,7 +4374,7 @@ Get the extension with a specific name. This is generally used by extensions in order to discover each other. -###### `name`Required +###### `name`Required - *Type:* string @@ -4385,24 +4385,24 @@ extensions in order to discover each other. | **Name** | **Type** | **Description** | | --- | --- | --- | -| extensions | {[ key: string ]: ServiceExtension} | The list of extensions that have been registered to run when preparing this service. | +| extensions | {[ key: string ]: ServiceExtension} | The list of extensions that have been registered to run when preparing this service. | --- -##### `extensions`Required +##### `extensions`Required ```typescript public readonly extensions: {[ key: string ]: ServiceExtension}; ``` -- *Type:* {[ key: string ]: ServiceExtension} +- *Type:* {[ key: string ]: ServiceExtension} The list of extensions that have been registered to run when preparing this service. --- -### ServiceExtension +### ServiceExtension The shape of a service extension. @@ -4410,21 +4410,21 @@ This abstract class is implemented by other extensions that extend the hooks to implement any custom logic that they want to run during each step of preparing the service. -#### Initializers +#### Initializers ```typescript -import { ServiceExtension } from 'cdk-ecs-service-extensions' +import { ServiceExtension } from '@aws-cdk-containers/ecs-service-extensions' new ServiceExtension(name: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| name | string | *No description.* | +| name | string | *No description.* | --- -##### `name`Required +##### `name`Required - *Type:* string @@ -4434,19 +4434,19 @@ new ServiceExtension(name: string) | **Name** | **Description** | | --- | --- | -| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | -| addHooks | A hook that allows the extension to add hooks to other extensions that are registered. | -| connectToService | This hook allows the extension to establish a connection to extensions from another service. | -| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | -| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | -| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | -| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | -| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | -| useTaskDefinition | Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. | +| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | +| addHooks | A hook that allows the extension to add hooks to other extensions that are registered. | +| connectToService | This hook allows the extension to establish a connection to extensions from another service. | +| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | +| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | +| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | +| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | +| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | +| useTaskDefinition | Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. | --- -##### `addContainerMutatingHook` +##### `addContainerMutatingHook` ```typescript public addContainerMutatingHook(hook: ContainerMutatingHook): void @@ -4459,13 +4459,13 @@ for the application extension. For example, the Firelens extension wants to be able to modify the settings of the application container to route logs through Firelens. -###### `hook`Required +###### `hook`Required -- *Type:* ContainerMutatingHook +- *Type:* ContainerMutatingHook --- -##### `addHooks` +##### `addHooks` ```typescript public addHooks(): void @@ -4473,7 +4473,7 @@ public addHooks(): void A hook that allows the extension to add hooks to other extensions that are registered. -##### `connectToService` +##### `connectToService` ```typescript public connectToService(service: Service, connectToProps?: ConnectToProps): void @@ -4485,21 +4485,21 @@ Usually used for things like allowing one service to talk to the load balancer or service mesh proxy for another service. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service The other service to connect to. --- -###### `connectToProps`Optional +###### `connectToProps`Optional -- *Type:* ConnectToProps +- *Type:* ConnectToProps --- -##### `modifyServiceProps` +##### `modifyServiceProps` ```typescript public modifyServiceProps(props: ServiceBuild): ServiceBuild @@ -4507,15 +4507,15 @@ public modifyServiceProps(props: ServiceBuild): ServiceBuild Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. -###### `props`Required +###### `props`Required -- *Type:* ServiceBuild +- *Type:* ServiceBuild The service properties to mutate. --- -##### `modifyTaskDefinitionProps` +##### `modifyTaskDefinitionProps` ```typescript public modifyTaskDefinitionProps(props: TaskDefinitionProps): TaskDefinitionProps @@ -4528,7 +4528,7 @@ extension needs to configure an Envoy proxy in the task definition, or the Application extension wants to set the overall resource for the task. -###### `props`Required +###### `props`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinitionProps @@ -4536,7 +4536,7 @@ Properties of the task definition to be created. --- -##### `prehook` +##### `prehook` ```typescript public prehook(parent: Service, scope: Construct): void @@ -4544,15 +4544,15 @@ public prehook(parent: Service, scope: Construct): void A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. -###### `parent`Required +###### `parent`Required -- *Type:* Service +- *Type:* Service The parent service which this extension has been added to. --- -###### `scope`Required +###### `scope`Required - *Type:* constructs.Construct @@ -4560,7 +4560,7 @@ The scope that this extension should create resources in. --- -##### `resolveContainerDependencies` +##### `resolveContainerDependencies` ```typescript public resolveContainerDependencies(): void @@ -4568,7 +4568,7 @@ public resolveContainerDependencies(): void Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. -##### `useService` +##### `useService` ```typescript public useService(service: Ec2Service | FargateService): void @@ -4579,7 +4579,7 @@ When this hook is implemented by extension, it allows the extension to use the s It is generally used to create any final resources which might depend on the service itself. -###### `service`Required +###### `service`Required - *Type:* aws-cdk-lib.aws_ecs.Ec2Service | aws-cdk-lib.aws_ecs.FargateService @@ -4587,7 +4587,7 @@ The generated service. --- -##### `useTaskDefinition` +##### `useTaskDefinition` ```typescript public useTaskDefinition(taskDefinition: TaskDefinition): void @@ -4595,7 +4595,7 @@ public useTaskDefinition(taskDefinition: TaskDefinition): void Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. -###### `taskDefinition`Required +###### `taskDefinition`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinition @@ -4608,12 +4608,12 @@ The created task definition to add containers to. | **Name** | **Type** | **Description** | | --- | --- | --- | -| name | string | The name of the extension. | -| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | +| name | string | The name of the extension. | +| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | --- -##### `name`Required +##### `name`Required ```typescript public readonly name: string; @@ -4625,7 +4625,7 @@ The name of the extension. --- -##### `container`Optional +##### `container`Optional ```typescript public readonly container: ContainerDefinition; @@ -4643,29 +4643,29 @@ connected to the service. --- -### TopicSubscription +### TopicSubscription -- *Implements:* ISubscribable +- *Implements:* ISubscribable The `TopicSubscription` class represents an SNS Topic resource that can be subscribed to by the service queues. -#### Initializers +#### Initializers ```typescript -import { TopicSubscription } from 'cdk-ecs-service-extensions' +import { TopicSubscription } from '@aws-cdk-containers/ecs-service-extensions' new TopicSubscription(props: TopicSubscriptionProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| props | TopicSubscriptionProps | *No description.* | +| props | TopicSubscriptionProps | *No description.* | --- -##### `props`Required +##### `props`Required -- *Type:* TopicSubscriptionProps +- *Type:* TopicSubscriptionProps --- @@ -4673,11 +4673,11 @@ new TopicSubscription(props: TopicSubscriptionProps) | **Name** | **Description** | | --- | --- | -| subscribe | This method sets up SNS Topic subscriptions for the SQS queue provided by the user. | +| subscribe | This method sets up SNS Topic subscriptions for the SQS queue provided by the user. | --- -##### `subscribe` +##### `subscribe` ```typescript public subscribe(extension: QueueExtension): IQueue @@ -4688,9 +4688,9 @@ This method sets up SNS Topic subscriptions for the SQS queue provided by the us If a `queue` is not provided, the default `eventsQueue` subscribes to the given topic. -###### `extension`Required +###### `extension`Required -- *Type:* QueueExtension +- *Type:* QueueExtension `QueueExtension` added to the service. @@ -4701,13 +4701,13 @@ the default `eventsQueue` subscribes to the given topic. | **Name** | **Type** | **Description** | | --- | --- | --- | -| topic | aws-cdk-lib.aws_sns.ITopic | *No description.* | -| queue | aws-cdk-lib.aws_sqs.IQueue | The queue that subscribes to the given topic. | -| subscriptionQueue | SubscriptionQueue | The subscription queue object for this subscription. | +| topic | aws-cdk-lib.aws_sns.ITopic | *No description.* | +| queue | aws-cdk-lib.aws_sqs.IQueue | The queue that subscribes to the given topic. | +| subscriptionQueue | SubscriptionQueue | The subscription queue object for this subscription. | --- -##### `topic`Required +##### `topic`Required ```typescript public readonly topic: ITopic; @@ -4717,7 +4717,7 @@ public readonly topic: ITopic; --- -##### ~~`queue`~~Optional +##### ~~`queue`~~Optional - *Deprecated:* use `subscriptionQueue` @@ -4732,13 +4732,13 @@ The queue that subscribes to the given topic. --- -##### `subscriptionQueue`Optional +##### `subscriptionQueue`Optional ```typescript public readonly subscriptionQueue: SubscriptionQueue; ``` -- *Type:* SubscriptionQueue +- *Type:* SubscriptionQueue - *Default:* none The subscription queue object for this subscription. @@ -4746,14 +4746,14 @@ The subscription queue object for this subscription. --- -### XRayExtension +### XRayExtension This extension adds an X-Ray daemon inside the task definition for capturing application trace spans and submitting them to the AWS X-Ray service. -#### Initializers +#### Initializers ```typescript -import { XRayExtension } from 'cdk-ecs-service-extensions' +import { XRayExtension } from '@aws-cdk-containers/ecs-service-extensions' new XRayExtension() ``` @@ -4767,19 +4767,19 @@ new XRayExtension() | **Name** | **Description** | | --- | --- | -| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | -| addHooks | A hook that allows the extension to add hooks to other extensions that are registered. | -| connectToService | This hook allows the extension to establish a connection to extensions from another service. | -| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | -| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | -| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | -| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | -| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | -| useTaskDefinition | Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. | +| addContainerMutatingHook | This hook allows another service extension to register a mutating hook for changing the primary container of this extension. | +| addHooks | A hook that allows the extension to add hooks to other extensions that are registered. | +| connectToService | This hook allows the extension to establish a connection to extensions from another service. | +| modifyServiceProps | Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. | +| modifyTaskDefinitionProps | This is a hook which allows extensions to modify the settings of the task definition prior to it being created. | +| prehook | A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. | +| resolveContainerDependencies | Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. | +| useService | When this hook is implemented by extension, it allows the extension to use the service which has been created. | +| useTaskDefinition | Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. | --- -##### `addContainerMutatingHook` +##### `addContainerMutatingHook` ```typescript public addContainerMutatingHook(hook: ContainerMutatingHook): void @@ -4792,13 +4792,13 @@ for the application extension. For example, the Firelens extension wants to be able to modify the settings of the application container to route logs through Firelens. -###### `hook`Required +###### `hook`Required -- *Type:* ContainerMutatingHook +- *Type:* ContainerMutatingHook --- -##### `addHooks` +##### `addHooks` ```typescript public addHooks(): void @@ -4806,7 +4806,7 @@ public addHooks(): void A hook that allows the extension to add hooks to other extensions that are registered. -##### `connectToService` +##### `connectToService` ```typescript public connectToService(service: Service, connectToProps?: ConnectToProps): void @@ -4818,21 +4818,21 @@ Usually used for things like allowing one service to talk to the load balancer or service mesh proxy for another service. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service The other service to connect to. --- -###### `connectToProps`Optional +###### `connectToProps`Optional -- *Type:* ConnectToProps +- *Type:* ConnectToProps --- -##### `modifyServiceProps` +##### `modifyServiceProps` ```typescript public modifyServiceProps(props: ServiceBuild): ServiceBuild @@ -4840,15 +4840,15 @@ public modifyServiceProps(props: ServiceBuild): ServiceBuild Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created. -###### `props`Required +###### `props`Required -- *Type:* ServiceBuild +- *Type:* ServiceBuild The service properties to mutate. --- -##### `modifyTaskDefinitionProps` +##### `modifyTaskDefinitionProps` ```typescript public modifyTaskDefinitionProps(props: TaskDefinitionProps): TaskDefinitionProps @@ -4861,7 +4861,7 @@ extension needs to configure an Envoy proxy in the task definition, or the Application extension wants to set the overall resource for the task. -###### `props`Required +###### `props`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinitionProps @@ -4869,7 +4869,7 @@ Properties of the task definition to be created. --- -##### `prehook` +##### `prehook` ```typescript public prehook(service: Service, scope: Construct): void @@ -4877,19 +4877,19 @@ public prehook(service: Service, scope: Construct): void A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance. -###### `service`Required +###### `service`Required -- *Type:* Service +- *Type:* Service --- -###### `scope`Required +###### `scope`Required - *Type:* constructs.Construct --- -##### `resolveContainerDependencies` +##### `resolveContainerDependencies` ```typescript public resolveContainerDependencies(): void @@ -4897,7 +4897,7 @@ public resolveContainerDependencies(): void Once all containers are added to the task definition, this hook is called for each extension to give it a chance to resolve its dependency graph so that its container starts in the right order based on the other extensions that were enabled. -##### `useService` +##### `useService` ```typescript public useService(service: Ec2Service | FargateService): void @@ -4908,7 +4908,7 @@ When this hook is implemented by extension, it allows the extension to use the s It is generally used to create any final resources which might depend on the service itself. -###### `service`Required +###### `service`Required - *Type:* aws-cdk-lib.aws_ecs.Ec2Service | aws-cdk-lib.aws_ecs.FargateService @@ -4916,7 +4916,7 @@ The generated service. --- -##### `useTaskDefinition` +##### `useTaskDefinition` ```typescript public useTaskDefinition(taskDefinition: TaskDefinition): void @@ -4924,7 +4924,7 @@ public useTaskDefinition(taskDefinition: TaskDefinition): void Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc. -###### `taskDefinition`Required +###### `taskDefinition`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinition @@ -4935,12 +4935,12 @@ Once the task definition is created, this hook is called for each extension to g | **Name** | **Type** | **Description** | | --- | --- | --- | -| name | string | The name of the extension. | -| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | +| name | string | The name of the extension. | +| container | aws-cdk-lib.aws_ecs.ContainerDefinition | The container for this extension. | --- -##### `name`Required +##### `name`Required ```typescript public readonly name: string; @@ -4952,7 +4952,7 @@ The name of the extension. --- -##### `container`Optional +##### `container`Optional ```typescript public readonly container: ContainerDefinition; @@ -4972,9 +4972,9 @@ connected to the service. ## Protocols -### IEnvironment +### IEnvironment -- *Implemented By:* Environment, ImportedEnvironment, IEnvironment +- *Implemented By:* Environment, ImportedEnvironment, IEnvironment An environment into which to deploy a service. @@ -4982,11 +4982,11 @@ An environment into which to deploy a service. | **Name** | **Description** | | --- | --- | -| addDefaultCloudMapNamespace | Add a default cloudmap namespace to the environment's cluster. | +| addDefaultCloudMapNamespace | Add a default cloudmap namespace to the environment's cluster. | --- -##### `addDefaultCloudMapNamespace` +##### `addDefaultCloudMapNamespace` ```typescript public addDefaultCloudMapNamespace(options: CloudMapNamespaceOptions): void @@ -4994,7 +4994,7 @@ public addDefaultCloudMapNamespace(options: CloudMapNamespaceOptions): void Add a default cloudmap namespace to the environment's cluster. -###### `options`Required +###### `options`Required - *Type:* aws-cdk-lib.aws_ecs.CloudMapNamespaceOptions @@ -5004,26 +5004,26 @@ Add a default cloudmap namespace to the environment's cluster. | **Name** | **Type** | **Description** | | --- | --- | --- | -| capacityType | EnvironmentCapacityType | The capacity type used by the service's cluster. | -| cluster | aws-cdk-lib.aws_ecs.ICluster | The cluster that is providing capacity for this service. | -| id | string | The name of this environment. | -| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC into which environment services should be placed. | +| capacityType | EnvironmentCapacityType | The capacity type used by the service's cluster. | +| cluster | aws-cdk-lib.aws_ecs.ICluster | The cluster that is providing capacity for this service. | +| id | string | The name of this environment. | +| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC into which environment services should be placed. | --- -##### `capacityType`Required +##### `capacityType`Required ```typescript public readonly capacityType: EnvironmentCapacityType; ``` -- *Type:* EnvironmentCapacityType +- *Type:* EnvironmentCapacityType The capacity type used by the service's cluster. --- -##### `cluster`Required +##### `cluster`Required ```typescript public readonly cluster: ICluster; @@ -5035,7 +5035,7 @@ The cluster that is providing capacity for this service. --- -##### `id`Required +##### `id`Required ```typescript public readonly id: string; @@ -5047,7 +5047,7 @@ The name of this environment. --- -##### `vpc`Required +##### `vpc`Required ```typescript public readonly vpc: IVpc; @@ -5059,11 +5059,11 @@ The VPC into which environment services should be placed. --- -### IGrantInjectable +### IGrantInjectable -- *Extends:* IInjectable +- *Extends:* IInjectable -- *Implemented By:* InjectableTopic, IGrantInjectable +- *Implemented By:* InjectableTopic, IGrantInjectable An interface that will be implemented by all the injectable resources that need to grant permissions to the task role. @@ -5071,26 +5071,26 @@ An interface that will be implemented by all the injectable resources that need | **Name** | **Description** | | --- | --- | -| grant | *No description.* | +| grant | *No description.* | --- -##### `grant` +##### `grant` ```typescript public grant(taskDefinition: TaskDefinition): void ``` -###### `taskDefinition`Required +###### `taskDefinition`Required - *Type:* aws-cdk-lib.aws_ecs.TaskDefinition --- -### IInjectable +### IInjectable -- *Implemented By:* InjectableTopic, IGrantInjectable, IInjectable +- *Implemented By:* InjectableTopic, IGrantInjectable, IInjectable An interface that will be implemented by all the resources that can be published events or written data to. @@ -5098,20 +5098,20 @@ An interface that will be implemented by all the resources that can be published | **Name** | **Description** | | --- | --- | -| environmentVariables | *No description.* | +| environmentVariables | *No description.* | --- -##### `environmentVariables` +##### `environmentVariables` ```typescript public environmentVariables(): {[ key: string ]: string} ``` -### ISubscribable +### ISubscribable -- *Implemented By:* TopicSubscription, ISubscribable +- *Implemented By:* TopicSubscription, ISubscribable An interface that will be implemented by all the resources that can be subscribed to. @@ -5119,11 +5119,11 @@ An interface that will be implemented by all the resources that can be subscribe | **Name** | **Description** | | --- | --- | -| subscribe | All classes implementing this interface must also implement the `subscribe()` method. | +| subscribe | All classes implementing this interface must also implement the `subscribe()` method. | --- -##### `subscribe` +##### `subscribe` ```typescript public subscribe(extension: QueueExtension): IQueue @@ -5131,9 +5131,9 @@ public subscribe(extension: QueueExtension): IQueue All classes implementing this interface must also implement the `subscribe()` method. -###### `extension`Required +###### `extension`Required -- *Type:* QueueExtension +- *Type:* QueueExtension --- @@ -5141,17 +5141,17 @@ All classes implementing this interface must also implement the `subscribe()` me | **Name** | **Type** | **Description** | | --- | --- | --- | -| subscriptionQueue | SubscriptionQueue | The `SubscriptionQueue` object for the `ISubscribable` object. | +| subscriptionQueue | SubscriptionQueue | The `SubscriptionQueue` object for the `ISubscribable` object. | --- -##### `subscriptionQueue`Optional +##### `subscriptionQueue`Optional ```typescript public readonly subscriptionQueue: SubscriptionQueue; ``` -- *Type:* SubscriptionQueue +- *Type:* SubscriptionQueue - *Default:* none The `SubscriptionQueue` object for the `ISubscribable` object. @@ -5160,7 +5160,7 @@ The `SubscriptionQueue` object for the `ISubscribable` object. ## Enums -### EnvironmentCapacityType +### EnvironmentCapacityType The types of capacity that are supported. @@ -5171,26 +5171,26 @@ behavior of an extension. | **Name** | **Description** | | --- | --- | -| FARGATE | Specify that the environment should use AWS Fargate for hosting containers. | -| EC2 | Specify that the environment should launch containers onto EC2 instances. | +| FARGATE | Specify that the environment should use AWS Fargate for hosting containers. | +| EC2 | Specify that the environment should launch containers onto EC2 instances. | --- -##### `FARGATE` +##### `FARGATE` Specify that the environment should use AWS Fargate for hosting containers. --- -##### `EC2` +##### `EC2` Specify that the environment should launch containers onto EC2 instances. --- -### Protocol +### Protocol Enum of supported AppMesh protocols. @@ -5198,29 +5198,29 @@ Enum of supported AppMesh protocols. | **Name** | **Description** | | --- | --- | -| HTTP | *No description.* | -| TCP | *No description.* | -| HTTP2 | *No description.* | -| GRPC | *No description.* | +| HTTP | *No description.* | +| TCP | *No description.* | +| HTTP2 | *No description.* | +| GRPC | *No description.* | --- -##### `HTTP` +##### `HTTP` --- -##### `TCP` +##### `TCP` --- -##### `HTTP2` +##### `HTTP2` --- -##### `GRPC` +##### `GRPC` ---