ShellScriptActionProps

class aws_cdk.pipelines.ShellScriptActionProps(*, action_name, commands, additional_artifacts=None, bash_options=None, environment=None, environment_variables=None, role_policy_statements=None, run_order=None, security_groups=None, subnet_selection=None, use_outputs=None, vpc=None)

Bases: object

(experimental) Properties for ShellScriptAction.

Parameters
  • action_name (str) – (experimental) Name of the validation action in the pipeline.

  • commands (Sequence[str]) – (experimental) Commands to run.

  • additional_artifacts (Optional[Sequence[Artifact]]) – (experimental) Additional artifacts to use as input for the CodeBuild project. You can use these files to load more complex test sets into the shellscript build environment. The files artifact given here will be unpacked into the current working directory, the other ones will be unpacked into directories which are available through the environment variables $CODEBUILD_SRC_DIR_. The CodeBuild job must have at least one input artifact, so you must provide either at least one additional artifact here or one stack output using useOutput. Default: - No additional artifacts

  • bash_options (Optional[str]) – (experimental) Bash options to set at the start of the script. Default: ‘-eu’ (errexit and nounset)

  • environment (Optional[BuildEnvironment]) – (experimental) The CodeBuild environment where scripts are executed. Default: LinuxBuildImage.STANDARD_4_0

  • environment_variables (Optional[Mapping[str, BuildEnvironmentVariable]]) – (experimental) Environment variables to send into build. Default: - No additional environment variables

  • role_policy_statements (Optional[Sequence[PolicyStatement]]) – (experimental) Additional policy statements to add to the execution role. Default: - No policy statements

  • run_order (Union[int, float, None]) – (experimental) RunOrder for this action. Use this to sequence the shell script after the deployments. The default value is 100 so you don’t have to supply the value if you just want to run this after the application stacks have been deployed, and you don’t have more than 100 stacks. Default: 100

  • security_groups (Optional[Sequence[ISecurityGroup]]) – (experimental) Which security group to associate with the script’s project network interfaces. If no security group is identified, one will be created automatically. Only used if ‘vpc’ is supplied. Default: - Security group will be automatically created.

  • subnet_selection (Optional[SubnetSelection]) – (experimental) Which subnets to use. Only used if ‘vpc’ is supplied. Default: - All private subnets.

  • use_outputs (Optional[Mapping[str, StackOutput]]) – (experimental) Stack outputs to make available as environment variables. Default: - No outputs used

  • vpc (Optional[IVpc]) – (experimental) The VPC where to execute the specified script. Default: - No VPC

Stability

experimental

Attributes

action_name

(experimental) Name of the validation action in the pipeline.

Stability

experimental

Return type

str

additional_artifacts

(experimental) Additional artifacts to use as input for the CodeBuild project.

You can use these files to load more complex test sets into the shellscript build environment.

The files artifact given here will be unpacked into the current working directory, the other ones will be unpacked into directories which are available through the environment variables $CODEBUILD_SRC_DIR_.

The CodeBuild job must have at least one input artifact, so you must provide either at least one additional artifact here or one stack output using useOutput.

Default
  • No additional artifacts

Stability

experimental

Return type

Optional[List[Artifact]]

bash_options

(experimental) Bash options to set at the start of the script.

Default

‘-eu’ (errexit and nounset)

Stability

experimental

Return type

Optional[str]

commands

(experimental) Commands to run.

Stability

experimental

Return type

List[str]

environment

(experimental) The CodeBuild environment where scripts are executed.

Default

LinuxBuildImage.STANDARD_4_0

Stability

experimental

Return type

Optional[BuildEnvironment]

environment_variables

(experimental) Environment variables to send into build.

Default
  • No additional environment variables

Stability

experimental

Return type

Optional[Mapping[str, BuildEnvironmentVariable]]

role_policy_statements

(experimental) Additional policy statements to add to the execution role.

Default
  • No policy statements

Stability

experimental

Return type

Optional[List[PolicyStatement]]

run_order

(experimental) RunOrder for this action.

Use this to sequence the shell script after the deployments.

The default value is 100 so you don’t have to supply the value if you just want to run this after the application stacks have been deployed, and you don’t have more than 100 stacks.

Default

100

Stability

experimental

Return type

Union[int, float, None]

security_groups

(experimental) Which security group to associate with the script’s project network interfaces.

If no security group is identified, one will be created automatically.

Only used if ‘vpc’ is supplied.

Default
  • Security group will be automatically created.

Stability

experimental

Return type

Optional[List[ISecurityGroup]]

subnet_selection

(experimental) Which subnets to use.

Only used if ‘vpc’ is supplied.

Default
  • All private subnets.

Stability

experimental

Return type

Optional[SubnetSelection]

use_outputs

(experimental) Stack outputs to make available as environment variables.

Default
  • No outputs used

Stability

experimental

Return type

Optional[Mapping[str, StackOutput]]

vpc

(experimental) The VPC where to execute the specified script.

Default
  • No VPC

Stability

experimental

Return type

Optional[IVpc]