Class ScheduleTargetConfig

(experimental) Config of a Schedule Target used during initialization of Schedule.

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

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Scheduler.Alpha;
using Amazon.CDK.AWS.IAM;

Role role;
ScheduleTargetInput scheduleTargetInput;
var tags;

var scheduleTargetConfig = new ScheduleTargetConfig {
    Arn = "arn",
    Role = role,

    // the properties below are optional
    DeadLetterConfig = new DeadLetterConfigProperty {
        Arn = "arn"
    },
    EcsParameters = new EcsParametersProperty {
        TaskDefinitionArn = "taskDefinitionArn",

        // the properties below are optional
        CapacityProviderStrategy = new [] { new CapacityProviderStrategyItemProperty {
            CapacityProvider = "capacityProvider",

            // the properties below are optional
            Base = 123,
            Weight = 123
        } },
        EnableEcsManagedTags = false,
        EnableExecuteCommand = false,
        Group = "group",
        LaunchType = "launchType",
        NetworkConfiguration = new NetworkConfigurationProperty {
            AwsvpcConfiguration = new AwsVpcConfigurationProperty {
                Subnets = new [] { "subnets" },

                // the properties below are optional
                AssignPublicIp = "assignPublicIp",
                SecurityGroups = new [] { "securityGroups" }
            }
        },
        PlacementConstraints = new [] { new PlacementConstraintProperty {
            Expression = "expression",
            Type = "type"
        } },
        PlacementStrategy = new [] { new PlacementStrategyProperty {
            Field = "field",
            Type = "type"
        } },
        PlatformVersion = "platformVersion",
        PropagateTags = "propagateTags",
        ReferenceId = "referenceId",
        Tags = tags,
        TaskCount = 123
    },
    EventBridgeParameters = new EventBridgeParametersProperty {
        DetailType = "detailType",
        Source = "source"
    },
    Input = scheduleTargetInput,
    KinesisParameters = new KinesisParametersProperty {
        PartitionKey = "partitionKey"
    },
    RetryPolicy = new RetryPolicyProperty {
        MaximumEventAgeInSeconds = 123,
        MaximumRetryAttempts = 123
    },
    SageMakerPipelineParameters = new SageMakerPipelineParametersProperty {
        PipelineParameterList = new [] { new SageMakerPipelineParameterProperty {
            Name = "name",
            Value = "value"
        } }
    },
    SqsParameters = new SqsParametersProperty {
        MessageGroupId = "messageGroupId"
    }
};

Synopsis

Constructors

ScheduleTargetConfig()

Properties

Arn

(experimental) The Amazon Resource Name (ARN) of the target.
DeadLetterConfig

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

(experimental) The templated target type for the Amazon ECS RunTask API Operation.
EventBridgeParameters

(experimental) The templated target type for the EventBridge PutEvents API operation.
Input

(experimental) What input to pass to the target.
KinesisParameters

(experimental) The templated target type for the Amazon Kinesis PutRecord API operation.
RetryPolicy

(experimental) 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.
Role

(experimental) Role to use to invoke this event target.
SageMakerPipelineParameters

(experimental) The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
SqsParameters

(experimental) The templated target type for the Amazon SQS SendMessage API Operation.

Constructors

ScheduleTargetConfig()

public ScheduleTargetConfig()

Properties

Arn

(experimental) The Amazon Resource Name (ARN) of the target.

public string Arn { get; set; }
Property Value

System.String

Remarks

Stability: Experimental

DeadLetterConfig

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

public CfnSchedule.IDeadLetterConfigProperty DeadLetterConfig { get; set; }
Property Value

CfnSchedule.IDeadLetterConfigProperty

Remarks

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

Stability: Experimental

EcsParameters

(experimental) The templated target type for the Amazon ECS RunTask API Operation.

public CfnSchedule.IEcsParametersProperty EcsParameters { get; set; }
Property Value

CfnSchedule.IEcsParametersProperty

Remarks

Stability: Experimental

EventBridgeParameters

(experimental) The templated target type for the EventBridge PutEvents API operation.

public CfnSchedule.IEventBridgeParametersProperty EventBridgeParameters { get; set; }
Property Value

CfnSchedule.IEventBridgeParametersProperty

Remarks

Stability: Experimental

Input

(experimental) What input to pass to the target.

public ScheduleTargetInput Input { get; set; }
Property Value

ScheduleTargetInput

Remarks

Stability: Experimental

KinesisParameters

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

public CfnSchedule.IKinesisParametersProperty KinesisParameters { get; set; }
Property Value

CfnSchedule.IKinesisParametersProperty

Remarks

Stability: Experimental

RetryPolicy

(experimental) 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.

public CfnSchedule.IRetryPolicyProperty RetryPolicy { get; set; }
Property Value

CfnSchedule.IRetryPolicyProperty

Remarks

Stability: Experimental

Role

(experimental) Role to use to invoke this event target.

public IRole Role { get; set; }
Property Value

IRole

Remarks

Stability: Experimental

SageMakerPipelineParameters

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

public CfnSchedule.ISageMakerPipelineParametersProperty SageMakerPipelineParameters { get; set; }
Property Value

CfnSchedule.ISageMakerPipelineParametersProperty

Remarks

Stability: Experimental

SqsParameters

(experimental) The templated target type for the Amazon SQS SendMessage API Operation.

public CfnSchedule.ISqsParametersProperty SqsParameters { get; set; }
Property Value

CfnSchedule.ISqsParametersProperty

Remarks

Stability: Experimental

Implements