ComponentDocumentStep

class aws_cdk.aws_imagebuilder_alpha.ComponentDocumentStep(*, action, inputs, name, if_=None, loop=None, on_failure=None, timeout=None)

Bases: object

(experimental) The step to run in a specific phase of the image build, which defines the step to execute to customize or test the instance.

Parameters:

  • action (ComponentAction) – (experimental) The action to perform in the step.

  • inputs (ComponentStepInputs) – (experimental) Contains parameters required by the action to run the step.

  • name (str) – (experimental) The name of the step.

  • if – (experimental) The condition to apply to the step. If the condition is false, then the step is skipped Default: - no condition is applied to the step and it gets executed

  • loop (Union[ComponentDocumentLoop, Dict[str, Any], None]) – (experimental) A looping construct defining a repeated sequence of instructions. Default: None

  • on_failure (Optional[ComponentOnFailure]) – (experimental) Specifies what the step should do in case of failure. Default: ComponentOnFailure.ABORT

  • timeout (Optional[Duration]) – (experimental) The timeout of the step. Default: - 120 minutes

Stability:

experimental

ExampleMetadata:

infused

Example:

step = imagebuilder.ComponentDocumentStep(
    name="configure-app",
    action=imagebuilder.ComponentAction.CREATE_FILE,
    inputs=imagebuilder.ComponentStepInputs.from_object({
        "path": "/etc/myapp/config.json",
        "content": "{"env": "production"}"
    })
)

Attributes

action

(experimental) The action to perform in the step.

Stability:

experimental

if_

(experimental) The condition to apply to the step.

If the condition is false, then the step is skipped

Default:

  • no condition is applied to the step and it gets executed

See:

https://docs.aws.amazon.com/imagebuilder/latest/userguide/toe-comparison-operators.html

Stability:

experimental

inputs

(experimental) Contains parameters required by the action to run the step.

See:

https://docs.aws.amazon.com/imagebuilder/latest/userguide/toe-action-modules.html

Stability:

experimental

loop

(experimental) A looping construct defining a repeated sequence of instructions.

Default:

None

Stability:

experimental

name

(experimental) The name of the step.

Stability:

experimental

on_failure

(experimental) Specifies what the step should do in case of failure.

Default:

ComponentOnFailure.ABORT

Stability:

experimental

timeout

(experimental) The timeout of the step.

Default:

  • 120 minutes

Stability:

experimental