Interface CfnBucket.IQueueConfigurationProperty

Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

Namespace: Amazon.CDK.AWS.S3

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IQueueConfigurationProperty

Syntax (vb)

Public Interface IQueueConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-queueconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.S3;

var queueConfigurationProperty = new QueueConfigurationProperty {
    Event = "event",
    Queue = "queue",

    // the properties below are optional
    Filter = new NotificationFilterProperty {
        S3Key = new S3KeyFilterProperty {
            Rules = new [] { new FilterRuleProperty {
                Name = "name",
                Value = "value"
            } }
        }
    }
};

Synopsis

Properties

Event	The Amazon S3 bucket event about which you want to publish messages to Amazon SQS.
Filter	The filtering rules that determine which objects trigger notifications.
Queue	The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.

Properties

Event

The Amazon S3 bucket event about which you want to publish messages to Amazon SQS.

string Event { get; }

Property Value

System.String

Remarks

For more information, see Supported Event Types in the Amazon S3 User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-queueconfiguration.html#cfn-s3-bucket-queueconfiguration-event

Filter

The filtering rules that determine which objects trigger notifications.

virtual object Filter { get; }

Property Value

System.Object

Remarks

For example, you can create a filter so that Amazon S3 sends notifications only when image files with a .jpg extension are added to the bucket. For more information, see Configuring event notifications using object key name filtering in the Amazon S3 User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-queueconfiguration.html#cfn-s3-bucket-queueconfiguration-filter

Queue

The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.

string Queue { get; }

Property Value

System.String

Remarks

FIFO queues are not allowed when enabling an SQS queue as the event notification destination.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-queueconfiguration.html#cfn-s3-bucket-queueconfiguration-queue