Package software.amazon.awscdk.services.codepipeline.actions

Class StackSetParameters

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.codepipeline.actions.StackSetParameters

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-24T10:56:29.363Z")
@Stability(Stable)
public abstract class StackSetParameters
extends software.amazon.jsii.JsiiObject

Base parameters for the StackSet.

Example:

 StackSetParameters parameters = StackSetParameters.fromLiteral(Map.of(
         "BucketName", "my-bucket",
         "Asset1", "true"));
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StackSetParameters()
protected	StackSetParameters(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	StackSetParameters(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static StackSetParameters	fromArtifactPath(ArtifactPath artifactPath)	Read the parameters from a JSON file from one of the pipeline's artifacts.
static StackSetParameters	fromLiteral(Map<String,String> parameters)	A list of template parameters for your stack set.
static StackSetParameters	fromLiteral(Map<String,String> parameters, List<String> usePreviousValues)	A list of template parameters for your stack set.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

StackSetParameters

protected StackSetParameters(software.amazon.jsii.JsiiObjectRef objRef)

StackSetParameters

protected StackSetParameters(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

StackSetParameters

@Stability(Stable)
protected StackSetParameters()

Method Details

fromArtifactPath

@Stability(Stable)
@NotNull
public static StackSetParameters fromArtifactPath(@NotNull
 ArtifactPath artifactPath)

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:

artifactPath - This parameter is required.

fromLiteral

@Stability(Stable)
@NotNull
public static StackSetParameters fromLiteral(@NotNull
 Map<String,String> parameters,
 @Nullable
 List<String> usePreviousValues)

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.

Example:

 StackSetParameters parameters = StackSetParameters.fromLiteral(Map.of(
         "BucketName", "my-bucket",
         "Asset1", "true"));
 

Parameters:

parameters - This parameter is required.

usePreviousValues -

fromLiteral

@Stability(Stable)
@NotNull
public static StackSetParameters fromLiteral(@NotNull
 Map<String,String> parameters)

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.

Example:

 StackSetParameters parameters = StackSetParameters.fromLiteral(Map.of(
         "BucketName", "my-bucket",
         "Asset1", "true"));
 

Parameters:

parameters - This parameter is required.