Package software.amazon.awscdk.services.ecs

Enum Class PropagatedTagSource

java.lang.Object

java.lang.Enum<PropagatedTagSource>

software.amazon.awscdk.services.ecs.PropagatedTagSource

All Implemented Interfaces:

Serializable, Comparable<PropagatedTagSource>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
           date="2025-04-22T23:08:11.737Z")
@Stability(Stable)
public enum PropagatedTagSource
extends Enum<PropagatedTagSource>

Propagate tags from either service or task definition.

Example:

 IVpc vpc = Vpc.fromLookup(this, "Vpc", VpcLookupOptions.builder()
         .isDefault(true)
         .build());
 Cluster cluster = Cluster.Builder.create(this, "FargateCluster").vpc(vpc).build();
 TaskDefinition taskDefinition = TaskDefinition.Builder.create(this, "TD")
         .memoryMiB("512")
         .cpu("256")
         .compatibility(Compatibility.FARGATE)
         .build();
 ContainerDefinition containerDefinition = taskDefinition.addContainer("TheContainer", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("foo/bar"))
         .memoryLimitMiB(256)
         .build());
 EcsRunTask runTask = EcsRunTask.Builder.create(this, "RunFargate")
         .integrationPattern(IntegrationPattern.RUN_JOB)
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .assignPublicIp(true)
         .containerOverrides(List.of(ContainerOverride.builder()
                 .containerDefinition(containerDefinition)
                 .environment(List.of(TaskEnvironmentVariable.builder().name("SOME_KEY").value(JsonPath.stringAt("$.SomeKey")).build()))
                 .build()))
         .launchTarget(new EcsFargateLaunchTarget())
         .propagatedTagSource(PropagatedTagSource.TASK_DEFINITION)
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NONE	Do not propagate.
SERVICE	Propagate tags from service.
TASK_DEFINITION	Propagate tags from task definition.

Method Summary

Modifier and Type	Method	Description
static PropagatedTagSource	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PropagatedTagSource[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SERVICE

@Stability(Stable)
public static final PropagatedTagSource SERVICE

Propagate tags from service.

TASK_DEFINITION

@Stability(Stable)
public static final PropagatedTagSource TASK_DEFINITION

Propagate tags from task definition.

NONE

@Stability(Stable)
public static final PropagatedTagSource NONE

Do not propagate.

Method Details

values

public static PropagatedTagSource[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PropagatedTagSource valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null