software.amazon.awscdk.StringListCfnOutputProps Maven / Gradle / Ivy
package software.amazon.awscdk;
/**
* Properties for ListOutput.
*/
@javax.annotation.Generated(value = "jsii-pacmak/0.10.5 (build 46bc9b0)", date = "2019-05-06T20:49:40.959Z")
public interface StringListCfnOutputProps extends software.amazon.jsii.JsiiSerializable {
/**
* The list of primitives to export.
*/
java.util.List getValues();
/**
* A condition from the "Conditions" section to associate with this output value.
*
* If the condition evaluates to `false`, this output value will not
* be included in the stack.
*/
software.amazon.awscdk.CfnCondition getCondition();
/**
* A String type that describes the output value. The description can be a maximum of 4 K in length.
*/
java.lang.String getDescription();
/**
* Disables the automatic allocation of an export name for this output.
*
* Default: false, which means that an export name is either explicitly
* specified or allocated based on the output's logical ID and stack name.
*/
java.lang.Boolean getDisableExport();
/**
* The name used to export the value of this output across stacks.
*
* To import
* the value from another stack, use `FnImportValue(export)`. You can create
* an import value token by calling `output.makeImportValue()`.
*
* Default: The default behavior is to automatically allocate an export name
* for outputs based on the stack name and the output's logical ID. To
* create an output without an export, set `disableExport: true`.
*/
java.lang.String getExport();
/**
* The separator to use to separate stringified values.
*
* Default: ","
*/
java.lang.String getSeparator();
/**
* @return a {@link Builder} of {@link StringListCfnOutputProps}
*/
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link StringListCfnOutputProps}
*/
final class Builder {
private java.util.List _values;
@javax.annotation.Nullable
private software.amazon.awscdk.CfnCondition _condition;
@javax.annotation.Nullable
private java.lang.String _description;
@javax.annotation.Nullable
private java.lang.Boolean _disableExport;
@javax.annotation.Nullable
private java.lang.String _export;
@javax.annotation.Nullable
private java.lang.String _separator;
/**
* Sets the value of Values
* @param value The list of primitives to export.
* @return {@code this}
*/
public Builder withValues(final java.util.List value) {
this._values = java.util.Objects.requireNonNull(value, "values is required");
return this;
}
/**
* Sets the value of Condition
* @param value A condition from the "Conditions" section to associate with this output value.
* @return {@code this}
*/
public Builder withCondition(@javax.annotation.Nullable final software.amazon.awscdk.CfnCondition value) {
this._condition = value;
return this;
}
/**
* Sets the value of Description
* @param value A String type that describes the output value. The description can be a maximum of 4 K in length.
* @return {@code this}
*/
public Builder withDescription(@javax.annotation.Nullable final java.lang.String value) {
this._description = value;
return this;
}
/**
* Sets the value of DisableExport
* @param value Disables the automatic allocation of an export name for this output.
* @return {@code this}
*/
public Builder withDisableExport(@javax.annotation.Nullable final java.lang.Boolean value) {
this._disableExport = value;
return this;
}
/**
* Sets the value of Export
* @param value The name used to export the value of this output across stacks.
* @return {@code this}
*/
public Builder withExport(@javax.annotation.Nullable final java.lang.String value) {
this._export = value;
return this;
}
/**
* Sets the value of Separator
* @param value The separator to use to separate stringified values.
* @return {@code this}
*/
public Builder withSeparator(@javax.annotation.Nullable final java.lang.String value) {
this._separator = value;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link StringListCfnOutputProps}
* @throws NullPointerException if any required attribute was not provided
*/
public StringListCfnOutputProps build() {
return new StringListCfnOutputProps() {
private final java.util.List $values = java.util.Objects.requireNonNull(_values, "values is required");
@javax.annotation.Nullable
private final software.amazon.awscdk.CfnCondition $condition = _condition;
@javax.annotation.Nullable
private final java.lang.String $description = _description;
@javax.annotation.Nullable
private final java.lang.Boolean $disableExport = _disableExport;
@javax.annotation.Nullable
private final java.lang.String $export = _export;
@javax.annotation.Nullable
private final java.lang.String $separator = _separator;
@Override
public java.util.List getValues() {
return this.$values;
}
@Override
public software.amazon.awscdk.CfnCondition getCondition() {
return this.$condition;
}
@Override
public java.lang.String getDescription() {
return this.$description;
}
@Override
public java.lang.Boolean getDisableExport() {
return this.$disableExport;
}
@Override
public java.lang.String getExport() {
return this.$export;
}
@Override
public java.lang.String getSeparator() {
return this.$separator;
}
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("values", om.valueToTree(this.getValues()));
obj.set("condition", om.valueToTree(this.getCondition()));
obj.set("description", om.valueToTree(this.getDescription()));
obj.set("disableExport", om.valueToTree(this.getDisableExport()));
obj.set("export", om.valueToTree(this.getExport()));
obj.set("separator", om.valueToTree(this.getSeparator()));
return obj;
}
};
}
}
/**
* A proxy class which represents a concrete javascript instance of this type.
*/
final static class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements software.amazon.awscdk.StringListCfnOutputProps {
protected Jsii$Proxy(final software.amazon.jsii.JsiiObject.InitializationMode mode) {
super(mode);
}
/**
* The list of primitives to export.
*/
@Override
public java.util.List getValues() {
return this.jsiiGet("values", java.util.List.class);
}
/**
* A condition from the "Conditions" section to associate with this output value.
*
* If the condition evaluates to `false`, this output value will not
* be included in the stack.
*/
@Override
@javax.annotation.Nullable
public software.amazon.awscdk.CfnCondition getCondition() {
return this.jsiiGet("condition", software.amazon.awscdk.CfnCondition.class);
}
/**
* A String type that describes the output value. The description can be a maximum of 4 K in length.
*/
@Override
@javax.annotation.Nullable
public java.lang.String getDescription() {
return this.jsiiGet("description", java.lang.String.class);
}
/**
* Disables the automatic allocation of an export name for this output.
*
* Default: false, which means that an export name is either explicitly
* specified or allocated based on the output's logical ID and stack name.
*/
@Override
@javax.annotation.Nullable
public java.lang.Boolean getDisableExport() {
return this.jsiiGet("disableExport", java.lang.Boolean.class);
}
/**
* The name used to export the value of this output across stacks.
*
* To import
* the value from another stack, use `FnImportValue(export)`. You can create
* an import value token by calling `output.makeImportValue()`.
*
* Default: The default behavior is to automatically allocate an export name
* for outputs based on the stack name and the output's logical ID. To
* create an output without an export, set `disableExport: true`.
*/
@Override
@javax.annotation.Nullable
public java.lang.String getExport() {
return this.jsiiGet("export", java.lang.String.class);
}
/**
* The separator to use to separate stringified values.
*
* Default: ","
*/
@Override
@javax.annotation.Nullable
public java.lang.String getSeparator() {
return this.jsiiGet("separator", java.lang.String.class);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy