From 2af367048bae69f82f972cc07f8925d14d64b379 Mon Sep 17 00:00:00 2001 From: Seb Kasprzak Date: Mon, 24 Oct 2022 19:23:45 +1100 Subject: [PATCH] added State and RuleName of eventbridge rule event source for Lambda and SFN --- .../sam-property-function-eventbridgerule.md | 16 ++++++++++++++++ ...y-statemachine-statemachineeventbridgerule.md | 16 ++++++++++++++++ 2 files changed, 32 insertions(+) diff --git a/doc_source/sam-property-function-eventbridgerule.md b/doc_source/sam-property-function-eventbridgerule.md index fbc1e6a..a5b56ad 100644 --- a/doc_source/sam-property-function-eventbridgerule.md +++ b/doc_source/sam-property-function-eventbridgerule.md @@ -17,6 +17,8 @@ To declare this entity in your AWS Serverless Application Model \(AWS SAM\) temp [InputPath](#sam-function-eventbridgerule-inputpath): String [Pattern](#sam-function-eventbridgerule-pattern): [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern) [RetryPolicy](#sam-function-eventbridgerule-retrypolicy): [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy) + [RuleName](#sam-function-eventbridgerule-name): String + [State](#sam-function-eventbridgerule-state): String [Target](#sam-function-eventbridgerule-target): Target ``` @@ -60,6 +62,19 @@ A `RetryPolicy` object that includes information about the retry policy settings *Required*: No *AWS CloudFormation compatibility*: This property is passed directly to the `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)` property of the `AWS::Events::Rule` `Target` data type\. + `RuleName` +The name of the rule\. If you omit this property, AWS SAM generates the name. +*Type*: String +*Required*: No +*AWS CloudFormation compatibility*: This property is passed directly to the `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name)` property of an `AWS::Events::Rule` resource\. + + `State` +The state of the rule\. +*Type*: String +*Required*: No +*Default*: `ENABLED` +*AWS CloudFormation compatibility*: This property is passed directly to the `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` property of an `AWS::Events::Rule` resource\. + `Target` The AWS resource that EventBridge invokes when a rule is triggered\. You can use this property to specify the logical ID of the target\. If this property is not specified, then AWS SAM generates the logical ID of the target\. *Type*: [Target](sam-property-function-target.md) @@ -79,6 +94,7 @@ EBRule: Type: EventBridgeRule Properties: Input: '{"Key": "Value"}' + RuleName: MyRule Pattern: detail: state: diff --git a/doc_source/sam-property-statemachine-statemachineeventbridgerule.md b/doc_source/sam-property-statemachine-statemachineeventbridgerule.md index 2051b63..4c55ddc 100644 --- a/doc_source/sam-property-statemachine-statemachineeventbridgerule.md +++ b/doc_source/sam-property-statemachine-statemachineeventbridgerule.md @@ -17,6 +17,8 @@ To declare this entity in your AWS Serverless Application Model \(AWS SAM\) temp [InputPath](#sam-statemachine-statemachineeventbridgerule-inputpath): String [Pattern](#sam-statemachine-statemachineeventbridgerule-pattern): [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern) [RetryPolicy](#sam-statemachine-statemachineeventbridgerule-retrypolicy): [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy) + [RuleName](#sam-function-eventbridgerule-name): String + [State](#sam-function-eventbridgerule-state): String ``` ## Properties @@ -58,6 +60,19 @@ A `RetryPolicy` object that includes information about the retry policy settings *Required*: No *AWS CloudFormation compatibility*: This property is passed directly to the `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)` property of the `AWS::Events::Rule` `Target` data type\. + `RuleName` +The name of the rule\. If you omit this property, AWS SAM generates the name. +*Type*: String +*Required*: No +*AWS CloudFormation compatibility*: This property is passed directly to the `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name)` property of an `AWS::Events::Rule` resource\. + + `State` +The state of the rule\. +*Type*: String +*Required*: No +*Default*: `ENABLED` +*AWS CloudFormation compatibility*: This property is passed directly to the `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` property of an `AWS::Events::Rule` resource\. + ## Examples ### EventBridgeRule @@ -75,4 +90,5 @@ EBRule: detail: state: - terminated + RuleName: MyRule ``` \ No newline at end of file