AWS CDK Reference

Appearance

v2.276.0

Experimental

@aws-cdk/aws-imagebuilder-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ComponentDocumentLoop Struct ​

The looping construct of a component defines a repeated sequence of instructions.

Stability
Experimental
Source
lib/component.ts

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as imagebuilder_alpha from '@aws-cdk/aws-imagebuilder-alpha';
const componentDocumentLoop: imagebuilder_alpha.ComponentDocumentLoop = {
  for: {
    end: 123,
    start: 123,
    updateBy: 123,
  },
  forEach: ['forEach'],
  name: 'name',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_imagebuilder_alpha as imagebuilder_alpha

component_document_loop = imagebuilder_alpha.ComponentDocumentLoop(
    for=imagebuilder_alpha.ComponentDocumentForLoop(
        end=123,
        start=123,
        update_by=123
    ),
    for_each=["forEach"],
    name="name"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.AWS.ImageBuilder.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ImageBuilder.Alpha;

var componentDocumentLoop = new ComponentDocumentLoop {
    For = new ComponentDocumentForLoop {
        End = 123,
        Start = 123,
        UpdateBy = 123
    },
    ForEach = new [] { "forEach" },
    Name = "name"
};
go
// Install: go get github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import imagebuilder_alpha "github.com/aws/aws-cdk-go/awsimagebuilderalpha"

componentDocumentLoop := &ComponentDocumentLoop{
	For: &ComponentDocumentForLoop{
		End: jsii.Number(123),
		Start: jsii.Number(123),
		UpdateBy: jsii.Number(123),
	},
	ForEach: []*string{
		jsii.String("forEach"),
	},
	Name: jsii.String("name"),
}

Properties ​

foroptionalComponentDocumentForLoopforoptionalComponentDocumentForLoopforoptionalComponentDocumentForLoopForoptionalComponentDocumentForLoopForoptionalComponentDocumentForLoop#
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.

forEachoptionalstring[]for_eachoptionaltyping.List[str]forEachoptionalList<String>ForEachoptionalstring[]ForEachoptional*[]*string#
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.

nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string= loop#
The name of the loop, which can be used to reference.