make policies and metrics properties

Author: shivlaks

packages/@aws-cdk/aws-stepfunctions-tasks/lib/lambda/invoke.ts

@@ -57,8 +57,6 @@ export class LambdaInvoke extends sfn.TaskStateBase {
   ];
 
   private readonly integrationPattern: sfn.IntegrationPattern;
-  private readonly metricsConfig: sfn.TaskMetricsConfig;
-  private readonly policies: iam.PolicyStatement[];
 
   constructor(scope: cdk.Construct, id: string, private readonly props: LambdaInvokeProps) {
     super(scope, id, props);
@@ -71,13 +69,13 @@ export class LambdaInvoke extends sfn.TaskStateBase {
       throw new Error('Task Token is required in `payload` for callback. Use Context.taskToken to set the token.');
     }
 
-    this.metricsConfig = {
+    this.taskMetrics = {
       metricPrefixSingular: 'LambdaFunction',
       metricPrefixPlural: 'LambdaFunctions',
       metricDimensions: { LambdaFunctionArn: this.props.lambdaFunction.functionArn },
     };
 
-    this.policies = [
+    this.taskPolicies = [
       new iam.PolicyStatement({
         resources: [this.props.lambdaFunction.functionArn],
         actions: ['lambda:InvokeFunction'],
@@ -102,21 +100,6 @@ export class LambdaInvoke extends sfn.TaskStateBase {
 
     return taskStateJson(taskStateConfig);
   }
-
-  /**
-   * Additional policy statements that will be added to the state machine's
-   * execution role
-   */
-  protected taskPolicies(): iam.PolicyStatement[] {
-    return this.policies;
-  }
-
-  /**
-   * metrics configuration properties for the task
-   */
-  protected taskMetrics(): sfn.TaskMetricsConfig {
-    return this.metricsConfig;
-  }
 }
 
 /**

packages/@aws-cdk/aws-stepfunctions-tasks/lib/sns/publish.ts

@@ -62,8 +62,6 @@ export class SnsPublish extends sfn.TaskStateBase {
   ];
 
   private readonly integrationPattern: sfn.IntegrationPattern;
-  private readonly metricsConfig: sfn.TaskMetricsConfig = {};
-  private readonly policies: iam.PolicyStatement[];
 
   constructor(scope: cdk.Construct, id: string, private readonly props: SnsPublishProps) {
     super(scope, id, props);
@@ -77,7 +75,7 @@ export class SnsPublish extends sfn.TaskStateBase {
       }
     }
 
-    this.policies = [
+    this.taskPolicies = [
       new iam.PolicyStatement({
         actions: ['sns:Publish'],
         resources: [this.props.topic.topicArn],
@@ -98,12 +96,4 @@ export class SnsPublish extends sfn.TaskStateBase {
 
     return taskStateJson(taskConfig);
   }
-
-  protected taskMetrics(): sfn.TaskMetricsConfig {
-    return this.metricsConfig;
-  }
-
-  protected taskPolicies(): iam.PolicyStatement[] {
-    return this.policies;
-  }
 }

packages/@aws-cdk/aws-stepfunctions-tasks/lib/sqs/send-message.ts

@@ -67,8 +67,6 @@ export class SqsSendMessage extends sfn.TaskStateBase {
   ];
 
   private readonly integrationPattern: sfn.IntegrationPattern;
-  private readonly metricsConfig: sfn.TaskMetricsConfig = {};
-  private readonly policies: iam.PolicyStatement[];
 
   constructor(scope: cdk.Construct, id: string, private readonly props: SqsSendMessageProps) {
     super(scope, id, props);
@@ -82,7 +80,7 @@ export class SqsSendMessage extends sfn.TaskStateBase {
       }
     }
 
-    this.policies = [
+    this.taskPolicies = [
       new iam.PolicyStatement({
         actions: ['sqs:SendMessage'],
         resources: [this.props.queue.queueArn],
@@ -104,12 +102,4 @@ export class SqsSendMessage extends sfn.TaskStateBase {
 
     return taskStateJson(taskConfig);
   }
-
-  protected taskMetrics(): sfn.TaskMetricsConfig {
-    return this.metricsConfig;
-  }
-
-  protected taskPolicies(): iam.PolicyStatement[] {
-    return this.policies;
-  }
 }

packages/@aws-cdk/aws-stepfunctions/lib/states/task-base.ts

@@ -89,6 +89,10 @@ export abstract class TaskStateBase extends State implements INextable {
 
   public readonly endStates: INextable[];
 
+  protected taskMetrics: TaskMetricsConfig = {};
+
+  protected taskPolicies: iam.PolicyStatement[] | undefined;
+
   constructor(scope: cdk.Construct, id: string, props: TaskStateBaseProps) {
     super(scope, id, props);
     this.endStates = [this];
@@ -144,7 +148,7 @@ export abstract class TaskStateBase extends State implements INextable {
     return new cloudwatch.Metric({
       namespace: 'AWS/States',
       metricName,
-      dimensions: this.taskMetrics().metricDimensions,
+      dimensions: this.taskMetrics?.metricDimensions,
       statistic: 'sum',
       ...props,
     }).attachTo(this);
@@ -156,7 +160,7 @@ export abstract class TaskStateBase extends State implements INextable {
    * @default average over 5 minutes
    */
   public metricRunTime(props?: cloudwatch.MetricOptions): cloudwatch.Metric {
-    return this.taskMetric(this.taskMetrics().metricPrefixSingular, 'RunTime', { statistic: 'avg', ...props });
+    return this.taskMetric(this.taskMetrics?.metricPrefixSingular, 'RunTime', { statistic: 'avg', ...props });
   }
 
   /**
@@ -165,7 +169,7 @@ export abstract class TaskStateBase extends State implements INextable {
    * @default average over 5 minutes
    */
   public metricScheduleTime(props?: cloudwatch.MetricOptions): cloudwatch.Metric {
-    return this.taskMetric(this.taskMetrics().metricPrefixSingular, 'ScheduleTime', { statistic: 'avg', ...props });
+    return this.taskMetric(this.taskMetrics?.metricPrefixSingular, 'ScheduleTime', { statistic: 'avg', ...props });
   }
 
   /**
@@ -174,7 +178,7 @@ export abstract class TaskStateBase extends State implements INextable {
    * @default average over 5 minutes
    */
   public metricTime(props?: cloudwatch.MetricOptions): cloudwatch.Metric {
-    return this.taskMetric(this.taskMetrics().metricPrefixSingular, 'Time', { statistic: 'avg', ...props });
+    return this.taskMetric(this.taskMetrics?.metricPrefixSingular, 'Time', { statistic: 'avg', ...props });
   }
 
   /**
@@ -183,7 +187,7 @@ export abstract class TaskStateBase extends State implements INextable {
    * @default sum over 5 minutes
    */
   public metricScheduled(props?: cloudwatch.MetricOptions): cloudwatch.Metric {
-    return this.taskMetric(this.taskMetrics().metricPrefixPlural, 'Scheduled', props);
+    return this.taskMetric(this.taskMetrics?.metricPrefixPlural, 'Scheduled', props);
   }
 
   /**
@@ -192,7 +196,7 @@ export abstract class TaskStateBase extends State implements INextable {
    * @default sum over 5 minutes
    */
   public metricTimedOut(props?: cloudwatch.MetricOptions): cloudwatch.Metric {
-    return this.taskMetric(this.taskMetrics().metricPrefixPlural, 'TimedOut', props);
+    return this.taskMetric(this.taskMetrics?.metricPrefixPlural, 'TimedOut', props);
   }
 
   /**
@@ -201,7 +205,7 @@ export abstract class TaskStateBase extends State implements INextable {
    * @default sum over 5 minutes
    */
   public metricStarted(props?: cloudwatch.MetricOptions): cloudwatch.Metric {
-    return this.taskMetric(this.taskMetrics().metricPrefixPlural, 'Started', props);
+    return this.taskMetric(this.taskMetrics?.metricPrefixPlural, 'Started', props);
   }
 
   /**
@@ -210,7 +214,7 @@ export abstract class TaskStateBase extends State implements INextable {
    * @default sum over 5 minutes
    */
   public metricSucceeded(props?: cloudwatch.MetricOptions): cloudwatch.Metric {
-    return this.taskMetric(this.taskMetrics().metricPrefixPlural, 'Succeeded', props);
+    return this.taskMetric(this.taskMetrics?.metricPrefixPlural, 'Succeeded', props);
   }
 
   /**
@@ -219,7 +223,7 @@ export abstract class TaskStateBase extends State implements INextable {
    * @default sum over 5 minutes
    */
   public metricFailed(props?: cloudwatch.MetricOptions): cloudwatch.Metric {
-    return this.taskMetric(this.taskMetrics().metricPrefixPlural, 'Failed', props);
+    return this.taskMetric(this.taskMetrics?.metricPrefixPlural, 'Failed', props);
   }
 
   /**
@@ -228,20 +232,16 @@ export abstract class TaskStateBase extends State implements INextable {
    * @default sum over 5 minutes
    */
   public metricHeartbeatTimedOut(props?: cloudwatch.MetricOptions): cloudwatch.Metric {
-    return this.taskMetric(this.taskMetrics().metricPrefixPlural, 'HeartbeatTimedOut', props);
+    return this.taskMetric(this.taskMetrics?.metricPrefixPlural, 'HeartbeatTimedOut', props);
   }
 
   protected whenBoundToGraph(graph: StateGraph) {
     super.whenBoundToGraph(graph);
-    for (const policyStatement of this.taskPolicies() || []) {
+    for (const policyStatement of this.taskPolicies || []) {
       graph.registerPolicyStatement(policyStatement);
     }
   }
 
-  protected abstract taskMetrics(): TaskMetricsConfig;
-
-  protected abstract taskPolicies(): iam.PolicyStatement[];
-
   protected abstract renderTask(): any;
 
   private taskMetric(prefix: string | undefined, suffix: string, props?: cloudwatch.MetricOptions): cloudwatch.Metric {