Class: Aws::DLM::Types::EventParameters

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

Overview

Note:

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

{
  event_type: "shareSnapshot", # required, accepts shareSnapshot
  snapshot_owner: ["AwsAccountId"], # required
  description_regex: "DescriptionRegex", # required
}

Specifies an event that triggers an event-based policy.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description_regexString

The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.

For example, specifying ^.*Created for policy: policy-1234567890abcdef0.*$ configures the policy to run only if snapshots created by policy policy-1234567890abcdef0 are shared with your account.

Returns:

  • (String)


598
599
600
601
602
603
604
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 598

class EventParameters < Struct.new(
  :event_type,
  :snapshot_owner,
  :description_regex)
  SENSITIVE = []
  include Aws::Structure
end

#event_typeString

The type of event. Currently, only snapshot sharing events are supported.

Returns:

  • (String)


598
599
600
601
602
603
604
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 598

class EventParameters < Struct.new(
  :event_type,
  :snapshot_owner,
  :description_regex)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_ownerArray<String>

The IDs of the Amazon Web Services accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified Amazon Web Services accounts shares a snapshot with your account.

Returns:

  • (Array<String>)


598
599
600
601
602
603
604
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 598

class EventParameters < Struct.new(
  :event_type,
  :snapshot_owner,
  :description_regex)
  SENSITIVE = []
  include Aws::Structure
end