StackSetParameters

class aws_cdk.aws_codepipeline_actions.StackSetParameters

Bases: object

Base parameters for the StackSet.

ExampleMetadata:

infused

Example:

parameters = codepipeline_actions.StackSetParameters.from_literal({
    "BucketName": "my-bucket",
    "Asset1": "true"
})

Static Methods

classmethod from_artifact_path(artifact_path)

Read the parameters from a JSON file from one of the pipeline’s artifacts.

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.

Parameters:

artifact_path (ArtifactPath) –

Return type:

StackSetParameters

classmethod from_literal(parameters, use_previous_values=None)

A list of template parameters for your stack set.

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.

Parameters:
  • parameters (Mapping[str, str]) –

  • use_previous_values (Optional[Sequence[str]]) –

Return type:

StackSetParameters

Example:

parameters = codepipeline_actions.StackSetParameters.from_literal({
    "BucketName": "my-bucket",
    "Asset1": "true"
})