BucketNotification
Manages a S3 Bucket Notification Configuration. For additional information, see the Configuring S3 Event Notifications section in the Amazon S3 Developer Guide.
NOTE: S3 Buckets only support a single notification configuration. Declaring multiple
aws.s3.BucketNotification
resources to the same S3 Bucket will cause a perpetual difference in configuration. See the example “Trigger multiple Lambda functions” for an option.
Example Usage
Add notification configuration to SNS Topic
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var bucket = new Aws.S3.Bucket("bucket", new Aws.S3.BucketArgs
{
});
var topic = new Aws.Sns.Topic("topic", new Aws.Sns.TopicArgs
{
Policy = bucket.Arn.Apply(arn => @$"{{
""Version"":""2012-10-17"",
""Statement"":[{{
""Effect"": ""Allow"",
""Principal"": {{ ""Service"": ""s3.amazonaws.com"" }},
""Action"": ""SNS:Publish"",
""Resource"": ""arn:aws:sns:*:*:s3-event-notification-topic"",
""Condition"":{{
""ArnLike"":{{""aws:SourceArn"":""{arn}""}}
}}
}}]
}}
"),
});
var bucketNotification = new Aws.S3.BucketNotification("bucketNotification", new Aws.S3.BucketNotificationArgs
{
Bucket = bucket.Id,
Topics =
{
new Aws.S3.Inputs.BucketNotificationTopicArgs
{
TopicArn = topic.Arn,
Events =
{
"s3:ObjectCreated:*",
},
FilterSuffix = ".log",
},
},
});
}
}
package main
import (
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/s3"
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/sns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
bucket, err := s3.NewBucket(ctx, "bucket", nil)
if err != nil {
return err
}
topic, err := sns.NewTopic(ctx, "topic", &sns.TopicArgs{
Policy: bucket.Arn.ApplyT(func(arn string) (string, error) {
return fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v%v%v", "{\n", " \"Version\":\"2012-10-17\",\n", " \"Statement\":[{\n", " \"Effect\": \"Allow\",\n", " \"Principal\": { \"Service\": \"s3.amazonaws.com\" },\n", " \"Action\": \"SNS:Publish\",\n", " \"Resource\": \"arn:aws:sns:*:*:s3-event-notification-topic\",\n", " \"Condition\":{\n", " \"ArnLike\":{\"aws:SourceArn\":\"", arn, "\"}\n", " }\n", " }]\n", "}\n"), nil
}).(pulumi.StringOutput),
})
if err != nil {
return err
}
_, err = s3.NewBucketNotification(ctx, "bucketNotification", &s3.BucketNotificationArgs{
Bucket: bucket.ID(),
Topics: s3.BucketNotificationTopicArray{
&s3.BucketNotificationTopicArgs{
TopicArn: topic.Arn,
Events: pulumi.StringArray{
pulumi.String("s3:ObjectCreated:*"),
},
FilterSuffix: pulumi.String(".log"),
},
},
})
if err != nil {
return err
}
return nil
})
}
import pulumi
import pulumi_aws as aws
bucket = aws.s3.Bucket("bucket")
topic = aws.sns.Topic("topic", policy=bucket.arn.apply(lambda arn: f"""{{
"Version":"2012-10-17",
"Statement":[{{
"Effect": "Allow",
"Principal": {{ "Service": "s3.amazonaws.com" }},
"Action": "SNS:Publish",
"Resource": "arn:aws:sns:*:*:s3-event-notification-topic",
"Condition":{{
"ArnLike":{{"aws:SourceArn":"{arn}"}}
}}
}}]
}}
"""))
bucket_notification = aws.s3.BucketNotification("bucketNotification",
bucket=bucket.id,
topics=[aws.s3.BucketNotificationTopicArgs(
topic_arn=topic.arn,
events=["s3:ObjectCreated:*"],
filter_suffix=".log",
)])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const bucket = new aws.s3.Bucket("bucket", {});
const topic = new aws.sns.Topic("topic", {policy: pulumi.interpolate`{
"Version":"2012-10-17",
"Statement":[{
"Effect": "Allow",
"Principal": { "Service": "s3.amazonaws.com" },
"Action": "SNS:Publish",
"Resource": "arn:aws:sns:*:*:s3-event-notification-topic",
"Condition":{
"ArnLike":{"aws:SourceArn":"${bucket.arn}"}
}
}]
}
`});
const bucketNotification = new aws.s3.BucketNotification("bucketNotification", {
bucket: bucket.id,
topics: [{
topicArn: topic.arn,
events: ["s3:ObjectCreated:*"],
filterSuffix: ".log",
}],
});
Add notification configuration to SQS Queue
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var bucket = new Aws.S3.Bucket("bucket", new Aws.S3.BucketArgs
{
});
var queue = new Aws.Sqs.Queue("queue", new Aws.Sqs.QueueArgs
{
Policy = bucket.Arn.Apply(arn => @$"{{
""Version"": ""2012-10-17"",
""Statement"": [
{{
""Effect"": ""Allow"",
""Principal"": ""*"",
""Action"": ""sqs:SendMessage"",
""Resource"": ""arn:aws:sqs:*:*:s3-event-notification-queue"",
""Condition"": {{
""ArnEquals"": {{ ""aws:SourceArn"": ""{arn}"" }}
}}
}}
]
}}
"),
});
var bucketNotification = new Aws.S3.BucketNotification("bucketNotification", new Aws.S3.BucketNotificationArgs
{
Bucket = bucket.Id,
Queues =
{
new Aws.S3.Inputs.BucketNotificationQueueArgs
{
QueueArn = queue.Arn,
Events =
{
"s3:ObjectCreated:*",
},
FilterSuffix = ".log",
},
},
});
}
}
package main
import (
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/s3"
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/sqs"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
bucket, err := s3.NewBucket(ctx, "bucket", nil)
if err != nil {
return err
}
queue, err := sqs.NewQueue(ctx, "queue", &sqs.QueueArgs{
Policy: bucket.Arn.ApplyT(func(arn string) (string, error) {
return fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v", "{\n", " \"Version\": \"2012-10-17\",\n", " \"Statement\": [\n", " {\n", " \"Effect\": \"Allow\",\n", " \"Principal\": \"*\",\n", " \"Action\": \"sqs:SendMessage\",\n", " \"Resource\": \"arn:aws:sqs:*:*:s3-event-notification-queue\",\n", " \"Condition\": {\n", " \"ArnEquals\": { \"aws:SourceArn\": \"", arn, "\" }\n", " }\n", " }\n", " ]\n", "}\n"), nil
}).(pulumi.StringOutput),
})
if err != nil {
return err
}
_, err = s3.NewBucketNotification(ctx, "bucketNotification", &s3.BucketNotificationArgs{
Bucket: bucket.ID(),
Queues: s3.BucketNotificationQueueArray{
&s3.BucketNotificationQueueArgs{
QueueArn: queue.Arn,
Events: pulumi.StringArray{
pulumi.String("s3:ObjectCreated:*"),
},
FilterSuffix: pulumi.String(".log"),
},
},
})
if err != nil {
return err
}
return nil
})
}
import pulumi
import pulumi_aws as aws
bucket = aws.s3.Bucket("bucket")
queue = aws.sqs.Queue("queue", policy=bucket.arn.apply(lambda arn: f"""{{
"Version": "2012-10-17",
"Statement": [
{{
"Effect": "Allow",
"Principal": "*",
"Action": "sqs:SendMessage",
"Resource": "arn:aws:sqs:*:*:s3-event-notification-queue",
"Condition": {{
"ArnEquals": {{ "aws:SourceArn": "{arn}" }}
}}
}}
]
}}
"""))
bucket_notification = aws.s3.BucketNotification("bucketNotification",
bucket=bucket.id,
queues=[aws.s3.BucketNotificationQueueArgs(
queue_arn=queue.arn,
events=["s3:ObjectCreated:*"],
filter_suffix=".log",
)])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const bucket = new aws.s3.Bucket("bucket", {});
const queue = new aws.sqs.Queue("queue", {policy: pulumi.interpolate`{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": "*",
"Action": "sqs:SendMessage",
"Resource": "arn:aws:sqs:*:*:s3-event-notification-queue",
"Condition": {
"ArnEquals": { "aws:SourceArn": "${bucket.arn}" }
}
}
]
}
`});
const bucketNotification = new aws.s3.BucketNotification("bucketNotification", {
bucket: bucket.id,
queues: [{
queueArn: queue.arn,
events: ["s3:ObjectCreated:*"],
filterSuffix: ".log",
}],
});
Add notification configuration to Lambda Function
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var iamForLambda = new Aws.Iam.Role("iamForLambda", new Aws.Iam.RoleArgs
{
AssumeRolePolicy = @"{
""Version"": ""2012-10-17"",
""Statement"": [
{
""Action"": ""sts:AssumeRole"",
""Principal"": {
""Service"": ""lambda.amazonaws.com""
},
""Effect"": ""Allow""
}
]
}
",
});
var func = new Aws.Lambda.Function("func", new Aws.Lambda.FunctionArgs
{
Code = new FileArchive("your-function.zip"),
Role = iamForLambda.Arn,
Handler = "exports.example",
Runtime = "go1.x",
});
var bucket = new Aws.S3.Bucket("bucket", new Aws.S3.BucketArgs
{
});
var allowBucket = new Aws.Lambda.Permission("allowBucket", new Aws.Lambda.PermissionArgs
{
Action = "lambda:InvokeFunction",
Function = func.Arn,
Principal = "s3.amazonaws.com",
SourceArn = bucket.Arn,
});
var bucketNotification = new Aws.S3.BucketNotification("bucketNotification", new Aws.S3.BucketNotificationArgs
{
Bucket = bucket.Id,
LambdaFunctions =
{
new Aws.S3.Inputs.BucketNotificationLambdaFunctionArgs
{
LambdaFunctionArn = func.Arn,
Events =
{
"s3:ObjectCreated:*",
},
FilterPrefix = "AWSLogs/",
FilterSuffix = ".log",
},
},
}, new CustomResourceOptions
{
DependsOn =
{
allowBucket,
},
});
}
}
Coming soon!
import pulumi
import pulumi_aws as aws
iam_for_lambda = aws.iam.Role("iamForLambda", assume_role_policy="""{
"Version": "2012-10-17",
"Statement": [
{
"Action": "sts:AssumeRole",
"Principal": {
"Service": "lambda.amazonaws.com"
},
"Effect": "Allow"
}
]
}
""")
func = aws.lambda_.Function("func",
code=pulumi.FileArchive("your-function.zip"),
role=iam_for_lambda.arn,
handler="exports.example",
runtime="go1.x")
bucket = aws.s3.Bucket("bucket")
allow_bucket = aws.lambda_.Permission("allowBucket",
action="lambda:InvokeFunction",
function=func.arn,
principal="s3.amazonaws.com",
source_arn=bucket.arn)
bucket_notification = aws.s3.BucketNotification("bucketNotification",
bucket=bucket.id,
lambda_functions=[aws.s3.BucketNotificationLambdaFunctionArgs(
lambda_function_arn=func.arn,
events=["s3:ObjectCreated:*"],
filter_prefix="AWSLogs/",
filter_suffix=".log",
)],
opts=pulumi.ResourceOptions(depends_on=[allow_bucket]))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const iamForLambda = new aws.iam.Role("iamForLambda", {assumeRolePolicy: `{
"Version": "2012-10-17",
"Statement": [
{
"Action": "sts:AssumeRole",
"Principal": {
"Service": "lambda.amazonaws.com"
},
"Effect": "Allow"
}
]
}
`});
const func = new aws.lambda.Function("func", {
code: new pulumi.asset.FileArchive("your-function.zip"),
role: iamForLambda.arn,
handler: "exports.example",
runtime: "go1.x",
});
const bucket = new aws.s3.Bucket("bucket", {});
const allowBucket = new aws.lambda.Permission("allowBucket", {
action: "lambda:InvokeFunction",
"function": func.arn,
principal: "s3.amazonaws.com",
sourceArn: bucket.arn,
});
const bucketNotification = new aws.s3.BucketNotification("bucketNotification", {
bucket: bucket.id,
lambdaFunctions: [{
lambdaFunctionArn: func.arn,
events: ["s3:ObjectCreated:*"],
filterPrefix: "AWSLogs/",
filterSuffix: ".log",
}],
}, {
dependsOn: [allowBucket],
});
Trigger multiple Lambda functions
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var iamForLambda = new Aws.Iam.Role("iamForLambda", new Aws.Iam.RoleArgs
{
AssumeRolePolicy = @"{
""Version"": ""2012-10-17"",
""Statement"": [
{
""Action"": ""sts:AssumeRole"",
""Principal"": {
""Service"": ""lambda.amazonaws.com""
},
""Effect"": ""Allow""
}
]
}
",
});
var func1 = new Aws.Lambda.Function("func1", new Aws.Lambda.FunctionArgs
{
Code = new FileArchive("your-function1.zip"),
Role = iamForLambda.Arn,
Handler = "exports.example",
Runtime = "go1.x",
});
var bucket = new Aws.S3.Bucket("bucket", new Aws.S3.BucketArgs
{
});
var allowBucket1 = new Aws.Lambda.Permission("allowBucket1", new Aws.Lambda.PermissionArgs
{
Action = "lambda:InvokeFunction",
Function = func1.Arn,
Principal = "s3.amazonaws.com",
SourceArn = bucket.Arn,
});
var func2 = new Aws.Lambda.Function("func2", new Aws.Lambda.FunctionArgs
{
Code = new FileArchive("your-function2.zip"),
Role = iamForLambda.Arn,
Handler = "exports.example",
});
var allowBucket2 = new Aws.Lambda.Permission("allowBucket2", new Aws.Lambda.PermissionArgs
{
Action = "lambda:InvokeFunction",
Function = func2.Arn,
Principal = "s3.amazonaws.com",
SourceArn = bucket.Arn,
});
var bucketNotification = new Aws.S3.BucketNotification("bucketNotification", new Aws.S3.BucketNotificationArgs
{
Bucket = bucket.Id,
LambdaFunctions =
{
new Aws.S3.Inputs.BucketNotificationLambdaFunctionArgs
{
LambdaFunctionArn = func1.Arn,
Events =
{
"s3:ObjectCreated:*",
},
FilterPrefix = "AWSLogs/",
FilterSuffix = ".log",
},
new Aws.S3.Inputs.BucketNotificationLambdaFunctionArgs
{
LambdaFunctionArn = func2.Arn,
Events =
{
"s3:ObjectCreated:*",
},
FilterPrefix = "OtherLogs/",
FilterSuffix = ".log",
},
},
}, new CustomResourceOptions
{
DependsOn =
{
allowBucket1,
allowBucket2,
},
});
}
}
Coming soon!
import pulumi
import pulumi_aws as aws
iam_for_lambda = aws.iam.Role("iamForLambda", assume_role_policy="""{
"Version": "2012-10-17",
"Statement": [
{
"Action": "sts:AssumeRole",
"Principal": {
"Service": "lambda.amazonaws.com"
},
"Effect": "Allow"
}
]
}
""")
func1 = aws.lambda_.Function("func1",
code=pulumi.FileArchive("your-function1.zip"),
role=iam_for_lambda.arn,
handler="exports.example",
runtime="go1.x")
bucket = aws.s3.Bucket("bucket")
allow_bucket1 = aws.lambda_.Permission("allowBucket1",
action="lambda:InvokeFunction",
function=func1.arn,
principal="s3.amazonaws.com",
source_arn=bucket.arn)
func2 = aws.lambda_.Function("func2",
code=pulumi.FileArchive("your-function2.zip"),
role=iam_for_lambda.arn,
handler="exports.example")
allow_bucket2 = aws.lambda_.Permission("allowBucket2",
action="lambda:InvokeFunction",
function=func2.arn,
principal="s3.amazonaws.com",
source_arn=bucket.arn)
bucket_notification = aws.s3.BucketNotification("bucketNotification",
bucket=bucket.id,
lambda_functions=[
aws.s3.BucketNotificationLambdaFunctionArgs(
lambda_function_arn=func1.arn,
events=["s3:ObjectCreated:*"],
filter_prefix="AWSLogs/",
filter_suffix=".log",
),
aws.s3.BucketNotificationLambdaFunctionArgs(
lambda_function_arn=func2.arn,
events=["s3:ObjectCreated:*"],
filter_prefix="OtherLogs/",
filter_suffix=".log",
),
],
opts=pulumi.ResourceOptions(depends_on=[
allow_bucket1,
allow_bucket2,
]))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const iamForLambda = new aws.iam.Role("iamForLambda", {assumeRolePolicy: `{
"Version": "2012-10-17",
"Statement": [
{
"Action": "sts:AssumeRole",
"Principal": {
"Service": "lambda.amazonaws.com"
},
"Effect": "Allow"
}
]
}
`});
const func1 = new aws.lambda.Function("func1", {
code: new pulumi.asset.FileArchive("your-function1.zip"),
role: iamForLambda.arn,
handler: "exports.example",
runtime: "go1.x",
});
const bucket = new aws.s3.Bucket("bucket", {});
const allowBucket1 = new aws.lambda.Permission("allowBucket1", {
action: "lambda:InvokeFunction",
"function": func1.arn,
principal: "s3.amazonaws.com",
sourceArn: bucket.arn,
});
const func2 = new aws.lambda.Function("func2", {
code: new pulumi.asset.FileArchive("your-function2.zip"),
role: iamForLambda.arn,
handler: "exports.example",
});
const allowBucket2 = new aws.lambda.Permission("allowBucket2", {
action: "lambda:InvokeFunction",
"function": func2.arn,
principal: "s3.amazonaws.com",
sourceArn: bucket.arn,
});
const bucketNotification = new aws.s3.BucketNotification("bucketNotification", {
bucket: bucket.id,
lambdaFunctions: [
{
lambdaFunctionArn: func1.arn,
events: ["s3:ObjectCreated:*"],
filterPrefix: "AWSLogs/",
filterSuffix: ".log",
},
{
lambdaFunctionArn: func2.arn,
events: ["s3:ObjectCreated:*"],
filterPrefix: "OtherLogs/",
filterSuffix: ".log",
},
],
}, {
dependsOn: [
allowBucket1,
allowBucket2,
],
});
Add multiple notification configurations to SQS Queue
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var bucket = new Aws.S3.Bucket("bucket", new Aws.S3.BucketArgs
{
});
var queue = new Aws.Sqs.Queue("queue", new Aws.Sqs.QueueArgs
{
Policy = bucket.Arn.Apply(arn => @$"{{
""Version"": ""2012-10-17"",
""Statement"": [
{{
""Effect"": ""Allow"",
""Principal"": ""*"",
""Action"": ""sqs:SendMessage"",
""Resource"": ""arn:aws:sqs:*:*:s3-event-notification-queue"",
""Condition"": {{
""ArnEquals"": {{ ""aws:SourceArn"": ""{arn}"" }}
}}
}}
]
}}
"),
});
var bucketNotification = new Aws.S3.BucketNotification("bucketNotification", new Aws.S3.BucketNotificationArgs
{
Bucket = bucket.Id,
Queues =
{
new Aws.S3.Inputs.BucketNotificationQueueArgs
{
Id = "image-upload-event",
QueueArn = queue.Arn,
Events =
{
"s3:ObjectCreated:*",
},
FilterPrefix = "images/",
},
new Aws.S3.Inputs.BucketNotificationQueueArgs
{
Id = "video-upload-event",
QueueArn = queue.Arn,
Events =
{
"s3:ObjectCreated:*",
},
FilterPrefix = "videos/",
},
},
});
}
}
package main
import (
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/s3"
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/sqs"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
bucket, err := s3.NewBucket(ctx, "bucket", nil)
if err != nil {
return err
}
queue, err := sqs.NewQueue(ctx, "queue", &sqs.QueueArgs{
Policy: bucket.Arn.ApplyT(func(arn string) (string, error) {
return fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v", "{\n", " \"Version\": \"2012-10-17\",\n", " \"Statement\": [\n", " {\n", " \"Effect\": \"Allow\",\n", " \"Principal\": \"*\",\n", " \"Action\": \"sqs:SendMessage\",\n", " \"Resource\": \"arn:aws:sqs:*:*:s3-event-notification-queue\",\n", " \"Condition\": {\n", " \"ArnEquals\": { \"aws:SourceArn\": \"", arn, "\" }\n", " }\n", " }\n", " ]\n", "}\n"), nil
}).(pulumi.StringOutput),
})
if err != nil {
return err
}
_, err = s3.NewBucketNotification(ctx, "bucketNotification", &s3.BucketNotificationArgs{
Bucket: bucket.ID(),
Queues: s3.BucketNotificationQueueArray{
&s3.BucketNotificationQueueArgs{
Id: pulumi.String("image-upload-event"),
QueueArn: queue.Arn,
Events: pulumi.StringArray{
pulumi.String("s3:ObjectCreated:*"),
},
FilterPrefix: pulumi.String("images/"),
},
&s3.BucketNotificationQueueArgs{
Id: pulumi.String("video-upload-event"),
QueueArn: queue.Arn,
Events: pulumi.StringArray{
pulumi.String("s3:ObjectCreated:*"),
},
FilterPrefix: pulumi.String("videos/"),
},
},
})
if err != nil {
return err
}
return nil
})
}
import pulumi
import pulumi_aws as aws
bucket = aws.s3.Bucket("bucket")
queue = aws.sqs.Queue("queue", policy=bucket.arn.apply(lambda arn: f"""{{
"Version": "2012-10-17",
"Statement": [
{{
"Effect": "Allow",
"Principal": "*",
"Action": "sqs:SendMessage",
"Resource": "arn:aws:sqs:*:*:s3-event-notification-queue",
"Condition": {{
"ArnEquals": {{ "aws:SourceArn": "{arn}" }}
}}
}}
]
}}
"""))
bucket_notification = aws.s3.BucketNotification("bucketNotification",
bucket=bucket.id,
queues=[
aws.s3.BucketNotificationQueueArgs(
id="image-upload-event",
queue_arn=queue.arn,
events=["s3:ObjectCreated:*"],
filter_prefix="images/",
),
aws.s3.BucketNotificationQueueArgs(
id="video-upload-event",
queue_arn=queue.arn,
events=["s3:ObjectCreated:*"],
filter_prefix="videos/",
),
])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const bucket = new aws.s3.Bucket("bucket", {});
const queue = new aws.sqs.Queue("queue", {policy: pulumi.interpolate`{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": "*",
"Action": "sqs:SendMessage",
"Resource": "arn:aws:sqs:*:*:s3-event-notification-queue",
"Condition": {
"ArnEquals": { "aws:SourceArn": "${bucket.arn}" }
}
}
]
}
`});
const bucketNotification = new aws.s3.BucketNotification("bucketNotification", {
bucket: bucket.id,
queues: [
{
id: "image-upload-event",
queueArn: queue.arn,
events: ["s3:ObjectCreated:*"],
filterPrefix: "images/",
},
{
id: "video-upload-event",
queueArn: queue.arn,
events: ["s3:ObjectCreated:*"],
filterPrefix: "videos/",
},
],
});
Create a BucketNotification Resource
new BucketNotification(name: string, args: BucketNotificationArgs, opts?: CustomResourceOptions);
@overload
def BucketNotification(resource_name: str,
opts: Optional[ResourceOptions] = None,
bucket: Optional[str] = None,
lambda_functions: Optional[Sequence[BucketNotificationLambdaFunctionArgs]] = None,
queues: Optional[Sequence[BucketNotificationQueueArgs]] = None,
topics: Optional[Sequence[BucketNotificationTopicArgs]] = None)
@overload
def BucketNotification(resource_name: str,
args: BucketNotificationArgs,
opts: Optional[ResourceOptions] = None)
func NewBucketNotification(ctx *Context, name string, args BucketNotificationArgs, opts ...ResourceOption) (*BucketNotification, error)
public BucketNotification(string name, BucketNotificationArgs args, CustomResourceOptions? opts = null)
- name string
- The unique name of the resource.
- args BucketNotificationArgs
- 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 BucketNotificationArgs
- 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 BucketNotificationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BucketNotificationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
BucketNotification Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The BucketNotification resource accepts the following input properties:
- Bucket string
- The name of the bucket to put notification configuration.
- Lambda
Functions List<BucketNotification Lambda Function Args> - Used to configure notifications to a Lambda Function (documented below).
- Queues
List<Bucket
Notification Queue Args> - The notification configuration to SQS Queue (documented below).
- Topics
List<Bucket
Notification Topic Args> - The notification configuration to SNS Topic (documented below).
- Bucket string
- The name of the bucket to put notification configuration.
- Lambda
Functions []BucketNotification Lambda Function - Used to configure notifications to a Lambda Function (documented below).
- Queues
[]Bucket
Notification Queue - The notification configuration to SQS Queue (documented below).
- Topics
[]Bucket
Notification Topic - The notification configuration to SNS Topic (documented below).
- bucket string
- The name of the bucket to put notification configuration.
- lambda
Functions BucketNotification Lambda Function Args[] - Used to configure notifications to a Lambda Function (documented below).
- queues
Bucket
Notification Queue Args[] - The notification configuration to SQS Queue (documented below).
- topics
Bucket
Notification Topic Args[] - The notification configuration to SNS Topic (documented below).
- bucket str
- The name of the bucket to put notification configuration.
- lambda_
functions Sequence[BucketNotification Lambda Function Args] - Used to configure notifications to a Lambda Function (documented below).
- queues
Sequence[Bucket
Notification Queue Args] - The notification configuration to SQS Queue (documented below).
- topics
Sequence[Bucket
Notification Topic Args] - The notification configuration to SNS Topic (documented below).
Outputs
All input properties are implicitly available as output properties. Additionally, the BucketNotification 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 str
- The provider-assigned unique ID for this managed resource.
Look up an Existing BucketNotification Resource
Get an existing BucketNotification 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?: BucketNotificationState, opts?: CustomResourceOptions): BucketNotification
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
bucket: Optional[str] = None,
lambda_functions: Optional[Sequence[BucketNotificationLambdaFunctionArgs]] = None,
queues: Optional[Sequence[BucketNotificationQueueArgs]] = None,
topics: Optional[Sequence[BucketNotificationTopicArgs]] = None) -> BucketNotification
func GetBucketNotification(ctx *Context, name string, id IDInput, state *BucketNotificationState, opts ...ResourceOption) (*BucketNotification, error)
public static BucketNotification Get(string name, Input<string> id, BucketNotificationState? state, CustomResourceOptions? opts = null)
- 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.
The following state arguments are supported:
- Bucket string
- The name of the bucket to put notification configuration.
- Lambda
Functions List<BucketNotification Lambda Function Args> - Used to configure notifications to a Lambda Function (documented below).
- Queues
List<Bucket
Notification Queue Args> - The notification configuration to SQS Queue (documented below).
- Topics
List<Bucket
Notification Topic Args> - The notification configuration to SNS Topic (documented below).
- Bucket string
- The name of the bucket to put notification configuration.
- Lambda
Functions []BucketNotification Lambda Function - Used to configure notifications to a Lambda Function (documented below).
- Queues
[]Bucket
Notification Queue - The notification configuration to SQS Queue (documented below).
- Topics
[]Bucket
Notification Topic - The notification configuration to SNS Topic (documented below).
- bucket string
- The name of the bucket to put notification configuration.
- lambda
Functions BucketNotification Lambda Function Args[] - Used to configure notifications to a Lambda Function (documented below).
- queues
Bucket
Notification Queue Args[] - The notification configuration to SQS Queue (documented below).
- topics
Bucket
Notification Topic Args[] - The notification configuration to SNS Topic (documented below).
- bucket str
- The name of the bucket to put notification configuration.
- lambda_
functions Sequence[BucketNotification Lambda Function Args] - Used to configure notifications to a Lambda Function (documented below).
- queues
Sequence[Bucket
Notification Queue Args] - The notification configuration to SQS Queue (documented below).
- topics
Sequence[Bucket
Notification Topic Args] - The notification configuration to SNS Topic (documented below).
Supporting Types
BucketNotificationLambdaFunction
- Events List<string>
- Specifies event for which to send notifications.
- Filter
Prefix string - Specifies object key name prefix.
- Filter
Suffix string - Specifies object key name suffix.
- Id string
- Specifies unique identifier for each of the notification configurations.
- Lambda
Function stringArn - Specifies Amazon Lambda function ARN.
- Events []string
- Specifies event for which to send notifications.
- Filter
Prefix string - Specifies object key name prefix.
- Filter
Suffix string - Specifies object key name suffix.
- Id string
- Specifies unique identifier for each of the notification configurations.
- Lambda
Function stringArn - Specifies Amazon Lambda function ARN.
- events string[]
- Specifies event for which to send notifications.
- filter
Prefix string - Specifies object key name prefix.
- filter
Suffix string - Specifies object key name suffix.
- id string
- Specifies unique identifier for each of the notification configurations.
- lambda
Function stringArn - Specifies Amazon Lambda function ARN.
- events Sequence[str]
- Specifies event for which to send notifications.
- filter_
prefix str - Specifies object key name prefix.
- filter_
suffix str - Specifies object key name suffix.
- id str
- Specifies unique identifier for each of the notification configurations.
- lambda_
function_ strarn - Specifies Amazon Lambda function ARN.
BucketNotificationQueue
- Events List<string>
- Specifies event for which to send notifications.
- Queue
Arn string - Specifies Amazon SQS queue ARN.
- Filter
Prefix string - Specifies object key name prefix.
- Filter
Suffix string - Specifies object key name suffix.
- Id string
- Specifies unique identifier for each of the notification configurations.
- Events []string
- Specifies event for which to send notifications.
- Queue
Arn string - Specifies Amazon SQS queue ARN.
- Filter
Prefix string - Specifies object key name prefix.
- Filter
Suffix string - Specifies object key name suffix.
- Id string
- Specifies unique identifier for each of the notification configurations.
- events string[]
- Specifies event for which to send notifications.
- queue
Arn string - Specifies Amazon SQS queue ARN.
- filter
Prefix string - Specifies object key name prefix.
- filter
Suffix string - Specifies object key name suffix.
- id string
- Specifies unique identifier for each of the notification configurations.
- events Sequence[str]
- Specifies event for which to send notifications.
- queue_
arn str - Specifies Amazon SQS queue ARN.
- filter_
prefix str - Specifies object key name prefix.
- filter_
suffix str - Specifies object key name suffix.
- id str
- Specifies unique identifier for each of the notification configurations.
BucketNotificationTopic
- Events List<string>
- Specifies event for which to send notifications.
- Topic
Arn string - Specifies Amazon SNS topic ARN.
- Filter
Prefix string - Specifies object key name prefix.
- Filter
Suffix string - Specifies object key name suffix.
- Id string
- Specifies unique identifier for each of the notification configurations.
- Events []string
- Specifies event for which to send notifications.
- Topic
Arn string - Specifies Amazon SNS topic ARN.
- Filter
Prefix string - Specifies object key name prefix.
- Filter
Suffix string - Specifies object key name suffix.
- Id string
- Specifies unique identifier for each of the notification configurations.
- events string[]
- Specifies event for which to send notifications.
- topic
Arn string - Specifies Amazon SNS topic ARN.
- filter
Prefix string - Specifies object key name prefix.
- filter
Suffix string - Specifies object key name suffix.
- id string
- Specifies unique identifier for each of the notification configurations.
- events Sequence[str]
- Specifies event for which to send notifications.
- topic_
arn str - Specifies Amazon SNS topic ARN.
- filter_
prefix str - Specifies object key name prefix.
- filter_
suffix str - Specifies object key name suffix.
- id str
- Specifies unique identifier for each of the notification configurations.
Import
S3 bucket notification can be imported using the bucket
, e.g.
$ pulumi import aws:s3/bucketNotification:BucketNotification bucket_notification bucket-name
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.