software.amazon.awscdk.services.codepipeline.actions.StackSetParameters Maven / Gradle / Ivy
Show all versions of codepipeline-actions Show documentation
package software.amazon.awscdk.services.codepipeline.actions;
/**
* Base parameters for the StackSet.
*
* Example:
*
*
* StackSetParameters parameters = StackSetParameters.fromLiteral(Map.of(
* "BucketName", "my-bucket",
* "Asset1", "true"));
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.74.0 (build 6d08790)", date = "2023-05-19T23:09:34.951Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.codepipeline.actions.$Module.class, fqn = "@aws-cdk/aws-codepipeline-actions.StackSetParameters")
public abstract class StackSetParameters extends software.amazon.jsii.JsiiObject {
protected StackSetParameters(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected StackSetParameters(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
protected StackSetParameters() {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this);
}
/**
* 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.
*
* @param artifactPath This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.codepipeline.actions.StackSetParameters fromArtifactPath(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.codepipeline.ArtifactPath artifactPath) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(software.amazon.awscdk.services.codepipeline.actions.StackSetParameters.class, "fromArtifactPath", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.codepipeline.actions.StackSetParameters.class), new Object[] { java.util.Objects.requireNonNull(artifactPath, "artifactPath is required") });
}
/**
* 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"));
*
*
* @param parameters This parameter is required.
* @param usePreviousValues
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.codepipeline.actions.StackSetParameters fromLiteral(final @org.jetbrains.annotations.NotNull java.util.Map parameters, final @org.jetbrains.annotations.Nullable java.util.List usePreviousValues) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(software.amazon.awscdk.services.codepipeline.actions.StackSetParameters.class, "fromLiteral", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.codepipeline.actions.StackSetParameters.class), new Object[] { java.util.Objects.requireNonNull(parameters, "parameters is required"), 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"));
*
*
* @param parameters This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.codepipeline.actions.StackSetParameters fromLiteral(final @org.jetbrains.annotations.NotNull java.util.Map parameters) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(software.amazon.awscdk.services.codepipeline.actions.StackSetParameters.class, "fromLiteral", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.codepipeline.actions.StackSetParameters.class), new Object[] { java.util.Objects.requireNonNull(parameters, "parameters is required") });
}
/**
* A proxy class which represents a concrete javascript instance of this type.
*/
@software.amazon.jsii.Internal
private static final class Jsii$Proxy extends software.amazon.awscdk.services.codepipeline.actions.StackSetParameters {
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
}
}