ScheduleTargetConfig

class aws_cdk.aws_scheduler_alpha.ScheduleTargetConfig(*, arn, role, dead_letter_config=None, ecs_parameters=None, event_bridge_parameters=None, input=None, kinesis_parameters=None, retry_policy=None, sage_maker_pipeline_parameters=None, sqs_parameters=None)

Bases: object

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

Parameters:

arn (str) – (experimental) The Amazon Resource Name (ARN) of the target.
role (IRole) – (experimental) Role to use to invoke this event target.
dead_letter_config (Union[DeadLetterConfigProperty, Dict[str, Any], None]) – (experimental) 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.
ecs_parameters (Union[EcsParametersProperty, Dict[str, Any], None]) – (experimental) The templated target type for the Amazon ECS RunTask API Operation.
event_bridge_parameters (Union[EventBridgeParametersProperty, Dict[str, Any], None]) – (experimental) The templated target type for the EventBridge PutEvents API operation.
input (Optional[ScheduleTargetInput]) – (experimental) What input to pass to the target.
kinesis_parameters (Union[KinesisParametersProperty, Dict[str, Any], None]) – (experimental) The templated target type for the Amazon Kinesis PutRecord API operation.
retry_policy (Union[RetryPolicyProperty, Dict[str, Any], None]) – (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.
sage_maker_pipeline_parameters (Union[SageMakerPipelineParametersProperty, Dict[str, Any], None]) – (experimental) The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
sqs_parameters (Union[SqsParametersProperty, Dict[str, Any], None]) – (experimental) The templated target type for the Amazon SQS SendMessage API Operation.

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_scheduler_alpha as scheduler_alpha
from aws_cdk import aws_iam as iam

# role: iam.Role
# schedule_target_input: scheduler_alpha.ScheduleTargetInput
# tags: Any

schedule_target_config = scheduler_alpha.ScheduleTargetConfig(
    arn="arn",
    role=role,

    # the properties below are optional
    dead_letter_config=DeadLetterConfigProperty(
        arn="arn"
    ),
    ecs_parameters=EcsParametersProperty(
        task_definition_arn="taskDefinitionArn",

        # the properties below are optional
        capacity_provider_strategy=[CapacityProviderStrategyItemProperty(
            capacity_provider="capacityProvider",

            # the properties below are optional
            base=123,
            weight=123
        )],
        enable_ecs_managed_tags=False,
        enable_execute_command=False,
        group="group",
        launch_type="launchType",
        network_configuration=NetworkConfigurationProperty(
            awsvpc_configuration=AwsVpcConfigurationProperty(
                subnets=["subnets"],

                # the properties below are optional
                assign_public_ip="assignPublicIp",
                security_groups=["securityGroups"]
            )
        ),
        placement_constraints=[PlacementConstraintProperty(
            expression="expression",
            type="type"
        )],
        placement_strategy=[PlacementStrategyProperty(
            field="field",
            type="type"
        )],
        platform_version="platformVersion",
        propagate_tags="propagateTags",
        reference_id="referenceId",
        tags=tags,
        task_count=123
    ),
    event_bridge_parameters=EventBridgeParametersProperty(
        detail_type="detailType",
        source="source"
    ),
    input=schedule_target_input,
    kinesis_parameters=KinesisParametersProperty(
        partition_key="partitionKey"
    ),
    retry_policy=RetryPolicyProperty(
        maximum_event_age_in_seconds=123,
        maximum_retry_attempts=123
    ),
    sage_maker_pipeline_parameters=SageMakerPipelineParametersProperty(
        pipeline_parameter_list=[SageMakerPipelineParameterProperty(
            name="name",
            value="value"
        )]
    ),
    sqs_parameters=SqsParametersProperty(
        message_group_id="messageGroupId"
    )
)

Attributes

arn

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

Stability:: experimental

dead_letter_config

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

Stability:: experimental

ecs_parameters

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

Stability:: experimental

event_bridge_parameters

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

Stability:: experimental

input

(experimental) What input to pass to the target.

Stability:: experimental

kinesis_parameters

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

Stability:: experimental

retry_policy

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

Stability:: experimental

role

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

Stability:: experimental

sage_maker_pipeline_parameters

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

Stability:: experimental

sqs_parameters

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

Stability:: experimental