{ "fingerprint": "CFHXuGvl9kGkEs1PVc2IQpM3rirXqgsKoysknnqWlfc=", "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "dependencies": { "@aws-cdk/cdk": { "dependencies": { "@aws-cdk/cx-api": { "targets": { "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "cdk", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "@aws-cdk/cdk" } }, "version": "0.8.2" } }, "description": "Bucket Notifications API for AWS S3", "homepage": "https://github.com/awslabs/aws-cdk", "license": "Apache-2.0", "name": "@aws-cdk/aws-s3-notifications", "readme": { "markdown": "## S3 Bucket Notifications API\n\nThis module includes the API that constructs should implement in order to be\nable to be used as destinations for bucket notifications.\n\nTo implement the `IBucketNotificationDestination`, a construct should implement\na method `asBucketNotificationDestination(bucketArn, bucketId)` which registers\nthis resource as a destination for bucket notifications _for the specified\nbucket_ and returns the ARN of the destination and it's type.\n" }, "repository": { "type": "git", "url": "https://github.com/awslabs/aws-cdk.git" }, "schema": "jsii/1.0", "targets": { "java": { "maven": { "artifactId": "s3-notifications", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3.notifications" }, "js": { "npm": "@aws-cdk/aws-s3-notifications" } }, "types": { "@aws-cdk/aws-s3-notifications.BucketNotificationDestinationProps": { "assembly": "@aws-cdk/aws-s3-notifications", "datatype": true, "docs": { "comment": "Represents the properties of a notification destination." }, "fqn": "@aws-cdk/aws-s3-notifications.BucketNotificationDestinationProps", "kind": "interface", "name": "BucketNotificationDestinationProps", "namespace": "@aws-cdk/aws-s3-notifications", "properties": [ { "docs": { "comment": "The notification type." }, "immutable": true, "name": "type", "type": { "fqn": "@aws-cdk/aws-s3-notifications.BucketNotificationDestinationType" } }, { "docs": { "comment": "The ARN of the destination (i.e. Lambda, SNS, SQS)." }, "immutable": true, "name": "arn", "type": { "fqn": "@aws-cdk/cdk.Arn" } } ] }, "@aws-cdk/aws-s3-notifications.BucketNotificationDestinationType": { "assembly": "@aws-cdk/aws-s3-notifications", "docs": { "comment": "Supported types of notification destinations." }, "fqn": "@aws-cdk/aws-s3-notifications.BucketNotificationDestinationType", "kind": "enum", "members": [ { "name": "Lambda" }, { "name": "Queue" }, { "name": "Topic" } ], "name": "BucketNotificationDestinationType", "namespace": "@aws-cdk/aws-s3-notifications" }, "@aws-cdk/aws-s3-notifications.IBucketNotificationDestination": { "assembly": "@aws-cdk/aws-s3-notifications", "docs": { "comment": "Implemented by constructs that can be used as bucket notification destinations." }, "fqn": "@aws-cdk/aws-s3-notifications.IBucketNotificationDestination", "kind": "interface", "methods": [ { "docs": { "comment": "Registers this resource to receive notifications for the specified\nbucket. This method will only be called once for each destination/bucket\npair and the result will be cached, so there is no need to implement\nidempotency in each destination." }, "name": "asBucketNotificationDestination", "parameters": [ { "docs": { "comment": "The ARN of the bucket" }, "name": "bucketArn", "type": { "fqn": "@aws-cdk/cdk.Arn" } }, { "docs": { "comment": "A unique ID of this bucket in the stack" }, "name": "bucketId", "type": { "primitive": "string" } } ], "returns": { "fqn": "@aws-cdk/aws-s3-notifications.BucketNotificationDestinationProps" } } ], "name": "IBucketNotificationDestination", "namespace": "@aws-cdk/aws-s3-notifications" } }, "version": "0.8.2" }