Class ProduceActionOptions
Options for the CodePipelineActionFactory.produce()
method.
Inheritance
Implements
Namespace: Amazon.CDK.Pipelines
Assembly: Amazon.CDK.Pipelines.dll
Syntax (csharp)
public class ProduceActionOptions : Object, IProduceActionOptions
Syntax (vb)
Public Class ProduceActionOptions
Inherits Object
Implements IProduceActionOptions
Remarks
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;
using Amazon.CDK.Pipelines;
using Constructs;
Artifact artifact;
ArtifactMap artifactMap;
Bucket bucket;
IBuildImage buildImage;
BuildSpec buildSpec;
CodePipeline codePipeline;
Construct construct;
PolicyStatement policyStatement;
SecurityGroup securityGroup;
Subnet subnet;
SubnetFilter subnetFilter;
var value;
Vpc vpc;
var produceActionOptions = new ProduceActionOptions {
ActionName = "actionName",
Artifacts = artifactMap,
Pipeline = codePipeline,
RunOrder = 123,
Scope = construct,
// the properties below are optional
BeforeSelfMutation = false,
CodeBuildDefaults = new CodeBuildOptions {
BuildEnvironment = 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
},
PartialBuildSpec = buildSpec,
RolePolicy = new [] { policyStatement },
SecurityGroups = new [] { securityGroup },
SubnetSelection = new SubnetSelection {
AvailabilityZones = new [] { "availabilityZones" },
OnePerAz = false,
SubnetFilters = new [] { subnetFilter },
SubnetGroupName = "subnetGroupName",
SubnetName = "subnetName",
Subnets = new [] { subnet },
SubnetType = SubnetType.ISOLATED
},
Timeout = Duration.Minutes(30),
Vpc = vpc
},
FallbackArtifact = artifact,
VariablesNamespace = "variablesNamespace"
};
Synopsis
Constructors
ProduceActionOptions() |
Properties
ActionName | Name the action should get. |
Artifacts | Helper object to translate FileSets to CodePipeline Artifacts. |
BeforeSelfMutation | Whether or not this action is inserted before self mutation. |
CodeBuildDefaults | If this action factory creates a CodeBuild step, default options to inherit. |
FallbackArtifact | An input artifact that CodeBuild projects that don't actually need an input artifact can use. |
Pipeline | The pipeline the action is being generated for. |
RunOrder | RunOrder the action should get. |
Scope | Scope in which to create constructs. |
VariablesNamespace | If this step is producing outputs, the variables namespace assigned to it. |
Constructors
ProduceActionOptions()
public ProduceActionOptions()
Properties
ActionName
Name the action should get.
public string ActionName { get; set; }
Property Value
System.String
Artifacts
Helper object to translate FileSets to CodePipeline Artifacts.
public ArtifactMap Artifacts { get; set; }
Property Value
BeforeSelfMutation
Whether or not this action is inserted before self mutation.
public Nullable<bool> BeforeSelfMutation { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
If it is, the action should take care to reflect some part of its own definition in the pipeline action definition, to trigger a restart after self-mutation (if necessary).
Default: false
CodeBuildDefaults
If this action factory creates a CodeBuild step, default options to inherit.
public ICodeBuildOptions CodeBuildDefaults { get; set; }
Property Value
Remarks
Default: - No CodeBuild project defaults
FallbackArtifact
An input artifact that CodeBuild projects that don't actually need an input artifact can use.
public Artifact_ FallbackArtifact { get; set; }
Property Value
Remarks
CodeBuild Projects MUST have an input artifact in order to be added to the Pipeline. If the Project doesn't actually care about its input (it can be anything), it can use the Artifact passed here.
Default: - A fallback artifact does not exist
Pipeline
The pipeline the action is being generated for.
public CodePipeline Pipeline { get; set; }
Property Value
RunOrder
RunOrder the action should get.
public double RunOrder { get; set; }
Property Value
System.Double
Scope
Scope in which to create constructs.
public Construct Scope { get; set; }
Property Value
Constructs.Construct
VariablesNamespace
If this step is producing outputs, the variables namespace assigned to it.
public string VariablesNamespace { get; set; }
Property Value
System.String
Remarks
Pass this on to the Action you are creating.
Default: - Step doesn't produce any outputs