Package-level declarations

Types

Link copied to clipboard
data class GetScheduleGroupResult(val arn: String? = null, val creationDate: String? = null, val lastModificationDate: String? = null, val state: ScheduleGroupState? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetScheduleResult(val arn: String? = null, val description: String? = null, val endDate: String? = null, val flexibleTimeWindow: ScheduleFlexibleTimeWindow? = null, val groupName: String? = null, val kmsKeyArn: String? = null, val scheduleExpression: String? = null, val scheduleExpressionTimezone: String? = null, val startDate: String? = null, val state: ScheduleState? = null, val target: ScheduleTarget? = null)
Link copied to clipboard
data class ScheduleAwsVpcConfiguration(val assignPublicIp: ScheduleAssignPublicIp? = null, val securityGroups: List<String>? = null, val subnets: List<String>)

This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.

Link copied to clipboard
data class ScheduleCapacityProviderStrategyItem(val base: Double? = null, val capacityProvider: String, val weight: Double? = null)

The details of a capacity provider strategy.

Link copied to clipboard
data class ScheduleDeadLetterConfig(val arn: String? = null)

A DeadLetterConfig object that contains information about a dead-letter queue configuration.

Link copied to clipboard
data class ScheduleEcsParameters(val capacityProviderStrategy: List<ScheduleCapacityProviderStrategyItem>? = null, val enableEcsManagedTags: Boolean? = null, val enableExecuteCommand: Boolean? = null, val group: String? = null, val launchType: ScheduleLaunchType? = null, val networkConfiguration: ScheduleNetworkConfiguration? = null, val placementConstraints: List<SchedulePlacementConstraint>? = null, val placementStrategy: List<SchedulePlacementStrategy>? = null, val platformVersion: String? = null, val propagateTags: SchedulePropagateTags? = null, val referenceId: String? = null, val tags: List<Map<String, String>>? = null, val taskCount: Double? = null, val taskDefinitionArn: String)

The custom parameters to be used when the target is an Amazon ECS task.

Link copied to clipboard
data class ScheduleEventBridgeParameters(val detailType: String, val source: String)

EventBridge PutEvent predefined target type.

Link copied to clipboard
data class ScheduleFlexibleTimeWindow(val maximumWindowInMinutes: Double? = null, val mode: ScheduleFlexibleTimeWindowMode)

Flexible time window allows configuration of a window within which a schedule can be invoked

Link copied to clipboard
data class ScheduleKinesisParameters(val partitionKey: String)

The custom parameter you can use to control the shard to which EventBridge Scheduler sends the event.

Link copied to clipboard
data class ScheduleNetworkConfiguration(val awsvpcConfiguration: ScheduleAwsVpcConfiguration? = null)

This structure specifies the network configuration for an ECS task.

Link copied to clipboard
data class SchedulePlacementConstraint(val expression: String? = null, val type: SchedulePlacementConstraintType? = null)

An object representing a constraint on task placement.

Link copied to clipboard
data class SchedulePlacementStrategy(val field: String? = null, val type: SchedulePlacementStrategyType? = null)

The task placement strategy for a task or service.

Link copied to clipboard
data class ScheduleRetryPolicy(val maximumEventAgeInSeconds: Double? = null, val maximumRetryAttempts: Double? = null)

A RetryPolicy object that includes information about the retry policy settings.

Link copied to clipboard
data class ScheduleSageMakerPipelineParameter(val name: String, val value: String)

Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.

Link copied to clipboard
data class ScheduleSageMakerPipelineParameters(val pipelineParameterList: List<ScheduleSageMakerPipelineParameter>? = null)

These are custom parameters to use when the target is a SageMaker Model Building Pipeline that starts based on AWS EventBridge Scheduler schedules.

Link copied to clipboard
data class ScheduleSqsParameters(val messageGroupId: String? = null)

Contains the message group ID to use when the target is a FIFO queue. If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.

Link copied to clipboard
data class ScheduleTarget(val arn: String, val deadLetterConfig: ScheduleDeadLetterConfig? = null, val ecsParameters: ScheduleEcsParameters? = null, val eventBridgeParameters: ScheduleEventBridgeParameters? = null, val input: String? = null, val kinesisParameters: ScheduleKinesisParameters? = null, val retryPolicy: ScheduleRetryPolicy? = null, val roleArn: String, val sageMakerPipelineParameters: ScheduleSageMakerPipelineParameters? = null, val sqsParameters: ScheduleSqsParameters? = null)

The schedule target.