We recommend new projects start with resources from the AWS provider.
aws-native.events.Rule
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::Events::Rule
Example Usage
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 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,
}])
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,
}],
});
Coming soon!
Create Rule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
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)
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.
- Event
Bus stringName - The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
- Event
Pattern 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.
- Role
Arn string - The Amazon Resource Name (ARN) of the role that is used for target invocation.
- Schedule
Expression 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.
Aws Native. Events. Rule State - The state of the rule.
- Targets
List<Pulumi.
Aws Native. Events. Inputs. Rule Target> - 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.
- Event
Bus stringName - The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
- Event
Pattern 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.
- Role
Arn string - The Amazon Resource Name (ARN) of the role that is used for target invocation.
- Schedule
Expression 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
Rule
State Enum - The state of the rule.
- Targets
[]Rule
Target Args - 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.
- event
Bus StringName - The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
- event
Pattern 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.
- role
Arn String - The Amazon Resource Name (ARN) of the role that is used for target invocation.
- schedule
Expression 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
Rule
State - The state of the rule.
- targets
List<Rule
Target> - 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.
- event
Bus stringName - 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 string
- The name of the rule.
- role
Arn string - The Amazon Resource Name (ARN) of the role that is used for target invocation.
- schedule
Expression 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
Rule
State - The state of the rule.
- targets
Rule
Target[] - 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_ strname - 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
Rule
State - The state of the rule.
- targets
Sequence[Rule
Target Args] - 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.
- event
Bus StringName - 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 String
- The name of the rule.
- role
Arn String - The Amazon Resource Name (ARN) of the role that is used for target invocation.
- schedule
Expression 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:
Supporting Types
RuleAppSyncParameters, RuleAppSyncParametersArgs
- Graph
Ql stringOperation 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 stringOperation 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 StringOperation 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 stringOperation 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_ stroperation 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 StringOperation 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.
- Assign
Public stringIp - Specifies whether the task's elastic network interface receives a public IP address. You can specify
ENABLED
only whenLaunchType
inEcsParameters
is set toFARGATE
. - Security
Groups 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.
- Assign
Public stringIp - Specifies whether the task's elastic network interface receives a public IP address. You can specify
ENABLED
only whenLaunchType
inEcsParameters
is set toFARGATE
. - Security
Groups []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.
- assign
Public StringIp - Specifies whether the task's elastic network interface receives a public IP address. You can specify
ENABLED
only whenLaunchType
inEcsParameters
is set toFARGATE
. - security
Groups 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.
- assign
Public stringIp - Specifies whether the task's elastic network interface receives a public IP address. You can specify
ENABLED
only whenLaunchType
inEcsParameters
is set toFARGATE
. - security
Groups 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_ strip - Specifies whether the task's elastic network interface receives a public IP address. You can specify
ENABLED
only whenLaunchType
inEcsParameters
is set toFARGATE
. - 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.
- assign
Public StringIp - Specifies whether the task's elastic network interface receives a public IP address. You can specify
ENABLED
only whenLaunchType
inEcsParameters
is set toFARGATE
. - security
Groups 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
- Job
Definition 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.
- Job
Name string - The name to use for this execution of the job, if the target is an AWS Batch job.
- Array
Properties Pulumi.Aws Native. Events. Inputs. Rule Batch Array Properties - 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 Pulumi.Aws Native. Events. Inputs. Rule Batch Retry Strategy - 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 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.
- Job
Name string - The name to use for this execution of the job, if the target is an AWS Batch job.
- Array
Properties RuleBatch Array Properties - 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 RuleBatch Retry Strategy - 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 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.
- job
Name String - The name to use for this execution of the job, if the target is an AWS Batch job.
- array
Properties RuleBatch Array Properties - 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 RuleBatch Retry Strategy - 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 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.
- job
Name string - The name to use for this execution of the job, if the target is an AWS Batch job.
- array
Properties RuleBatch Array Properties - 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 RuleBatch Retry Strategy - 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 RuleBatch Array Properties - 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 RuleBatch Retry Strategy - 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 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.
- job
Name String - The name to use for this execution of the job, if the target is an AWS Batch job.
- array
Properties 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.
- retry
Strategy 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
- Capacity
Provider 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.
- Capacity
Provider 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.
- capacity
Provider 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.
- capacity
Provider 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.
- capacity
Provider 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
- Task
Definition stringArn - The ARN of the task definition to use if the event target is an Amazon ECS task.
- Capacity
Provider List<Pulumi.Strategy Aws Native. Events. Inputs. Rule Capacity Provider Strategy Item> The capacity provider strategy to use for the task.
If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
or launchType is specified, thedefaultCapacityProviderStrategy
for the cluster is used.- 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 boolCommand - 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.
- Launch
Type 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 . - Network
Configuration Pulumi.Aws Native. Events. Inputs. Rule Network Configuration 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 ifLaunchType
isFARGATE
because theawsvpc
mode is required for Fargate tasks.If you specify
NetworkConfiguration
when the target ECS task does not use theawsvpc
network mode, the task fails.- Placement
Constraints List<Pulumi.Aws Native. Events. Inputs. Rule Placement Constraint> - 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 List<Pulumi.Aws Native. Events. Inputs. Rule Placement Strategy> - The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
- Platform
Version 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
isFARGATE
. For more information about valid platform versions, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .- 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.
- Reference
Id string - The reference ID to use for the task.
- Tag
List List<Pulumi.Aws Native. Events. Inputs. Rule Tag> - 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.
- Task
Count int - The number of tasks to create based on
TaskDefinition
. The default is 1.
- Task
Definition stringArn - The ARN of the task definition to use if the event target is an Amazon ECS task.
- Capacity
Provider []RuleStrategy Capacity Provider Strategy Item The capacity provider strategy to use for the task.
If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
or launchType is specified, thedefaultCapacityProviderStrategy
for the cluster is used.- 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 boolCommand - 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.
- Launch
Type 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 . - Network
Configuration RuleNetwork Configuration 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 ifLaunchType
isFARGATE
because theawsvpc
mode is required for Fargate tasks.If you specify
NetworkConfiguration
when the target ECS task does not use theawsvpc
network mode, the task fails.- Placement
Constraints []RulePlacement Constraint - 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 []RulePlacement Strategy - The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
- Platform
Version 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
isFARGATE
. For more information about valid platform versions, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .- 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.
- Reference
Id string - The reference ID to use for the task.
- Tag
List []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.
- Task
Count int - The number of tasks to create based on
TaskDefinition
. The default is 1.
- task
Definition StringArn - The ARN of the task definition to use if the event target is an Amazon ECS task.
- capacity
Provider List<RuleStrategy Capacity Provider Strategy Item> The capacity provider strategy to use for the task.
If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
or launchType is specified, thedefaultCapacityProviderStrategy
for the cluster is used.- 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.
- enable
Execute BooleanCommand - 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.
- launch
Type 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 . - network
Configuration RuleNetwork Configuration 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 ifLaunchType
isFARGATE
because theawsvpc
mode is required for Fargate tasks.If you specify
NetworkConfiguration
when the target ECS task does not use theawsvpc
network mode, the task fails.- placement
Constraints List<RulePlacement Constraint> - 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 List<RulePlacement Strategy> - The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
- platform
Version 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
isFARGATE
. For more information about valid platform versions, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .- 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.
- reference
Id String - The reference ID to use for the task.
- tag
List List<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.
- task
Count Integer - The number of tasks to create based on
TaskDefinition
. The default is 1.
- task
Definition stringArn - The ARN of the task definition to use if the event target is an Amazon ECS task.
- capacity
Provider RuleStrategy Capacity Provider Strategy Item[] The capacity provider strategy to use for the task.
If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
or launchType is specified, thedefaultCapacityProviderStrategy
for the cluster is used.- 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.
- enable
Execute booleanCommand - 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.
- launch
Type 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 . - network
Configuration RuleNetwork Configuration 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 ifLaunchType
isFARGATE
because theawsvpc
mode is required for Fargate tasks.If you specify
NetworkConfiguration
when the target ECS task does not use theawsvpc
network mode, the task fails.- placement
Constraints RulePlacement Constraint[] - 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 RulePlacement Strategy[] - The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
- platform
Version 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
isFARGATE
. For more information about valid platform versions, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .- 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.
- reference
Id string - The reference ID to use for the task.
- tag
List 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.
- task
Count number - The number of tasks to create based on
TaskDefinition
. The default is 1.
- task_
definition_ strarn - The ARN of the task definition to use if the event target is an Amazon ECS task.
- capacity_
provider_ Sequence[Rulestrategy Capacity Provider Strategy Item] The capacity provider strategy to use for the task.
If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
or launchType is specified, thedefaultCapacityProviderStrategy
for the cluster is used.- 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_ boolcommand - 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 - 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 . - network_
configuration RuleNetwork Configuration 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 ifLaunchType
isFARGATE
because theawsvpc
mode is required for Fargate tasks.If you specify
NetworkConfiguration
when the target ECS task does not use theawsvpc
network mode, the task fails.- placement_
constraints Sequence[RulePlacement Constraint] - 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[RulePlacement Strategy] - 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
.This structure is used only if
LaunchType
isFARGATE
. For more information about valid platform versions, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .- str
- 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.
- reference_
id str - The reference ID to use for the task.
- tag_
list Sequence[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.
- task_
count int - The number of tasks to create based on
TaskDefinition
. The default is 1.
- task
Definition StringArn - The ARN of the task definition to use if the event target is an Amazon ECS task.
- capacity
Provider List<Property Map>Strategy The capacity provider strategy to use for the task.
If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
or launchType is specified, thedefaultCapacityProviderStrategy
for the cluster is used.- 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.
- enable
Execute BooleanCommand - 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.
- launch
Type 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 . - network
Configuration Property Map 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 ifLaunchType
isFARGATE
because theawsvpc
mode is required for Fargate tasks.If you specify
NetworkConfiguration
when the target ECS task does not use theawsvpc
network mode, the task fails.- placement
Constraints 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).
- placement
Strategies List<Property Map> - The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
- platform
Version 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
isFARGATE
. For more information about valid platform versions, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .- 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.
- reference
Id String - The reference ID to use for the task.
- tag
List List<Property Map> - 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.
- task
Count Number - The number of tasks to create based on
TaskDefinition
. The default is 1.
RuleHttpParameters, RuleHttpParametersArgs
- Header
Parameters Dictionary<string, string> - The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
- Path
Parameter List<string>Values - The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").
- Query
String Dictionary<string, string>Parameters - The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
- Header
Parameters map[string]string - The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
- Path
Parameter []stringValues - The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").
- Query
String map[string]stringParameters - The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
- header
Parameters Map<String,String> - The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
- path
Parameter List<String>Values - The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").
- query
String Map<String,String>Parameters - The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
- header
Parameters {[key: string]: string} - The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
- path
Parameter string[]Values - The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").
- query
String {[key: string]: string}Parameters - 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_ Sequence[str]values - The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").
- query_
string_ Mapping[str, str]parameters - The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
- header
Parameters Map<String> - The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
- path
Parameter List<String>Values - The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").
- query
String Map<String>Parameters - The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
RuleInputTransformer, RuleInputTransformerArgs
- Input
Template 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 eachInputPathsMaps
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
andInputTemplate
."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 Dictionary<string, string>Map 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 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 eachInputPathsMaps
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
andInputTemplate
."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[string]stringMap 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 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 eachInputPathsMaps
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
andInputTemplate
."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<String,String>Map 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 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 eachInputPathsMaps
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
andInputTemplate
."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 {[key: string]: string}Map 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 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 eachInputPathsMaps
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
andInputTemplate
."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_ Mapping[str, str]map 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 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 eachInputPathsMaps
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
andInputTemplate
."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<String>Map 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
- Partition
Key stringPath - 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 stringPath - 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 StringPath - 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 stringPath - 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_ strpath - 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 StringPath - 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
- Aws
Vpc Pulumi.Configuration Aws Native. Events. Inputs. Rule Aws Vpc Configuration - 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 RuleConfiguration Aws Vpc Configuration - 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 RuleConfiguration Aws Vpc Configuration - 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 RuleConfiguration Aws Vpc Configuration - 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_ Ruleconfiguration Aws Vpc Configuration - 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 Property MapConfiguration - 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.
- Db
User string - The database user name. Required when authenticating using temporary credentials.
- Secret
Manager stringArn - 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.
- Statement
Name string - 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.
- Db
User string - The database user name. Required when authenticating using temporary credentials.
- Secret
Manager stringArn - 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.
- Statement
Name string - 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.
- db
User String - The database user name. Required when authenticating using temporary credentials.
- secret
Manager StringArn - 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.
- statement
Name String - The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
- with
Event 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.
- db
User string - The database user name. Required when authenticating using temporary credentials.
- secret
Manager stringArn - 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.
- statement
Name string - The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
- with
Event 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_ strarn - 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.
- db
User String - The database user name. Required when authenticating using temporary credentials.
- secret
Manager StringArn - 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.
- statement
Name String - The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
- with
Event Boolean - Indicates whether to send an event back to EventBridge after the SQL statement runs.
RuleRetryPolicy, RuleRetryPolicyArgs
- Maximum
Event intAge In Seconds - The maximum amount of time, in seconds, to continue to make retry attempts.
- Maximum
Retry intAttempts - 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 intAge In Seconds - The maximum amount of time, in seconds, to continue to make retry attempts.
- Maximum
Retry intAttempts - 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 IntegerAge In Seconds - The maximum amount of time, in seconds, to continue to make retry attempts.
- maximum
Retry IntegerAttempts - 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 numberAge In Seconds - The maximum amount of time, in seconds, to continue to make retry attempts.
- maximum
Retry numberAttempts - 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_ intage_ in_ seconds - The maximum amount of time, in seconds, to continue to make retry attempts.
- maximum_
retry_ intattempts - 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 NumberAge In Seconds - The maximum amount of time, in seconds, to continue to make retry attempts.
- maximum
Retry NumberAttempts - 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
- Run
Command List<Pulumi.Targets Aws Native. Events. Inputs. Rule Run Command Target> - Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.
- Run
Command []RuleTargets Run Command Target - Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.
- run
Command List<RuleTargets Run Command Target> - Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.
- run
Command RuleTargets Run Command Target[] - Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.
- run_
command_ Sequence[Ruletargets Run Command Target] - Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.
- run
Command List<Property Map>Targets - Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.
RuleRunCommandTarget, RuleRunCommandTargetArgs
RuleSageMakerPipelineParameter, RuleSageMakerPipelineParameterArgs
RuleSageMakerPipelineParameters, RuleSageMakerPipelineParametersArgs
- Pipeline
Parameter List<Pulumi.List Aws Native. Events. Inputs. Rule Sage Maker Pipeline Parameter> - List of Parameter names and values for SageMaker Model Building Pipeline execution.
- Pipeline
Parameter []RuleList Sage Maker Pipeline Parameter - List of Parameter names and values for SageMaker Model Building Pipeline execution.
- pipeline
Parameter List<RuleList Sage Maker Pipeline Parameter> - List of Parameter names and values for SageMaker Model Building Pipeline execution.
- pipeline
Parameter RuleList Sage Maker Pipeline Parameter[] - List of Parameter names and values for SageMaker Model Building Pipeline execution.
- pipeline_
parameter_ Sequence[Rulelist Sage Maker Pipeline Parameter] - List of Parameter names and values for SageMaker Model Building Pipeline execution.
- pipeline
Parameter List<Property Map>List - List of Parameter names and values for SageMaker Model Building Pipeline execution.
RuleSqsParameters, RuleSqsParametersArgs
- Message
Group stringId - The FIFO message group ID to use as the target.
- Message
Group stringId - The FIFO message group ID to use as the target.
- message
Group StringId - The FIFO message group ID to use as the target.
- message
Group stringId - The FIFO message group ID to use as the target.
- message_
group_ strid - The FIFO message group ID to use as the target.
- message
Group StringId - The FIFO message group ID to use as the target.
RuleState, RuleStateArgs
- Disabled
- DISABLED
- Enabled
- ENABLED
- Enabled
With All Cloudtrail Management Events - ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS
- Rule
State Disabled - DISABLED
- Rule
State Enabled - ENABLED
- Rule
State 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
- 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
- "DISABLED"
- DISABLED
- "ENABLED"
- ENABLED
- "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS"
- ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS
RuleTag, RuleTagArgs
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.
- App
Sync Pulumi.Parameters Aws Native. Events. Inputs. Rule App Sync Parameters - Contains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API.
- Batch
Parameters Pulumi.Aws Native. Events. Inputs. Rule Batch Parameters - 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 Pulumi.Config Aws Native. Events. Inputs. Rule Dead Letter Config - The
DeadLetterConfig
that defines the target queue to send dead-letter queue events to. - Ecs
Parameters Pulumi.Aws Native. Events. Inputs. Rule Ecs Parameters - 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 .
- Http
Parameters Pulumi.Aws Native. Events. Inputs. Rule Http Parameters 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 .
- Input
Path 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 .
- Input
Transformer Pulumi.Aws Native. Events. Inputs. Rule Input Transformer - 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.
- Kinesis
Parameters Pulumi.Aws Native. Events. Inputs. Rule Kinesis Parameters - 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. - Redshift
Data Pulumi.Parameters Aws Native. Events. Inputs. Rule Redshift Data Parameters 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 Pulumi.Aws Native. Events. Inputs. Rule Retry Policy - The retry policy configuration to use for the dead-letter queue.
- Role
Arn 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.
- Run
Command Pulumi.Parameters Aws Native. Events. Inputs. Rule Run Command Parameters - Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
- Sage
Maker Pulumi.Pipeline Parameters Aws Native. Events. Inputs. Rule Sage Maker Pipeline Parameters Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.
If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.
- Sqs
Parameters Pulumi.Aws Native. Events. Inputs. Rule Sqs Parameters 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.
- App
Sync RuleParameters App Sync Parameters - Contains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API.
- Batch
Parameters RuleBatch Parameters - 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 RuleConfig Dead Letter Config - The
DeadLetterConfig
that defines the target queue to send dead-letter queue events to. - Ecs
Parameters RuleEcs Parameters - 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 .
- Http
Parameters RuleHttp Parameters 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 .
- Input
Path 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 .
- Input
Transformer RuleInput Transformer - 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.
- Kinesis
Parameters RuleKinesis Parameters - 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. - Redshift
Data RuleParameters Redshift Data Parameters 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 RuleRetry Policy - The retry policy configuration to use for the dead-letter queue.
- Role
Arn 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.
- Run
Command RuleParameters Run Command Parameters - Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
- Sage
Maker RulePipeline Parameters Sage Maker Pipeline Parameters Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.
If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.
- Sqs
Parameters RuleSqs Parameters 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.
- app
Sync RuleParameters App Sync Parameters - Contains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API.
- batch
Parameters RuleBatch Parameters - 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 RuleConfig Dead Letter Config - The
DeadLetterConfig
that defines the target queue to send dead-letter queue events to. - ecs
Parameters RuleEcs Parameters - 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 .
- http
Parameters RuleHttp Parameters 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 .
- input
Path 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 .
- input
Transformer RuleInput Transformer - 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.
- kinesis
Parameters RuleKinesis Parameters - 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. - redshift
Data RuleParameters Redshift Data Parameters 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 RuleRetry Policy - The retry policy configuration to use for the dead-letter queue.
- role
Arn 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.
- run
Command RuleParameters Run Command Parameters - Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
- sage
Maker RulePipeline Parameters Sage Maker Pipeline Parameters Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.
If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.
- sqs
Parameters RuleSqs Parameters 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.
- app
Sync RuleParameters App Sync Parameters - Contains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API.
- batch
Parameters RuleBatch Parameters - 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 RuleConfig Dead Letter Config - The
DeadLetterConfig
that defines the target queue to send dead-letter queue events to. - ecs
Parameters RuleEcs Parameters - 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 .
- http
Parameters RuleHttp Parameters 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 .
- input
Path 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 .
- input
Transformer RuleInput Transformer - 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.
- kinesis
Parameters RuleKinesis Parameters - 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. - redshift
Data RuleParameters Redshift Data Parameters 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 RuleRetry Policy - The retry policy configuration to use for the dead-letter queue.
- role
Arn 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.
- run
Command RuleParameters Run Command Parameters - Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
- sage
Maker RulePipeline Parameters Sage Maker Pipeline Parameters Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.
If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.
- sqs
Parameters RuleSqs Parameters 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_ Ruleparameters App Sync Parameters - Contains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API.
- batch_
parameters RuleBatch Parameters - 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_ Ruleconfig Dead Letter Config - The
DeadLetterConfig
that defines the target queue to send dead-letter queue events to. - ecs_
parameters RuleEcs Parameters - 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 .
- http_
parameters RuleHttp Parameters 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 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 - 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 .
- input_
transformer RuleInput Transformer - 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.
- kinesis_
parameters RuleKinesis Parameters - 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. - redshift_
data_ Ruleparameters Redshift Data Parameters 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 RuleRetry Policy - 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_ Ruleparameters Run Command Parameters - Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
- sage_
maker_ Rulepipeline_ parameters Sage Maker Pipeline Parameters Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.
If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.
- sqs_
parameters RuleSqs Parameters 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.
- app
Sync Property MapParameters - Contains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API.
- batch
Parameters 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 .
- dead
Letter Property MapConfig - The
DeadLetterConfig
that defines the target queue to send dead-letter queue events to. - ecs
Parameters Property Map - 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 .
- http
Parameters Property Map 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 .
- input
Path 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 .
- input
Transformer Property Map - 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.
- kinesis
Parameters Property Map - 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. - redshift
Data Property MapParameters 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 Property Map - The retry policy configuration to use for the dead-letter queue.
- role
Arn 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.
- run
Command Property MapParameters - Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
- sage
Maker Property MapPipeline Parameters Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.
If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.
- sqs
Parameters 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.