Class UniversalTargetProps

(experimental) Properties for a Universal Target.

Inheritance
System.Object
UniversalTargetProps
Namespace: Amazon.CDK.AWS.Scheduler.Targets.Alpha
Assembly: Amazon.CDK.AWS.Scheduler.Targets.Alpha.dll
Syntax (csharp)
public class UniversalTargetProps : Object, IUniversalTargetProps, IScheduleTargetBaseProps
Syntax (vb)
Public Class UniversalTargetProps
    Inherits Object
    Implements IUniversalTargetProps, IScheduleTargetBaseProps
Remarks

Stability: Experimental

ExampleMetadata: infused

Examples
new Schedule(this, "Schedule", new ScheduleProps {
    Schedule = ScheduleExpression.Cron(new CronOptionsWithTimezone {
        Minute = "0",
        Hour = "0"
    }),
    Target = new Universal(new UniversalTargetProps {
        Service = "rds",
        Action = "stopDBCluster",
        Input = ScheduleTargetInput.FromObject(new Dictionary<string, string> {
            { "DbClusterIdentifier", "my-db" }
        })
    })
});

Synopsis

Constructors

UniversalTargetProps()

Properties

Action

(experimental) The API action to call. Must be camelCase.
DeadLetterQueue

(experimental) The SQS queue to be used as deadLetterQueue.
Input

(experimental) Input passed to the target.
MaxEventAge

(experimental) The maximum age of a request that Scheduler sends to a target for processing.
PolicyStatements

(experimental) The IAM policy statements needed to invoke the target. These statements are attached to the Scheduler's role.
RetryAttempts

(experimental) The maximum number of times to retry when the target returns an error.
Role

(experimental) An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf.
Service

(experimental) The AWS service to call.

Constructors

UniversalTargetProps()

public UniversalTargetProps()

Properties

Action

(experimental) The API action to call. Must be camelCase.

public string Action { get; set; }
Property Value

System.String

Remarks

You cannot use read-only API actions such as common GET operations.

Stability: Experimental

See: https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-targets-universal.html#unsupported-api-actions

DeadLetterQueue

(experimental) The SQS queue to be used as deadLetterQueue.

public IQueue DeadLetterQueue { get; set; }
Property Value

IQueue

Remarks

The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.

Default: - no dead-letter queue

Stability: Experimental

Input

(experimental) Input passed to the target.

public ScheduleTargetInput Input { get; set; }
Property Value

ScheduleTargetInput

Remarks

Default: - no input.

Stability: Experimental

MaxEventAge

(experimental) The maximum age of a request that Scheduler sends to a target for processing.

public Duration MaxEventAge { get; set; }
Property Value

Duration

Remarks

Minimum value of 60. Maximum value of 86400.

Default: Duration.hours(24)

Stability: Experimental

PolicyStatements

(experimental) The IAM policy statements needed to invoke the target. These statements are attached to the Scheduler's role.

public PolicyStatement[] PolicyStatements { get; set; }
Property Value

PolicyStatement[]

Remarks

Note that the default may not be the correct actions as not all AWS services follows the same IAM action pattern, or there may be more actions needed to invoke the target.

Default: - Policy with service:action action only.

Stability: Experimental

RetryAttempts

(experimental) The maximum number of times to retry when the target returns an error.

public Nullable<double> RetryAttempts { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

Minimum value of 0. Maximum value of 185.

Default: 185

Stability: Experimental

Role

(experimental) An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf.

public IRole Role { get; set; }
Property Value

IRole

Remarks

If none provided templates target will automatically create an IAM role with all the minimum necessary permissions to interact with the templated target. If you wish you may specify your own IAM role, then the templated targets will grant minimal required permissions.

Default: - created by target

Stability: Experimental

Service

(experimental) The AWS service to call.

public string Service { get; set; }
Property Value

System.String

Remarks

This must be in lowercase.

Stability: Experimental

Implements