Class: AWSCDK::Scheduler::CfnSchedule::DeadLetterConfigProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Scheduler::CfnSchedule::DeadLetterConfigProperty

Defined in:

scheduler/cfn_schedule.rb

Overview

An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.

If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-deadletterconfig.html

Instance Attribute Summary

• #arn ⇒ String^? readonly

  The Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(arn: nil) ⇒ DeadLetterConfigProperty constructor

  A new instance of DeadLetterConfigProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(arn: nil) ⇒ DeadLetterConfigProperty

Returns a new instance of DeadLetterConfigProperty.

Parameters:

• arn (String, nil) (defaults to: nil) —

  The Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue.

# File 'scheduler/cfn_schedule.rb', line 769

def initialize(arn: nil)
  @arn = arn
  Jsii::Type.check_type(@arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn") unless @arn.nil?
end

Instance Attribute Details

#arn ⇒ String^? (readonly)

The Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-deadletterconfig.html#cfn-scheduler-schedule-deadletterconfig-arn

# File 'scheduler/cfn_schedule.rb', line 778

def arn
  @arn
end

Class Method Details

.jsii_properties ⇒ Object

# File 'scheduler/cfn_schedule.rb', line 780

def self.jsii_properties
  {
    :arn => "arn",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'scheduler/cfn_schedule.rb', line 786

def to_jsii
  result = {}
  result.merge!({
    "arn" => @arn,
  })
  result.compact
end