AWS CDK Reference

Appearance

v2.274.0

StackSetParameters Class ​

Base parameters for the StackSet.

Source
aws-codepipeline-actions/lib/cloudformation/stackset-types.ts
Type last changed
v2.13.0 · 19 Feb 2022

Example ​

ts
const parameters = codepipeline_actions.StackSetParameters.fromLiteral({
 BucketName: 'my-bucket',
 Asset1: 'true',
});

Initializer ​

ts
new StackSetParameters()
python
StackSetParameters()
java
new StackSetParameters()
csharp
new StackSetParameters()
go
NewStackSetParameters()

Methods ​

fromArtifactPath(artifactPath: ArtifactPath): StackSetParameters // chainable@staticmethod def from_artifact_path(artifact_path: ArtifactPath) -> StackSetParameterspublic static StackSetParameters fromArtifactPath(ArtifactPath artifactPath)public static StackSetParameters FromArtifactPath(ArtifactPath artifactPath)func FromArtifactPath(ArtifactPath ArtifactPath) StackSetParametersstatic#
Read the parameters from a JSON file from one of the pipeline's artifacts.
notes

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(parameters: { [key: string]: string }, usePreviousValues?: string[]): StackSetParameters // chainable@staticmethod def from_literal(parameters: typing.Mapping[str, str], use_previous_values: typing.Optional[typing.List[str]] = None) -> StackSetParameterspublic static StackSetParameters fromLiteral(Map<String, String> parameters, List<String> usePreviousValues)public static StackSetParameters FromLiteral(IDictionary<string, string> parameters, string[]? usePreviousValues = null)func FromLiteral(Parameters *map[string]*string, UsePreviousValues *[]*string) StackSetParametersstatic#
A list of template parameters for your stack set.
notes · example

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.

ts
const parameters = codepipeline_actions.StackSetParameters.fromLiteral({
 BucketName: 'my-bucket',
 Asset1: 'true',
});