Rule

eventbridge.services.k8s.aws/v1alpha1

Metadata#

Contains information about a rule in Amazon EventBridge.

Spec#

description: string
eventBusName: string
eventBusRef: 
  from: 
    name: string
    namespace: string
eventPattern: string
name: string
roleARN: string
scheduleExpression: string
state: string
tags:
- key: string
  value: string
targets:
- arn: string
  batchParameters: 
    arrayProperties: 
      size: integer
    jobDefinition: string
    jobName: string
    retryStrategy: 
      attempts: integer
  deadLetterConfig: 
    arn: string
  ecsParameters: 
    capacityProviderStrategy:
    - base: integer
      capacityProvider: string
      weight: integer
    enableECSManagedTags: boolean
    enableExecuteCommand: boolean
    group: string
    launchType: string
    networkConfiguration: 
      awsVPCConfiguration: 
        assignPublicIP: string
        securityGroups:
        - string
        subnets:
        - string
    placementConstraints:
    - expression: string
      type_: string
    placementStrategy:
    - field: string
      type_: string
    platformVersion: string
    propagateTags: string
    referenceID: string
    tags:
    - key: string
      value: string
    taskCount: integer
    taskDefinitionARN: string
  httpParameters: 
    headerParameters: {}
    pathParameterValues:
    - string
    queryStringParameters: {}
  id: string
  input: string
  inputPath: string
  inputTransformer: 
    inputPathsMap: {}
    inputTemplate: string
  kinesisParameters: 
    partitionKeyPath: string
  redshiftDataParameters: 
    database: string
    dbUser: string
    secretManagerARN: string
    sql: string
    sqls:
    - string
    statementName: string
    withEvent: boolean
  retryPolicy: 
    maximumEventAgeInSeconds: integer
    maximumRetryAttempts: integer
  roleARN: string
  runCommandParameters: 
    runCommandTargets:
    - key: string
      values:
      - string
  sageMakerPipelineParameters: 
    pipelineParameterList:
    - name: string
      value: string
  sqsParameters: 
    messageGroupID: string

If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the Amazon EventBridge User Guide. || targets.[].arn
Optional | string
| | targets.[].batchParameters
Optional | object
The custom parameters to be used when the target is an Batch job. | | targets.[].batchParameters.arrayProperties
Optional | object
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 Batch job. | | targets.[].batchParameters.arrayProperties.size
Optional | integer
| | targets.[].batchParameters.jobDefinition
Optional | string
| | targets.[].batchParameters.jobName
Optional | string
| | targets.[].batchParameters.retryStrategy
Optional | object
The retry strategy to use for failed jobs, if the target is an Batch job.
If you specify a retry strategy here, it overrides the retry strategy defined
in the job definition. | | targets.[].batchParameters.retryStrategy.attempts
Optional | integer
| | targets.[].deadLetterConfig
Optional | object
Configuration details of the Amazon SQS queue for EventBridge to use as a
dead-letter queue (DLQ).

For more information, see Using dead-letter queues to process undelivered
events (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rule-event-delivery.html#eb-rule-dlq)
in the EventBridge User Guide. | | targets.[].deadLetterConfig.arn
Optional | string
| | targets.[].ecsParameters
Optional | object
The custom parameters to be used when the target is an Amazon ECS task. | | targets.[].ecsParameters.capacityProviderStrategy
Optional | array
| | targets.[].ecsParameters.capacityProviderStrategy.[]
Required | object
The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) in the Amazon ECS API Reference. || targets.[].ecsParameters.capacityProviderStrategy.[].base
Optional | integer
| | targets.[].ecsParameters.capacityProviderStrategy.[].capacityProvider
Optional | string
| | targets.[].ecsParameters.capacityProviderStrategy.[].weight
Optional | integer
| | targets.[].ecsParameters.enableECSManagedTags
Optional | boolean
| | targets.[].ecsParameters.enableExecuteCommand
Optional | boolean
| | targets.[].ecsParameters.group
Optional | string
| | targets.[].ecsParameters.launchType
Optional | string
| | targets.[].ecsParameters.networkConfiguration
Optional | object
This structure specifies the network configuration for an ECS task. | | targets.[].ecsParameters.networkConfiguration.awsVPCConfiguration
Optional | object
This structure specifies the VPC subnets and security groups for the task,
and whether a public IP address is to be used. This structure is relevant
only for ECS tasks that use the awsvpc network mode. | | targets.[].ecsParameters.networkConfiguration.awsVPCConfiguration.assignPublicIP
Optional | string
| | targets.[].ecsParameters.networkConfiguration.awsVPCConfiguration.securityGroups
Optional | array
| | targets.[].ecsParameters.networkConfiguration.awsVPCConfiguration.securityGroups.[]
Required | string
|| targets.[].ecsParameters.networkConfiguration.awsVPCConfiguration.subnets
Optional | array
| | targets.[].ecsParameters.networkConfiguration.awsVPCConfiguration.subnets.[]
Required | string
|| targets.[].ecsParameters.placementConstraints
Optional | array
| | targets.[].ecsParameters.placementConstraints.[]
Required | object
An object representing a constraint on task placement. To learn more, see Task Placement Constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the Amazon Elastic Container Service Developer Guide. || targets.[].ecsParameters.placementConstraints.[].expression
Optional | string
| | **targets.[].ecsParameters.placementConstraints.[].type_**
Optional | **string**
| | **targets.[].ecsParameters.placementStrategy**
Optional | **array**
| | **targets.[].ecsParameters.placementStrategy.[]**
Required | **object**
The task placement strategy for a task or service. To learn more, see Task Placement Strategies (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the Amazon Elastic Container Service Service Developer Guide. || **targets.[].ecsParameters.placementStrategy.[].field**
Optional | **string**
| | **targets.[].ecsParameters.placementStrategy.[].type_**
Optional | **string**
| | **targets.[].ecsParameters.platformVersion**
Optional | **string**
| | **targets.[].ecsParameters.propagateTags**
Optional | **string**
| | **targets.[].ecsParameters.referenceID**
Optional | **string**
| | **targets.[].ecsParameters.tags**
Optional | **array**
| | **targets.[].ecsParameters.tags.[]**
Required | **object**
A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging. || **targets.[].ecsParameters.tags.[].key**
Optional | **string**
| | **targets.[].ecsParameters.tags.[].value**
Optional | **string**
| | **targets.[].ecsParameters.taskCount**
Optional | **integer**
| | **targets.[].ecsParameters.taskDefinitionARN**
Optional | **string**
| | **targets.[].httpParameters**
Optional | **object**
These are custom parameter to be used when the target is an API Gateway APIs
or EventBridge ApiDestinations. In the latter case, these are merged with
any InvocationParameters specified on the Connection, with any values from
the Connection taking precedence. | | **targets.[].httpParameters.headerParameters**
Optional | **object**
| | **targets.[].httpParameters.pathParameterValues**
Optional | **array**
| | **targets.[].httpParameters.pathParameterValues.[]**
Required | **string**
|| **targets.[].httpParameters.queryStringParameters**
Optional | **object**
| | **targets.[].id**
Optional | **string**
| | **targets.[].input**
Optional | **string**
| | **targets.[].inputPath**
Optional | **string**
| | **targets.[].inputTransformer**
Optional | **object**
Contains the parameters needed for you to provide custom input to a target
based on one or more pieces of data extracted from the event. | | **targets.[].inputTransformer.inputPathsMap**
Optional | **object**
| | **targets.[].inputTransformer.inputTemplate**
Optional | **string**
| | **targets.[].kinesisParameters**
Optional | **object**
This object enables you to specify a JSON path to extract from the event
and use as the partition key for the Amazon Kinesis data stream, so that
you can control the shard to which the event goes. If you do not include
this parameter, the default is to use the eventId as the partition key. | | **targets.[].kinesisParameters.partitionKeyPath**
Optional | **string**
| | **targets.[].redshiftDataParameters**
Optional | **object**
These are custom parameters to be used when the target is a Amazon Redshift
cluster to invoke the Amazon Redshift Data API ExecuteStatement based on
EventBridge events. | | **targets.[].redshiftDataParameters.database**
Optional | **string**
Redshift Database | | **targets.[].redshiftDataParameters.dbUser**
Optional | **string**
Database user name | | **targets.[].redshiftDataParameters.secretManagerARN**
Optional | **string**
Optional SecretManager ARN which stores the database credentials | | **targets.[].redshiftDataParameters.sql**
Optional | **string**
A single Redshift SQL | | **targets.[].redshiftDataParameters.sqls**
Optional | **array**
A list of SQLs. | | **targets.[].redshiftDataParameters.sqls.[]**
Required | **string**
|| **targets.[].redshiftDataParameters.statementName**
Optional | **string**
A name for Redshift DataAPI statement which can be used as filter of ListStatement. | | **targets.[].redshiftDataParameters.withEvent**
Optional | **boolean**
| | **targets.[].retryPolicy**
Optional | **object**
A RetryPolicy object that includes information about the retry policy settings. | | **targets.[].retryPolicy.maximumEventAgeInSeconds**
Optional | **integer**
| | **targets.[].retryPolicy.maximumRetryAttempts**
Optional | **integer**
| | **targets.[].roleARN**
Optional | **string**
| | **targets.[].runCommandParameters**
Optional | **object**
This parameter contains the criteria (either InstanceIds or a tag) used to
specify which EC2 instances are to be sent the command. | | **targets.[].runCommandParameters.runCommandTargets**
Optional | **array**
| | **targets.[].runCommandParameters.runCommandTargets.[]**
Required | **object**
Information about the EC2 instances that are to be sent the command, specified as key-value pairs. Each RunCommandTarget block can include only one key, but this key may specify multiple values. || **targets.[].runCommandParameters.runCommandTargets.[].key**
Optional | **string**
| | **targets.[].runCommandParameters.runCommandTargets.[].values**
Optional | **array**
| | **targets.[].runCommandParameters.runCommandTargets.[].values.[]**
Required | **string**
|| **targets.[].sageMakerPipelineParameters**
Optional | **object**
These are custom parameters to use when the target is a SageMaker Model Building
Pipeline that starts based on EventBridge events. | | **targets.[].sageMakerPipelineParameters.pipelineParameterList**
Optional | **array**
| | **targets.[].sageMakerPipelineParameters.pipelineParameterList.[]**
Required | **object**
Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline. || **targets.[].sageMakerPipelineParameters.pipelineParameterList.[].name**
Optional | **string**
| | **targets.[].sageMakerPipelineParameters.pipelineParameterList.[].value**
Optional | **string**
| | **targets.[].sqsParameters**
Optional | **object**
This structure includes the custom parameter to be used when the target is
an SQS FIFO queue. | | **targets.[].sqsParameters.messageGroupID**
Optional | **string**
|

Status#

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string