Package software.amazon.awscdk.services.imagebuilder.alpha

Interface ComponentDocumentLoop

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ComponentDocumentLoop.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:34.441Z")
@Stability(Experimental)
public interface ComponentDocumentLoop
extends software.amazon.jsii.JsiiSerializable

(experimental) The looping construct of a component defines a repeated sequence of instructions.

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.imagebuilder.alpha.*;
 ComponentDocumentLoop componentDocumentLoop = ComponentDocumentLoop.builder()
         .for(ComponentDocumentForLoop.builder()
                 .end(123)
                 .start(123)
                 .updateBy(123)
                 .build())
         .forEach(List.of("forEach"))
         .name("name")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ComponentDocumentLoop.Builder	builder()
default List<String>	getForEach()	(experimental) The forEach loop iterates on an explicit list of values, which can be strings and chained expressions.
default ComponentDocumentForLoop	getForValue()	(experimental) The for loop iterates on a range of integers specified within a boundary outlined by the start and end of the variables.
default String	getName()	(experimental) The name of the loop, which can be used to reference.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getForValue

@Stability(Experimental)
@Nullable
default ComponentDocumentForLoop getForValue()

(experimental) The for loop iterates on a range of integers specified within a boundary outlined by the start and end of the variables.

Default: - none if `forEach` is provided. otherwise, `for` is required.

getForEach

@Stability(Experimental)
@Nullable
default List<String> getForEach()

(experimental) The forEach loop iterates on an explicit list of values, which can be strings and chained expressions.

Default: - none if `for` is provided. otherwise, `forEach` is required.

getName

@Stability(Experimental)
@Nullable
default String getName()

(experimental) The name of the loop, which can be used to reference.

Default: loop

builder

@Stability(Experimental)
static ComponentDocumentLoop.Builder builder()

Returns:

a ComponentDocumentLoop.Builder of ComponentDocumentLoop