Class: Aws::S3::Types::TopicConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass TopicConfiguration data as a hash:

{
  id: "NotificationId",
  topic_arn: "TopicArn", # required
  events: ["s3:ReducedRedundancyLostObject"], # required, accepts s3:ReducedRedundancyLostObject, s3:ObjectCreated:*, s3:ObjectCreated:Put, s3:ObjectCreated:Post, s3:ObjectCreated:Copy, s3:ObjectCreated:CompleteMultipartUpload, s3:ObjectRemoved:*, s3:ObjectRemoved:Delete, s3:ObjectRemoved:DeleteMarkerCreated, s3:ObjectRestore:*, s3:ObjectRestore:Post, s3:ObjectRestore:Completed, s3:Replication:*, s3:Replication:OperationFailedReplication, s3:Replication:OperationNotTracked, s3:Replication:OperationMissedThreshold, s3:Replication:OperationReplicatedAfterThreshold
  filter: {
    key: {
      filter_rules: [
        {
          name: "prefix", # accepts prefix, suffix
          value: "FilterRuleValue",
        },
      ],
    },
  },
}

A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#eventsArray<String>

The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in the Amazon Simple Storage Service Developer Guide.

Returns:

  • (Array<String>)


12588
12589
12590
12591
12592
12593
12594
12595
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12588

class TopicConfiguration < Struct.new(
  :id,
  :topic_arn,
  :events,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#filterTypes::NotificationConfigurationFilter

Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.



12588
12589
12590
12591
12592
12593
12594
12595
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12588

class TopicConfiguration < Struct.new(
  :id,
  :topic_arn,
  :events,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#idString

An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

Returns:

  • (String)


12588
12589
12590
12591
12592
12593
12594
12595
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12588

class TopicConfiguration < Struct.new(
  :id,
  :topic_arn,
  :events,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#topic_arnString

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

Returns:

  • (String)


12588
12589
12590
12591
12592
12593
12594
12595
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 12588

class TopicConfiguration < Struct.new(
  :id,
  :topic_arn,
  :events,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end