AWS::S3::Bucket NotificationConfiguration
Describes the notification configuration for an Amazon S3 bucket.
If you create the target resource and related permissions in the same template, you might have a circular dependency.
For example, you might use the AWS::Lambda::Permission
resource to grant
the bucket permission to invoke an AWS Lambda function. However, AWS CloudFormation
can't
create the bucket until the bucket has permission to invoke the function (AWS CloudFormation
checks whether the bucket can invoke the function). If you're using Refs to pass the
bucket
name, this leads to a circular dependency.
To avoid this dependency, you can create all resources without specifying the notification configuration. Then, update the stack with a notification configuration.
For more information on permissions, see AWS::Lambda::Permission and Granting Permissions to Publish Event Notification Messages to a Destination.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "LambdaConfigurations" :
[ LambdaConfiguration, ... ]
, "QueueConfigurations" :[ QueueConfiguration, ... ]
, "TopicConfigurations" :[ TopicConfiguration, ... ]
}
YAML
LambdaConfigurations:
- LambdaConfiguration
QueueConfigurations:- QueueConfiguration
TopicConfigurations:- TopicConfiguration
Properties
LambdaConfigurations
-
Describes the AWS Lambda functions to invoke and the events for which to invoke them.
Required: No
Type: List of LambdaConfiguration
Update requires: No interruption
QueueConfigurations
-
The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.
Required: No
Type: List of QueueConfiguration
Update requires: No interruption
TopicConfigurations
-
The topic to which notifications are sent and the events for which notifications are generated.
Required: No
Type: List of TopicConfiguration
Update requires: No interruption
Examples
Receive S3 bucket notifications to an SNS topic
The following example template shows an Amazon S3 bucket with a notification configuration that sends an event to the specified SNS topic when S3 has lost all replicas of an object.
JSON
{ "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "S3Bucket": { "Type": "AWS::S3::Bucket", "Properties": { "AccessControl": "Private", "NotificationConfiguration": { "TopicConfigurations": [ { "Topic": "arn:aws:sns:us-east-1:123456789012:TestTopic", "Event": "s3:ReducedRedundancyLostObject" } ] } } } }, "Outputs": { "BucketName": { "Value": { "Ref": "S3Bucket" }, "Description": "Name of the sample Amazon S3 bucket with a notification configuration." } } }
YAML
AWSTemplateFormatVersion: 2010-09-09 Resources: S3Bucket: Type: 'AWS::S3::Bucket' Properties: AccessControl: Private NotificationConfiguration: TopicConfigurations: - Topic: 'arn:aws:sns:us-east-1:123456789012:TestTopic' Event: 's3:ReducedRedundancyLostObject' Outputs: BucketName: Value: !Ref S3Bucket Description: Name of the sample Amazon S3 bucket with a notification configuration.