Package software.amazon.awscdk.services.pcs

Interface CfnComputeNodeGroup.NodeLifecycleScriptProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnComputeNodeGroup.NodeLifecycleScriptProperty.Jsii$Proxy

Enclosing class:

CfnComputeNodeGroup

@Stability(Stable)
public static interface CfnComputeNodeGroup.NodeLifecycleScriptProperty
extends software.amazon.jsii.JsiiSerializable

A single lifecycle script with its source, arguments, and error behavior.

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.pcs.*;
 NodeLifecycleScriptProperty nodeLifecycleScriptProperty = NodeLifecycleScriptProperty.builder()
         .name("name")
         .scriptSource(ScriptSourceProperty.builder()
                 .scriptLocation("scriptLocation")
                 // the properties below are optional
                 .checksum("checksum")
                 .s3VersionId("s3VersionId")
                 .build())
         // the properties below are optional
         .arguments(List.of("arguments"))
         .executionPolicy("executionPolicy")
         .onError("onError")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-nodelifecyclescript.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnComputeNodeGroup.NodeLifecycleScriptProperty.Builder	builder()
default List<String>	getArguments()	An ordered list of arguments passed to the script.
default String	getExecutionPolicy()	Whether the script runs only on the node's first boot (FIRST_BOOT_ONLY) or on every boot including reboots (EVERY_BOOT).
String	getName()	A human-readable name that identifies the script.
default String	getOnError()	The behavior when the script exits with an error.
Object	getScriptSource()	The external location of a lifecycle script.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

A human-readable name that identifies the script.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-nodelifecyclescript.html#cfn-pcs-computenodegroup-nodelifecyclescript-name

getScriptSource

@Stability(Stable)
@NotNull
Object getScriptSource()

The external location of a lifecycle script.

Returns union: either IResolvable or CfnComputeNodeGroup.ScriptSourceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-nodelifecyclescript.html#cfn-pcs-computenodegroup-nodelifecyclescript-scriptsource

getArguments

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

An ordered list of arguments passed to the script.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-nodelifecyclescript.html#cfn-pcs-computenodegroup-nodelifecyclescript-arguments

getExecutionPolicy

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

Whether the script runs only on the node's first boot (FIRST_BOOT_ONLY) or on every boot including reboots (EVERY_BOOT).

Defaults to FIRST_BOOT_ONLY.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-nodelifecyclescript.html#cfn-pcs-computenodegroup-nodelifecyclescript-executionpolicy

getOnError

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

The behavior when the script exits with an error.

Defaults to TERMINATE.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-nodelifecyclescript.html#cfn-pcs-computenodegroup-nodelifecyclescript-onerror

builder

@Stability(Stable)
static CfnComputeNodeGroup.NodeLifecycleScriptProperty.Builder builder()

Returns:

a CfnComputeNodeGroup.NodeLifecycleScriptProperty.Builder of CfnComputeNodeGroup.NodeLifecycleScriptProperty