Class StackSetParameters
Base parameters for the StackSet.
Inheritance
Namespace: Amazon.CDK.AWS.CodePipeline.Actions
Assembly: Amazon.CDK.AWS.CodePipeline.Actions.dll
Syntax (csharp)
public abstract class StackSetParameters : DeputyBase
Syntax (vb)
Public MustInherit Class StackSetParameters
Inherits DeputyBase
Remarks
ExampleMetadata: infused
Examples
var parameters = StackSetParameters.FromLiteral(new Dictionary<string, string> {
{ "BucketName", "my-bucket" },
{ "Asset1", "true" }
});
Synopsis
Constructors
StackSetParameters() | |
StackSetParameters(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
StackSetParameters(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Methods
FromArtifactPath(ArtifactPath_) | Read the parameters from a JSON file from one of the pipeline's artifacts. |
FromLiteral(IDictionary<String, String>, String[]) | A list of template parameters for your stack set. |
Constructors
StackSetParameters()
protected StackSetParameters()
StackSetParameters(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected StackSetParameters(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
StackSetParameters(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected StackSetParameters(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Methods
FromArtifactPath(ArtifactPath_)
Read the parameters from a JSON file from one of the pipeline's artifacts.
public static StackSetParameters FromArtifactPath(ArtifactPath_ artifactPath)
Parameters
- artifactPath ArtifactPath_
Returns
Remarks
The file needs to contain a list of { ParameterKey, ParameterValue, UsePreviousValue }
objects, like
this:
[
{
"ParameterKey": "BucketName",
"ParameterValue": "my-bucket"
},
{
"ParameterKey": "Asset1",
"ParameterValue": "true"
},
{
"ParameterKey": "Asset2",
"UsePreviousValue": true
}
]
You must specify all template parameters. Parameters you don't specify will revert
to their Default
values as specified in the template.
For of parameters you want to retain their existing values
without specifying what those values are, set UsePreviousValue: true
.
Use of this feature is discouraged. CDK is for
specifying desired-state infrastructure, and use of this feature makes the
parameter values unmanaged.
FromLiteral(IDictionary<String, String>, String[])
A list of template parameters for your stack set.
public static StackSetParameters FromLiteral(IDictionary<string, string> parameters, string[] usePreviousValues = null)
Parameters
- parameters System.Collections.Generic.IDictionary<System.String, System.String>
- usePreviousValues System.String[]
Returns
Remarks
You must specify all template parameters. Parameters you don't specify will revert
to their Default
values as specified in the template.
Specify the names of parameters you want to retain their existing values, without specifying what those values are, in an array in the second argument to this function. Use of this feature is discouraged. CDK is for specifying desired-state infrastructure, and use of this feature makes the parameter values unmanaged.
Examples
var parameters = StackSetParameters.FromLiteral(new Dictionary<string, string> {
{ "BucketName", "my-bucket" },
{ "Asset1", "true" }
});