@propulsionworks/cloudformation 0.0.2 → 0.1.0

package/out/exports/resources.generated/aws-events-eventbuspolicy.d.ts

@@ -0,0 +1,70 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type EventsEventBusPolicy = ResourceDefinitionWithAttributes<"AWS::Events::EventBusPolicy", EventsEventBusPolicyProps, EventsEventBusPolicyAttribs>;
+/**
+ * Running `PutPermission` permits the specified AWS account or AWS organization to put events to the specified *event bus* . Amazon EventBridge rules in your account are triggered by these events arriving to an event bus in your account.
+ *
+ * For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target.
+ *
+ * To enable multiple AWS accounts to put events to your event bus, run `PutPermission` once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run `PutPermission` once specifying `Principal` as "*" and specifying the AWS organization ID in `Condition` , to grant permissions to all accounts in that organization.
+ *
+ * If you grant permissions using an organization, then accounts in that organization must specify a `RoleArn` with proper permissions when they use `PutTarget` to add your account's event bus as a target. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide* .
+ *
+ * The permission policy on the event bus cannot exceed 10 KB in size.
+ */
+export type EventsEventBusPolicyProps = {
+    /**
+     * The action that you are enabling the other account to perform.
+     */
+    Action?: string | undefined;
+    /**
+     * This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization. For more information about AWS Organizations, see [What Is AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html) in the *AWS Organizations User Guide* .
+     *
+     * If you specify `Condition` with an AWS organization ID, and specify "*" as the value for `Principal` , you grant permission to all the accounts in the named organization.
+     *
+     * The `Condition` is a JSON string which must contain `Type` , `Key` , and `Value` fields.
+     */
+    Condition?: Condition | undefined;
+    /**
+     * The name of the event bus associated with the rule. If you omit this, the default event bus is used.
+     */
+    EventBusName?: string | undefined;
+    /**
+     * The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.
+     *
+     * If you specify "*" without specifying `Condition` , avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an `account` field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.
+     */
+    Principal?: string | undefined;
+    /**
+     * A JSON string that describes the permission policy statement. You can include a `Policy` parameter in the request instead of using the `StatementId` , `Action` , `Principal` , or `Condition` parameters.
+     */
+    Statement?: Record<string, unknown> | undefined;
+    /**
+     * An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this `StatementId` when you run [RemovePermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html) .
+     *
+     * > Each `StatementId` must be unique.
+     */
+    StatementId: string;
+};
+export type EventsEventBusPolicyAttribs = {
+    Id: string;
+};
+/**
+ * A JSON string which you can use to limit the event bus permissions you are granting to only accounts that fulfill the condition. Currently, the only supported condition is membership in a certain AWS organization. The string must contain `Type` , `Key` , and `Value` fields. The `Value` field specifies the ID of the AWS organization. Following is an example value for `Condition` :
+ *
+ * `'{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value": "o-1234567890"}'`
+ */
+export type Condition = {
+    /**
+     * Specifies the key for the condition. Currently the only supported key is `aws:PrincipalOrgID` .
+     */
+    Key?: string | undefined;
+    /**
+     * Specifies the type of condition. Currently the only supported value is `StringEquals` .
+     */
+    Type?: string | undefined;
+    /**
+     * Specifies the value for the key. Currently, this must be the ID of the organization.
+     */
+    Value?: string | undefined;
+};
+//# sourceMappingURL=aws-events-eventbuspolicy.d.ts.map

package/out/exports/resources.generated/aws-events-rule.d.ts

@@ -0,0 +1,585 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type EventsRule = ResourceDefinitionWithAttributes<"AWS::Events::Rule", EventsRuleProps, EventsRuleAttribs>;
+/**
+ * Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using [DisableRule](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html) .
+ *
+ * A single rule watches for events from a single event bus. Events generated by AWS services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see [CreateEventBus](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html) .
+ *
+ * If you are updating an existing rule, the rule is replaced with what you specify in this `PutRule` command. If you omit arguments in `PutRule` , the old values for those arguments are not kept. Instead, they are replaced with null values.
+ *
+ * When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect.
+ *
+ * A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.
+ *
+ * Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
+ *
+ * In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.
+ *
+ * To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.
+ *
+ * An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see [Managing Your Costs with Budgets](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html) .
+ *
+ * > As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing rules in your account. For more information, see [Generating CloudFormation templates from an EventBridge rule](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-generate-template.html) in the *Amazon EventBridge User Guide* .
+ */
+export type EventsRuleProps = {
+    /**
+     * The description of the rule.
+     */
+    Description?: string | undefined;
+    /**
+     * The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
+     */
+    EventBusName?: string | undefined;
+    /**
+     * The event pattern of the rule. For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the **Amazon EventBridge User Guide** .
+     */
+    EventPattern?: string | Record<string, unknown> | undefined;
+    /**
+     * The name of the rule.
+     */
+    Name?: string | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of the role that is used for target invocation.
+     *
+     * If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a `RoleArn` with proper permissions in the `Target` structure, instead of here in this parameter.
+     */
+    RoleArn?: string | undefined;
+    /**
+     * The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see [Creating an Amazon EventBridge rule that runs on a schedule](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html) .
+     */
+    ScheduleExpression?: string | undefined;
+    /**
+     * The state of the rule.
+     *
+     * Valid values include:
+     *
+     * - `DISABLED` : The rule is disabled. EventBridge does not match any events against the rule.
+     * - `ENABLED` : The rule is enabled. EventBridge matches events against the rule, *except* for AWS management events delivered through CloudTrail.
+     * - `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS` : The rule is enabled for all events, including AWS management events delivered through CloudTrail.
+     *
+     * Management events provide visibility into management operations that are performed on resources in your AWS account. These are also known as control plane operations. For more information, see [Logging management events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html#logging-management-events) in the *CloudTrail User Guide* , and [Filtering management events from AWS services](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-cloudtrail) in the **Amazon EventBridge User Guide** .
+     *
+     * This value is only valid for rules on the [default](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is-how-it-works-concepts.html#eb-bus-concepts-buses) event bus or [custom event buses](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-event-bus.html) . It does not apply to [partner event buses](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-saas.html) .
+     */
+    State?: "DISABLED" | "ENABLED" | "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS" | undefined;
+    /**
+     * Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
+     *
+     * Targets are the resources that are invoked when a rule is triggered.
+     *
+     * The maximum number of entries per request is 10.
+     *
+     * > Each rule can have up to five (5) targets associated with it at one time.
+     *
+     * For a list of services you can configure as targets for events, see [EventBridge targets](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html) in the **Amazon EventBridge User Guide** .
+     *
+     * Creating rules with built-in targets is supported only in the AWS Management Console . The built-in targets are:
+     *
+     * - `Amazon EBS CreateSnapshot API call`
+     * - `Amazon EC2 RebootInstances API call`
+     * - `Amazon EC2 StopInstances API call`
+     * - `Amazon EC2 TerminateInstances API call`
+     *
+     * For some target types, `PutTargets` provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the `KinesisParameters` argument. To invoke a command on multiple EC2 instances with one rule, you can use the `RunCommandParameters` field.
+     *
+     * To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions:
+     *
+     * - For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.
+     * - For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets` .
+     *
+     * For more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the **Amazon EventBridge User Guide** .
+     *
+     * If another AWS account is in the same region and has granted you permission (using `PutPermission` ), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the `Arn` value when you run `PutTargets` . If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see [Amazon EventBridge Pricing](https://docs.aws.amazon.com/eventbridge/pricing/) .
+     *
+     * > `Input` , `InputPath` , and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account.
+     *
+     * If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide* .
+     *
+     * > If you have an IAM role on a cross-account event bus target, a `PutTargets` call without a role on the same target (same `Id` and `Arn` ) will not remove the role.
+     *
+     * For more information about enabling cross-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html) .
+     *
+     * *Input* , *InputPath* , and *InputTransformer* are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:
+     *
+     * - If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
+     * - If *Input* is specified in the form of valid JSON, then the matched event is overridden with this constant.
+     * - If *InputPath* is specified in the form of JSONPath (for example, `$.detail` ), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).
+     * - If *InputTransformer* is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.
+     *
+     * When you specify `InputPath` or `InputTransformer` , you must use JSON dot notation, not bracket notation.
+     *
+     * When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.
+     *
+     * This action can partially fail if too many requests are made at the same time. If that happens, `FailedEntryCount` is non-zero in the response and each entry in `FailedEntries` provides the ID of the failed target and the error code.
+     */
+    Targets?: Target[] | undefined;
+};
+export type EventsRuleAttribs = {
+    /**
+     * The ARN of the rule, such as `arn:aws:events:us-east-2:123456789012:rule/example` .
+     */
+    Arn: string;
+};
+/**
+ * Contains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API.
+ */
+export type AppSyncParameters = {
+    /**
+     * The GraphQL operation; that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service.
+     *
+     * For more information, see [Operations](https://docs.aws.amazon.com/appsync/latest/devguide/graphql-architecture.html#graphql-operations) in the *AWS AppSync User Guide* .
+     */
+    GraphQLOperation: string;
+};
+/**
+ * This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the `awsvpc` network mode.
+ */
+export type AwsVpcConfiguration = {
+    /**
+     * Specifies whether the task's elastic network interface receives a public IP address. You can specify `ENABLED` only when `LaunchType` in `EcsParameters` is set to `FARGATE` .
+     */
+    AssignPublicIp?: string | undefined;
+    /**
+     * Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
+     */
+    SecurityGroups?: string[] | undefined;
+    /**
+     * Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
+     */
+    Subnets: string[];
+};
+/**
+ * The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.
+ */
+export type BatchArrayProperties = {
+    /**
+     * The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.
+     */
+    Size?: number | undefined;
+};
+/**
+ * The custom parameters to be used when the target is an AWS Batch job.
+ */
+export type BatchParameters = {
+    /**
+     * The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.
+     */
+    ArrayProperties?: BatchArrayProperties | undefined;
+    /**
+     * The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist.
+     */
+    JobDefinition: string;
+    /**
+     * The name to use for this execution of the job, if the target is an AWS Batch job.
+     */
+    JobName: string;
+    /**
+     * The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.
+     */
+    RetryStrategy?: BatchRetryStrategy | undefined;
+};
+/**
+ * The retry strategy to use for failed jobs, if the target is an AWS Batch job. If you specify a retry strategy here, it overrides the retry strategy defined in the job definition.
+ */
+export type BatchRetryStrategy = {
+    /**
+     * The number of times to attempt to retry, if the job fails. Valid values are 1–10.
+     */
+    Attempts?: number | undefined;
+};
+/**
+ * The details of a capacity provider strategy. To learn more, see [CapacityProviderStrategyItem](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) in the Amazon ECS API Reference.
+ */
+export type CapacityProviderStrategyItem = {
+    /**
+     * The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
+     */
+    Base?: number | undefined;
+    /**
+     * The short name of the capacity provider.
+     */
+    CapacityProvider: string;
+    /**
+     * The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
+     */
+    Weight?: number | undefined;
+};
+/**
+ * Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).
+ *
+ * For more information, see [Using dead-letter queues to process undelivered events](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rule-event-delivery.html#eb-rule-dlq) in the *EventBridge User Guide* .
+ */
+export type DeadLetterConfig = {
+    /**
+     * The ARN of the SQS queue specified as the target for the dead-letter queue.
+     */
+    Arn?: string | undefined;
+};
+/**
+ * The custom parameters to be used when the target is an Amazon ECS task.
+ */
+export type EcsParameters = {
+    /**
+     * The capacity provider strategy to use for the task.
+     *
+     * If a `capacityProviderStrategy` is specified, the `launchType` parameter must be omitted. If no `capacityProviderStrategy` or launchType is specified, the `defaultCapacityProviderStrategy` for the cluster is used.
+     */
+    CapacityProviderStrategy?: CapacityProviderStrategyItem[] | undefined;
+    /**
+     * Specifies whether to enable Amazon ECS managed tags for the task. For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the Amazon Elastic Container Service Developer Guide.
+     */
+    EnableECSManagedTags?: boolean | undefined;
+    /**
+     * Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
+     */
+    EnableExecuteCommand?: boolean | undefined;
+    /**
+     * Specifies an ECS task group for the task. The maximum length is 255 characters.
+     */
+    Group?: string | undefined;
+    /**
+     * Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The `FARGATE` value is supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more information, see [AWS Fargate on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) in the *Amazon Elastic Container Service Developer Guide* .
+     */
+    LaunchType?: string | undefined;
+    /**
+     * Use this structure if the Amazon ECS task uses the `awsvpc` network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if `LaunchType` is `FARGATE` because the `awsvpc` mode is required for Fargate tasks.
+     *
+     * If you specify `NetworkConfiguration` when the target ECS task does not use the `awsvpc` network mode, the task fails.
+     */
+    NetworkConfiguration?: NetworkConfiguration | undefined;
+    /**
+     * An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
+     */
+    PlacementConstraints?: PlacementConstraint[] | undefined;
+    /**
+     * The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
+     */
+    PlacementStrategies?: PlacementStrategy[] | undefined;
+    /**
+     * Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as `1.1.0` .
+     *
+     * This structure is used only if `LaunchType` is `FARGATE` . For more information about valid platform versions, see [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide* .
+     */
+    PlatformVersion?: string | undefined;
+    /**
+     * Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
+     */
+    PropagateTags?: string | undefined;
+    /**
+     * The reference ID to use for the task.
+     */
+    ReferenceId?: string | undefined;
+    /**
+     * The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) in the Amazon ECS API Reference.
+     */
+    TagList?: Tag[] | undefined;
+    /**
+     * The number of tasks to create based on `TaskDefinition` . The default is 1.
+     */
+    TaskCount?: number | undefined;
+    /**
+     * The ARN of the task definition to use if the event target is an Amazon ECS task.
+     */
+    TaskDefinitionArn: string;
+};
+/**
+ * These are custom parameter to be used when the target is an API Gateway APIs or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.
+ */
+export type HttpParameters = {
+    /**
+     * The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
+     */
+    HeaderParameters?: Record<string, string> | undefined;
+    /**
+     * The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").
+     */
+    PathParameterValues?: string[] | undefined;
+    /**
+     * The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
+     */
+    QueryStringParameters?: Record<string, string> | undefined;
+};
+/**
+ * Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.
+ */
+export type InputTransformer = {
+    /**
+     * Map of JSON paths to be extracted from the event. You can then insert these in the template in `InputTemplate` to produce the output you want to be sent to the target.
+     *
+     * `InputPathsMap` is an array key-value pairs, where each value is a valid JSON path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket notation.
+     *
+     * The keys cannot start with " AWS ."
+     */
+    InputPathsMap?: Record<string, string> | undefined;
+    /**
+     * Input template where you specify placeholders that will be filled with the values of the keys from `InputPathsMap` to customize the data sent to the target. Enclose each `InputPathsMaps` value in brackets: < *value* >
+     *
+     * If `InputTemplate` is a JSON object (surrounded by curly braces), the following restrictions apply:
+     *
+     * - The placeholder cannot be used as an object key.
+     *
+     * The following example shows the syntax for using `InputPathsMap` and `InputTemplate` .
+     *
+     * `"InputTransformer":`
+     *
+     * `{`
+     *
+     * `"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},`
+     *
+     * `"InputTemplate": "<instance> is in state <status>"`
+     *
+     * `}`
+     *
+     * To have the `InputTemplate` include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:
+     *
+     * `"InputTransformer":`
+     *
+     * `{`
+     *
+     * `"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},`
+     *
+     * `"InputTemplate": "<instance> is in state \"<status>\""`
+     *
+     * `}`
+     *
+     * The `InputTemplate` can also be valid JSON with varibles in quotes or out, as in the following example:
+     *
+     * `"InputTransformer":`
+     *
+     * `{`
+     *
+     * `"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},`
+     *
+     * `"InputTemplate": '{"myInstance": <instance>,"myStatus": "<instance> is in state \"<status>\""}'`
+     *
+     * `}`
+     */
+    InputTemplate: string;
+};
+/**
+ * This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis data stream, so that you can control the shard to which the event goes. If you do not include this parameter, the default is to use the `eventId` as the partition key.
+ */
+export type KinesisParameters = {
+    /**
+     * The JSON path to be extracted from the event and used as the partition key. For more information, see [Amazon Kinesis Streams Key Concepts](https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key) in the *Amazon Kinesis Streams Developer Guide* .
+     */
+    PartitionKeyPath: string;
+};
+/**
+ * This structure specifies the network configuration for an ECS task.
+ */
+export type NetworkConfiguration = {
+    /**
+     * Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the `awsvpc` network mode.
+     */
+    AwsVpcConfiguration?: AwsVpcConfiguration | undefined;
+};
+/**
+ * An object representing a constraint on task placement. To learn more, see [Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the Amazon Elastic Container Service Developer Guide.
+ */
+export type PlacementConstraint = {
+    /**
+     * A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is `distinctInstance` . To learn more, see [Cluster Query Language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the Amazon Elastic Container Service Developer Guide.
+     */
+    Expression?: string | undefined;
+    /**
+     * The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
+     */
+    Type?: string | undefined;
+};
+/**
+ * The task placement strategy for a task or service. To learn more, see [Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the Amazon Elastic Container Service Service Developer Guide.
+ */
+export type PlacementStrategy = {
+    /**
+     * The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
+     */
+    Field?: string | undefined;
+    /**
+     * The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
+     */
+    Type?: string | undefined;
+};
+/**
+ * These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
+ */
+export type RedshiftDataParameters = {
+    /**
+     * The name of the database. Required when authenticating using temporary credentials.
+     */
+    Database: string;
+    /**
+     * The database user name. Required when authenticating using temporary credentials.
+     */
+    DbUser?: string | undefined;
+    /**
+     * The name or ARN of the secret that enables access to the database. Required when authenticating using AWS Secrets Manager.
+     */
+    SecretManagerArn?: string | undefined;
+    /**
+     * The SQL statement text to run.
+     */
+    Sql?: string | undefined;
+    /**
+     * One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.
+     */
+    Sqls?: string[] | undefined;
+    /**
+     * The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
+     */
+    StatementName?: string | undefined;
+    /**
+     * Indicates whether to send an event back to EventBridge after the SQL statement runs.
+     */
+    WithEvent?: boolean | undefined;
+};
+/**
+ * A `RetryPolicy` object that includes information about the retry policy settings.
+ */
+export type RetryPolicy = {
+    /**
+     * The maximum amount of time, in seconds, to continue to make retry attempts.
+     */
+    MaximumEventAgeInSeconds?: number | undefined;
+    /**
+     * The maximum number of retry attempts to make before the request fails. Retry attempts continue until either the maximum number of attempts is made or until the duration of the `MaximumEventAgeInSeconds` is met.
+     */
+    MaximumRetryAttempts?: number | undefined;
+};
+/**
+ * This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances are to be sent the command.
+ */
+export type RunCommandParameters = {
+    /**
+     * Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.
+     */
+    RunCommandTargets: RunCommandTarget[];
+};
+/**
+ * Information about the EC2 instances that are to be sent the command, specified as key-value pairs. Each `RunCommandTarget` block can include only one key, but this key may specify multiple values.
+ */
+export type RunCommandTarget = {
+    /**
+     * Can be either `tag:` *tag-key* or `InstanceIds` .
+     */
+    Key: string;
+    /**
+     * If `Key` is `tag:` *tag-key* , `Values` is a list of tag values. If `Key` is `InstanceIds` , `Values` is a list of Amazon EC2 instance IDs.
+     */
+    Values: string[];
+};
+/**
+ * Name/Value pair of a parameter to start execution of a SageMaker AI Model Building Pipeline.
+ */
+export type SageMakerPipelineParameter = {
+    /**
+     * Name of parameter to start execution of a SageMaker AI Model Building Pipeline.
+     */
+    Name: string;
+    /**
+     * Value of parameter to start execution of a SageMaker AI Model Building Pipeline.
+     */
+    Value: string;
+};
+/**
+ * These are custom parameters to use when the target is a SageMaker AI Model Building Pipeline that starts based on EventBridge events.
+ */
+export type SageMakerPipelineParameters = {
+    /**
+     * List of Parameter names and values for SageMaker AI Model Building Pipeline execution.
+     */
+    PipelineParameterList?: SageMakerPipelineParameter[] | undefined;
+};
+/**
+ * This structure includes the custom parameter to be used when the target is an SQS FIFO queue.
+ */
+export type SqsParameters = {
+    /**
+     * The FIFO message group ID to use as the target.
+     */
+    MessageGroupId: string;
+};
+/**
+ * Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see [PutTargets](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html) .
+ *
+ * If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide* .
+ */
+export type Target = {
+    /**
+     * Contains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API.
+     */
+    AppSyncParameters?: AppSyncParameters | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of the target.
+     */
+    Arn: string;
+    /**
+     * If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see [Jobs](https://docs.aws.amazon.com/batch/latest/userguide/jobs.html) in the *AWS Batch User Guide* .
+     */
+    BatchParameters?: BatchParameters | undefined;
+    /**
+     * The `DeadLetterConfig` that defines the target queue to send dead-letter queue events to.
+     */
+    DeadLetterConfig?: DeadLetterConfig | undefined;
+    /**
+     * Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see [Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon EC2 Container Service Developer Guide* .
+     */
+    EcsParameters?: EcsParameters | undefined;
+    /**
+     * Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.
+     *
+     * If you specify an API Gateway API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
+     */
+    HttpParameters?: HttpParameters | undefined;
+    /**
+     * The ID of the target within the specified rule. Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.
+     */
+    Id: string;
+    /**
+     * Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see [The JavaScript Object Notation (JSON) Data Interchange Format](https://docs.aws.amazon.com/http://www.rfc-editor.org/rfc/rfc7159.txt) .
+     */
+    Input?: string | undefined;
+    /**
+     * The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You may use JSON dot notation or bracket notation. For more information about JSON paths, see [JSONPath](https://docs.aws.amazon.com/http://goessner.net/articles/JsonPath/) .
+     */
+    InputPath?: string | undefined;
+    /**
+     * 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.
+     */
+    InputTransformer?: InputTransformer | undefined;
+    /**
+     * The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If you do not include this parameter, the default is to use the `eventId` as the partition key.
+     */
+    KinesisParameters?: KinesisParameters | undefined;
+    /**
+     * Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.
+     *
+     * If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
+     */
+    RedshiftDataParameters?: RedshiftDataParameters | undefined;
+    /**
+     * The retry policy configuration to use for the dead-letter queue.
+     */
+    RetryPolicy?: RetryPolicy | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.
+     */
+    RoleArn?: string | undefined;
+    /**
+     * Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
+     */
+    RunCommandParameters?: RunCommandParameters | undefined;
+    /**
+     * Contains the SageMaker AI Model Building Pipeline parameters to start execution of a SageMaker AI Model Building Pipeline.
+     *
+     * If you specify a SageMaker AI Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.
+     */
+    SageMakerPipelineParameters?: SageMakerPipelineParameters | undefined;
+    /**
+     * Contains the message group ID to use when the target is a FIFO queue.
+     *
+     * If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.
+     */
+    SqsParameters?: SqsParameters | undefined;
+};
+//# sourceMappingURL=aws-events-rule.d.ts.map