Class ShellScriptActionProps
(deprecated) Properties for ShellScriptAction.
Inheritance
Implements
Namespace: Amazon.CDK.Pipelines
Assembly: Amazon.CDK.Pipelines.dll
Syntax (csharp)
public class ShellScriptActionProps : Object, IShellScriptActionProps
Syntax (vb)
Public Class ShellScriptActionProps
Inherits Object
Implements IShellScriptActionProps
Remarks
Stability: Deprecated
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodeBuild;
using Amazon.CDK.AWS.CodePipeline;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.AWS.S3;
using Amazon.CDK.Pipelines;
Artifact artifact;
Bucket bucket;
IBuildImage buildImage;
PolicyStatement policyStatement;
SecurityGroup securityGroup;
StackOutput stackOutput;
Subnet subnet;
SubnetFilter subnetFilter;
var value;
Vpc vpc;
var shellScriptActionProps = new ShellScriptActionProps {
ActionName = "actionName",
Commands = new [] { "commands" },
// the properties below are optional
AdditionalArtifacts = new [] { artifact },
BashOptions = "bashOptions",
Environment = new BuildEnvironment {
BuildImage = buildImage,
Certificate = new BuildEnvironmentCertificate {
Bucket = bucket,
ObjectKey = "objectKey"
},
ComputeType = ComputeType.SMALL,
EnvironmentVariables = new Dictionary<string, BuildEnvironmentVariable> {
{ "environmentVariablesKey", new BuildEnvironmentVariable {
Value = value,
// the properties below are optional
Type = BuildEnvironmentVariableType.PLAINTEXT
} }
},
Privileged = false
},
EnvironmentVariables = new Dictionary<string, BuildEnvironmentVariable> {
{ "environmentVariablesKey", new BuildEnvironmentVariable {
Value = value,
// the properties below are optional
Type = BuildEnvironmentVariableType.PLAINTEXT
} }
},
RolePolicyStatements = new [] { policyStatement },
RunOrder = 123,
SecurityGroups = new [] { securityGroup },
SubnetSelection = new SubnetSelection {
AvailabilityZones = new [] { "availabilityZones" },
OnePerAz = false,
SubnetFilters = new [] { subnetFilter },
SubnetGroupName = "subnetGroupName",
SubnetName = "subnetName",
Subnets = new [] { subnet },
SubnetType = SubnetType.ISOLATED
},
UseOutputs = new Dictionary<string, StackOutput> {
{ "useOutputsKey", stackOutput }
},
Vpc = vpc
};
Synopsis
Constructors
ShellScriptActionProps() |
Properties
ActionName | (deprecated) Name of the validation action in the pipeline. |
AdditionalArtifacts | (deprecated) Additional artifacts to use as input for the CodeBuild project. |
BashOptions | (deprecated) Bash options to set at the start of the script. |
Commands | (deprecated) Commands to run. |
Environment | (deprecated) The CodeBuild environment where scripts are executed. |
EnvironmentVariables | (deprecated) Environment variables to send into build. |
RolePolicyStatements | (deprecated) Additional policy statements to add to the execution role. |
RunOrder | (deprecated) RunOrder for this action. |
SecurityGroups | (deprecated) Which security group to associate with the script's project network interfaces. |
SubnetSelection | (deprecated) Which subnets to use. |
UseOutputs | (deprecated) Stack outputs to make available as environment variables. |
Vpc | (deprecated) The VPC where to execute the specified script. |
Constructors
ShellScriptActionProps()
public ShellScriptActionProps()
Properties
ActionName
(deprecated) Name of the validation action in the pipeline.
public string ActionName { get; set; }
Property Value
System.String
Remarks
Stability: Deprecated
AdditionalArtifacts
(deprecated) Additional artifacts to use as input for the CodeBuild project.
public Artifact_[] AdditionalArtifacts { get; set; }
Property Value
Remarks
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: Deprecated
BashOptions
(deprecated) Bash options to set at the start of the script.
public string BashOptions { get; set; }
Property Value
System.String
Remarks
Default: '-eu' (errexit and nounset)
Stability: Deprecated
Commands
(deprecated) Commands to run.
public string[] Commands { get; set; }
Property Value
System.String[]
Remarks
Stability: Deprecated
Environment
(deprecated) The CodeBuild environment where scripts are executed.
public IBuildEnvironment Environment { get; set; }
Property Value
Remarks
Default: LinuxBuildImage.STANDARD_5_0
Stability: Deprecated
EnvironmentVariables
(deprecated) Environment variables to send into build.
public IDictionary<string, IBuildEnvironmentVariable> EnvironmentVariables { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, IBuildEnvironmentVariable>
Remarks
Default: - No additional environment variables
Stability: Deprecated
RolePolicyStatements
(deprecated) Additional policy statements to add to the execution role.
public PolicyStatement[] RolePolicyStatements { get; set; }
Property Value
Remarks
Default: - No policy statements
Stability: Deprecated
RunOrder
(deprecated) RunOrder for this action.
public Nullable<double> RunOrder { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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: Deprecated
SecurityGroups
(deprecated) Which security group to associate with the script's project network interfaces.
public ISecurityGroup[] SecurityGroups { get; set; }
Property Value
Remarks
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: Deprecated
SubnetSelection
(deprecated) Which subnets to use.
public ISubnetSelection SubnetSelection { get; set; }
Property Value
Remarks
Only used if 'vpc' is supplied.
Default: - All private subnets.
Stability: Deprecated
UseOutputs
(deprecated) Stack outputs to make available as environment variables.
public IDictionary<string, StackOutput> UseOutputs { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, StackOutput>
Remarks
Default: - No outputs used
Stability: Deprecated
Vpc
(deprecated) The VPC where to execute the specified script.
public IVpc Vpc { get; set; }
Property Value
Remarks
Default: - No VPC
Stability: Deprecated