Add deprecated annotation

aws · Jun 28, 2019 · b1403ae · b1403ae
1 parent 0a7fd09
commit b1403ae
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/packages/@aws-cdk/aws-ecs/lib/base/base-service.ts b/packages/@aws-cdk/aws-ecs/lib/base/base-service.ts
@@ -73,6 +73,22 @@ export interface BaseServiceProps {
  * @default - AWS Cloud Map service discovery is not enabled.
  */
  readonly cloudMapOptions?: CloudMapOptions;
+
+ /**
+ * Whether the new long ARN format has been enabled on ECS services.
+ * NOTE: This assumes customer has opted into the new format for the IAM role used for the service, and is a
+ * workaround for a current bug in Cloudformation in which the service name is not correctly returned when long ARN is
+ * enabled.
+ *
+ * Old ARN format: arn:aws:ecs:region:aws_account_id:service/service-name
+ * New ARN format: arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name
+ *
+ * See: https://docs.aws.amazon.com/AmazonECS/latest/userguide/ecs-resource-ids.html
+ *
+ * @default none
+ * @deprecated this property is no longer used. Long arns are automatically handled by cloud formation.
+ */
+ readonly longArnEnabled?: boolean;
 }
 
 /**