software.amazon.awscdk.services.codepipeline.actions.ManualApprovalActionProps Maven / Gradle / Ivy
package software.amazon.awscdk.services.codepipeline.actions;
/**
* Construction properties of the {@link ManualApprovalAction}.
*/
@javax.annotation.Generated(value = "jsii-pacmak/0.10.3 (build 6bbf743)", date = "2019-05-02T10:15:47.482Z")
public interface ManualApprovalActionProps extends software.amazon.jsii.JsiiSerializable, software.amazon.awscdk.services.codepipeline.CommonActionProps {
/**
* Any additional information that you want to include in the notification email message.
*/
java.lang.String getAdditionalInformation();
/**
* Optional SNS topic to send notifications to when an approval is pending.
*/
software.amazon.awscdk.services.sns.ITopic getNotificationTopic();
/**
* A list of email addresses to subscribe to notifications when this Action is pending approval. If this has been provided, but not `notificationTopic`, a new Topic will be created.
*/
java.util.List getNotifyEmails();
/**
* @return a {@link Builder} of {@link ManualApprovalActionProps}
*/
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link ManualApprovalActionProps}
*/
final class Builder {
@javax.annotation.Nullable
private java.lang.String _additionalInformation;
@javax.annotation.Nullable
private software.amazon.awscdk.services.sns.ITopic _notificationTopic;
@javax.annotation.Nullable
private java.util.List _notifyEmails;
private java.lang.String _actionName;
@javax.annotation.Nullable
private java.lang.Number _runOrder;
/**
* Sets the value of AdditionalInformation
* @param value Any additional information that you want to include in the notification email message.
* @return {@code this}
*/
public Builder withAdditionalInformation(@javax.annotation.Nullable final java.lang.String value) {
this._additionalInformation = value;
return this;
}
/**
* Sets the value of NotificationTopic
* @param value Optional SNS topic to send notifications to when an approval is pending.
* @return {@code this}
*/
public Builder withNotificationTopic(@javax.annotation.Nullable final software.amazon.awscdk.services.sns.ITopic value) {
this._notificationTopic = value;
return this;
}
/**
* Sets the value of NotifyEmails
* @param value A list of email addresses to subscribe to notifications when this Action is pending approval. If this has been provided, but not `notificationTopic`, a new Topic will be created.
* @return {@code this}
*/
public Builder withNotifyEmails(@javax.annotation.Nullable final java.util.List value) {
this._notifyEmails = value;
return this;
}
/**
* Sets the value of ActionName
* @param value The physical, human-readable name of the Action. Not that Action names must be unique within a single Stage.
* @return {@code this}
*/
public Builder withActionName(final java.lang.String value) {
this._actionName = java.util.Objects.requireNonNull(value, "actionName is required");
return this;
}
/**
* Sets the value of RunOrder
* @param value The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute.
* @return {@code this}
*/
public Builder withRunOrder(@javax.annotation.Nullable final java.lang.Number value) {
this._runOrder = value;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link ManualApprovalActionProps}
* @throws NullPointerException if any required attribute was not provided
*/
public ManualApprovalActionProps build() {
return new ManualApprovalActionProps() {
@javax.annotation.Nullable
private final java.lang.String $additionalInformation = _additionalInformation;
@javax.annotation.Nullable
private final software.amazon.awscdk.services.sns.ITopic $notificationTopic = _notificationTopic;
@javax.annotation.Nullable
private final java.util.List $notifyEmails = _notifyEmails;
private final java.lang.String $actionName = java.util.Objects.requireNonNull(_actionName, "actionName is required");
@javax.annotation.Nullable
private final java.lang.Number $runOrder = _runOrder;
@Override
public java.lang.String getAdditionalInformation() {
return this.$additionalInformation;
}
@Override
public software.amazon.awscdk.services.sns.ITopic getNotificationTopic() {
return this.$notificationTopic;
}
@Override
public java.util.List getNotifyEmails() {
return this.$notifyEmails;
}
@Override
public java.lang.String getActionName() {
return this.$actionName;
}
@Override
public java.lang.Number getRunOrder() {
return this.$runOrder;
}
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("additionalInformation", om.valueToTree(this.getAdditionalInformation()));
obj.set("notificationTopic", om.valueToTree(this.getNotificationTopic()));
obj.set("notifyEmails", om.valueToTree(this.getNotifyEmails()));
obj.set("actionName", om.valueToTree(this.getActionName()));
obj.set("runOrder", om.valueToTree(this.getRunOrder()));
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.services.codepipeline.actions.ManualApprovalActionProps {
protected Jsii$Proxy(final software.amazon.jsii.JsiiObject.InitializationMode mode) {
super(mode);
}
/**
* Any additional information that you want to include in the notification email message.
*/
@Override
@javax.annotation.Nullable
public java.lang.String getAdditionalInformation() {
return this.jsiiGet("additionalInformation", java.lang.String.class);
}
/**
* Optional SNS topic to send notifications to when an approval is pending.
*/
@Override
@javax.annotation.Nullable
public software.amazon.awscdk.services.sns.ITopic getNotificationTopic() {
return this.jsiiGet("notificationTopic", software.amazon.awscdk.services.sns.ITopic.class);
}
/**
* A list of email addresses to subscribe to notifications when this Action is pending approval. If this has been provided, but not `notificationTopic`, a new Topic will be created.
*/
@Override
@javax.annotation.Nullable
public java.util.List getNotifyEmails() {
return this.jsiiGet("notifyEmails", java.util.List.class);
}
/**
* The physical, human-readable name of the Action. Not that Action names must be unique within a single Stage.
*/
@Override
public java.lang.String getActionName() {
return this.jsiiGet("actionName", java.lang.String.class);
}
/**
* The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute.
*
* Default: 1
*
* @see https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html
*/
@Override
@javax.annotation.Nullable
public java.lang.Number getRunOrder() {
return this.jsiiGet("runOrder", java.lang.Number.class);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy