Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. eventbridge
  5. Rule
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.eventbridge.Rule

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

    Provides a Event Bridge Rule resource.

    For information about Event Bridge Rule and how to use it, see What is Rule.

    NOTE: Available since v1.129.0.

    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: RuleArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Rule(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         event_bus_name: Optional[str] = None,
         filter_pattern: Optional[str] = None,
         rule_name: Optional[str] = None,
         targets: Optional[Sequence[RuleTargetArgs]] = None,
         description: Optional[str] = None,
         status: Optional[str] = None)
    func NewRule(ctx *Context, name string, args RuleArgs, opts ...ResourceOption) (*Rule, error)
    public Rule(string name, RuleArgs args, CustomResourceOptions? opts = null)
    public Rule(String name, RuleArgs args)
public Rule(String name, RuleArgs args, CustomResourceOptions options)

    type: alicloud:eventbridge: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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleruleResourceResourceFromEventbridgerule = new AliCloud.EventBridge.Rule("exampleruleResourceResourceFromEventbridgerule", new()
{
    EventBusName = "string",
    FilterPattern = "string",
    RuleName = "string",
    Targets = new[]
    {
        new AliCloud.EventBridge.Inputs.RuleTargetArgs
        {
            Endpoint = "string",
            ParamLists = new[]
            {
                new AliCloud.EventBridge.Inputs.RuleTargetParamListArgs
                {
                    Form = "string",
                    ResourceKey = "string",
                    Template = "string",
                    Value = "string",
                },
            },
            TargetId = "string",
            Type = "string",
            DeadLetterQueue = new AliCloud.EventBridge.Inputs.RuleTargetDeadLetterQueueArgs
            {
                Arn = "string",
            },
            PushRetryStrategy = "string",
        },
    },
    Description = "string",
    Status = "string",
});

    example, err := eventbridge.NewRule(ctx, "exampleruleResourceResourceFromEventbridgerule", &eventbridge.RuleArgs{
	EventBusName:  pulumi.String("string"),
	FilterPattern: pulumi.String("string"),
	RuleName:      pulumi.String("string"),
	Targets: eventbridge.RuleTargetArray{
		&eventbridge.RuleTargetArgs{
			Endpoint: pulumi.String("string"),
			ParamLists: eventbridge.RuleTargetParamListArray{
				&eventbridge.RuleTargetParamListArgs{
					Form:        pulumi.String("string"),
					ResourceKey: pulumi.String("string"),
					Template:    pulumi.String("string"),
					Value:       pulumi.String("string"),
				},
			},
			TargetId: pulumi.String("string"),
			Type:     pulumi.String("string"),
			DeadLetterQueue: &eventbridge.RuleTargetDeadLetterQueueArgs{
				Arn: pulumi.String("string"),
			},
			PushRetryStrategy: pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	Status:      pulumi.String("string"),
})

    var exampleruleResourceResourceFromEventbridgerule = new Rule("exampleruleResourceResourceFromEventbridgerule", RuleArgs.builder()
    .eventBusName("string")
    .filterPattern("string")
    .ruleName("string")
    .targets(RuleTargetArgs.builder()
        .endpoint("string")
        .paramLists(RuleTargetParamListArgs.builder()
            .form("string")
            .resourceKey("string")
            .template("string")
            .value("string")
            .build())
        .targetId("string")
        .type("string")
        .deadLetterQueue(RuleTargetDeadLetterQueueArgs.builder()
            .arn("string")
            .build())
        .pushRetryStrategy("string")
        .build())
    .description("string")
    .status("string")
    .build());

    examplerule_resource_resource_from_eventbridgerule = alicloud.eventbridge.Rule("exampleruleResourceResourceFromEventbridgerule",
    event_bus_name="string",
    filter_pattern="string",
    rule_name="string",
    targets=[{
        "endpoint": "string",
        "param_lists": [{
            "form": "string",
            "resource_key": "string",
            "template": "string",
            "value": "string",
        }],
        "target_id": "string",
        "type": "string",
        "dead_letter_queue": {
            "arn": "string",
        },
        "push_retry_strategy": "string",
    }],
    description="string",
    status="string")

    const exampleruleResourceResourceFromEventbridgerule = new alicloud.eventbridge.Rule("exampleruleResourceResourceFromEventbridgerule", {
    eventBusName: "string",
    filterPattern: "string",
    ruleName: "string",
    targets: [{
        endpoint: "string",
        paramLists: [{
            form: "string",
            resourceKey: "string",
            template: "string",
            value: "string",
        }],
        targetId: "string",
        type: "string",
        deadLetterQueue: {
            arn: "string",
        },
        pushRetryStrategy: "string",
    }],
    description: "string",
    status: "string",
});

    type: alicloud:eventbridge:Rule
properties:
    description: string
    eventBusName: string
    filterPattern: string
    ruleName: string
    status: string
    targets:
        - deadLetterQueue:
            arn: string
          endpoint: string
          paramLists:
            - form: string
              resourceKey: string
              template: string
              value: string
          pushRetryStrategy: string
          targetId: string
          type: string

    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:

    EventBusName string
    The name of the event bus.
    FilterPattern string
    The pattern to match interested events. Event mode, JSON format. The value description is as follows: stringEqual mode. stringExpression mode. Each field has up to 5 expressions (map structure).
    RuleName string
    The name of the event rule.
    Targets List<Pulumi.AliCloud.EventBridge.Inputs.RuleTarget>
    The targets of rule. See targets below.
    Description string
    The description of the event rule.
    Status string
    The status of the event rule. Valid values: ENABLE, DISABLE.
    EventBusName string
    The name of the event bus.
    FilterPattern string
    The pattern to match interested events. Event mode, JSON format. The value description is as follows: stringEqual mode. stringExpression mode. Each field has up to 5 expressions (map structure).
    RuleName string
    The name of the event rule.
    Targets []RuleTargetArgs
    The targets of rule. See targets below.
    Description string
    The description of the event rule.
    Status string
    The status of the event rule. Valid values: ENABLE, DISABLE.
    eventBusName String
    The name of the event bus.
    filterPattern String
    The pattern to match interested events. Event mode, JSON format. The value description is as follows: stringEqual mode. stringExpression mode. Each field has up to 5 expressions (map structure).
    ruleName String
    The name of the event rule.
    targets List<RuleTarget>
    The targets of rule. See targets below.
    description String
    The description of the event rule.
    status String
    The status of the event rule. Valid values: ENABLE, DISABLE.
    eventBusName string
    The name of the event bus.
    filterPattern string
    The pattern to match interested events. Event mode, JSON format. The value description is as follows: stringEqual mode. stringExpression mode. Each field has up to 5 expressions (map structure).
    ruleName string
    The name of the event rule.
    targets RuleTarget[]
    The targets of rule. See targets below.
    description string
    The description of the event rule.
    status string
    The status of the event rule. Valid values: ENABLE, DISABLE.
    event_bus_name str
    The name of the event bus.
    filter_pattern str
    The pattern to match interested events. Event mode, JSON format. The value description is as follows: stringEqual mode. stringExpression mode. Each field has up to 5 expressions (map structure).
    rule_name str
    The name of the event rule.
    targets Sequence[RuleTargetArgs]
    The targets of rule. See targets below.
    description str
    The description of the event rule.
    status str
    The status of the event rule. Valid values: ENABLE, DISABLE.
    eventBusName String
    The name of the event bus.
    filterPattern String
    The pattern to match interested events. Event mode, JSON format. The value description is as follows: stringEqual mode. stringExpression mode. Each field has up to 5 expressions (map structure).
    ruleName String
    The name of the event rule.
    targets List<Property Map>
    The targets of rule. See targets below.
    description String
    The description of the event rule.
    status String
    The status of the event rule. Valid values: ENABLE, DISABLE.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Rule Resource

    Get an existing Rule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RuleState, opts?: CustomResourceOptions): Rule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        event_bus_name: Optional[str] = None,
        filter_pattern: Optional[str] = None,
        rule_name: Optional[str] = None,
        status: Optional[str] = None,
        targets: Optional[Sequence[RuleTargetArgs]] = None) -> Rule
    func GetRule(ctx *Context, name string, id IDInput, state *RuleState, opts ...ResourceOption) (*Rule, error)
    public static Rule Get(string name, Input<string> id, RuleState? state, CustomResourceOptions? opts = null)
    public static Rule get(String name, Output<String> id, RuleState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    The description of the event rule.
    EventBusName string
    The name of the event bus.
    FilterPattern string
    The pattern to match interested events. Event mode, JSON format. The value description is as follows: stringEqual mode. stringExpression mode. Each field has up to 5 expressions (map structure).
    RuleName string
    The name of the event rule.
    Status string
    The status of the event rule. Valid values: ENABLE, DISABLE.
    Targets List<Pulumi.AliCloud.EventBridge.Inputs.RuleTarget>
    The targets of rule. See targets below.
    Description string
    The description of the event rule.
    EventBusName string
    The name of the event bus.
    FilterPattern string
    The pattern to match interested events. Event mode, JSON format. The value description is as follows: stringEqual mode. stringExpression mode. Each field has up to 5 expressions (map structure).
    RuleName string
    The name of the event rule.
    Status string
    The status of the event rule. Valid values: ENABLE, DISABLE.
    Targets []RuleTargetArgs
    The targets of rule. See targets below.
    description String
    The description of the event rule.
    eventBusName String
    The name of the event bus.
    filterPattern String
    The pattern to match interested events. Event mode, JSON format. The value description is as follows: stringEqual mode. stringExpression mode. Each field has up to 5 expressions (map structure).
    ruleName String
    The name of the event rule.
    status String
    The status of the event rule. Valid values: ENABLE, DISABLE.
    targets List<RuleTarget>
    The targets of rule. See targets below.
    description string
    The description of the event rule.
    eventBusName string
    The name of the event bus.
    filterPattern string
    The pattern to match interested events. Event mode, JSON format. The value description is as follows: stringEqual mode. stringExpression mode. Each field has up to 5 expressions (map structure).
    ruleName string
    The name of the event rule.
    status string
    The status of the event rule. Valid values: ENABLE, DISABLE.
    targets RuleTarget[]
    The targets of rule. See targets below.
    description str
    The description of the event rule.
    event_bus_name str
    The name of the event bus.
    filter_pattern str
    The pattern to match interested events. Event mode, JSON format. The value description is as follows: stringEqual mode. stringExpression mode. Each field has up to 5 expressions (map structure).
    rule_name str
    The name of the event rule.
    status str
    The status of the event rule. Valid values: ENABLE, DISABLE.
    targets Sequence[RuleTargetArgs]
    The targets of rule. See targets below.
    description String
    The description of the event rule.
    eventBusName String
    The name of the event bus.
    filterPattern String
    The pattern to match interested events. Event mode, JSON format. The value description is as follows: stringEqual mode. stringExpression mode. Each field has up to 5 expressions (map structure).
    ruleName String
    The name of the event rule.
    status String
    The status of the event rule. Valid values: ENABLE, DISABLE.
    targets List<Property Map>
    The targets of rule. See targets below.

    Supporting Types

    RuleTarget, RuleTargetArgs

    Endpoint string
    The endpoint of the event target.
    ParamLists List<Pulumi.AliCloud.EventBridge.Inputs.RuleTargetParamList>
    The parameters that are configured for the event target. See param_list below.
    TargetId string
    The ID of the custom event target.
    Type string
    The type of the event target. Valid values: acs.alikafka, acs.api.destination, acs.arms.loki, acs.datahub, acs.dingtalk, acs.eventbridge, acs.eventbridge.olap, acs.eventbus.SLSCloudLens, acs.fc.function, acs.fnf, acs.k8s, acs.mail, acs.mns.queue, acs.mns.topic, acs.openapi, acs.rabbitmq, acs.rds.mysql, acs.rocketmq, acs.sae, acs.sls, acs.sms, http,https and mysql. NOTE: From version 1.208.1, type can be set to acs.alikafka, acs.api.destination, acs.arms.loki, acs.datahub, acs.eventbridge.olap, acs.eventbus.SLSCloudLens, acs.fnf, acs.k8s, acs.openapi, acs.rds.mysql, acs.sae, acs.sls, mysql.
    DeadLetterQueue Pulumi.AliCloud.EventBridge.Inputs.RuleTargetDeadLetterQueue
    The dead letter queue. Events that are not processed or exceed the number of retries will be written to the dead letter. Support message service MNS and message queue RocketMQ. See dead_letter_queue below.
    PushRetryStrategy string
    The retry policy that is used to push the event. Valid values:

    • BACKOFF_RETRY: Backoff retry. The request can be retried up to three times. The interval between two consecutive retries is a random value between 10 and 20 seconds.
    • EXPONENTIAL_DECAY_RETRY: Exponential decay retry. The request can be retried up to 176 times. The interval between two consecutive retries exponentially increases to 512 seconds, and the total retry time is one day. The specific retry intervals are 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 512, ..., and 512 seconds, including a maximum of one hundred and sixty-seven 512 seconds in total.
    Endpoint string
    The endpoint of the event target.
    ParamLists []RuleTargetParamList
    The parameters that are configured for the event target. See param_list below.
    TargetId string
    The ID of the custom event target.
    Type string
    The type of the event target. Valid values: acs.alikafka, acs.api.destination, acs.arms.loki, acs.datahub, acs.dingtalk, acs.eventbridge, acs.eventbridge.olap, acs.eventbus.SLSCloudLens, acs.fc.function, acs.fnf, acs.k8s, acs.mail, acs.mns.queue, acs.mns.topic, acs.openapi, acs.rabbitmq, acs.rds.mysql, acs.rocketmq, acs.sae, acs.sls, acs.sms, http,https and mysql. NOTE: From version 1.208.1, type can be set to acs.alikafka, acs.api.destination, acs.arms.loki, acs.datahub, acs.eventbridge.olap, acs.eventbus.SLSCloudLens, acs.fnf, acs.k8s, acs.openapi, acs.rds.mysql, acs.sae, acs.sls, mysql.
    DeadLetterQueue RuleTargetDeadLetterQueue
    The dead letter queue. Events that are not processed or exceed the number of retries will be written to the dead letter. Support message service MNS and message queue RocketMQ. See dead_letter_queue below.
    PushRetryStrategy string
    The retry policy that is used to push the event. Valid values:

    • BACKOFF_RETRY: Backoff retry. The request can be retried up to three times. The interval between two consecutive retries is a random value between 10 and 20 seconds.
    • EXPONENTIAL_DECAY_RETRY: Exponential decay retry. The request can be retried up to 176 times. The interval between two consecutive retries exponentially increases to 512 seconds, and the total retry time is one day. The specific retry intervals are 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 512, ..., and 512 seconds, including a maximum of one hundred and sixty-seven 512 seconds in total.
    endpoint String
    The endpoint of the event target.
    paramLists List<RuleTargetParamList>
    The parameters that are configured for the event target. See param_list below.
    targetId String
    The ID of the custom event target.
    type String
    The type of the event target. Valid values: acs.alikafka, acs.api.destination, acs.arms.loki, acs.datahub, acs.dingtalk, acs.eventbridge, acs.eventbridge.olap, acs.eventbus.SLSCloudLens, acs.fc.function, acs.fnf, acs.k8s, acs.mail, acs.mns.queue, acs.mns.topic, acs.openapi, acs.rabbitmq, acs.rds.mysql, acs.rocketmq, acs.sae, acs.sls, acs.sms, http,https and mysql. NOTE: From version 1.208.1, type can be set to acs.alikafka, acs.api.destination, acs.arms.loki, acs.datahub, acs.eventbridge.olap, acs.eventbus.SLSCloudLens, acs.fnf, acs.k8s, acs.openapi, acs.rds.mysql, acs.sae, acs.sls, mysql.
    deadLetterQueue RuleTargetDeadLetterQueue
    The dead letter queue. Events that are not processed or exceed the number of retries will be written to the dead letter. Support message service MNS and message queue RocketMQ. See dead_letter_queue below.
    pushRetryStrategy String
    The retry policy that is used to push the event. Valid values:

    • BACKOFF_RETRY: Backoff retry. The request can be retried up to three times. The interval between two consecutive retries is a random value between 10 and 20 seconds.
    • EXPONENTIAL_DECAY_RETRY: Exponential decay retry. The request can be retried up to 176 times. The interval between two consecutive retries exponentially increases to 512 seconds, and the total retry time is one day. The specific retry intervals are 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 512, ..., and 512 seconds, including a maximum of one hundred and sixty-seven 512 seconds in total.
    endpoint string
    The endpoint of the event target.
    paramLists RuleTargetParamList[]
    The parameters that are configured for the event target. See param_list below.
    targetId string
    The ID of the custom event target.
    type string
    The type of the event target. Valid values: acs.alikafka, acs.api.destination, acs.arms.loki, acs.datahub, acs.dingtalk, acs.eventbridge, acs.eventbridge.olap, acs.eventbus.SLSCloudLens, acs.fc.function, acs.fnf, acs.k8s, acs.mail, acs.mns.queue, acs.mns.topic, acs.openapi, acs.rabbitmq, acs.rds.mysql, acs.rocketmq, acs.sae, acs.sls, acs.sms, http,https and mysql. NOTE: From version 1.208.1, type can be set to acs.alikafka, acs.api.destination, acs.arms.loki, acs.datahub, acs.eventbridge.olap, acs.eventbus.SLSCloudLens, acs.fnf, acs.k8s, acs.openapi, acs.rds.mysql, acs.sae, acs.sls, mysql.
    deadLetterQueue RuleTargetDeadLetterQueue
    The dead letter queue. Events that are not processed or exceed the number of retries will be written to the dead letter. Support message service MNS and message queue RocketMQ. See dead_letter_queue below.
    pushRetryStrategy string
    The retry policy that is used to push the event. Valid values:

    • BACKOFF_RETRY: Backoff retry. The request can be retried up to three times. The interval between two consecutive retries is a random value between 10 and 20 seconds.
    • EXPONENTIAL_DECAY_RETRY: Exponential decay retry. The request can be retried up to 176 times. The interval between two consecutive retries exponentially increases to 512 seconds, and the total retry time is one day. The specific retry intervals are 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 512, ..., and 512 seconds, including a maximum of one hundred and sixty-seven 512 seconds in total.
    endpoint str
    The endpoint of the event target.
    param_lists Sequence[RuleTargetParamList]
    The parameters that are configured for the event target. See param_list below.
    target_id str
    The ID of the custom event target.
    type str
    The type of the event target. Valid values: acs.alikafka, acs.api.destination, acs.arms.loki, acs.datahub, acs.dingtalk, acs.eventbridge, acs.eventbridge.olap, acs.eventbus.SLSCloudLens, acs.fc.function, acs.fnf, acs.k8s, acs.mail, acs.mns.queue, acs.mns.topic, acs.openapi, acs.rabbitmq, acs.rds.mysql, acs.rocketmq, acs.sae, acs.sls, acs.sms, http,https and mysql. NOTE: From version 1.208.1, type can be set to acs.alikafka, acs.api.destination, acs.arms.loki, acs.datahub, acs.eventbridge.olap, acs.eventbus.SLSCloudLens, acs.fnf, acs.k8s, acs.openapi, acs.rds.mysql, acs.sae, acs.sls, mysql.
    dead_letter_queue RuleTargetDeadLetterQueue
    The dead letter queue. Events that are not processed or exceed the number of retries will be written to the dead letter. Support message service MNS and message queue RocketMQ. See dead_letter_queue below.
    push_retry_strategy str
    The retry policy that is used to push the event. Valid values:

    • BACKOFF_RETRY: Backoff retry. The request can be retried up to three times. The interval between two consecutive retries is a random value between 10 and 20 seconds.
    • EXPONENTIAL_DECAY_RETRY: Exponential decay retry. The request can be retried up to 176 times. The interval between two consecutive retries exponentially increases to 512 seconds, and the total retry time is one day. The specific retry intervals are 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 512, ..., and 512 seconds, including a maximum of one hundred and sixty-seven 512 seconds in total.
    endpoint String
    The endpoint of the event target.
    paramLists List<Property Map>
    The parameters that are configured for the event target. See param_list below.
    targetId String
    The ID of the custom event target.
    type String
    The type of the event target. Valid values: acs.alikafka, acs.api.destination, acs.arms.loki, acs.datahub, acs.dingtalk, acs.eventbridge, acs.eventbridge.olap, acs.eventbus.SLSCloudLens, acs.fc.function, acs.fnf, acs.k8s, acs.mail, acs.mns.queue, acs.mns.topic, acs.openapi, acs.rabbitmq, acs.rds.mysql, acs.rocketmq, acs.sae, acs.sls, acs.sms, http,https and mysql. NOTE: From version 1.208.1, type can be set to acs.alikafka, acs.api.destination, acs.arms.loki, acs.datahub, acs.eventbridge.olap, acs.eventbus.SLSCloudLens, acs.fnf, acs.k8s, acs.openapi, acs.rds.mysql, acs.sae, acs.sls, mysql.
    deadLetterQueue Property Map
    The dead letter queue. Events that are not processed or exceed the number of retries will be written to the dead letter. Support message service MNS and message queue RocketMQ. See dead_letter_queue below.
    pushRetryStrategy String
    The retry policy that is used to push the event. Valid values:

    • BACKOFF_RETRY: Backoff retry. The request can be retried up to three times. The interval between two consecutive retries is a random value between 10 and 20 seconds.
    • EXPONENTIAL_DECAY_RETRY: Exponential decay retry. The request can be retried up to 176 times. The interval between two consecutive retries exponentially increases to 512 seconds, and the total retry time is one day. The specific retry intervals are 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 512, ..., and 512 seconds, including a maximum of one hundred and sixty-seven 512 seconds in total.

    RuleTargetDeadLetterQueue, RuleTargetDeadLetterQueueArgs

    Arn string
    The Alibaba Cloud Resource Name (ARN) of the dead letter queue. Events that are not processed or whose maximum retries are exceeded are written to the dead-letter queue. The ARN feature is supported by the following queue types: MNS and Message Queue for Apache RocketMQ.
    Arn string
    The Alibaba Cloud Resource Name (ARN) of the dead letter queue. Events that are not processed or whose maximum retries are exceeded are written to the dead-letter queue. The ARN feature is supported by the following queue types: MNS and Message Queue for Apache RocketMQ.
    arn String
    The Alibaba Cloud Resource Name (ARN) of the dead letter queue. Events that are not processed or whose maximum retries are exceeded are written to the dead-letter queue. The ARN feature is supported by the following queue types: MNS and Message Queue for Apache RocketMQ.
    arn string
    The Alibaba Cloud Resource Name (ARN) of the dead letter queue. Events that are not processed or whose maximum retries are exceeded are written to the dead-letter queue. The ARN feature is supported by the following queue types: MNS and Message Queue for Apache RocketMQ.
    arn str
    The Alibaba Cloud Resource Name (ARN) of the dead letter queue. Events that are not processed or whose maximum retries are exceeded are written to the dead-letter queue. The ARN feature is supported by the following queue types: MNS and Message Queue for Apache RocketMQ.
    arn String
    The Alibaba Cloud Resource Name (ARN) of the dead letter queue. Events that are not processed or whose maximum retries are exceeded are written to the dead-letter queue. The ARN feature is supported by the following queue types: MNS and Message Queue for Apache RocketMQ.

    RuleTargetParamList, RuleTargetParamListArgs

    Form string
    The format of the event target parameter. Valid values: ORIGINAL, TEMPLATE, JSONPATH, CONSTANT.
    ResourceKey string
    The resource parameter of the event target. For more information, see How to use it
    Template string
    The template of the event target parameter.
    Value string

    The value of the event target parameter.

    NOTE: There exists a potential diff error that the backend service will return a default param as following:

    param_list {
resource_key = "IsBase64Encode"
form         = "CONSTANT"
value        = "false"
template     = ""
}

    In order to fix the diff, from version 1.160.0, this resource has removed the param which resource_key = "IsBase64Encode" and value = "false". If you want to set resource_key = "IsBase64Encode", please avoid to set value = "false".

    Form string
    The format of the event target parameter. Valid values: ORIGINAL, TEMPLATE, JSONPATH, CONSTANT.
    ResourceKey string
    The resource parameter of the event target. For more information, see How to use it
    Template string
    The template of the event target parameter.
    Value string

    The value of the event target parameter.

    NOTE: There exists a potential diff error that the backend service will return a default param as following:

    param_list {
resource_key = "IsBase64Encode"
form         = "CONSTANT"
value        = "false"
template     = ""
}

    In order to fix the diff, from version 1.160.0, this resource has removed the param which resource_key = "IsBase64Encode" and value = "false". If you want to set resource_key = "IsBase64Encode", please avoid to set value = "false".

    form String
    The format of the event target parameter. Valid values: ORIGINAL, TEMPLATE, JSONPATH, CONSTANT.
    resourceKey String
    The resource parameter of the event target. For more information, see How to use it
    template String
    The template of the event target parameter.
    value String

    The value of the event target parameter.

    NOTE: There exists a potential diff error that the backend service will return a default param as following:

    param_list {
resource_key = "IsBase64Encode"
form         = "CONSTANT"
value        = "false"
template     = ""
}

    In order to fix the diff, from version 1.160.0, this resource has removed the param which resource_key = "IsBase64Encode" and value = "false". If you want to set resource_key = "IsBase64Encode", please avoid to set value = "false".

    form string
    The format of the event target parameter. Valid values: ORIGINAL, TEMPLATE, JSONPATH, CONSTANT.
    resourceKey string
    The resource parameter of the event target. For more information, see How to use it
    template string
    The template of the event target parameter.
    value string

    The value of the event target parameter.

    NOTE: There exists a potential diff error that the backend service will return a default param as following:

    param_list {
resource_key = "IsBase64Encode"
form         = "CONSTANT"
value        = "false"
template     = ""
}

    In order to fix the diff, from version 1.160.0, this resource has removed the param which resource_key = "IsBase64Encode" and value = "false". If you want to set resource_key = "IsBase64Encode", please avoid to set value = "false".

    form str
    The format of the event target parameter. Valid values: ORIGINAL, TEMPLATE, JSONPATH, CONSTANT.
    resource_key str
    The resource parameter of the event target. For more information, see How to use it
    template str
    The template of the event target parameter.
    value str

    The value of the event target parameter.

    NOTE: There exists a potential diff error that the backend service will return a default param as following:

    param_list {
resource_key = "IsBase64Encode"
form         = "CONSTANT"
value        = "false"
template     = ""
}

    In order to fix the diff, from version 1.160.0, this resource has removed the param which resource_key = "IsBase64Encode" and value = "false". If you want to set resource_key = "IsBase64Encode", please avoid to set value = "false".

    form String
    The format of the event target parameter. Valid values: ORIGINAL, TEMPLATE, JSONPATH, CONSTANT.
    resourceKey String
    The resource parameter of the event target. For more information, see How to use it
    template String
    The template of the event target parameter.
    value String

    The value of the event target parameter.

    NOTE: There exists a potential diff error that the backend service will return a default param as following:

    param_list {
resource_key = "IsBase64Encode"
form         = "CONSTANT"
value        = "false"
template     = ""
}

    In order to fix the diff, from version 1.160.0, this resource has removed the param which resource_key = "IsBase64Encode" and value = "false". If you want to set resource_key = "IsBase64Encode", please avoid to set value = "false".

    Import

    Event Bridge Rule can be imported using the id, e.g.

    $ pulumi import alicloud:eventbridge/rule:Rule example <event_bus_name>:<rule_name>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-alicloud