Interface ICdkPipelineProps
(deprecated) Properties for a CdkPipeline.
Namespace: Amazon.CDK.Pipelines
Assembly: Amazon.CDK.Pipelines.dll
Syntax (csharp)
public interface ICdkPipelineProps
Syntax (vb)
Public Interface ICdkPipelineProps
Remarks
Stability: Deprecated
ExampleMetadata: infused
Examples
var sourceArtifact = new Artifact();
var cloudAssemblyArtifact = new Artifact();
var pipeline = new CdkPipeline(this, "MyPipeline", new CdkPipelineProps {
CloudAssemblyArtifact = cloudAssemblyArtifact,
SynthAction = SimpleSynthAction.StandardNpmSynth(new StandardNpmSynthOptions {
SourceArtifact = sourceArtifact,
CloudAssemblyArtifact = cloudAssemblyArtifact,
Environment = new BuildEnvironment {
Privileged = true
}
})
});
Synopsis
Properties
AssetBuildSpec | (deprecated) Custom BuildSpec that is merged with generated one (for asset publishing actions). |
AssetPreInstallCommands | (deprecated) Additional commands to run before installing cdk-assets during the asset publishing step Use this to setup proxies or npm mirrors. |
CdkCliVersion | (deprecated) CDK CLI version to use in pipeline. |
CloudAssemblyArtifact | (deprecated) The artifact you have defined to be the artifact to hold the cloudAssemblyArtifact for the synth action. |
CodePipeline | (deprecated) Existing CodePipeline to add deployment stages to. |
CrossAccountKeys | (deprecated) Create KMS keys for cross-account deployments. |
DockerCredentials | (deprecated) A list of credentials used to authenticate to Docker registries. |
EnableKeyRotation | (deprecated) Enables KMS key rotation for cross-account keys. |
PipelineName | (deprecated) Name of the pipeline. |
SelfMutating | (deprecated) Whether the pipeline will update itself. |
SelfMutationBuildSpec | (deprecated) Custom BuildSpec that is merged with generated one (for self-mutation stage). |
SinglePublisherPerType | (deprecated) Whether this pipeline creates one asset upload action per asset type or one asset upload per asset. |
SourceAction | (deprecated) The CodePipeline action used to retrieve the CDK app's source. |
SubnetSelection | (deprecated) Which subnets to use. |
SupportDockerAssets | (deprecated) Whether the pipeline needs to build Docker images in the UpdatePipeline stage. |
SynthAction | (deprecated) The CodePipeline action build and synthesis step of the CDK app. |
Vpc | (deprecated) The VPC where to execute the CdkPipeline actions. |
Properties
AssetBuildSpec
(deprecated) Custom BuildSpec that is merged with generated one (for asset publishing actions).
virtual BuildSpec AssetBuildSpec { get; }
Property Value
Remarks
Default: - none
Stability: Deprecated
AssetPreInstallCommands
(deprecated) Additional commands to run before installing cdk-assets during the asset publishing step Use this to setup proxies or npm mirrors.
virtual string[] AssetPreInstallCommands { get; }
Property Value
System.String[]
Remarks
Default: -
Stability: Deprecated
CdkCliVersion
(deprecated) CDK CLI version to use in pipeline.
virtual string CdkCliVersion { get; }
Property Value
System.String
Remarks
Some Actions in the pipeline will download and run a version of the CDK CLI. Specify the version here.
Default: - Latest version
Stability: Deprecated
CloudAssemblyArtifact
(deprecated) The artifact you have defined to be the artifact to hold the cloudAssemblyArtifact for the synth action.
Artifact_ CloudAssemblyArtifact { get; }
Property Value
Remarks
Stability: Deprecated
CodePipeline
(deprecated) Existing CodePipeline to add deployment stages to.
virtual Pipeline CodePipeline { get; }
Property Value
Remarks
Use this if you want more control over the CodePipeline that gets created. You can choose to not pass this value, in which case a new CodePipeline is created with default settings.
If you pass an existing CodePipeline, it should have been created
with restartExecutionOnUpdate: true
.
[disable-awslint:ref-via-interface]
Default: - A new CodePipeline is automatically generated
Stability: Deprecated
CrossAccountKeys
(deprecated) Create KMS keys for cross-account deployments.
virtual Nullable<bool> CrossAccountKeys { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
This controls whether the pipeline is enabled for cross-account deployments.
Can only be set if codePipeline
is not set.
By default cross-account deployments are enabled, but this feature requires that KMS Customer Master Keys are created which have a cost of $1/month.
If you do not need cross-account deployments, you can set this to false
to
not create those keys and save on that cost (the artifact bucket will be
encrypted with an AWS-managed key). However, cross-account deployments will
no longer be possible.
Default: true
Stability: Deprecated
DockerCredentials
(deprecated) A list of credentials used to authenticate to Docker registries.
virtual DockerCredential[] DockerCredentials { get; }
Property Value
Remarks
Specify any credentials necessary within the pipeline to build, synth, update, or publish assets.
Default: []
Stability: Deprecated
EnableKeyRotation
(deprecated) Enables KMS key rotation for cross-account keys.
virtual Nullable<bool> EnableKeyRotation { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Cannot be set if crossAccountKeys
was set to false
.
Key rotation costs $1/month when enabled.
Default: - false (key rotation is disabled)
Stability: Deprecated
PipelineName
(deprecated) Name of the pipeline.
virtual string PipelineName { get; }
Property Value
System.String
Remarks
Can only be set if codePipeline
is not set.
Default: - A name is automatically generated
Stability: Deprecated
SelfMutating
(deprecated) Whether the pipeline will update itself.
virtual Nullable<bool> SelfMutating { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
This needs to be set to true
to allow the pipeline to reconfigure
itself when assets or stages are being added to it, and true
is the
recommended setting.
You can temporarily set this to false
while you are iterating
on the pipeline itself and prefer to deploy changes using cdk deploy
.
Default: true
Stability: Deprecated
SelfMutationBuildSpec
(deprecated) Custom BuildSpec that is merged with generated one (for self-mutation stage).
virtual BuildSpec SelfMutationBuildSpec { get; }
Property Value
Remarks
Default: - none
Stability: Deprecated
SinglePublisherPerType
(deprecated) Whether this pipeline creates one asset upload action per asset type or one asset upload per asset.
virtual Nullable<bool> SinglePublisherPerType { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Deprecated
SourceAction
(deprecated) The CodePipeline action used to retrieve the CDK app's source.
virtual IAction SourceAction { get; }
Property Value
Remarks
Default: - Required unless codePipeline
is given
Stability: Deprecated
SubnetSelection
(deprecated) Which subnets to use.
virtual ISubnetSelection SubnetSelection { get; }
Property Value
Remarks
Only used if 'vpc' is supplied.
Default: - All private subnets.
Stability: Deprecated
SupportDockerAssets
(deprecated) Whether the pipeline needs to build Docker images in the UpdatePipeline stage.
virtual Nullable<bool> SupportDockerAssets { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
If the UpdatePipeline stage tries to build a Docker image and this flag is not
set to true
, the build step will run in non-privileged mode and consequently
will fail with a message like:
Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
This flag has an effect only if selfMutating
is also true
.
Default: - false
Stability: Deprecated
SynthAction
(deprecated) The CodePipeline action build and synthesis step of the CDK app.
virtual IAction SynthAction { get; }
Property Value
Remarks
Default: - Required unless codePipeline
or sourceAction
is given
Stability: Deprecated
Vpc
(deprecated) The VPC where to execute the CdkPipeline actions.
virtual IVpc Vpc { get; }
Property Value
Remarks
Default: - No VPC
Stability: Deprecated