# AWS::Serverless::StateMachine
Creates an Amazon Step Functions state machine, which you can use to orchestrate Amazon Lambda functions and other Amazon resources to form complex and robust workflows.
For more information about Step Functions, see the [Amazon Step Functions Developer Guide](https://docs.amazonaws.cn/step-functions/latest/dg/welcome.html).
**Note**
When you deploy to Amazon CloudFormation, Amazon SAM transforms your Amazon SAM resources into Amazon CloudFormation resources. For more information, see [Generated Amazon CloudFormation resources for Amazon SAM](sam-specification-generated-resources.md).
## Syntax
To declare this entity in your Amazon Serverless Application Model (Amazon SAM) template, use the following syntax.
### YAML
```
Type: AWS::Serverless::StateMachine
Properties:
AutoPublishAlias: String
UseAliasAsEventTarget: Boolean
[Definition](#sam-statemachine-definition): Map
[DefinitionSubstitutions](#sam-statemachine-definitionsubstitutions): Map
[DefinitionUri](#sam-statemachine-definitionuri): String | [S3Location](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitions3location)
DeploymentPreference: [DeploymentPreference](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html)
[Events](#sam-statemachine-events): EventSource
[Logging](#sam-statemachine-logging): [LoggingConfiguration](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration)
[Name](#sam-statemachine-name): String
[PermissionsBoundary](#sam-statemachine-permissionsboundary): String
[Policies](#sam-statemachine-policies): String | List | Map
PropagateTags: Boolean
[RolePath](#sam-statemachine-rolepath): String
[Role](#sam-statemachine-role): String
[Tags](#sam-statemachine-tags): Map
[Tracing](#sam-statemachine-tracing): [TracingConfiguration](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tracingconfiguration)
[Type](#sam-statemachine-type): String
```
## Properties
`AutoPublishAlias`
The name of the state machine alias. To learn more about using Step Functions state machine aliases, see [ Manage continuous deployments with versions and aliases](https://docs.amazonaws.cn/step-functions/latest/dg/concepts-cd-aliasing-versioning.html) in the *Amazon Step Functions Developer Guide*.
Use `DeploymentPreference` to configure deployment preferences for your alias. If you don’t specify `DeploymentPreference`, Amazon SAM will configure traffic to shift to the newer state machine version all at once.
Amazon SAM sets the version’s `DeletionPolicy` and `UpdateReplacePolicy` to `Retain` by default. Previous versions will not be deleted automatically.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the ` [ Name](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachinealias.html#cfn-stepfunctions-statemachinealias-name)` property of an `AWS::StepFunctions::StateMachineAlias` resource.
`UseAliasAsEventTarget`
Indicate whether or not to pass the alias, created by using the `AutoPublishAlias` property, to the events source's target defined with [Events](#sam-statemachine-events).
Specify `True` to use the alias as the events' target.
*Type*: Boolean
*Required*: No
*Default*: `False`
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`Definition`
The state machine definition is an object, where the format of the object matches the format of your Amazon SAM template file, for example, JSON or YAML. State machine definitions adhere to the [Amazon States Language](https://docs.amazonaws.cn/step-functions/latest/dg/concepts-amazon-states-language.html).
For an example of an inline state machine definition, see [Examples](#sam-resource-statemachine--examples).
You must provide either a `Definition` or a `DefinitionUri`.
*Type*: Map
*Required*: Conditional
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`DefinitionSubstitutions`
A string-to-string map that specifies the mappings for placeholder variables in the state machine definition. This enables you to inject values obtained at runtime (for example, from intrinsic functions) into the state machine definition.
*Type*: Map
*Required*: No
*Amazon CloudFormation compatibility*: This property is similar to the `[DefinitionSubstitutions](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitionsubstitutions)` property of an `AWS::StepFunctions::StateMachine` resource. If any intrinsic functions are specified in an inline state machine definition, Amazon SAM adds entries to this property to inject them into the state machine definition.
`DefinitionUri`
The Amazon Simple Storage Service (Amazon S3) URI or local file path of the state machine definition written in the [Amazon States Language](https://docs.amazonaws.cn/step-functions/latest/dg/concepts-amazon-states-language.html).
If you provide a local file path, the template must go through the workflow that includes the `sam deploy` or `sam package` command to correctly transform the definition. To do this, you must use version 0.52.0 or later of the Amazon SAM CLI.
You must provide either a `Definition` or a `DefinitionUri`.
*Type*: String \$1 [S3Location](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitions3location)
*Required*: Conditional
*Amazon CloudFormation compatibility*: This property is passed directly to the `[DefinitionS3Location](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitions3location)` property of an `AWS::StepFunctions::StateMachine` resource.
`DeploymentPreference`
The settings that enable and configure gradual state machine deployments. To learn more about Step Functions gradual deployments, see [ Manage continuous deployments with versions and aliases](https://docs.amazonaws.cn/step-functions/latest/dg/concepts-cd-aliasing-versioning.html) in the *Amazon Step Functions Developer Guide*.
Specify `AutoPublishAlias` before configuring this property. Your `DeploymentPreference` settings will be applied to the alias specified with `AutoPublishAlias`.
When you specify `DeploymentPreference`, Amazon SAM generates the `StateMachineVersionArn` sub-property value automatically.
*Type*: [DeploymentPreference](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html)
*Required*: No
*Amazon CloudFormation compatibility*: Amazon SAM generates and attaches the `StateMachineVersionArn` property value to `DeploymentPreference` and passes `DeploymentPreference` to the `[DeploymentPreference](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachinealias.html#cfn-stepfunctions-statemachinealias-deploymentpreference)` property of an `AWS::StepFunctions::StateMachineAlias` resource.
`Events`
Specifies the events that trigger this state machine. Events consist of a type and a set of properties that depend on the type.
*Type*: [EventSource](sam-property-statemachine-statemachineeventsource.md)
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`Logging`
Defines which execution history events are logged and where they are logged.
*Type*: [LoggingConfiguration](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration)
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[LoggingConfiguration](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration)` property of an `AWS::StepFunctions::StateMachine` resource.
`Name`
The name of the state machine.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[StateMachineName](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinename)` property of an `AWS::StepFunctions::StateMachine` resource.
`PermissionsBoundary`
The ARN of a permissions boundary to use for this state machine's execution role. This property only works if the role is generated for you.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[PermissionsBoundary](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-permissionsboundary)` property of an `AWS::IAM::Role` resource.
`Policies`
Permission policies for this state machine. Policies will be appended to the state machine's default Amazon Identity and Access Management (IAM) execution role.
This property accepts a single value or list of values. Allowed values include:
+ [Amazon SAM policy templates](serverless-policy-templates.md).
+ The ARN of an [Amazon managed policy](https://docs.amazonaws.cn/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#aws-managed-policies) or [customer managed policy](https://docs.amazonaws.cn/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#customer-managed-policies).
+ The name of an Amazon managed policy from the following [ list](https://github.com/aws/serverless-application-model/blob/develop/samtranslator/internal/data/aws_managed_policies.json).
+ An [ inline IAM policy](https://docs.amazonaws.cn/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#inline-policies) formatted in YAML as a map.
If you set the `Role` property, this property is ignored.
*Type*: String \$1 List \$1 Map
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`PropagateTags`
Indicate whether or not to pass tags from the `Tags` property to your [AWS::Serverless::StateMachine](sam-specification-generated-resources-statemachine.md) generated resources. Specify `True` to propagate tags in your generated resources.
*Type*: Boolean
*Required*: No
*Default*: `False`
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`Role`
The ARN of an IAM role to use as this state machine's execution role.
*Type*: String
*Required*: Conditional
*Amazon CloudFormation compatibility*: This property is passed directly to the `[ RoleArn](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-rolearn)` property of an `AWS::StepFunctions::StateMachine` resource.
`RolePath`
The path to the state machine's IAM execution role.
Use this property when the role is generated for you. Do not use when the role is specified with the `Role` property.
*Type*: String
*Required*: Conditional
*Amazon CloudFormation compatibility*: This property is passed directly to the `[Path](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-path)` property of an `AWS::IAM::Role` resource.
`Tags`
A string-to-string map that specifies the tags added to the state machine and the corresponding execution role. For information about valid keys and values for tags, see the [Tags](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tags) property of an [https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html) resource.
*Type*: Map
*Required*: No
*Amazon CloudFormation compatibility*: This property is similar to the `[Tags](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tags)` property of an `AWS::StepFunctions::StateMachine` resource. Amazon SAM automatically adds a `stateMachine:createdBy:SAM` tag to this resource, and to the default role that is generated for it.
`Tracing`
Selects whether or not Amazon X-Ray is enabled for the state machine. For more information about using X-Ray with Step Functions, see [Amazon X-Ray and Step Functions](https://docs.amazonaws.cn/step-functions/latest/dg/concepts-xray-tracing.html) in the *Amazon Step Functions Developer Guide*.
*Type*: [TracingConfiguration](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tracingconfiguration)
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[TracingConfiguration](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tracingconfiguration)` property of an `AWS::StepFunctions::StateMachine` resource.
`Type`
The type of the state machine.
*Valid values*: `STANDARD` or `EXPRESS`
*Type*: String
*Required*: No
*Default*: `STANDARD`
*Amazon CloudFormation compatibility*: This property is passed directly to the `[StateMachineType](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinetype)` property of an `AWS::StepFunctions::StateMachine` resource.
## Return Values
### Ref
When you provide the logical ID of this resource to the Ref intrinsic function, Ref returns the Amazon Resource Name (ARN) of the underlying `AWS::StepFunctions::StateMachine` resource.
For more information about using the `Ref` function, see [https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) in the *Amazon CloudFormation User Guide*.
### Fn::GetAtt
`Fn::GetAtt` returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using `Fn::GetAtt`, see [https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) in the *Amazon CloudFormation User Guide*.
`Name`
Returns the name of the state machine, such as `HelloWorld-StateMachine`.
## Examples
### State Machine Definition File
The following is an example of an inline state machine definition that allows a lambda function to invoke state machine. Note that this example expects the `Role` property to configure proper policy to allow invocation. The `my_state_machine.asl.json` file must be written in the [Amazon States Language](https://docs.amazonaws.cn/step-functions/latest/dg/concepts-amazon-states-language.html).
In this example, the `DefinitionSubstitution` entries allow the state machine to include resources that are declared in the Amazon SAM template file.
#### YAML
```
MySampleStateMachine:
Type: AWS::Serverless::StateMachine
Properties:
DefinitionUri: statemachine/my_state_machine.asl.json
Role: arn:aws:iam::123456123456:role/service-role/my-sample-role
Tracing:
Enabled: true
DefinitionSubstitutions:
MyFunctionArn: !GetAtt MyFunction.Arn
MyDDBTable: !Ref TransactionTable
```
### Inline State Machine Definition
The following is an example of an inline state machine definition.
In this example, the Amazon SAM template file is written in YAML, so the state machine definition is also in YAML. To declare an inline state machine definition in JSON, write your Amazon SAM template file in JSON.
#### YAML
```
MySampleStateMachine:
Type: AWS::Serverless::StateMachine
Properties:
Definition:
StartAt: MyLambdaState
States:
MyLambdaState:
Type: Task
Resource: arn:aws:lambda:us-east-1:123456123456:function:my-sample-lambda-app
End: true
Role: arn:aws:iam::123456123456:role/service-role/my-sample-role
Tracing:
Enabled: true
```
# EventSource
The object describing the source of events which trigger the state machine. Each event consists of a type and a set of properties that depend on that type. For more information about the properties of each event source, see the subtopic corresponding to that type.
## Syntax
To declare this entity in your Amazon Serverless Application Model (Amazon SAM) template, use the following syntax.
### YAML
```
[Properties](#sam-statemachine-statemachineeventsource-properties): Schedule | ScheduleV2 | CloudWatchEvent | EventBridgeRule | Api
[Type](#sam-statemachine-statemachineeventsource-type): String
```
## Properties
`Properties`
An object describing the properties of this event mapping. The set of properties must conform to the defined `Type`.
*Type*: [Schedule](sam-property-statemachine-statemachineschedule.md) \$1 [ScheduleV2](sam-property-statemachine-statemachineschedulev2.md) \$1 [CloudWatchEvent](sam-property-statemachine-statemachinecloudwatchevent.md) \$1 [EventBridgeRule](sam-property-statemachine-statemachineeventbridgerule.md) \$1 [Api](sam-property-statemachine-statemachineapi.md)
*Required*: Yes
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`Type`
The event type.
*Valid values*: `Api`, `Schedule`, `ScheduleV2`, `CloudWatchEvent`, `EventBridgeRule`
*Type*: String
*Required*: Yes
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
## Examples
### API
The following is an example of an event of the `API` type.
#### YAML
```
ApiEvent:
Type: Api
Properties:
Method: get
Path: /group/{user}
RestApiId:
Ref: MyApi
```
# Api
The object describing an `Api` event source type. If an [AWS::Serverless::Api](sam-resource-api.md) resource is defined, the path and method values must correspond to an operation in the OpenAPI definition of the API.
## Syntax
To declare this entity in your Amazon Serverless Application Model (Amazon SAM) template, use the following syntax.
### YAML
```
[Auth](#sam-statemachine-statemachineapi-auth): ApiStateMachineAuth
[Method](#sam-statemachine-statemachineapi-method): String
[Path](#sam-statemachine-statemachineapi-path): String
[RestApiId](#sam-statemachine-statemachineapi-restapiid): String
UnescapeMappingTemplate: Boolean
```
## Properties
`Auth`
The authorization configuration for this API, path, and method.
Use this property to override the API's `DefaultAuthorizer` setting for an individual path, when no `DefaultAuthorizer` is specified, or to override the default `ApiKeyRequired` setting.
*Type*: [ApiStateMachineAuth](sam-property-statemachine-apistatemachineauth.md)
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`Method`
The HTTP method for which this function is invoked.
*Type*: String
*Required*: Yes
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`Path`
The URI path for which this function is invoked. The value must start with `/`.
*Type*: String
*Required*: Yes
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`RestApiId`
The identifier of a `RestApi` resource, which must contain an operation with the given path and method. Typically, this is set to reference an [AWS::Serverless::Api](sam-resource-api.md) resource that is defined in this template.
If you don't define this property, Amazon SAM creates a default [AWS::Serverless::Api](sam-resource-api.md) resource using a generated `OpenApi` document. That resource contains a union of all paths and methods defined by `Api` events in the same template that do not specify a `RestApiId`.
This property can't reference an [AWS::Serverless::Api](sam-resource-api.md) resource that is defined in another template.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`UnescapeMappingTemplate`
Unescapes single quotes, by replacing `\'` with `'`, on the input that is passed to the state machine. Use when your input contains single quotes.
If set to `False` and your input contains single quotes, an error will occur.
*Type*: Boolean
*Required*: No
*Default*: False
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
## Examples
### ApiEvent
The following is an example of an event of the `Api` type.
#### YAML
```
Events:
ApiEvent:
Type: Api
Properties:
Path: /path
Method: get
```
# ApiStateMachineAuth
Configures authorization at the event level, for a specific API, path, and method.
## Syntax
To declare this entity in your Amazon Serverless Application Model (Amazon SAM) template, use the following syntax.
### YAML
```
[ApiKeyRequired](#sam-statemachine-apistatemachineauth-apikeyrequired): Boolean
[AuthorizationScopes](#sam-statemachine-apistatemachineauth-authorizationscopes): List
[Authorizer](#sam-statemachine-apistatemachineauth-authorizer): String
[ResourcePolicy](#sam-statemachine-apistatemachineauth-resourcepolicy): ResourcePolicyStatement
```
## Properties
`ApiKeyRequired`
Requires an API key for this API, path, and method.
*Type*: Boolean
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`AuthorizationScopes`
The authorization scopes to apply to this API, path, and method.
The scopes that you specify will override any scopes applied by the `DefaultAuthorizer` property if you have specified it.
*Type*: List
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`Authorizer`
The `Authorizer` for a specific state machine.
If you have specified a global authorizer for the API and want to make this state machine public, override the global authorizer by setting `Authorizer` to `NONE`.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`ResourcePolicy`
Configure the resource policy for this API and path.
*Type*: [ResourcePolicyStatement](sam-property-statemachine-resourcepolicystatement.md)
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
## Examples
### StateMachine-Auth
The following example specifies authorization at the state machine level.
#### YAML
```
Auth:
ApiKeyRequired: true
Authorizer: NONE
```
# ResourcePolicyStatement
Configures a resource policy for all methods and paths of an API. For more information about resource policies, see [Controlling access to an API with API Gateway resource policies](https://docs.amazonaws.cn/apigateway/latest/developerguide/apigateway-resource-policies.html) in the *API Gateway Developer Guide*.
## Syntax
To declare this entity in your Amazon Serverless Application Model (Amazon SAM) template, use the following syntax.
### YAML
```
[AwsAccountBlacklist](#sam-statemachine-resourcepolicystatement-awsaccountblacklist): List
[AwsAccountWhitelist](#sam-statemachine-resourcepolicystatement-awsaccountwhitelist): List
[CustomStatements](#sam-statemachine-resourcepolicystatement-customstatements): List
[IntrinsicVpcBlacklist](#sam-statemachine-resourcepolicystatement-intrinsicvpcblacklist): List
[IntrinsicVpcWhitelist](#sam-statemachine-resourcepolicystatement-intrinsicvpcwhitelist): List
[IntrinsicVpceBlacklist](#sam-statemachine-resourcepolicystatement-intrinsicvpceblacklist): List
[IntrinsicVpceWhitelist](#sam-statemachine-resourcepolicystatement-intrinsicvpcewhitelist): List
[IpRangeBlacklist](#sam-statemachine-resourcepolicystatement-iprangeblacklist): List
[IpRangeWhitelist](#sam-statemachine-resourcepolicystatement-iprangewhitelist): List
[SourceVpcBlacklist](#sam-statemachine-resourcepolicystatement-sourcevpcblacklist): List
[SourceVpcWhitelist](#sam-statemachine-resourcepolicystatement-sourcevpcwhitelist): List
```
## Properties
`AwsAccountBlacklist`
The Amazon accounts to block.
*Type*: List of String
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`AwsAccountWhitelist`
The Amazon accounts to allow. For an example use of this property, see the Examples section at the bottom of this page.
*Type*: List of String
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`CustomStatements`
A list of custom resource policy statements to apply to this API. For an example use of this property, see the Examples section at the bottom of this page.
*Type*: List
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`IntrinsicVpcBlacklist`
The list of virtual private clouds (VPCs) to block, where each VPC is specified as a reference such as a [dynamic reference](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/dynamic-references.html) or the `Ref` [intrinsic function](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). For an example use of this property, see the Examples section at the bottom of this page.
*Type*: List
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`IntrinsicVpcWhitelist`
The list of VPCs to allow, where each VPC is specified as a reference such as a [dynamic reference](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/dynamic-references.html) or the `Ref` [intrinsic function](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).
*Type*: List
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`IntrinsicVpceBlacklist`
The list of VPC endpoints to block, where each VPC endpoint is specified as a reference such as a [dynamic reference](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/dynamic-references.html) or the `Ref` [intrinsic function](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).
*Type*: List
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`IntrinsicVpceWhitelist`
The list of VPC endpoints to allow, where each VPC endpoint is specified as a reference such as a [dynamic reference](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/dynamic-references.html) or the `Ref` [intrinsic function](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). For an example use of this property, see the Examples section at the bottom of this page.
*Type*: List
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`IpRangeBlacklist`
The IP addresses or address ranges to block. For an example use of this property, see the Examples section at the bottom of this page.
*Type*: List
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`IpRangeWhitelist`
The IP addresses or address ranges to allow.
*Type*: List
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`SourceVpcBlacklist`
The source VPC or VPC endpoints to block. Source VPC names must start with `"vpc-"` and source VPC endpoint names must start with `"vpce-"`. For an example use of this property, see the Examples section at the bottom of this page.
*Type*: List
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`SourceVpcWhitelist`
The source VPC or VPC endpoints to allow. Source VPC names must start with `"vpc-"` and source VPC endpoint names must start with `"vpce-"`.
*Type*: List
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
## Examples
### Resource Policy Example
The following example blocks two IP addresses and a source VPC, and allows an Amazon account.
#### YAML
```
Auth:
ResourcePolicy:
CustomStatements: [{
"Effect": "Allow",
"Principal": "*",
"Action": "execute-api:Invoke",
"Resource": "execute-api:/Prod/GET/pets",
"Condition": {
"IpAddress": {
"aws:SourceIp": "1.2.3.4"
}
}
}]
IpRangeBlacklist:
- "10.20.30.40"
- "1.2.3.4"
SourceVpcBlacklist:
- "vpce-1a2b3c4d"
AwsAccountWhitelist:
- "111122223333"
IntrinsicVpcBlacklist:
- "{{resolve:ssm:SomeVPCReference:1}}"
- !Ref MyVPC
IntrinsicVpceWhitelist:
- "{{resolve:ssm:SomeVPCEReference:1}}"
- !Ref MyVPCE
```
# CloudWatchEvent
The object describing a `CloudWatchEvent` event source type.
Amazon Serverless Application Model (Amazon SAM) generates an [https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html) resource when this event type is set.
**Important Note**: [EventBridgeRule](sam-property-statemachine-statemachineeventbridgerule.md) is the preferred event source type to use, instead of `CloudWatchEvent`. `EventBridgeRule` and `CloudWatchEvent` use the same underlying service, API, and Amazon CloudFormation resources. However, Amazon SAM will add support for new features only to `EventBridgeRule`.
## Syntax
To declare this entity in your Amazon Serverless Application Model (Amazon SAM) template, use the following syntax.
### YAML
```
[EventBusName](#sam-statemachine-statemachinecloudwatchevent-eventbusname): String
[Input](#sam-statemachine-statemachinecloudwatchevent-input): String
[InputPath](#sam-statemachine-statemachinecloudwatchevent-inputpath): String
[Pattern](#sam-statemachine-statemachinecloudwatchevent-pattern): [EventPattern](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
```
## Properties
`EventBusName`
The event bus to associate with this rule. If you omit this property, Amazon SAM uses the default event bus.
*Type*: String
*Required*: No
*Default*: Default event bus
*Amazon CloudFormation compatibility*: This property is passed directly to the `[EventBusName](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname)` property of an `AWS::Events::Rule` resource.
`Input`
Valid JSON text passed to the target. If you use this property, nothing from the event text itself is passed to the target.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[Input](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` property of an `AWS::Events::Rule Target` resource.
`InputPath`
When you don't want to pass the entire matched event to the target, use the `InputPath` property to describe which part of the event to pass.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[InputPath](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath)` property of an `AWS::Events::Rule Target` resource.
`Pattern`
Describes which events are routed to the specified target. For more information, see [Events and Event Patterns in EventBridge](https://docs.amazonaws.cn/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide*.
*Type*: [EventPattern](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
*Required*: Yes
*Amazon CloudFormation compatibility*: This property is passed directly to the `[EventPattern](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)` property of an `AWS::Events::Rule` resource.
## Examples
### CloudWatchEvent
The following is an example of a `CloudWatchEvent` event source type.
#### YAML
```
CWEvent:
Type: CloudWatchEvent
Properties:
Input: '{"Key": "Value"}'
Pattern:
detail:
state:
- running
```
# EventBridgeRule
The object describing an `EventBridgeRule` event source type, which sets your state machine as the target for an Amazon EventBridge rule. For more information, see [What Is Amazon EventBridge?](https://docs.amazonaws.cn/eventbridge/latest/userguide/what-is-amazon-eventbridge.html) in the *Amazon EventBridge User Guide*.
Amazon SAM generates an [https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html) resource when this event type is set.
## Syntax
To declare this entity in your Amazon Serverless Application Model (Amazon SAM) template, use the following syntax.
### YAML
```
DeadLetterConfig: DeadLetterConfig
EventBusName: String
Input: String
InputPath: String
InputTransformer: [InputTransformer](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html)
Pattern: [EventPattern](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
RetryPolicy: [RetryPolicy](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)
RuleName: String
State: String
Target: Target
```
## Properties
`DeadLetterConfig`
Configure the Amazon Simple Queue Service (Amazon SQS) queue where EventBridge sends events after a failed target invocation. Invocation can fail, for example, when sending an event to a Lambda function that doesn't exist, or when EventBridge has insufficient permissions to invoke the Lambda function. For more information, see [Event retry policy and using dead-letter queues](https://docs.amazonaws.cn/eventbridge/latest/userguide/rule-dlq.html) in the *Amazon EventBridge User Guide*.
*Type*: [DeadLetterConfig](sam-property-statemachine-statemachinedeadletterconfig.md)
*Required*: No
*Amazon CloudFormation compatibility*: This property is similar to the `[DeadLetterConfig](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig)` property of the `AWS::Events::Rule` `Target` data type. The Amazon SAM version of this property includes additional subproperties, in case you want Amazon SAM to create the dead-letter queue for you.
`EventBusName`
The event bus to associate with this rule. If you omit this property, Amazon SAM uses the default event bus.
*Type*: String
*Required*: No
*Default*: Default event bus
*Amazon CloudFormation compatibility*: This property is passed directly to the `[EventBusName](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname)` property of an `AWS::Events::Rule` resource.
`Input`
Valid JSON text passed to the target. If you use this property, nothing from the event text itself is passed to the target.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[Input](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` property of an `AWS::Events::Rule Target` resource.
`InputPath`
When you don't want to pass the entire matched event to the target, use the `InputPath` property to describe which part of the event to pass.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[InputPath](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath)` property of an `AWS::Events::Rule Target` resource.
`InputTransformer`
Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target. For more information, see [ Amazon EventBridge input transformation](https://docs.amazonaws.cn/eventbridge/latest/userguide/eb-transform-target-input.html) in the *Amazon EventBridge User Guide*.
*Type*: [InputTransformer](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputtransformer)
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[InputTransformer](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html) ` property of an `AWS::Events::Rule` `Target` data type.
`Pattern`
Describes which events are routed to the specified target. For more information, see [Events and Event Patterns in EventBridge](https://docs.amazonaws.cn/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide*.
*Type*: [EventPattern](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
*Required*: Yes
*Amazon CloudFormation compatibility*: This property is passed directly to the `[EventPattern](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)` property of an `AWS::Events::Rule` resource.
`RetryPolicy`
A `RetryPolicy` object that includes information about the retry policy settings. For more information, see [Event retry policy and using dead-letter queues](https://docs.amazonaws.cn/eventbridge/latest/userguide/rule-dlq.html) in the *Amazon EventBridge User Guide*.
*Type*: [RetryPolicy](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[RetryPolicy](https://docs.amazonaws.cn/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.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[Name](https://docs.amazonaws.cn/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.
*Valid values*: `[ DISABLED | ENABLED ]`
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[State](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` property of an `AWS::Events::Rule` resource.
`Target`
The Amazon 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 Amazon SAM generates the logical ID of the target.
*Type*: [Target](sam-property-statemachine-statemachinetarget.md)
*Required*: No
*Amazon CloudFormation compatibility*: This property is similar to the `[Targets](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets)` property of an `AWS::Events::Rule` resource. The Amazon SAM version of this property only allows you to specify the logical ID of a single target.
## Examples
### EventBridgeRule
The following is an example of an `EventBridgeRule` event source type.
#### YAML
```
EBRule:
Type: EventBridgeRule
Properties:
Input: '{"Key": "Value"}'
Pattern:
detail:
state:
- terminated
```
# DeadLetterConfig
The object used to specify the Amazon Simple Queue Service (Amazon SQS) queue where EventBridge sends events after a failed target invocation. Invocation can fail, for example, when sending an event to a state machine that doesn’t exist, or insufficient permissions to invoke the state machine. For more information, see [Event retry policy and using dead-letter queues](https://docs.amazonaws.cn/eventbridge/latest/userguide/rule-dlq.html) in the *Amazon EventBridge User Guide*.
## Syntax
To declare this entity in your Amazon Serverless Application Model (Amazon SAM) template, use the following syntax.
### YAML
```
[Arn](#sam-statemachine-statemachinedeadletterconfig-arn): String
[QueueLogicalId](#sam-statemachine-statemachinedeadletterconfig-queuelogicalid): String
[Type](#sam-statemachine-statemachinedeadletterconfig-type): String
```
## Properties
`Arn`
The Amazon Resource Name (ARN) of the Amazon SQS queue specified as the target for the dead-letter queue.
Specify either the `Type` property or `Arn` property, but not both.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[Arn](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn)` property of the `AWS::Events::Rule` `DeadLetterConfig` data type.
`QueueLogicalId`
The custom name of the dead letter queue that Amazon SAM creates if `Type` is specified.
If the `Type` property is not set, this property is ignored.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`Type`
The type of the queue. When this property is set, Amazon SAM automatically creates a dead-letter queue and attaches necessary [resource-based policy](https://docs.amazonaws.cn/eventbridge/latest/userguide/rule-dlq.html#dlq-perms) to grant permission to rule resource to send events to the queue.
Specify either the `Type` property or `Arn` property, but not both.
*Valid values*: `SQS`
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
## Examples
### DeadLetterConfig
DeadLetterConfig
#### YAML
```
DeadLetterConfig:
Type: SQS
QueueLogicalId: MyDLQ
```
# Target
Configures the Amazon resource that EventBridge invokes when a rule is triggered.
## Syntax
To declare this entity in your Amazon Serverless Application Model (Amazon SAM) template, use the following syntax.
### YAML
```
[Id](#sam-statemachine-statemachinetarget-id): String
```
## Properties
`Id`
The logical ID of the target.
The value of `Id` can include alphanumeric characters, periods (`.`), hyphens (`-`), and underscores (`_`).
*Type*: String
*Required*: Yes
*Amazon CloudFormation compatibility*: This property is passed directly to the `[Id](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id)` property of the `AWS::Events::Rule` `Target` data type.
## Examples
### Target
#### YAML
```
EBRule:
Type: EventBridgeRule
Properties:
Target:
Id: MyTarget
```
# Schedule
The object describing a `Schedule` event source type, which sets your state machine as the target of an EventBridge rule that triggers on a schedule. For more information, see [What Is Amazon EventBridge?](https://docs.amazonaws.cn/eventbridge/latest/userguide/what-is-amazon-eventbridge.html) in the *Amazon EventBridge User Guide*.
Amazon Serverless Application Model (Amazon SAM) generates an [https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html) resource when this event type is set.
## Syntax
To declare this entity in your Amazon Serverless Application Model (Amazon SAM) template, use the following syntax.
### YAML
```
[DeadLetterConfig](#sam-statemachine-statemachineschedule-deadletterconfig): DeadLetterConfig
[Description](#sam-statemachine-statemachineschedule-description): String
[Enabled](#sam-statemachine-statemachineschedule-enabled): Boolean
[Input](#sam-statemachine-statemachineschedule-input): String
[Name](#sam-statemachine-statemachineschedule-name): String
[RetryPolicy](#sam-statemachine-statemachineschedule-retrypolicy): [RetryPolicy](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)
[RoleArn](#sam-statemachine-statemachineschedulev-rolearn): String
[Schedule](#sam-statemachine-statemachineschedule-schedule): String
[State](#sam-statemachine-statemachineschedule-state): String
Target: Target
```
## Properties
`DeadLetterConfig`
Configure the Amazon Simple Queue Service (Amazon SQS) queue where EventBridge sends events after a failed target invocation. Invocation can fail, for example, when sending an event to a Lambda function that doesn't exist, or when EventBridge has insufficient permissions to invoke the Lambda function. For more information, see [Event retry policy and using dead-letter queues](https://docs.amazonaws.cn/eventbridge/latest/userguide/rule-dlq.html) in the *Amazon EventBridge User Guide*.
*Type*: [DeadLetterConfig](sam-property-statemachine-statemachinescheduledeadletterconfig.md)
*Required*: No
*Amazon CloudFormation compatibility*: This property is similar to the `[DeadLetterConfig](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig)` property of the `AWS::Events::Rule` `Target` data type. The Amazon SAM version of this property includes additional subproperties, in case you want Amazon SAM to create the dead-letter queue for you.
`Description`
A description of the rule.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[Description](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description)` property of an `AWS::Events::Rule` resource.
`Enabled`
Indicates whether the rule is enabled.
To disable the rule, set this property to `false`.
Specify either the `Enabled` or `State` property, but not both.
*Type*: Boolean
*Required*: No
*Amazon CloudFormation compatibility*: This property is similar to the `[State](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` property of an `AWS::Events::Rule` resource. If this property is set to `true` then Amazon SAM passes `ENABLED`, otherwise it passes `DISABLED`.
`Input`
Valid JSON text passed to the target. If you use this property, nothing from the event text itself is passed to the target.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[Input](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` property of an `AWS::Events::Rule Target` resource.
`Name`
The name of the rule. If you don't specify a name, Amazon CloudFormation generates a unique physical ID and uses that ID for the rule name.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[Name](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name)` property of an `AWS::Events::Rule` resource.
`RetryPolicy`
A `RetryPolicy` object that includes information about the retry policy settings. For more information, see [Event retry policy and using dead-letter queues](https://docs.amazonaws.cn/eventbridge/latest/userguide/rule-dlq.html) in the *Amazon EventBridge User Guide*.
*Type*: [RetryPolicy](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[RetryPolicy](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)` property of the `AWS::Events::Rule` `Target` data type.
`RoleArn`
The ARN of the IAM role that EventBridge Scheduler will use for the target when the schedule is invoked.
*Type*: [RoleArn](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)
*Required*: No. If not provided, a new role will be created and used.
*Amazon CloudFormation compatibility*: This property is passed directly to the `[RoleArn](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)` property of the `AWS::Scheduler::Schedule` `Target` data type.
`Schedule`
The scheduling expression that determines when and how often the rule runs. For more information, see [Schedule Expressions for Rules](https://docs.amazonaws.cn/eventbridge/latest/userguide/eb-create-rule-schedule.html).
*Type*: String
*Required*: Yes
*Amazon CloudFormation compatibility*: This property is passed directly to the `[ScheduleExpression](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression)` property of an `AWS::Events::Rule` resource.
`State`
The state of the rule.
*Accepted values:* `DISABLED | ENABLED`
Specify either the `Enabled` or `State` property, but not both.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[State](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` property of an `AWS::Events::Rule` resource.
`Target`
The Amazon 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 Amazon SAM generates the logical ID of the target.
*Type*: [Target](sam-property-statemachine-statemachinetarget.md)
*Required*: No
*Amazon CloudFormation compatibility*: This property is similar to the `[Targets](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets)` property of an `AWS::Events::Rule` resource. The Amazon SAM version of this property only allows you to specify the logical ID of a single target.
## Examples
### CloudWatch Schedule Event
CloudWatch Schedule Event Example
#### YAML
```
CWSchedule:
Type: Schedule
Properties:
Schedule: 'rate(1 minute)'
Name: TestSchedule
Description: test schedule
Enabled: false
```
# DeadLetterConfig
The object used to specify the Amazon Simple Queue Service (Amazon SQS) queue where EventBridge sends events after a failed target invocation. Invocation can fail, for example, when sending an event to a state machine that doesn’t exist, or insufficient permissions to invoke the state machine. For more information, see [Event retry policy and using dead-letter queues](https://docs.amazonaws.cn/eventbridge/latest/userguide/rule-dlq.html) in the *Amazon EventBridge User Guide*.
## Syntax
To declare this entity in your Amazon Serverless Application Model (Amazon SAM) template, use the following syntax.
### YAML
```
[Arn](#sam-statemachine-statemachinescheduledeadletterconfig-arn): String
[QueueLogicalId](#sam-statemachine-statemachinescheduledeadletterconfig-queuelogicalid): String
[Type](#sam-statemachine-statemachinescheduledeadletterconfig-type): String
```
## Properties
`Arn`
The Amazon Resource Name (ARN) of the Amazon SQS queue specified as the target for the dead-letter queue.
Specify either the `Type` property or `Arn` property, but not both.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[Arn](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn)` property of the `AWS::Events::Rule` `DeadLetterConfig` data type.
`QueueLogicalId`
The custom name of the dead letter queue that Amazon SAM creates if `Type` is specified.
If the `Type` property is not set, this property is ignored.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`Type`
The type of the queue. When this property is set, Amazon SAM automatically creates a dead-letter queue and attaches necessary [resource-based policy](https://docs.amazonaws.cn/eventbridge/latest/userguide/rule-dlq.html#dlq-perms) to grant permission to rule resource to send events to the queue.
Specify either the `Type` property or `Arn` property, but not both.
*Valid values*: `SQS`
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
## Examples
### DeadLetterConfig
DeadLetterConfig
#### YAML
```
DeadLetterConfig:
Type: SQS
QueueLogicalId: MyDLQ
```
# Target
Configures the Amazon resource that EventBridge invokes when a rule is triggered.
## Syntax
To declare this entity in your Amazon Serverless Application Model (Amazon SAM) template, use the following syntax.
### YAML
```
[Id](#sam-statemachine-statemachinescheduletarget-id): String
```
## Properties
`Id`
The logical ID of the target.
The value of `Id` can include alphanumeric characters, periods (`.`), hyphens (`-`), and underscores (`_`).
*Type*: String
*Required*: Yes
*Amazon CloudFormation compatibility*: This property is passed directly to the `[Id](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id)` property of the `AWS::Events::Rule` `Target` data type.
## Examples
### Target
#### YAML
```
EBRule:
Type: Schedule
Properties:
Target:
Id: MyTarget
```
# ScheduleV2
The object describing a `ScheduleV2` event source type, which sets your state machine as the target of an Amazon EventBridge Scheduler event that triggers on a schedule. For more information, see [What is Amazon EventBridge Scheduler?](https://docs.amazonaws.cn/scheduler/latest/UserGuide/what-is-scheduler.html) in the *EventBridge Scheduler User Guide*.
Amazon Serverless Application Model (Amazon SAM) generates an [https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html) resource when this event type is set.
## Syntax
To declare this entity in your Amazon Serverless Application Model (Amazon SAM) template, use the following syntax.
### YAML
```
DeadLetterConfig: DeadLetterConfig
[Description](#sam-statemachine-statemachineschedulev2-description): String
[EndDate](#sam-statemachine-statemachineschedulev2-enddate): String
[FlexibleTimeWindow](#sam-statemachine-statemachineschedulev2-flexibletimewindow): FlexibleTimeWindow
[GroupName](#sam-statemachine-statemachineschedulev2-groupname): String
[Input](#sam-statemachine-statemachineschedulev2-input): String
[KmsKeyArn](#sam-statemachine-statemachineschedulev2-kmskeyarn): String
[Name](#sam-statemachine-statemachineschedulev2-name): String
OmitName: Boolean
[PermissionsBoundary](#sam-statemachine-statemachineschedulev2-permissionsboundary): String
[RetryPolicy](#sam-statemachine-statemachineschedulev2-retrypolicy): RetryPolicy
[RoleArn](#sam-statemachine-statemachineschedulev2-rolearn): String
[ScheduleExpression](#sam-statemachine-statemachineschedulev2-scheduleexpression): String
[ScheduleExpressionTimezone](#sam-statemachine-statemachineschedulev2-scheduleexpressiontimezone): String
[StartDate](#sam-statemachine-statemachineschedulev2-startdate): String
[State](#sam-statemachine-statemachineschedulev2-state): String
```
## Properties
`DeadLetterConfig`
Configure the Amazon Simple Queue Service (Amazon SQS) queue where EventBridge sends events after a failed target invocation. Invocation can fail, for example, when sending an event to a Lambda function that doesn't exist, or when EventBridge has insufficient permissions to invoke the Lambda function. For more information, see [Configuring a dead-letter queue for EventBridge Scheduler](https://docs.amazonaws.cn/scheduler/latest/UserGuide/configuring-schedule-dlq.html) in the *EventBridge Scheduler User Guide*.
*Type*: [DeadLetterConfig](sam-property-statemachine-statemachinescheduledeadletterconfig.md)
*Required*: No
*Amazon CloudFormation compatibility*: This property is similar to the `[DeadLetterConfig](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-deadletterconfig)` property of the `AWS::Scheduler::Schedule` `Target` data type. The Amazon SAM version of this property includes additional subproperties, in case you want Amazon SAM to create the dead-letter queue for you.
`Description`
A description of the schedule.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[Description](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-description)` property of an `AWS::Scheduler::Schedule` resource.
`EndDate`
The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the **EndDate** you specify.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[EndDate](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-enddate)` property of an `AWS::Scheduler::Schedule` resource.
`FlexibleTimeWindow`
Allows configuration of a window within which a schedule can be invoked.
*Type*: [FlexibleTimeWindow](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-flexibletimewindow)
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[FlexibleTimeWindow](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler.html#cfn-scheduler-schedule-flexibletimewindow)` property of an `AWS::Scheduler::Schedule` resource.
`GroupName`
The name of the schedule group to associate with this schedule. If not defined, the default group is used.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[GroupName](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-groupname)` property of an `AWS::Scheduler::Schedule` resource.
`Input`
Valid JSON text passed to the target. If you use this property, nothing from the event text itself is passed to the target.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[Input](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-input)` property of an `AWS::Scheduler::Schedule Target` resource.
`KmsKeyArn`
The ARN for a KMS Key that will be used to encrypt customer data.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[KmsKeyArn](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-kmskeyarn)` property of an `AWS::Scheduler::Schedule` resource.
`Name`
The name of the schedule. If you don't specify a name, Amazon SAM generates a name in the format `StateMachine-Logical-IDEvent-Source-Name` and uses that ID for the schedule name.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[Name](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-name)` property of an `AWS::Scheduler::Schedule` resource.
`OmitName`
By default, Amazon SAM generates and uses a schedule name in the format of **. Set this property to `true` to have Amazon CloudFormation generate a unique physical ID and use that for the schedule name instead.
*Type*: Boolean
*Required*: No
*Default*: `false`
*Amazon CloudFormation compatibility*: This property is unique to Amazon SAM and doesn't have an Amazon CloudFormation equivalent.
`PermissionsBoundary`
The ARN of the policy used to set the permissions boundary for the role.
If `PermissionsBoundary` is defined, Amazon SAM will apply the same boundaries to the scheduler schedule's target IAM role.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[PermissionsBoundary](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-permissionsboundary)` property of an `AWS::IAM::Role` resource.
`RetryPolicy`
A `RetryPolicy` object that includes information about the retry policy settings.
*Type*: [RetryPolicy](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-retrypolicy)
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[RetryPolicy](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-retrypolicy)` property of the `AWS::Scheduler::Schedule` `Target` data type.
`RoleArn`
The ARN of the IAM role that EventBridge Scheduler will use for the target when the schedule is invoked.
*Type*: [RoleArn](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[RoleArn](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)` property of the `AWS::Scheduler::Schedule` `Target` data type.
`ScheduleExpression`
The scheduling expression that determines when and how often the schedule runs.
*Type*: String
*Required*: Yes
*Amazon CloudFormation compatibility*: This property is passed directly to the `[ScheduleExpression](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpression)` property of an `AWS::Scheduler::Schedule` resource.
`ScheduleExpressionTimezone`
The timezone in which the scheduling expression is evaluated.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[ScheduleExpressionTimezone](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpressiontimezone)` property of an `AWS::Scheduler::Schedule` resource.
`StartDate`
The date, in UTC, after which the schedule can begin invoking a target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the **StartDate** you specify.
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[StartDate](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-startdate)` property of an `AWS::Scheduler::Schedule` resource.
`State`
The state of the schedule.
*Accepted values:* `DISABLED | ENABLED`
*Type*: String
*Required*: No
*Amazon CloudFormation compatibility*: This property is passed directly to the `[State](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-state)` property of an `AWS::Scheduler::Schedule` resource.
## Examples
### Basic example of defining a ScheduleV2 resource
```
StateMachine:
Type: AWS::Serverless::StateMachine
Properties:
Name: MyStateMachine
Events:
ScheduleEvent:
Type: ScheduleV2
Properties:
ScheduleExpression: "rate(1 minute)"
ComplexScheduleEvent:
Type: ScheduleV2
Properties:
ScheduleExpression: rate(1 minute)
FlexibleTimeWindow:
Mode: FLEXIBLE
MaximumWindowInMinutes: 5
StartDate: '2022-12-28T12:00:00.000Z'
EndDate: '2023-01-28T12:00:00.000Z'
ScheduleExpressionTimezone: UTC
RetryPolicy:
MaximumRetryAttempts: 5
MaximumEventAgeInSeconds: 300
DeadLetterConfig:
Type: SQS
DefinitionUri:
Bucket: sam-sam-s3-demo-bucket
Key: my-state-machine.asl.json
Version: 3
Policies:
- LambdaInvokePolicy:
FunctionName: !Ref MyFunction
```