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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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, s3:ObjectRestore:Delete, s3:LifecycleTransition, s3:IntelligentTiering, s3:ObjectAcl:Put, s3:LifecycleExpiration:*, s3:LifecycleExpiration:Delete, s3:LifecycleExpiration:DeleteMarkerCreated, s3:ObjectTagging:*, s3:ObjectTagging:Put, s3:ObjectTagging:Delete
  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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#events ⇒ Array<String>

The Amazon S3 bucket event about which to send notifications. For more information, see [Supported Event Types] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html

Returns:

  • (Array<String>) 


16421
16422
16423
16424
16425
16426
16427
16428
 
# File 'lib/aws-sdk-s3/types.rb', line 16421

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

#filter ⇒ Types::NotificationConfigurationFilter

Specifies object key name filtering rules. For information about key name filtering, see [Configuring Event Notifications] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html

Returns:



16421
16422
16423
16424
16425
16426
16427
16428
 
# File 'lib/aws-sdk-s3/types.rb', line 16421

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

#id ⇒ String

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

Returns:

  • (String) 


16421
16422
16423
16424
16425
16426
16427
16428
 
# File 'lib/aws-sdk-s3/types.rb', line 16421

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

#topic_arn ⇒ String

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) 


16421
16422
16423
16424
16425
16426
16427
16428
 
# File 'lib/aws-sdk-s3/types.rb', line 16421

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