AWS::EventsV2::Subscriber

EventsV2 Subscriber

Resource type definition for AWS::EventsV2::Subscriber, an Amazon EventBridge subscription that delivers events from an event bus to a target. Canonical identity is the combination of bus, name, and target. Replacement uses delete_then_create.

Properties

16 configurable properties. 3 required. Click a row to see details.

Filter:
PropertyTypeFlags
EventBusArn
string
RequiredCreate-only
InvokeConfiguration
InvokeConfiguration
Required
Name
string
RequiredCreate-only
BatchConfiguration
BatchConfiguration
Description
string
FilterConfiguration
FilterConfiguration
LogConfiguration
LogConfiguration
OnFailureConfiguration
OnFailureConfiguration
PointInTimeConfiguration
PointInTimeConfiguration
Create-only
ResumePosition
string
Write-only
RetryPolicy
RetryPolicy
StartingPosition
string
Create-only
State
string
Tags
Array<Tag>
Transformer
Transformer
Type
string
Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
BusNamestringThe name of the event bus this subscriber belongs to. This property is read-only.
CreationTimestringCreation timestamp (ISO-8601), read-only.
LastModifiedTimestringLast-modification timestamp (ISO-8601), read-only.
SubscriberArnstringThe Amazon Resource Name (ARN) of the subscriber.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::EventsV2::Subscriber

Resources:
  MyResource:
    Type: AWS::EventsV2::Subscriber
    Properties:
      Name: "my-name"
      EventBusArn: "arn:aws:service:region:account:resource"
      InvokeConfiguration: "value"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

events:CreateSubscriberevents:DescribeSubscriberevents:ListSubscribersevents:ListTagsForResourceevents:TagResourceiam:PassRole

read

events:DescribeSubscriberevents:ListTagsForResource

update

events:UpdateSubscriberevents:DescribeSubscriberevents:TagResourceevents:UntagResourceiam:PassRole

delete

events:DeleteSubscriberevents:DescribeSubscriber

list

events:ListSubscribers

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceEventsV2
Properties20
Required3
TaggingSupported
Primary IDSubscriberArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

NameEventBusArnInvokeConfiguration/TargetArnTypeStartingPositionPointInTimeConfiguration

Related Resources

External Links