Package software.amazon.awscdk.services.scheduler.alpha

Interface ScheduleTargetConfig

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ScheduleTargetConfig.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:11.886Z") @Stability(Experimental) public interface ScheduleTargetConfig extends software.amazon.jsii.JsiiSerializable
(experimental) Config of a Schedule Target used during initialization of Schedule.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.scheduler.alpha.*;
 import software.amazon.awscdk.services.iam.*;
 Role role;
 ScheduleTargetInput scheduleTargetInput;
 Object tags;
 ScheduleTargetConfig scheduleTargetConfig = ScheduleTargetConfig.builder()
         .arn("arn")
         .role(role)
         // the properties below are optional
         .deadLetterConfig(DeadLetterConfigProperty.builder()
                 .arn("arn")
                 .build())
         .ecsParameters(EcsParametersProperty.builder()
                 .taskDefinitionArn("taskDefinitionArn")
                 // the properties below are optional
                 .capacityProviderStrategy(List.of(CapacityProviderStrategyItemProperty.builder()
                         .capacityProvider("capacityProvider")
                         // the properties below are optional
                         .base(123)
                         .weight(123)
                         .build()))
                 .enableEcsManagedTags(false)
                 .enableExecuteCommand(false)
                 .group("group")
                 .launchType("launchType")
                 .networkConfiguration(NetworkConfigurationProperty.builder()
                         .awsvpcConfiguration(AwsVpcConfigurationProperty.builder()
                                 .subnets(List.of("subnets"))
                                 // the properties below are optional
                                 .assignPublicIp("assignPublicIp")
                                 .securityGroups(List.of("securityGroups"))
                                 .build())
                         .build())
                 .placementConstraints(List.of(PlacementConstraintProperty.builder()
                         .expression("expression")
                         .type("type")
                         .build()))
                 .placementStrategy(List.of(PlacementStrategyProperty.builder()
                         .field("field")
                         .type("type")
                         .build()))
                 .platformVersion("platformVersion")
                 .propagateTags("propagateTags")
                 .referenceId("referenceId")
                 .tags(tags)
                 .taskCount(123)
                 .build())
         .eventBridgeParameters(EventBridgeParametersProperty.builder()
                 .detailType("detailType")
                 .source("source")
                 .build())
         .input(scheduleTargetInput)
         .kinesisParameters(KinesisParametersProperty.builder()
                 .partitionKey("partitionKey")
                 .build())
         .retryPolicy(RetryPolicyProperty.builder()
                 .maximumEventAgeInSeconds(123)
                 .maximumRetryAttempts(123)
                 .build())
         .sageMakerPipelineParameters(SageMakerPipelineParametersProperty.builder()
                 .pipelineParameterList(List.of(SageMakerPipelineParameterProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .build())
         .sqsParameters(SqsParametersProperty.builder()
                 .messageGroupId("messageGroupId")
                 .build())
         .build();

  • Method Details

    • getArn

      @Stability(Experimental) @NotNull String getArn()
      (experimental) The Amazon Resource Name (ARN) of the target.

    • getRole

      @Stability(Experimental) @NotNull IRole getRole()
      (experimental) Role to use to invoke this event target.

    • getDeadLetterConfig

      @Stability(Experimental) @Nullable default CfnSchedule.DeadLetterConfigProperty getDeadLetterConfig()
      (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.\

    • getEcsParameters

      @Stability(Experimental) @Nullable default CfnSchedule.EcsParametersProperty getEcsParameters()
      (experimental) The templated target type for the Amazon ECS RunTask API Operation.

    • getEventBridgeParameters

      @Stability(Experimental) @Nullable default CfnSchedule.EventBridgeParametersProperty getEventBridgeParameters()
      (experimental) The templated target type for the EventBridge PutEvents API operation.

    • getInput

      @Stability(Experimental) @Nullable default ScheduleTargetInput getInput()
      (experimental) What input to pass to the target.

    • getKinesisParameters

      @Stability(Experimental) @Nullable default CfnSchedule.KinesisParametersProperty getKinesisParameters()
      (experimental) The templated target type for the Amazon Kinesis PutRecord API operation.

    • getRetryPolicy

      @Stability(Experimental) @Nullable default CfnSchedule.RetryPolicyProperty getRetryPolicy()
      (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.

    • getSageMakerPipelineParameters

      @Stability(Experimental) @Nullable default CfnSchedule.SageMakerPipelineParametersProperty getSageMakerPipelineParameters()
      (experimental) The templated target type for the Amazon SageMaker StartPipelineExecution API operation.

    • getSqsParameters

      @Stability(Experimental) @Nullable default CfnSchedule.SqsParametersProperty getSqsParameters()
      (experimental) The templated target type for the Amazon SQS SendMessage API Operation.

    • builder

      @Stability(Experimental) static ScheduleTargetConfig.Builder builder()
      Returns:
      a ScheduleTargetConfig.Builder of ScheduleTargetConfig