Class: AWSCDK::Scheduler::CfnSchedule::TargetProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
scheduler/cfn_schedule.rb

Overview

The schedule's target.

EventBridge Scheduler supports templated target that invoke common API operations, as well as universal targets that you can customize to invoke over 6,000 API operations across more than 270 services. You can only specify one templated or universal target for a schedule.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arn:, role_arn:, dead_letter_config: nil, ecs_parameters: nil, event_bridge_parameters: nil, input: nil, kinesis_parameters: nil, retry_policy: nil, sage_maker_pipeline_parameters: nil, sqs_parameters: nil) ⇒ TargetProperty

Returns a new instance of TargetProperty.

Parameters:



1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
 
# File 'scheduler/cfn_schedule.rb', line 1406

def initialize(arn:, role_arn:, dead_letter_config: nil, ecs_parameters: nil, event_bridge_parameters: nil, input: nil, kinesis_parameters: nil, retry_policy: nil, sage_maker_pipeline_parameters: nil, sqs_parameters: nil)
  @arn = arn
  Jsii::Type.check_type(@arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @dead_letter_config = dead_letter_config.is_a?(Hash) ? ::AWSCDK::Scheduler::CfnSchedule::DeadLetterConfigProperty.new(**dead_letter_config.transform_keys(&:to_sym)) : dead_letter_config
  Jsii::Type.check_type(@dead_letter_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zY2hlZHVsZXIuQ2ZuU2NoZWR1bGUuRGVhZExldHRlckNvbmZpZ1Byb3BlcnR5In1dfX0=")), "deadLetterConfig") unless @dead_letter_config.nil?
  @ecs_parameters = ecs_parameters.is_a?(Hash) ? ::AWSCDK::Scheduler::CfnSchedule::ECSParametersProperty.new(**ecs_parameters.transform_keys(&:to_sym)) : ecs_parameters
  Jsii::Type.check_type(@ecs_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zY2hlZHVsZXIuQ2ZuU2NoZWR1bGUuRWNzUGFyYW1ldGVyc1Byb3BlcnR5In1dfX0=")), "ecsParameters") unless @ecs_parameters.nil?
  @event_bridge_parameters = event_bridge_parameters.is_a?(Hash) ? ::AWSCDK::Scheduler::CfnSchedule::EventBridgeParametersProperty.new(**event_bridge_parameters.transform_keys(&:to_sym)) : event_bridge_parameters
  Jsii::Type.check_type(@event_bridge_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zY2hlZHVsZXIuQ2ZuU2NoZWR1bGUuRXZlbnRCcmlkZ2VQYXJhbWV0ZXJzUHJvcGVydHkifV19fQ==")), "eventBridgeParameters") unless @event_bridge_parameters.nil?
  @input = input
  Jsii::Type.check_type(@input, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "input") unless @input.nil?
  @kinesis_parameters = kinesis_parameters.is_a?(Hash) ? ::AWSCDK::Scheduler::CfnSchedule::KinesisParametersProperty.new(**kinesis_parameters.transform_keys(&:to_sym)) : kinesis_parameters
  Jsii::Type.check_type(@kinesis_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zY2hlZHVsZXIuQ2ZuU2NoZWR1bGUuS2luZXNpc1BhcmFtZXRlcnNQcm9wZXJ0eSJ9XX19")), "kinesisParameters") unless @kinesis_parameters.nil?
  @retry_policy = retry_policy.is_a?(Hash) ? ::AWSCDK::Scheduler::CfnSchedule::RetryPolicyProperty.new(**retry_policy.transform_keys(&:to_sym)) : retry_policy
  Jsii::Type.check_type(@retry_policy, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zY2hlZHVsZXIuQ2ZuU2NoZWR1bGUuUmV0cnlQb2xpY3lQcm9wZXJ0eSJ9XX19")), "retryPolicy") unless @retry_policy.nil?
  @sage_maker_pipeline_parameters = sage_maker_pipeline_parameters.is_a?(Hash) ? ::AWSCDK::Scheduler::CfnSchedule::SageMakerPipelineParametersProperty.new(**sage_maker_pipeline_parameters.transform_keys(&:to_sym)) : sage_maker_pipeline_parameters
  Jsii::Type.check_type(@sage_maker_pipeline_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zY2hlZHVsZXIuQ2ZuU2NoZWR1bGUuU2FnZU1ha2VyUGlwZWxpbmVQYXJhbWV0ZXJzUHJvcGVydHkifV19fQ==")), "sageMakerPipelineParameters") unless @sage_maker_pipeline_parameters.nil?
  @sqs_parameters = sqs_parameters.is_a?(Hash) ? ::AWSCDK::Scheduler::CfnSchedule::SQSParametersProperty.new(**sqs_parameters.transform_keys(&:to_sym)) : sqs_parameters
  Jsii::Type.check_type(@sqs_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zY2hlZHVsZXIuQ2ZuU2NoZWR1bGUuU3FzUGFyYW1ldGVyc1Byb3BlcnR5In1dfX0=")), "sqsParameters") unless @sqs_parameters.nil?
end

Instance Attribute Details

#arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the target.

Returns:

  • (String)

See Also:



1433
1434
1435
 
# File 'scheduler/cfn_schedule.rb', line 1433

def arn
  @arn
end

#dead_letter_config ⇒ AWSCDK::IResolvable, ... (readonly)

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.

Returns:

See Also:



1445
1446
1447
 
# File 'scheduler/cfn_schedule.rb', line 1445

def dead_letter_config
  @dead_letter_config
end

#ecs_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

The templated target type for the Amazon ECS RunTask API operation.

Returns:

See Also:



1450
1451
1452
 
# File 'scheduler/cfn_schedule.rb', line 1450

def ecs_parameters
  @ecs_parameters
end

#event_bridge_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

The templated target type for the EventBridge PutEvents API operation.

Returns:

See Also:



1455
1456
1457
 
# File 'scheduler/cfn_schedule.rb', line 1455

def event_bridge_parameters
  @event_bridge_parameters
end

#input ⇒ String? (readonly)

The text, or well-formed JSON, passed to the target.

If you are configuring a templated Lambda , AWS Step Functions , or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, Amazon EventBridge Scheduler delivers a default notification to the target.

Returns:

  • (String, nil)

See Also:



1462
1463
1464
 
# File 'scheduler/cfn_schedule.rb', line 1462

def input
  @input
end

#kinesis_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

The templated target type for the Amazon Kinesis PutRecord API operation.

Returns:

See Also:



1467
1468
1469
 
# File 'scheduler/cfn_schedule.rb', line 1467

def kinesis_parameters
  @kinesis_parameters
end

#retry_policy ⇒ AWSCDK::IResolvable, ... (readonly)

A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.

Returns:

See Also:



1472
1473
1474
 
# File 'scheduler/cfn_schedule.rb', line 1472

def retry_policy
  @retry_policy
end

#role_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.

Returns:

  • (String)

See Also:



1438
1439
1440
 
# File 'scheduler/cfn_schedule.rb', line 1438

def role_arn
  @role_arn
end

#sage_maker_pipeline_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

The templated target type for the Amazon SageMaker StartPipelineExecution API operation.

Returns:

See Also:



1477
1478
1479
 
# File 'scheduler/cfn_schedule.rb', line 1477

def sage_maker_pipeline_parameters
  @sage_maker_pipeline_parameters
end

#sqs_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide .

Returns:

See Also:



1482
1483
1484
 
# File 'scheduler/cfn_schedule.rb', line 1482

def sqs_parameters
  @sqs_parameters
end

Class Method Details

.jsii_properties ⇒ Object 



1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
 
# File 'scheduler/cfn_schedule.rb', line 1484

def self.jsii_properties
  {
    :arn => "arn",
    :role_arn => "roleArn",
    :dead_letter_config => "deadLetterConfig",
    :ecs_parameters => "ecsParameters",
    :event_bridge_parameters => "eventBridgeParameters",
    :input => "input",
    :kinesis_parameters => "kinesisParameters",
    :retry_policy => "retryPolicy",
    :sage_maker_pipeline_parameters => "sageMakerPipelineParameters",
    :sqs_parameters => "sqsParameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
 
# File 'scheduler/cfn_schedule.rb', line 1499

def to_jsii
  result = {}
  result.merge!({
    "arn" => @arn,
    "roleArn" => @role_arn,
    "deadLetterConfig" => @dead_letter_config,
    "ecsParameters" => @ecs_parameters,
    "eventBridgeParameters" => @event_bridge_parameters,
    "input" => @input,
    "kinesisParameters" => @kinesis_parameters,
    "retryPolicy" => @retry_policy,
    "sageMakerPipelineParameters" => @sage_maker_pipeline_parameters,
    "sqsParameters" => @sqs_parameters,
  })
  result.compact
end