software.amazon.awscdk.pipelines

Class ShellScriptActionProps.Builder

java.lang.Object

software.amazon.awscdk.pipelines.ShellScriptActionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ShellScriptActionProps>

Enclosing interface:

ShellScriptActionProps

@Stability(value=Experimental)
public static final class ShellScriptActionProps.Builder
extends Object
implements software.amazon.jsii.Builder<ShellScriptActionProps>

A builder for ShellScriptActionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ShellScriptActionProps.Builder	actionName(String actionName) Sets the value of ShellScriptActionProps.getActionName()
ShellScriptActionProps.Builder	additionalArtifacts(List<? extends Artifact> additionalArtifacts) Sets the value of ShellScriptActionProps.getAdditionalArtifacts()
ShellScriptActionProps.Builder	bashOptions(String bashOptions) Sets the value of ShellScriptActionProps.getBashOptions()
ShellScriptActionProps	build() Builds the configured instance.
ShellScriptActionProps.Builder	commands(List<String> commands) Sets the value of ShellScriptActionProps.getCommands()
ShellScriptActionProps.Builder	environment(BuildEnvironment environment) Sets the value of ShellScriptActionProps.getEnvironment()
ShellScriptActionProps.Builder	environmentVariables(Map<String,? extends BuildEnvironmentVariable> environmentVariables) Sets the value of ShellScriptActionProps.getEnvironmentVariables()
ShellScriptActionProps.Builder	rolePolicyStatements(List<? extends PolicyStatement> rolePolicyStatements) Sets the value of ShellScriptActionProps.getRolePolicyStatements()
ShellScriptActionProps.Builder	runOrder(Number runOrder) Sets the value of ShellScriptActionProps.getRunOrder()
ShellScriptActionProps.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups) Sets the value of ShellScriptActionProps.getSecurityGroups()
ShellScriptActionProps.Builder	subnetSelection(SubnetSelection subnetSelection) Sets the value of ShellScriptActionProps.getSubnetSelection()
ShellScriptActionProps.Builder	useOutputs(Map<String,? extends StackOutput> useOutputs) Sets the value of ShellScriptActionProps.getUseOutputs()
ShellScriptActionProps.Builder	vpc(IVpc vpc) Sets the value of ShellScriptActionProps.getVpc()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

actionName

@Stability(value=Experimental)
public ShellScriptActionProps.Builder actionName(String actionName)

Sets the value of ShellScriptActionProps.getActionName()

Parameters:

actionName - Name of the validation action in the pipeline. This parameter is required.

Returns:

this

commands

@Stability(value=Experimental)
public ShellScriptActionProps.Builder commands(List<String> commands)

Sets the value of ShellScriptActionProps.getCommands()

Parameters:

commands - Commands to run. This parameter is required.

Returns:

this

additionalArtifacts

@Stability(value=Experimental)
public ShellScriptActionProps.Builder additionalArtifacts(List<? extends Artifact> additionalArtifacts)

Sets the value of ShellScriptActionProps.getAdditionalArtifacts()

Parameters:

additionalArtifacts - 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.

Returns:

this

bashOptions

@Stability(value=Experimental)
public ShellScriptActionProps.Builder bashOptions(String bashOptions)

Sets the value of ShellScriptActionProps.getBashOptions()

Parameters:

bashOptions - Bash options to set at the start of the script.

Returns:

this

environment

@Stability(value=Experimental)
public ShellScriptActionProps.Builder environment(BuildEnvironment environment)

Sets the value of ShellScriptActionProps.getEnvironment()

Parameters:

environment - The CodeBuild environment where scripts are executed.

Returns:

this

environmentVariables

@Stability(value=Experimental)
public ShellScriptActionProps.Builder environmentVariables(Map<String,? extends BuildEnvironmentVariable> environmentVariables)

Sets the value of ShellScriptActionProps.getEnvironmentVariables()

Parameters:

environmentVariables - Environment variables to send into build.

Returns:

this

rolePolicyStatements

@Stability(value=Experimental)
public ShellScriptActionProps.Builder rolePolicyStatements(List<? extends PolicyStatement> rolePolicyStatements)

Sets the value of ShellScriptActionProps.getRolePolicyStatements()

Parameters:

rolePolicyStatements - Additional policy statements to add to the execution role.

Returns:

this

runOrder

@Stability(value=Experimental)
public ShellScriptActionProps.Builder runOrder(Number runOrder)

Sets the value of ShellScriptActionProps.getRunOrder()

Parameters:

runOrder - 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.

Returns:

this

securityGroups

@Stability(value=Experimental)
public ShellScriptActionProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)

Sets the value of ShellScriptActionProps.getSecurityGroups()

Parameters:

securityGroups - 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.

Returns:

this

subnetSelection

@Stability(value=Experimental)
public ShellScriptActionProps.Builder subnetSelection(SubnetSelection subnetSelection)

Sets the value of ShellScriptActionProps.getSubnetSelection()

Parameters:

subnetSelection - Which subnets to use. Only used if 'vpc' is supplied.

Returns:

this

useOutputs

@Stability(value=Experimental)
public ShellScriptActionProps.Builder useOutputs(Map<String,? extends StackOutput> useOutputs)

Sets the value of ShellScriptActionProps.getUseOutputs()

Parameters:

useOutputs - Stack outputs to make available as environment variables.

Returns:

this

vpc

@Stability(value=Experimental)
public ShellScriptActionProps.Builder vpc(IVpc vpc)

Sets the value of ShellScriptActionProps.getVpc()

Parameters:

vpc - The VPC where to execute the specified script.

Returns:

this

build

@Stability(value=Experimental)
public ShellScriptActionProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ShellScriptActionProps>

Returns:

a new instance of ShellScriptActionProps

Throws:

NullPointerException - if any required attribute was not provided