Package software.amazon.awscdk.services.ecs.patterns

Interface ScheduledTaskImageProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ScheduledEc2TaskImageOptions, ScheduledFargateTaskImageOptions

All Known Implementing Classes:

ScheduledEc2TaskImageOptions.Jsii$Proxy, ScheduledFargateTaskImageOptions.Jsii$Proxy, ScheduledTaskImageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-27T16:50:57.221Z")
@Stability(Stable)
public interface ScheduledTaskImageProps
extends software.amazon.jsii.JsiiSerializable

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.ecs.*;
 import software.amazon.awscdk.services.ecs.patterns.*;
 ContainerImage containerImage;
 LogDriver logDriver;
 Secret secret;
 ScheduledTaskImageProps scheduledTaskImageProps = ScheduledTaskImageProps.builder()
         .image(containerImage)
         // the properties below are optional
         .command(List.of("command"))
         .containerName("containerName")
         .environment(Map.of(
                 "environmentKey", "environment"))
         .logDriver(logDriver)
         .secrets(Map.of(
                 "secretsKey", secret))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ScheduledTaskImageProps.Builder	A builder for ScheduledTaskImageProps
static final class	ScheduledTaskImageProps.Jsii$Proxy	An implementation for ScheduledTaskImageProps

Method Summary

Modifier and Type	Method	Description
static ScheduledTaskImageProps.Builder	builder()
default List<String>	getCommand()	The command that is passed to the container.
default String	getContainerName()	Optional name for the container added.
default Map<String,String>	getEnvironment()	The environment variables to pass to the container.
ContainerImage	getImage()	The image used to start a container.
default LogDriver	getLogDriver()	The log driver to use.
default Map<String,Secret>	getSecrets()	The secret to expose to the container as an environment variable.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getImage

@Stability(Stable)
@NotNull
ContainerImage getImage()

The image used to start a container.

Image or taskDefinition must be specified, but not both.

Default: - none

getCommand

@Stability(Stable)
@Nullable
default List<String> getCommand()

The command that is passed to the container.

If you provide a shell command as a single string, you have to quote command-line arguments.

Default: - CMD value built into container image.

getContainerName

@Stability(Stable)
@Nullable
default String getContainerName()

Optional name for the container added.

Default: - ScheduledContainer

getEnvironment

@Stability(Stable)
@Nullable
default Map<String,String> getEnvironment()

The environment variables to pass to the container.

Default: none

getLogDriver

@Stability(Stable)
@Nullable
default LogDriver getLogDriver()

The log driver to use.

Default: - AwsLogDriver if enableLogging is true

getSecrets

@Stability(Stable)
@Nullable
default Map<String,Secret> getSecrets()

The secret to expose to the container as an environment variable.

Default: - No secret environment variables.

builder

@Stability(Stable)
static ScheduledTaskImageProps.Builder builder()

Returns:

a ScheduledTaskImageProps.Builder of ScheduledTaskImageProps