Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. events
  5. getRule

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.events.getRule

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Events::Rule

    Using getRule

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRule(args: GetRuleArgs, opts?: InvokeOptions): Promise<GetRuleResult>
function getRuleOutput(args: GetRuleOutputArgs, opts?: InvokeOptions): Output<GetRuleResult>
    def get_rule(arn: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetRuleResult
def get_rule_output(arn: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetRuleResult]
    func LookupRule(ctx *Context, args *LookupRuleArgs, opts ...InvokeOption) (*LookupRuleResult, error)
func LookupRuleOutput(ctx *Context, args *LookupRuleOutputArgs, opts ...InvokeOption) LookupRuleResultOutput

    > Note: This function is named LookupRule in the Go SDK.

    public static class GetRule 
{
    public static Task<GetRuleResult> InvokeAsync(GetRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetRuleResult> Invoke(GetRuleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRuleResult> getRule(GetRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:events:getRule
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
    Arn string
    The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
    arn String
    The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
    arn string
    The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
    arn str
    The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
    arn String
    The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.

    getRule Result

    The following output properties are available:

    Arn string
    The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
    Description string
    The description of the rule.
    EventBusName string
    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
    EventPattern object

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

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

    RoleArn string
    The Amazon Resource Name (ARN) of the role that is used for target invocation.
    ScheduleExpression string
    The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.
    State Pulumi.AwsNative.Events.RuleState
    The state of the rule.
    Targets List<Pulumi.AwsNative.Events.Outputs.RuleTarget>
    Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resources that are invoked when a rule is triggered.
    Arn string
    The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
    Description string
    The description of the rule.
    EventBusName string
    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
    EventPattern interface{}

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

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

    RoleArn string
    The Amazon Resource Name (ARN) of the role that is used for target invocation.
    ScheduleExpression string
    The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.
    State RuleStateEnum
    The state of the rule.
    Targets []RuleTarget
    Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resources that are invoked when a rule is triggered.
    arn String
    The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
    description String
    The description of the rule.
    eventBusName String
    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
    eventPattern Object

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

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

    roleArn String
    The Amazon Resource Name (ARN) of the role that is used for target invocation.
    scheduleExpression String
    The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.
    state RuleState
    The state of the rule.
    targets List<RuleTarget>
    Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resources that are invoked when a rule is triggered.
    arn string
    The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
    description string
    The description of the rule.
    eventBusName string
    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
    eventPattern any

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

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

    roleArn string
    The Amazon Resource Name (ARN) of the role that is used for target invocation.
    scheduleExpression string
    The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.
    state RuleState
    The state of the rule.
    targets RuleTarget[]
    Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resources that are invoked when a rule is triggered.
    arn str
    The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
    description str
    The description of the rule.
    event_bus_name str
    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
    event_pattern Any

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

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

    role_arn str
    The Amazon Resource Name (ARN) of the role that is used for target invocation.
    schedule_expression str
    The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.
    state RuleState
    The state of the rule.
    targets Sequence[RuleTarget]
    Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resources that are invoked when a rule is triggered.
    arn String
    The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
    description String
    The description of the rule.
    eventBusName String
    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
    eventPattern Any

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

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

    roleArn String
    The Amazon Resource Name (ARN) of the role that is used for target invocation.
    scheduleExpression String
    The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.
    state "DISABLED" | "ENABLED" | "ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS"
    The state of the rule.
    targets List<Property Map>
    Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resources that are invoked when a rule is triggered.

    Supporting Types

    RuleAppSyncParameters

    RuleAwsVpcConfiguration

    Subnets List<string>
    AssignPublicIp string
    SecurityGroups List<string>
    Subnets []string
    AssignPublicIp string
    SecurityGroups []string
    subnets List<String>
    assignPublicIp String
    securityGroups List<String>
    subnets string[]
    assignPublicIp string
    securityGroups string[]
    subnets Sequence[str]
    assign_public_ip str
    security_groups Sequence[str]
    subnets List<String>
    assignPublicIp String
    securityGroups List<String>

    RuleBatchArrayProperties

    Size int
    Size int
    size Integer
    size number
    size int
    size Number

    RuleBatchParameters

    RuleBatchRetryStrategy

    attempts Integer
    attempts number
    attempts Number

    RuleCapacityProviderStrategyItem

    capacityProvider String
    base Integer
    weight Integer
    capacityProvider string
    base number
    weight number
    capacityProvider String
    base Number
    weight Number

    RuleDeadLetterConfig

    Arn string
    Arn string
    arn String
    arn string
    arn str
    arn String

    RuleEcsParameters

    RuleHttpParameters

    HeaderParameters Dictionary<string, string>
    PathParameterValues List<string>
    QueryStringParameters Dictionary<string, string>
    HeaderParameters map[string]string
    PathParameterValues []string
    QueryStringParameters map[string]string
    headerParameters Map<String,String>
    pathParameterValues List<String>
    queryStringParameters Map<String,String>
    headerParameters {[key: string]: string}
    pathParameterValues string[]
    queryStringParameters {[key: string]: string}
    header_parameters Mapping[str, str]
    path_parameter_values Sequence[str]
    query_string_parameters Mapping[str, str]

    RuleInputTransformer

    InputTemplate string
    InputPathsMap Dictionary<string, string>
    InputTemplate string
    InputPathsMap map[string]string
    inputTemplate String
    inputPathsMap Map<String,String>
    inputTemplate string
    inputPathsMap {[key: string]: string}
    input_template str
    input_paths_map Mapping[str, str]
    inputTemplate String
    inputPathsMap Map<String>

    RuleKinesisParameters

    RuleNetworkConfiguration

    RulePlacementConstraint

    Expression string
    Type string
    Expression string
    Type string
    expression String
    type String
    expression string
    type string
    expression String
    type String

    RulePlacementStrategy

    Field string
    Type string
    Field string
    Type string
    field String
    type String
    field string
    type string
    field str
    type str
    field String
    type String

    RuleRedshiftDataParameters

    Database string
    DbUser string
    SecretManagerArn string
    Sql string
    Sqls List<string>
    StatementName string
    WithEvent bool
    Database string
    DbUser string
    SecretManagerArn string
    Sql string
    Sqls []string
    StatementName string
    WithEvent bool
    database String
    dbUser String
    secretManagerArn String
    sql String
    sqls List<String>
    statementName String
    withEvent Boolean
    database string
    dbUser string
    secretManagerArn string
    sql string
    sqls string[]
    statementName string
    withEvent boolean
    database String
    dbUser String
    secretManagerArn String
    sql String
    sqls List<String>
    statementName String
    withEvent Boolean

    RuleRetryPolicy

    RuleRunCommandParameters

    RuleRunCommandTarget

    Key string
    Values List<string>
    Key string
    Values []string
    key String
    values List<String>
    key string
    values string[]
    key str
    values Sequence[str]
    key String
    values List<String>

    RuleSageMakerPipelineParameter

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    RuleSageMakerPipelineParameters

    RuleSqsParameters

    RuleState

    RuleTag

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    RuleTarget

    Arn string
    Id string
    AppSyncParameters Pulumi.AwsNative.Events.Inputs.RuleAppSyncParameters
    BatchParameters Pulumi.AwsNative.Events.Inputs.RuleBatchParameters
    DeadLetterConfig Pulumi.AwsNative.Events.Inputs.RuleDeadLetterConfig
    EcsParameters Pulumi.AwsNative.Events.Inputs.RuleEcsParameters
    HttpParameters Pulumi.AwsNative.Events.Inputs.RuleHttpParameters
    Input string
    InputPath string
    InputTransformer Pulumi.AwsNative.Events.Inputs.RuleInputTransformer
    KinesisParameters Pulumi.AwsNative.Events.Inputs.RuleKinesisParameters
    RedshiftDataParameters Pulumi.AwsNative.Events.Inputs.RuleRedshiftDataParameters
    RetryPolicy Pulumi.AwsNative.Events.Inputs.RuleRetryPolicy
    RoleArn string
    RunCommandParameters Pulumi.AwsNative.Events.Inputs.RuleRunCommandParameters
    SageMakerPipelineParameters Pulumi.AwsNative.Events.Inputs.RuleSageMakerPipelineParameters
    SqsParameters Pulumi.AwsNative.Events.Inputs.RuleSqsParameters

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
    pulumi/pulumi-aws-native