software.amazon.awscdk.services.iot.actions.alpha.OpenSearchActionProps Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of iot-actions-alpha Show documentation
Show all versions of iot-actions-alpha Show documentation
Receipt rule actions for AWS IoT
package software.amazon.awscdk.services.iot.actions.alpha;
/**
* (experimental) Configuration properties of an action for Open Search.
*
* Example:
*
*
* import software.amazon.awscdk.services.opensearchservice.*;
* Domain domain;
* TopicRule topicRule = TopicRule.Builder.create(this, "TopicRule")
* .sql(IotSql.fromStringAsVer20160323("SELECT topic(2) as device_id, year, month, day FROM 'device/+/data'"))
* .build();
* topicRule.addAction(OpenSearchAction.Builder.create(domain)
* .id("my-id")
* .index("my-index")
* .type("my-type")
* .build());
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-10-11T15:56:08.453Z")
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.iot.actions.alpha.$Module.class, fqn = "@aws-cdk/aws-iot-actions-alpha.OpenSearchActionProps")
@software.amazon.jsii.Jsii.Proxy(OpenSearchActionProps.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface OpenSearchActionProps extends software.amazon.jsii.JsiiSerializable, software.amazon.awscdk.services.iot.actions.alpha.CommonActionProps {
/**
* (experimental) The unique identifier for the document you are storing.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.lang.String getId();
/**
* (experimental) The OpenSearch index where you want to store your data.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.lang.String getIndex();
/**
* (experimental) The type of document you are storing.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.lang.String getType();
/**
* @return a {@link Builder} of {@link OpenSearchActionProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link OpenSearchActionProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.String id;
java.lang.String index;
java.lang.String type;
software.amazon.awscdk.services.iam.IRole role;
/**
* Sets the value of {@link OpenSearchActionProps#getId}
* @param id The unique identifier for the document you are storing. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder id(java.lang.String id) {
this.id = id;
return this;
}
/**
* Sets the value of {@link OpenSearchActionProps#getIndex}
* @param index The OpenSearch index where you want to store your data. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder index(java.lang.String index) {
this.index = index;
return this;
}
/**
* Sets the value of {@link OpenSearchActionProps#getType}
* @param type The type of document you are storing. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder type(java.lang.String type) {
this.type = type;
return this;
}
/**
* Sets the value of {@link OpenSearchActionProps#getRole}
* @param role The IAM role that allows access to AWS service.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder role(software.amazon.awscdk.services.iam.IRole role) {
this.role = role;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link OpenSearchActionProps}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public OpenSearchActionProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link OpenSearchActionProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements OpenSearchActionProps {
private final java.lang.String id;
private final java.lang.String index;
private final java.lang.String type;
private final software.amazon.awscdk.services.iam.IRole role;
/**
* 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.id = software.amazon.jsii.Kernel.get(this, "id", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.index = software.amazon.jsii.Kernel.get(this, "index", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.type = software.amazon.jsii.Kernel.get(this, "type", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.role = software.amazon.jsii.Kernel.get(this, "role", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.iam.IRole.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.id = java.util.Objects.requireNonNull(builder.id, "id is required");
this.index = java.util.Objects.requireNonNull(builder.index, "index is required");
this.type = java.util.Objects.requireNonNull(builder.type, "type is required");
this.role = builder.role;
}
@Override
public final java.lang.String getId() {
return this.id;
}
@Override
public final java.lang.String getIndex() {
return this.index;
}
@Override
public final java.lang.String getType() {
return this.type;
}
@Override
public final software.amazon.awscdk.services.iam.IRole getRole() {
return this.role;
}
@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("id", om.valueToTree(this.getId()));
data.set("index", om.valueToTree(this.getIndex()));
data.set("type", om.valueToTree(this.getType()));
if (this.getRole() != null) {
data.set("role", om.valueToTree(this.getRole()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@aws-cdk/aws-iot-actions-alpha.OpenSearchActionProps"));
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;
OpenSearchActionProps.Jsii$Proxy that = (OpenSearchActionProps.Jsii$Proxy) o;
if (!id.equals(that.id)) return false;
if (!index.equals(that.index)) return false;
if (!type.equals(that.type)) return false;
return this.role != null ? this.role.equals(that.role) : that.role == null;
}
@Override
public final int hashCode() {
int result = this.id.hashCode();
result = 31 * result + (this.index.hashCode());
result = 31 * result + (this.type.hashCode());
result = 31 * result + (this.role != null ? this.role.hashCode() : 0);
return result;
}
}
}