AWS Cloud Control v1.27.0, Apr 14 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.events.Rule

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-aws-native

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var eventBridgeIAMrole = new AwsNative.Iam.Role("eventBridgeIAMrole", new()
    {
        AssumeRolePolicyDocument = new Dictionary<string, object?>
        {
            ["version"] = "2012-10-17",
            ["statement"] = new[]
            {
                new Dictionary<string, object?>
                {
                    ["effect"] = "Allow",
                    ["principal"] = new Dictionary<string, object?>
                    {
                        ["service"] = "events.amazonaws.com",
                    },
                    ["action"] = "sts:AssumeRole",
                },
            },
        },
        Path = "/",
        Policies = new[]
        {
            new AwsNative.Iam.Inputs.RolePolicyArgs
            {
                PolicyName = "PutEventsDestinationBus",
                PolicyDocument = new Dictionary<string, object?>
                {
                    ["version"] = "2012-10-17",
                    ["statement"] = new[]
                    {
                        new Dictionary<string, object?>
                        {
                            ["effect"] = "Allow",
                            ["action"] = new[]
                            {
                                "events:PutEvents",
                            },
                            ["resource"] = new[]
                            {
                                "arn:aws:events:us-east-1:123456789012:event-bus/CrossRegionDestinationBus",
                            },
                        },
                    },
                },
            },
        },
    });

    var eventRuleRegion1 = new AwsNative.Events.Rule("eventRuleRegion1", new()
    {
        Description = "Routes to us-east-1 event bus",
        EventBusName = "MyBusName",
        State = AwsNative.Events.RuleState.Enabled,
        EventPattern = new Dictionary<string, object?>
        {
            ["source"] = new[]
            {
                "MyTestApp",
            },
            ["detail"] = new[]
            {
                "MyTestAppDetail",
            },
        },
        Targets = new[]
        {
            new AwsNative.Events.Inputs.RuleTargetArgs
            {
                Arn = "arn:aws:events:us-east-1:123456789012:event-bus/CrossRegionDestinationBus",
                Id = " CrossRegionDestinationBus",
                RoleArn = eventBridgeIAMrole.Arn,
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/events"
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/iam"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		eventBridgeIAMrole, err := iam.NewRole(ctx, "eventBridgeIAMrole", &iam.RoleArgs{
			AssumeRolePolicyDocument: pulumi.Any(map[string]interface{}{
				"version": "2012-10-17",
				"statement": []map[string]interface{}{
					map[string]interface{}{
						"effect": "Allow",
						"principal": map[string]interface{}{
							"service": "events.amazonaws.com",
						},
						"action": "sts:AssumeRole",
					},
				},
			}),
			Path: pulumi.String("/"),
			Policies: iam.RolePolicyTypeArray{
				&iam.RolePolicyTypeArgs{
					PolicyName: pulumi.String("PutEventsDestinationBus"),
					PolicyDocument: pulumi.Any(map[string]interface{}{
						"version": "2012-10-17",
						"statement": []map[string]interface{}{
							map[string]interface{}{
								"effect": "Allow",
								"action": []string{
									"events:PutEvents",
								},
								"resource": []string{
									"arn:aws:events:us-east-1:123456789012:event-bus/CrossRegionDestinationBus",
								},
							},
						},
					}),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = events.NewRule(ctx, "eventRuleRegion1", &events.RuleArgs{
			Description:  pulumi.String("Routes to us-east-1 event bus"),
			EventBusName: pulumi.String("MyBusName"),
			State:        events.RuleStateEnabled,
			EventPattern: pulumi.Any(map[string]interface{}{
				"source": []string{
					"MyTestApp",
				},
				"detail": []string{
					"MyTestAppDetail",
				},
			}),
			Targets: events.RuleTargetArray{
				&events.RuleTargetArgs{
					Arn:     pulumi.String("arn:aws:events:us-east-1:123456789012:event-bus/CrossRegionDestinationBus"),
					Id:      pulumi.String(" CrossRegionDestinationBus"),
					RoleArn: eventBridgeIAMrole.Arn,
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const eventBridgeIAMrole = new aws_native.iam.Role("eventBridgeIAMrole", {
    assumeRolePolicyDocument: {
        version: "2012-10-17",
        statement: [{
            effect: "Allow",
            principal: {
                service: "events.amazonaws.com",
            },
            action: "sts:AssumeRole",
        }],
    },
    path: "/",
    policies: [{
        policyName: "PutEventsDestinationBus",
        policyDocument: {
            version: "2012-10-17",
            statement: [{
                effect: "Allow",
                action: ["events:PutEvents"],
                resource: ["arn:aws:events:us-east-1:123456789012:event-bus/CrossRegionDestinationBus"],
            }],
        },
    }],
});
const eventRuleRegion1 = new aws_native.events.Rule("eventRuleRegion1", {
    description: "Routes to us-east-1 event bus",
    eventBusName: "MyBusName",
    state: aws_native.events.RuleState.Enabled,
    eventPattern: {
        source: ["MyTestApp"],
        detail: ["MyTestAppDetail"],
    },
    targets: [{
        arn: "arn:aws:events:us-east-1:123456789012:event-bus/CrossRegionDestinationBus",
        id: " CrossRegionDestinationBus",
        roleArn: eventBridgeIAMrole.arn,
    }],
});

import pulumi
import pulumi_aws_native as aws_native

event_bridge_ia_mrole = aws_native.iam.Role("eventBridgeIAMrole",
    assume_role_policy_document={
        "version": "2012-10-17",
        "statement": [{
            "effect": "Allow",
            "principal": {
                "service": "events.amazonaws.com",
            },
            "action": "sts:AssumeRole",
        }],
    },
    path="/",
    policies=[{
        "policy_name": "PutEventsDestinationBus",
        "policy_document": {
            "version": "2012-10-17",
            "statement": [{
                "effect": "Allow",
                "action": ["events:PutEvents"],
                "resource": ["arn:aws:events:us-east-1:123456789012:event-bus/CrossRegionDestinationBus"],
            }],
        },
    }])
event_rule_region1 = aws_native.events.Rule("eventRuleRegion1",
    description="Routes to us-east-1 event bus",
    event_bus_name="MyBusName",
    state=aws_native.events.RuleState.ENABLED,
    event_pattern={
        "source": ["MyTestApp"],
        "detail": ["MyTestAppDetail"],
    },
    targets=[{
        "arn": "arn:aws:events:us-east-1:123456789012:event-bus/CrossRegionDestinationBus",
        "id": " CrossRegionDestinationBus",
        "role_arn": event_bridge_ia_mrole.arn,
    }])

Coming soon!

Create Rule Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

TypeScript
Python
Go
C#
Java
YAML

new Rule(name: string, args?: RuleArgs, opts?: CustomResourceOptions);

@overload
def Rule(resource_name: str,
         args: Optional[RuleArgs] = None,
         opts: Optional[ResourceOptions] = None)

@overload
def Rule(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         description: Optional[str] = None,
         event_bus_name: Optional[str] = None,
         event_pattern: Optional[Any] = None,
         name: Optional[str] = None,
         role_arn: Optional[str] = None,
         schedule_expression: Optional[str] = None,
         state: Optional[RuleState] = None,
         targets: Optional[Sequence[RuleTargetArgs]] = None)

func NewRule(ctx *Context, name string, args *RuleArgs, opts ...ResourceOption) (*Rule, error)

public Rule(string name, RuleArgs? args = null, CustomResourceOptions? opts = null)

public Rule(String name, RuleArgs args)
public Rule(String name, RuleArgs args, CustomResourceOptions options)

type: aws-native:events:Rule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args RuleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args RuleArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args RuleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RuleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args RuleArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Rule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Rule resource accepts the following input properties:

Description string

The description of the rule.

EventBusName string

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

EventPattern object

The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Search the CloudFormation User Guide for AWS::Events::Rule for more information about the expected schema for this property.

Name string

The name of the rule.

RoleArn string

The Amazon Resource Name (ARN) of the role that is used for target invocation.

ScheduleExpression string

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.

State Pulumi.AwsNative.Events.RuleState

The state of the rule.

Targets List<Pulumi.AwsNative.Events.Inputs.RuleTarget>

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.

Description string

The description of the rule.

EventBusName string

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

EventPattern interface{}

The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Search the CloudFormation User Guide for AWS::Events::Rule for more information about the expected schema for this property.

Name string

The name of the rule.

RoleArn string

The Amazon Resource Name (ARN) of the role that is used for target invocation.

ScheduleExpression string

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.

State RuleStateEnum

The state of the rule.

Targets []RuleTargetArgs

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.

description String

The description of the rule.

eventBusName String

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

eventPattern Object

The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Search the CloudFormation User Guide for AWS::Events::Rule for more information about the expected schema for this property.

name String

The name of the rule.

roleArn String

The Amazon Resource Name (ARN) of the role that is used for target invocation.

scheduleExpression String

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.

state RuleState

The state of the rule.

targets List<RuleTarget>

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.

description string

The description of the rule.

eventBusName string

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

eventPattern any

The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Search the CloudFormation User Guide for AWS::Events::Rule for more information about the expected schema for this property.

name string

The name of the rule.

roleArn string

The Amazon Resource Name (ARN) of the role that is used for target invocation.

scheduleExpression string

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.

state RuleState

The state of the rule.

targets RuleTarget[]

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.

description str

The description of the rule.

event_bus_name str

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

event_pattern Any

The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Search the CloudFormation User Guide for AWS::Events::Rule for more information about the expected schema for this property.

name str

The name of the rule.

role_arn str

The Amazon Resource Name (ARN) of the role that is used for target invocation.

schedule_expression str

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.

state RuleState

The state of the rule.

targets Sequence[RuleTargetArgs]

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.

description String

The description of the rule.

eventBusName String

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

eventPattern Any

The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Search the CloudFormation User Guide for AWS::Events::Rule for more information about the expected schema for this property.

name String

The name of the rule.

roleArn String

The Amazon Resource Name (ARN) of the role that is used for target invocation.

scheduleExpression String

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.

state "DISABLED" | "ENABLED" | "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS"

The state of the rule.

targets List<Property Map>

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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Rule resource produces the following output properties:

Arn string: The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
Id string: The provider-assigned unique ID for this managed resource.

Arn string: The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
Id string: The provider-assigned unique ID for this managed resource.

arn String: The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
id String: The provider-assigned unique ID for this managed resource.

arn string: The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
id string: The provider-assigned unique ID for this managed resource.

arn str: The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
id str: The provider-assigned unique ID for this managed resource.

arn String: The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
id String: The provider-assigned unique ID for this managed resource.

Supporting Types

RuleAppSyncParameters
, RuleAppSyncParametersArgs

GraphQlOperation string

The GraphQL operation; that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service.

For more information, see Operations in the AWS AppSync User Guide .

GraphQlOperation string

The GraphQL operation; that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service.

For more information, see Operations in the AWS AppSync User Guide .

graphQlOperation String

The GraphQL operation; that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service.

For more information, see Operations in the AWS AppSync User Guide .

graphQlOperation string

The GraphQL operation; that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service.

For more information, see Operations in the AWS AppSync User Guide .

graph_ql_operation str

The GraphQL operation; that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service.

For more information, see Operations in the AWS AppSync User Guide .

graphQlOperation String

The GraphQL operation; that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service.

For more information, see Operations in the AWS AppSync User Guide .

RuleAwsVpcConfiguration
, RuleAwsVpcConfigurationArgs

Subnets List<string>: Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
AssignPublicIp string: 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 .
SecurityGroups List<string>: 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.

Subnets []string: Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
AssignPublicIp string: 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 .
SecurityGroups []string: 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.

subnets List<String>: Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
assignPublicIp String: 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 .
securityGroups List<String>: 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.

subnets string[]: Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
assignPublicIp string: 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 .
securityGroups string[]: 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.

subnets Sequence[str]: Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
assign_public_ip str: 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 .
security_groups Sequence[str]: 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.

subnets List<String>: Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
assignPublicIp String: 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 .
securityGroups List<String>: 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.

RuleBatchArrayProperties
, RuleBatchArrayPropertiesArgs

Size int: The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.

Size int: The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.

size Integer: The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.

size number: The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.

size int: The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.

size Number: The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.

RuleBatchParameters
, RuleBatchParametersArgs

JobDefinition string: 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.
JobName string: The name to use for this execution of the job, if the target is an AWS Batch job.
ArrayProperties Pulumi.AwsNative.Events.Inputs.RuleBatchArrayProperties: 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.
RetryStrategy Pulumi.AwsNative.Events.Inputs.RuleBatchRetryStrategy: 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.

JobDefinition string: 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.
JobName string: The name to use for this execution of the job, if the target is an AWS Batch job.
ArrayProperties RuleBatchArrayProperties: 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.
RetryStrategy RuleBatchRetryStrategy: 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.

jobDefinition String: 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.
jobName String: The name to use for this execution of the job, if the target is an AWS Batch job.
arrayProperties RuleBatchArrayProperties: 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.
retryStrategy RuleBatchRetryStrategy: 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.

jobDefinition string: 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.
jobName string: The name to use for this execution of the job, if the target is an AWS Batch job.
arrayProperties RuleBatchArrayProperties: 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.
retryStrategy RuleBatchRetryStrategy: 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.

job_definition str: 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.
job_name str: The name to use for this execution of the job, if the target is an AWS Batch job.
array_properties RuleBatchArrayProperties: 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.
retry_strategy RuleBatchRetryStrategy: 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.

jobDefinition String: 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.
jobName String: The name to use for this execution of the job, if the target is an AWS Batch job.
arrayProperties Property Map: 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.
retryStrategy Property Map: 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.

RuleBatchRetryStrategy
, RuleBatchRetryStrategyArgs

Attempts int: The number of times to attempt to retry, if the job fails. Valid values are 1–10.

Attempts int: The number of times to attempt to retry, if the job fails. Valid values are 1–10.

attempts Integer: The number of times to attempt to retry, if the job fails. Valid values are 1–10.

attempts number: The number of times to attempt to retry, if the job fails. Valid values are 1–10.

attempts int: The number of times to attempt to retry, if the job fails. Valid values are 1–10.

attempts Number: The number of times to attempt to retry, if the job fails. Valid values are 1–10.

RuleCapacityProviderStrategyItem
, RuleCapacityProviderStrategyItemArgs

CapacityProvider string: The short name of the capacity provider.
Base int: 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.
Weight int: 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.

CapacityProvider string: The short name of the capacity provider.
Base int: 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.
Weight int: 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.

capacityProvider String: The short name of the capacity provider.
base Integer: 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.
weight Integer: 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.

capacityProvider string: The short name of the capacity provider.
base number: 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.
weight number: 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.

capacity_provider str: The short name of the capacity provider.
base int: 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.
weight int: 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.

capacityProvider String: The short name of the capacity provider.
base Number: 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.
weight Number: 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.

RuleDeadLetterConfig
, RuleDeadLetterConfigArgs

Arn string: The ARN of the SQS queue specified as the target for the dead-letter queue.

Arn string: The ARN of the SQS queue specified as the target for the dead-letter queue.

arn String: The ARN of the SQS queue specified as the target for the dead-letter queue.

arn string: The ARN of the SQS queue specified as the target for the dead-letter queue.

arn str: The ARN of the SQS queue specified as the target for the dead-letter queue.

arn String: The ARN of the SQS queue specified as the target for the dead-letter queue.

RuleEcsParameters
, RuleEcsParametersArgs

TaskDefinitionArn string

The ARN of the task definition to use if the event target is an Amazon ECS task.

CapacityProviderStrategy List<Pulumi.AwsNative.Events.Inputs.RuleCapacityProviderStrategyItem>

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.

EnableEcsManagedTags bool

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

EnableExecuteCommand bool

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.

Group string

Specifies an ECS task group for the task. The maximum length is 255 characters.

LaunchType string

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 in the Amazon Elastic Container Service Developer Guide .

NetworkConfiguration Pulumi.AwsNative.Events.Inputs.RuleNetworkConfiguration

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.

PlacementConstraints List<Pulumi.AwsNative.Events.Inputs.RulePlacementConstraint>

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).

PlacementStrategies List<Pulumi.AwsNative.Events.Inputs.RulePlacementStrategy>

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

PlatformVersion string

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 in the Amazon Elastic Container Service Developer Guide .

PropagateTags string

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.

ReferenceId string

The reference ID to use for the task.

TagList List<Pulumi.AwsNative.Events.Inputs.RuleTag>

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 in the Amazon ECS API Reference.

TaskCount int

The number of tasks to create based on TaskDefinition . The default is 1.

TaskDefinitionArn string

The ARN of the task definition to use if the event target is an Amazon ECS task.

CapacityProviderStrategy []RuleCapacityProviderStrategyItem

The capacity provider strategy to use for the task.

EnableEcsManagedTags bool

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

EnableExecuteCommand bool

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.

Group string

Specifies an ECS task group for the task. The maximum length is 255 characters.

LaunchType string

NetworkConfiguration RuleNetworkConfiguration

If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.

PlacementConstraints []RulePlacementConstraint

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).

PlacementStrategies []RulePlacementStrategy

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

PlatformVersion string

Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0 .

PropagateTags string

ReferenceId string

The reference ID to use for the task.

TagList []RuleTag

TaskCount int

The number of tasks to create based on TaskDefinition . The default is 1.

taskDefinitionArn String

The ARN of the task definition to use if the event target is an Amazon ECS task.

capacityProviderStrategy List<RuleCapacityProviderStrategyItem>

The capacity provider strategy to use for the task.

enableEcsManagedTags Boolean

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

enableExecuteCommand Boolean

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.

group String

Specifies an ECS task group for the task. The maximum length is 255 characters.

launchType String

networkConfiguration RuleNetworkConfiguration

If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.

placementConstraints List<RulePlacementConstraint>

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).

placementStrategies List<RulePlacementStrategy>

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

platformVersion String

Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0 .

propagateTags String

referenceId String

The reference ID to use for the task.

tagList List<RuleTag>

taskCount Integer

The number of tasks to create based on TaskDefinition . The default is 1.

taskDefinitionArn string

The ARN of the task definition to use if the event target is an Amazon ECS task.

capacityProviderStrategy RuleCapacityProviderStrategyItem[]

The capacity provider strategy to use for the task.

enableEcsManagedTags boolean

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

enableExecuteCommand boolean

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.

group string

Specifies an ECS task group for the task. The maximum length is 255 characters.

launchType string

networkConfiguration RuleNetworkConfiguration

If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.

placementConstraints RulePlacementConstraint[]

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).

placementStrategies RulePlacementStrategy[]

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

platformVersion string

Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0 .

propagateTags string

referenceId string

The reference ID to use for the task.

tagList RuleTag[]

taskCount number

The number of tasks to create based on TaskDefinition . The default is 1.

task_definition_arn str

The ARN of the task definition to use if the event target is an Amazon ECS task.

capacity_provider_strategy Sequence[RuleCapacityProviderStrategyItem]

The capacity provider strategy to use for the task.

enable_ecs_managed_tags bool

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

enable_execute_command bool

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.

group str

Specifies an ECS task group for the task. The maximum length is 255 characters.

launch_type str

network_configuration RuleNetworkConfiguration

If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.

placement_constraints Sequence[RulePlacementConstraint]

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).

placement_strategies Sequence[RulePlacementStrategy]

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

platform_version str

Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0 .

propagate_tags str

reference_id str

The reference ID to use for the task.

tag_list Sequence[RuleTag]

task_count int

The number of tasks to create based on TaskDefinition . The default is 1.

taskDefinitionArn String

The ARN of the task definition to use if the event target is an Amazon ECS task.

capacityProviderStrategy List<Property Map>

The capacity provider strategy to use for the task.

enableEcsManagedTags Boolean

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

enableExecuteCommand Boolean

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.

group String

Specifies an ECS task group for the task. The maximum length is 255 characters.

launchType String

networkConfiguration Property Map

If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.

placementConstraints List<Property Map>

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).

placementStrategies List<Property Map>

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

platformVersion String

Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0 .

propagateTags String

referenceId String

The reference ID to use for the task.

tagList List<Property Map>

taskCount Number

The number of tasks to create based on TaskDefinition . The default is 1.

RuleHttpParameters
, RuleHttpParametersArgs

HeaderParameters Dictionary<string, string>: The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
PathParameterValues List<string>: The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").
QueryStringParameters Dictionary<string, string>: The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.

HeaderParameters map[string]string: The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
PathParameterValues []string: The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").
QueryStringParameters map[string]string: The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.

headerParameters Map<String,String>: The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
pathParameterValues List<String>: The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").
queryStringParameters Map<String,String>: The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.

headerParameters {[key: string]: string}: The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
pathParameterValues string[]: The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").
queryStringParameters {[key: string]: string}: The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.

header_parameters Mapping[str, str]: The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
path_parameter_values Sequence[str]: The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").
query_string_parameters Mapping[str, str]: The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.

headerParameters Map<String>: The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
pathParameterValues List<String>: The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").
queryStringParameters Map<String>: The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.

RuleInputTransformer
, RuleInputTransformerArgs

InputTemplate string

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>\""}'

}

InputPathsMap Dictionary<string, string>

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 ."

InputTemplate string

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>\""}'

}

InputPathsMap map[string]string

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 ."

inputTemplate String

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>\""}'

}

inputPathsMap Map<String,String>

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 ."

inputTemplate string

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>\""}'

}

inputPathsMap {[key: string]: string}

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 ."

input_template str

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>\""}'

}

input_paths_map Mapping[str, str]

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 ."

inputTemplate String

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>\""}'

}

inputPathsMap Map<String>

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 ."

RuleKinesisParameters
, RuleKinesisParametersArgs

PartitionKeyPath string: The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide .

PartitionKeyPath string: The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide .

partitionKeyPath String: The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide .

partitionKeyPath string: The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide .

partition_key_path str: The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide .

partitionKeyPath String: The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide .

RuleNetworkConfiguration
, RuleNetworkConfigurationArgs

AwsVpcConfiguration Pulumi.AwsNative.Events.Inputs.RuleAwsVpcConfiguration: 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 RuleAwsVpcConfiguration: 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 RuleAwsVpcConfiguration: 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 RuleAwsVpcConfiguration: 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.

aws_vpc_configuration RuleAwsVpcConfiguration: 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 Property Map: 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.

RulePlacementConstraint
, RulePlacementConstraintArgs

Expression string: 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 in the Amazon Elastic Container Service Developer Guide.
Type string: 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.

Expression string: 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 in the Amazon Elastic Container Service Developer Guide.
Type string: 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.

expression String: 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 in the Amazon Elastic Container Service Developer Guide.
type String: 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.

expression string: 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 in the Amazon Elastic Container Service Developer Guide.
type string: 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.

expression str: 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 in the Amazon Elastic Container Service Developer Guide.
type str: 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.

expression String: 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 in the Amazon Elastic Container Service Developer Guide.
type String: 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.

RulePlacementStrategy
, RulePlacementStrategyArgs

Field string: 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.
Type string: 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).

Field string: 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.
Type string: 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).

field String: 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.
type String: 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).

field string: 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.
type string: 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).

field str: 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.
type str: 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).

field String: 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.
type String: 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).

RuleRedshiftDataParameters
, RuleRedshiftDataParametersArgs

Database string: The name of the database. Required when authenticating using temporary credentials.
DbUser string: The database user name. Required when authenticating using temporary credentials.
SecretManagerArn string: The name or ARN of the secret that enables access to the database. Required when authenticating using AWS Secrets Manager.
Sql string: The SQL statement text to run.
Sqls List<string>: 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.
StatementName string: The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
WithEvent bool: Indicates whether to send an event back to EventBridge after the SQL statement runs.

Database string: The name of the database. Required when authenticating using temporary credentials.
DbUser string: The database user name. Required when authenticating using temporary credentials.
SecretManagerArn string: The name or ARN of the secret that enables access to the database. Required when authenticating using AWS Secrets Manager.
Sql string: The SQL statement text to run.
Sqls []string: 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.
StatementName string: The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
WithEvent bool: Indicates whether to send an event back to EventBridge after the SQL statement runs.

database String: The name of the database. Required when authenticating using temporary credentials.
dbUser String: The database user name. Required when authenticating using temporary credentials.
secretManagerArn String: The name or ARN of the secret that enables access to the database. Required when authenticating using AWS Secrets Manager.
sql String: The SQL statement text to run.
sqls List<String>: 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.
statementName String: The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
withEvent Boolean: Indicates whether to send an event back to EventBridge after the SQL statement runs.

database string: The name of the database. Required when authenticating using temporary credentials.
dbUser string: The database user name. Required when authenticating using temporary credentials.
secretManagerArn string: The name or ARN of the secret that enables access to the database. Required when authenticating using AWS Secrets Manager.
sql string: The SQL statement text to run.
sqls string[]: 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.
statementName string: The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
withEvent boolean: Indicates whether to send an event back to EventBridge after the SQL statement runs.

database str: The name of the database. Required when authenticating using temporary credentials.
db_user str: The database user name. Required when authenticating using temporary credentials.
secret_manager_arn str: The name or ARN of the secret that enables access to the database. Required when authenticating using AWS Secrets Manager.
sql str: The SQL statement text to run.
sqls Sequence[str]: 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.
statement_name str: The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
with_event bool: Indicates whether to send an event back to EventBridge after the SQL statement runs.

database String: The name of the database. Required when authenticating using temporary credentials.
dbUser String: The database user name. Required when authenticating using temporary credentials.
secretManagerArn String: The name or ARN of the secret that enables access to the database. Required when authenticating using AWS Secrets Manager.
sql String: The SQL statement text to run.
sqls List<String>: 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.
statementName String: The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
withEvent Boolean: Indicates whether to send an event back to EventBridge after the SQL statement runs.

RuleRetryPolicy
, RuleRetryPolicyArgs

MaximumEventAgeInSeconds int: The maximum amount of time, in seconds, to continue to make retry attempts.
MaximumRetryAttempts int: 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.

MaximumEventAgeInSeconds int: The maximum amount of time, in seconds, to continue to make retry attempts.
MaximumRetryAttempts int: 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.

maximumEventAgeInSeconds Integer: The maximum amount of time, in seconds, to continue to make retry attempts.
maximumRetryAttempts Integer: 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.

maximumEventAgeInSeconds number: The maximum amount of time, in seconds, to continue to make retry attempts.
maximumRetryAttempts number: 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.

maximum_event_age_in_seconds int: The maximum amount of time, in seconds, to continue to make retry attempts.
maximum_retry_attempts int: 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.

maximumEventAgeInSeconds Number: The maximum amount of time, in seconds, to continue to make retry attempts.
maximumRetryAttempts Number: 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.

RuleRunCommandParameters
, RuleRunCommandParametersArgs

RunCommandTargets List<Pulumi.AwsNative.Events.Inputs.RuleRunCommandTarget>: Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.

RunCommandTargets []RuleRunCommandTarget: Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.

runCommandTargets List<RuleRunCommandTarget>: Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.

runCommandTargets RuleRunCommandTarget[]: Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.

run_command_targets Sequence[RuleRunCommandTarget]: Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.

runCommandTargets List<Property Map>: Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.

RuleRunCommandTarget
, RuleRunCommandTargetArgs

Key string: Can be either tag: tag-key or InstanceIds .
Values List<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.

Key string: Can be either tag: tag-key or InstanceIds .
Values []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.

key String: Can be either tag: tag-key or InstanceIds .
values List<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.

key string: Can be either tag: tag-key or InstanceIds .
values 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.

key str: Can be either tag: tag-key or InstanceIds .
values Sequence[str]: 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.

key String: Can be either tag: tag-key or InstanceIds .
values List<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.

RuleSageMakerPipelineParameter
, RuleSageMakerPipelineParameterArgs

Name string: Name of parameter to start execution of a SageMaker AI Model Building Pipeline.
Value string: Value of parameter to start execution of a SageMaker AI Model Building Pipeline.

Name string: Name of parameter to start execution of a SageMaker AI Model Building Pipeline.
Value string: Value of parameter to start execution of a SageMaker AI Model Building Pipeline.

name String: Name of parameter to start execution of a SageMaker AI Model Building Pipeline.
value String: Value of parameter to start execution of a SageMaker AI Model Building Pipeline.

name string: Name of parameter to start execution of a SageMaker AI Model Building Pipeline.
value string: Value of parameter to start execution of a SageMaker AI Model Building Pipeline.

name str: Name of parameter to start execution of a SageMaker AI Model Building Pipeline.
value str: Value of parameter to start execution of a SageMaker AI Model Building Pipeline.

name String: Name of parameter to start execution of a SageMaker AI Model Building Pipeline.
value String: Value of parameter to start execution of a SageMaker AI Model Building Pipeline.

RuleSageMakerPipelineParameters
, RuleSageMakerPipelineParametersArgs

PipelineParameterList List<Pulumi.AwsNative.Events.Inputs.RuleSageMakerPipelineParameter>: List of Parameter names and values for SageMaker AI Model Building Pipeline execution.

PipelineParameterList []RuleSageMakerPipelineParameter: List of Parameter names and values for SageMaker AI Model Building Pipeline execution.

pipelineParameterList List<RuleSageMakerPipelineParameter>: List of Parameter names and values for SageMaker AI Model Building Pipeline execution.

pipelineParameterList RuleSageMakerPipelineParameter[]: List of Parameter names and values for SageMaker AI Model Building Pipeline execution.

pipeline_parameter_list Sequence[RuleSageMakerPipelineParameter]: List of Parameter names and values for SageMaker AI Model Building Pipeline execution.

pipelineParameterList List<Property Map>: List of Parameter names and values for SageMaker AI Model Building Pipeline execution.

RuleSqsParameters
, RuleSqsParametersArgs

MessageGroupId string: The FIFO message group ID to use as the target.

MessageGroupId string: The FIFO message group ID to use as the target.

messageGroupId String: The FIFO message group ID to use as the target.

messageGroupId string: The FIFO message group ID to use as the target.

message_group_id str: The FIFO message group ID to use as the target.

messageGroupId String: The FIFO message group ID to use as the target.

RuleState
, RuleStateArgs

Disabled: DISABLED
Enabled: ENABLED
EnabledWithAllCloudtrailManagementEvents: ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS

RuleStateDisabled: DISABLED
RuleStateEnabled: ENABLED
RuleStateEnabledWithAllCloudtrailManagementEvents: ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS

Disabled: DISABLED
Enabled: ENABLED
EnabledWithAllCloudtrailManagementEvents: ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS

Disabled: DISABLED
Enabled: ENABLED
EnabledWithAllCloudtrailManagementEvents: ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS

DISABLED: DISABLED
ENABLED: ENABLED
ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS

"DISABLED": DISABLED
"ENABLED": ENABLED
"ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS": ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS

RuleTag
, RuleTagArgs

Key string: A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
Value string: The value for the specified tag key.

Key string: A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
Value string: The value for the specified tag key.

key String: A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
value String: The value for the specified tag key.

key string: A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
value string: The value for the specified tag key.

key str: A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
value str: The value for the specified tag key.

key String: A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
value String: The value for the specified tag key.

RuleTarget
, RuleTargetArgs

Arn string

The Amazon Resource Name (ARN) of the target.

Id string

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.

AppSyncParameters Pulumi.AwsNative.Events.Inputs.RuleAppSyncParameters

Contains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API.

BatchParameters Pulumi.AwsNative.Events.Inputs.RuleBatchParameters

If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the AWS Batch User Guide .

DeadLetterConfig Pulumi.AwsNative.Events.Inputs.RuleDeadLetterConfig

The DeadLetterConfig that defines the target queue to send dead-letter queue events to.

EcsParameters Pulumi.AwsNative.Events.Inputs.RuleEcsParameters

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 in the Amazon EC2 Container Service Developer Guide .

HttpParameters Pulumi.AwsNative.Events.Inputs.RuleHttpParameters

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.

Input 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 .

InputPath string

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 .

InputTransformer Pulumi.AwsNative.Events.Inputs.RuleInputTransformer

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.

KinesisParameters Pulumi.AwsNative.Events.Inputs.RuleKinesisParameters

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.

RedshiftDataParameters Pulumi.AwsNative.Events.Inputs.RuleRedshiftDataParameters

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.

RetryPolicy Pulumi.AwsNative.Events.Inputs.RuleRetryPolicy

The retry policy configuration to use for the dead-letter queue.

RoleArn string

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.

RunCommandParameters Pulumi.AwsNative.Events.Inputs.RuleRunCommandParameters

Parameters used when you are using the rule to invoke Amazon EC2 Run Command.

SageMakerPipelineParameters Pulumi.AwsNative.Events.Inputs.RuleSageMakerPipelineParameters

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.

SqsParameters Pulumi.AwsNative.Events.Inputs.RuleSqsParameters

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.

Arn string

The Amazon Resource Name (ARN) of the target.

Id string

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.

AppSyncParameters RuleAppSyncParameters

Contains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API.

BatchParameters RuleBatchParameters

If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the AWS Batch User Guide .

DeadLetterConfig RuleDeadLetterConfig

The DeadLetterConfig that defines the target queue to send dead-letter queue events to.

EcsParameters RuleEcsParameters

HttpParameters RuleHttpParameters

Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.

Input 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 .

InputPath string

InputTransformer RuleInputTransformer

KinesisParameters RuleKinesisParameters

RedshiftDataParameters RuleRedshiftDataParameters

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.

RetryPolicy RuleRetryPolicy

The retry policy configuration to use for the dead-letter queue.

RoleArn string

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.

RunCommandParameters RuleRunCommandParameters

Parameters used when you are using the rule to invoke Amazon EC2 Run Command.

SageMakerPipelineParameters RuleSageMakerPipelineParameters

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.

SqsParameters RuleSqsParameters

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.

arn String

The Amazon Resource Name (ARN) of the target.

id String

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.

appSyncParameters RuleAppSyncParameters

Contains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API.

batchParameters RuleBatchParameters

If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the AWS Batch User Guide .

deadLetterConfig RuleDeadLetterConfig

The DeadLetterConfig that defines the target queue to send dead-letter queue events to.

ecsParameters RuleEcsParameters

httpParameters RuleHttpParameters

Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.

input 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 .

inputPath String

inputTransformer RuleInputTransformer

kinesisParameters RuleKinesisParameters

redshiftDataParameters RuleRedshiftDataParameters

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.

retryPolicy RuleRetryPolicy

The retry policy configuration to use for the dead-letter queue.

roleArn String

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.

runCommandParameters RuleRunCommandParameters

Parameters used when you are using the rule to invoke Amazon EC2 Run Command.

sageMakerPipelineParameters RuleSageMakerPipelineParameters

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.

sqsParameters RuleSqsParameters

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.

arn string

The Amazon Resource Name (ARN) of the target.

id string

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.

appSyncParameters RuleAppSyncParameters

Contains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API.

batchParameters RuleBatchParameters

If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the AWS Batch User Guide .

deadLetterConfig RuleDeadLetterConfig

The DeadLetterConfig that defines the target queue to send dead-letter queue events to.

ecsParameters RuleEcsParameters

httpParameters RuleHttpParameters

Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.

input 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 .

inputPath string

inputTransformer RuleInputTransformer

kinesisParameters RuleKinesisParameters

redshiftDataParameters RuleRedshiftDataParameters

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.

retryPolicy RuleRetryPolicy

The retry policy configuration to use for the dead-letter queue.

roleArn string

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.

runCommandParameters RuleRunCommandParameters

Parameters used when you are using the rule to invoke Amazon EC2 Run Command.

sageMakerPipelineParameters RuleSageMakerPipelineParameters

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.

sqsParameters RuleSqsParameters

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.

arn str

The Amazon Resource Name (ARN) of the target.

id str

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.

app_sync_parameters RuleAppSyncParameters

Contains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API.

batch_parameters RuleBatchParameters

If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the AWS Batch User Guide .

dead_letter_config RuleDeadLetterConfig

The DeadLetterConfig that defines the target queue to send dead-letter queue events to.

ecs_parameters RuleEcsParameters

http_parameters RuleHttpParameters

Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.

input str

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 .

input_path str

input_transformer RuleInputTransformer

kinesis_parameters RuleKinesisParameters

redshift_data_parameters RuleRedshiftDataParameters

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.

retry_policy RuleRetryPolicy

The retry policy configuration to use for the dead-letter queue.

role_arn str

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.

run_command_parameters RuleRunCommandParameters

Parameters used when you are using the rule to invoke Amazon EC2 Run Command.

sage_maker_pipeline_parameters RuleSageMakerPipelineParameters

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.

sqs_parameters RuleSqsParameters

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.

arn String

The Amazon Resource Name (ARN) of the target.

id String

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.

appSyncParameters Property Map

Contains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API.

batchParameters Property Map

If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the AWS Batch User Guide .

deadLetterConfig Property Map

The DeadLetterConfig that defines the target queue to send dead-letter queue events to.

ecsParameters Property Map

httpParameters Property Map

Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.

input 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 .

inputPath String

inputTransformer Property Map

kinesisParameters Property Map

redshiftDataParameters Property Map

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.

retryPolicy Property Map

The retry policy configuration to use for the dead-letter queue.

roleArn String

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.

runCommandParameters Property Map

Parameters used when you are using the rule to invoke Amazon EC2 Run Command.

sageMakerPipelineParameters Property Map

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.

sqsParameters Property Map

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.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.events.Rule

On this page

On this page

Example Usage

Example

Create Rule Resource

Constructor syntax

Parameters

Rule Resource Properties

Inputs

Outputs

Supporting Types

RuleAppSyncParameters
, RuleAppSyncParametersArgs

RuleAwsVpcConfiguration
, RuleAwsVpcConfigurationArgs

RuleBatchArrayProperties
, RuleBatchArrayPropertiesArgs

RuleBatchParameters
, RuleBatchParametersArgs

RuleBatchRetryStrategy
, RuleBatchRetryStrategyArgs

RuleCapacityProviderStrategyItem
, RuleCapacityProviderStrategyItemArgs

RuleDeadLetterConfig
, RuleDeadLetterConfigArgs

RuleEcsParameters
, RuleEcsParametersArgs

RuleHttpParameters
, RuleHttpParametersArgs

RuleInputTransformer
, RuleInputTransformerArgs

RuleKinesisParameters
, RuleKinesisParametersArgs

RuleNetworkConfiguration
, RuleNetworkConfigurationArgs

RulePlacementConstraint
, RulePlacementConstraintArgs

RulePlacementStrategy
, RulePlacementStrategyArgs

RuleRedshiftDataParameters
, RuleRedshiftDataParametersArgs

RuleRetryPolicy
, RuleRetryPolicyArgs

RuleRunCommandParameters
, RuleRunCommandParametersArgs

RuleRunCommandTarget
, RuleRunCommandTargetArgs

RuleSageMakerPipelineParameter
, RuleSageMakerPipelineParameterArgs

RuleSageMakerPipelineParameters
, RuleSageMakerPipelineParametersArgs

RuleSqsParameters
, RuleSqsParametersArgs

RuleState
, RuleStateArgs

RuleTag
, RuleTagArgs

RuleTarget
, RuleTargetArgs

Package Details

On this page

On this page

aws-native.events.Rule

On this page

On this page

Example Usage

Example

Create Rule Resource

Constructor syntax

Parameters

Rule Resource Properties

Inputs

Outputs

Supporting Types

RuleAppSyncParameters, RuleAppSyncParametersArgs

RuleAwsVpcConfiguration, RuleAwsVpcConfigurationArgs

RuleBatchArrayProperties, RuleBatchArrayPropertiesArgs

RuleBatchParameters, RuleBatchParametersArgs

RuleBatchRetryStrategy, RuleBatchRetryStrategyArgs

RuleCapacityProviderStrategyItem, RuleCapacityProviderStrategyItemArgs

RuleDeadLetterConfig, RuleDeadLetterConfigArgs

RuleEcsParameters, RuleEcsParametersArgs

RuleHttpParameters, RuleHttpParametersArgs

RuleInputTransformer, RuleInputTransformerArgs

RuleKinesisParameters, RuleKinesisParametersArgs

RuleNetworkConfiguration, RuleNetworkConfigurationArgs

RulePlacementConstraint, RulePlacementConstraintArgs

RulePlacementStrategy, RulePlacementStrategyArgs

RuleRedshiftDataParameters, RuleRedshiftDataParametersArgs

RuleRetryPolicy, RuleRetryPolicyArgs

RuleRunCommandParameters, RuleRunCommandParametersArgs

RuleRunCommandTarget, RuleRunCommandTargetArgs

RuleSageMakerPipelineParameter, RuleSageMakerPipelineParameterArgs

RuleSageMakerPipelineParameters, RuleSageMakerPipelineParametersArgs

RuleSqsParameters, RuleSqsParametersArgs

RuleState, RuleStateArgs

RuleTag, RuleTagArgs

RuleTarget, RuleTargetArgs

Package Details

On this page

On this page

RuleAppSyncParameters
, RuleAppSyncParametersArgs

RuleAwsVpcConfiguration
, RuleAwsVpcConfigurationArgs

RuleBatchArrayProperties
, RuleBatchArrayPropertiesArgs

RuleBatchParameters
, RuleBatchParametersArgs

RuleBatchRetryStrategy
, RuleBatchRetryStrategyArgs

RuleCapacityProviderStrategyItem
, RuleCapacityProviderStrategyItemArgs

RuleDeadLetterConfig
, RuleDeadLetterConfigArgs

RuleEcsParameters
, RuleEcsParametersArgs

RuleHttpParameters
, RuleHttpParametersArgs

RuleInputTransformer
, RuleInputTransformerArgs

RuleKinesisParameters
, RuleKinesisParametersArgs

RuleNetworkConfiguration
, RuleNetworkConfigurationArgs

RulePlacementConstraint
, RulePlacementConstraintArgs

RulePlacementStrategy
, RulePlacementStrategyArgs

RuleRedshiftDataParameters
, RuleRedshiftDataParametersArgs

RuleRetryPolicy
, RuleRetryPolicyArgs

RuleRunCommandParameters
, RuleRunCommandParametersArgs

RuleRunCommandTarget
, RuleRunCommandTargetArgs

RuleSageMakerPipelineParameter
, RuleSageMakerPipelineParameterArgs

RuleSageMakerPipelineParameters
, RuleSageMakerPipelineParametersArgs

RuleSqsParameters
, RuleSqsParametersArgs

RuleState
, RuleStateArgs

RuleTag
, RuleTagArgs

RuleTarget
, RuleTargetArgs