software.amazon.awscdk.services.iot.actions.alpha.HttpActionSigV4Auth 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;
/**
* Example:
*
*
* 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(
* HttpsAction.Builder.create("https://example.com/endpoint")
* .confirmationUrl("https://example.com")
* .headers(List.of(HttpActionHeader.builder().key("key0").value("value0").build(), HttpActionHeader.builder().key("key1").value("value1").build()))
* .auth(HttpActionSigV4Auth.builder().serviceName("serviceName").signingRegion("us-east-1").build())
* .build());
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-10-11T15:56:08.448Z")
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.iot.actions.alpha.$Module.class, fqn = "@aws-cdk/aws-iot-actions-alpha.HttpActionSigV4Auth")
@software.amazon.jsii.Jsii.Proxy(HttpActionSigV4Auth.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface HttpActionSigV4Auth extends software.amazon.jsii.JsiiSerializable {
/**
* (experimental) The service name.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.lang.String getServiceName();
/**
* (experimental) The signing region.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.lang.String getSigningRegion();
/**
* @return a {@link Builder} of {@link HttpActionSigV4Auth}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link HttpActionSigV4Auth}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.String serviceName;
java.lang.String signingRegion;
/**
* Sets the value of {@link HttpActionSigV4Auth#getServiceName}
* @param serviceName The service name. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder serviceName(java.lang.String serviceName) {
this.serviceName = serviceName;
return this;
}
/**
* Sets the value of {@link HttpActionSigV4Auth#getSigningRegion}
* @param signingRegion The signing region. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder signingRegion(java.lang.String signingRegion) {
this.signingRegion = signingRegion;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link HttpActionSigV4Auth}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public HttpActionSigV4Auth build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link HttpActionSigV4Auth}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements HttpActionSigV4Auth {
private final java.lang.String serviceName;
private final java.lang.String signingRegion;
/**
* 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.serviceName = software.amazon.jsii.Kernel.get(this, "serviceName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.signingRegion = software.amazon.jsii.Kernel.get(this, "signingRegion", 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.serviceName = java.util.Objects.requireNonNull(builder.serviceName, "serviceName is required");
this.signingRegion = java.util.Objects.requireNonNull(builder.signingRegion, "signingRegion is required");
}
@Override
public final java.lang.String getServiceName() {
return this.serviceName;
}
@Override
public final java.lang.String getSigningRegion() {
return this.signingRegion;
}
@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("serviceName", om.valueToTree(this.getServiceName()));
data.set("signingRegion", om.valueToTree(this.getSigningRegion()));
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.HttpActionSigV4Auth"));
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;
HttpActionSigV4Auth.Jsii$Proxy that = (HttpActionSigV4Auth.Jsii$Proxy) o;
if (!serviceName.equals(that.serviceName)) return false;
return this.signingRegion.equals(that.signingRegion);
}
@Override
public final int hashCode() {
int result = this.serviceName.hashCode();
result = 31 * result + (this.signingRegion.hashCode());
return result;
}
}
}