Options for the CodePipelineActionFactory.produce() method.

Namespace: Amazon.CDK.Pipelines

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IProduceActionOptions

Syntax (vb)

Public Interface IProduceActionOptions

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK;
            using Amazon.CDK.AWS.CodeBuild;
            using Amazon.CDK.AWS.CodePipeline;
            using Amazon.CDK.AWS.EC2;
            using Amazon.CDK.AWS.IAM;
            using Amazon.CDK.AWS.Logs;
            using Amazon.CDK.AWS.S3;
            using Amazon.CDK.Pipelines;
            using Constructs;

            Artifact artifact;
            ArtifactMap artifactMap;
            Bucket bucket;
            IBuildImage buildImage;
            BuildSpec buildSpec;
            Cache cache;
            CodePipeline codePipeline;
            Construct construct;
            IFileSystemLocation fileSystemLocation;
            Fleet fleet;
            LogGroup logGroup;
            PolicyStatement policyStatement;
            SecurityGroup securityGroup;
            StackOutputsMap stackOutputsMap;
            Subnet subnet;
            SubnetFilter subnetFilter;
            var value;
            Vpc vpc;
            var produceActionOptions = new ProduceActionOptions {
                ActionName = "actionName",
                Artifacts = artifactMap,
                Pipeline = codePipeline,
                RunOrder = 123,
                Scope = construct,
                StackOutputsMap = stackOutputsMap,

                // 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,
                        DockerServer = new DockerServerOptions {
                            ComputeType = DockerServerComputeType.SMALL,

                            // the properties below are optional
                            SecurityGroups = new [] { securityGroup }
                        },
                        EnvironmentVariables = new Dictionary<string, BuildEnvironmentVariable> {
                            { "environmentVariablesKey", new BuildEnvironmentVariable {
                                Value = value,

                                // the properties below are optional
                                Type = BuildEnvironmentVariableType.PLAINTEXT
                            } }
                        },
                        Fleet = fleet,
                        Privileged = false
                    },
                    Cache = cache,
                    FileSystemLocations = new [] { fileSystemLocation },
                    Logging = new LoggingOptions {
                        CloudWatch = new CloudWatchLoggingOptions {
                            Enabled = false,
                            LogGroup = logGroup,
                            Prefix = "prefix"
                        },
                        S3 = new S3LoggingOptions {
                            Bucket = bucket,

                            // the properties below are optional
                            Enabled = false,
                            Encrypted = false,
                            Prefix = "prefix"
                        }
                    },
                    PartialBuildSpec = buildSpec,
                    RolePolicy = new [] { policyStatement },
                    SecurityGroups = new [] { securityGroup },
                    SubnetSelection = new SubnetSelection {
                        AvailabilityZones = new [] { "availabilityZones" },
                        OnePerAz = false,
                        SubnetFilters = new [] { subnetFilter },
                        SubnetGroupName = "subnetGroupName",
                        Subnets = new [] { subnet },
                        SubnetType = SubnetType.PRIVATE_ISOLATED
                    },
                    Timeout = Duration.Minutes(30),
                    Vpc = vpc
                },
                FallbackArtifact = artifact,
                VariablesNamespace = "variablesNamespace"
            };

Synopsis

Properties

Properties

ActionName

string ActionName { get; }

Artifacts

ArtifactMap Artifacts { get; }

BeforeSelfMutation

bool? BeforeSelfMutation { get; }

CodeBuildDefaults

ICodeBuildOptions? CodeBuildDefaults { get; }

FallbackArtifact

Artifact_? FallbackArtifact { get; }

Pipeline

CodePipeline Pipeline { get; }

RunOrder

Scope

StackOutputsMap

StackOutputsMap StackOutputsMap { get; }

VariablesNamespace

string? VariablesNamespace { get; }