io.github.cdklabs.cdk.stacksets.TargetOptions Maven / Gradle / Ivy
package io.github.cdklabs.cdk.stacksets;
/**
* (experimental) Common options for deploying a StackSet to a target.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.83.0 (build fd4544d)", date = "2023-06-13T00:17:42.442Z")
@software.amazon.jsii.Jsii(module = io.github.cdklabs.cdk.stacksets.$Module.class, fqn = "cdk-stacksets.TargetOptions")
@software.amazon.jsii.Jsii.Proxy(TargetOptions.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface TargetOptions extends software.amazon.jsii.JsiiSerializable {
/**
* (experimental) A list of regions the Stack should be deployed to.
*
* If {@link StackSetProps.operationPreferences.regionOrder} is specified
* then the StackSet will be deployed sequentially otherwise it will be
* deployed to all regions in parallel.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.util.List getRegions();
/**
* (experimental) Parameter overrides that should be applied to only this target.
*
* Default: - use parameter overrides specified in {@link StackSetProps.parameterOverrides}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.util.Map getParameterOverrides() {
return null;
}
/**
* @return a {@link Builder} of {@link TargetOptions}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link TargetOptions}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
java.util.List regions;
java.util.Map parameterOverrides;
/**
* Sets the value of {@link TargetOptions#getRegions}
* @param regions A list of regions the Stack should be deployed to. This parameter is required.
* If {@link StackSetProps.operationPreferences.regionOrder} is specified
* then the StackSet will be deployed sequentially otherwise it will be
* deployed to all regions in parallel.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder regions(java.util.List regions) {
this.regions = regions;
return this;
}
/**
* Sets the value of {@link TargetOptions#getParameterOverrides}
* @param parameterOverrides Parameter overrides that should be applied to only this target.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder parameterOverrides(java.util.Map parameterOverrides) {
this.parameterOverrides = parameterOverrides;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link TargetOptions}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public TargetOptions build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link TargetOptions}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements TargetOptions {
private final java.util.List regions;
private final java.util.Map parameterOverrides;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.regions = software.amazon.jsii.Kernel.get(this, "regions", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class)));
this.parameterOverrides = software.amazon.jsii.Kernel.get(this, "parameterOverrides", software.amazon.jsii.NativeType.mapOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class)));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.regions = java.util.Objects.requireNonNull(builder.regions, "regions is required");
this.parameterOverrides = builder.parameterOverrides;
}
@Override
public final java.util.List getRegions() {
return this.regions;
}
@Override
public final java.util.Map getParameterOverrides() {
return this.parameterOverrides;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("regions", om.valueToTree(this.getRegions()));
if (this.getParameterOverrides() != null) {
data.set("parameterOverrides", om.valueToTree(this.getParameterOverrides()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("cdk-stacksets.TargetOptions"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
TargetOptions.Jsii$Proxy that = (TargetOptions.Jsii$Proxy) o;
if (!regions.equals(that.regions)) return false;
return this.parameterOverrides != null ? this.parameterOverrides.equals(that.parameterOverrides) : that.parameterOverrides == null;
}
@Override
public final int hashCode() {
int result = this.regions.hashCode();
result = 31 * result + (this.parameterOverrides != null ? this.parameterOverrides.hashCode() : 0);
return result;
}
}
}