io.github.cdklabs.cdk.stacksets.OrganizationsTargetOptions Maven / Gradle / Ivy
package io.github.cdklabs.cdk.stacksets;
/**
* (experimental) Options for deploying a StackSet to a set of Organizational Units (OUs).
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.83.0 (build fd4544d)", date = "2023-06-13T00:17:42.427Z")
@software.amazon.jsii.Jsii(module = io.github.cdklabs.cdk.stacksets.$Module.class, fqn = "cdk-stacksets.OrganizationsTargetOptions")
@software.amazon.jsii.Jsii.Proxy(OrganizationsTargetOptions.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface OrganizationsTargetOptions extends software.amazon.jsii.JsiiSerializable, io.github.cdklabs.cdk.stacksets.TargetOptions {
/**
* (experimental) A list of organizational unit ids to deploy to.
*
* The StackSet will
* deploy the provided Stack template to all accounts in the OU.
* This can be further filtered by specifying either additionalAccounts
* or excludeAccounts.
*
* If the deploymentType is specified with autoDeployEnabled then
* the StackSet will automatically deploy the Stack to new accounts as they
* are added to the specified organizationalUnits
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.util.List getOrganizationalUnits();
/**
* (experimental) A list of additional AWS accounts to deploy the StackSet to.
*
* This can be
* used to deploy the StackSet to additional AWS accounts that exist in a
* different OU than what has been provided in organizationalUnits
*
* Default: - Stacks will only be deployed to accounts that exist in the
* specified organizationalUnits
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.util.List getAdditionalAccounts() {
return null;
}
/**
* (experimental) A list of AWS accounts to exclude from deploying the StackSet to.
*
* This can
* be useful if there are accounts that exist in an OU that is provided in
* organizationalUnits, but you do not want the StackSet to be deployed.
*
* Default: - Stacks will be deployed to all accounts that exist in the OUs
* specified in the organizationUnits property
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.util.List getExcludeAccounts() {
return null;
}
/**
* @return a {@link Builder} of {@link OrganizationsTargetOptions}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link OrganizationsTargetOptions}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
java.util.List organizationalUnits;
java.util.List additionalAccounts;
java.util.List excludeAccounts;
java.util.List regions;
java.util.Map parameterOverrides;
/**
* Sets the value of {@link OrganizationsTargetOptions#getOrganizationalUnits}
* @param organizationalUnits A list of organizational unit ids to deploy to. This parameter is required.
* The StackSet will
* deploy the provided Stack template to all accounts in the OU.
* This can be further filtered by specifying either additionalAccounts
* or excludeAccounts.
*
* If the deploymentType is specified with autoDeployEnabled then
* the StackSet will automatically deploy the Stack to new accounts as they
* are added to the specified organizationalUnits
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder organizationalUnits(java.util.List organizationalUnits) {
this.organizationalUnits = organizationalUnits;
return this;
}
/**
* Sets the value of {@link OrganizationsTargetOptions#getAdditionalAccounts}
* @param additionalAccounts A list of additional AWS accounts to deploy the StackSet to.
* This can be
* used to deploy the StackSet to additional AWS accounts that exist in a
* different OU than what has been provided in organizationalUnits
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder additionalAccounts(java.util.List additionalAccounts) {
this.additionalAccounts = additionalAccounts;
return this;
}
/**
* Sets the value of {@link OrganizationsTargetOptions#getExcludeAccounts}
* @param excludeAccounts A list of AWS accounts to exclude from deploying the StackSet to.
* This can
* be useful if there are accounts that exist in an OU that is provided in
* organizationalUnits, but you do not want the StackSet to be deployed.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder excludeAccounts(java.util.List excludeAccounts) {
this.excludeAccounts = excludeAccounts;
return this;
}
/**
* Sets the value of {@link OrganizationsTargetOptions#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 OrganizationsTargetOptions#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 OrganizationsTargetOptions}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public OrganizationsTargetOptions build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link OrganizationsTargetOptions}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements OrganizationsTargetOptions {
private final java.util.List organizationalUnits;
private final java.util.List additionalAccounts;
private final java.util.List excludeAccounts;
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.organizationalUnits = software.amazon.jsii.Kernel.get(this, "organizationalUnits", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class)));
this.additionalAccounts = software.amazon.jsii.Kernel.get(this, "additionalAccounts", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class)));
this.excludeAccounts = software.amazon.jsii.Kernel.get(this, "excludeAccounts", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class)));
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.organizationalUnits = java.util.Objects.requireNonNull(builder.organizationalUnits, "organizationalUnits is required");
this.additionalAccounts = builder.additionalAccounts;
this.excludeAccounts = builder.excludeAccounts;
this.regions = java.util.Objects.requireNonNull(builder.regions, "regions is required");
this.parameterOverrides = builder.parameterOverrides;
}
@Override
public final java.util.List getOrganizationalUnits() {
return this.organizationalUnits;
}
@Override
public final java.util.List getAdditionalAccounts() {
return this.additionalAccounts;
}
@Override
public final java.util.List getExcludeAccounts() {
return this.excludeAccounts;
}
@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("organizationalUnits", om.valueToTree(this.getOrganizationalUnits()));
if (this.getAdditionalAccounts() != null) {
data.set("additionalAccounts", om.valueToTree(this.getAdditionalAccounts()));
}
if (this.getExcludeAccounts() != null) {
data.set("excludeAccounts", om.valueToTree(this.getExcludeAccounts()));
}
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.OrganizationsTargetOptions"));
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;
OrganizationsTargetOptions.Jsii$Proxy that = (OrganizationsTargetOptions.Jsii$Proxy) o;
if (!organizationalUnits.equals(that.organizationalUnits)) return false;
if (this.additionalAccounts != null ? !this.additionalAccounts.equals(that.additionalAccounts) : that.additionalAccounts != null) return false;
if (this.excludeAccounts != null ? !this.excludeAccounts.equals(that.excludeAccounts) : that.excludeAccounts != null) return false;
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.organizationalUnits.hashCode();
result = 31 * result + (this.additionalAccounts != null ? this.additionalAccounts.hashCode() : 0);
result = 31 * result + (this.excludeAccounts != null ? this.excludeAccounts.hashCode() : 0);
result = 31 * result + (this.regions.hashCode());
result = 31 * result + (this.parameterOverrides != null ? this.parameterOverrides.hashCode() : 0);
return result;
}
}
}