software.amazon.awsconstructs.services.iotkinesisfirehoses3.IotToKinesisFirehoseToS3Props Maven / Gradle / Ivy
Show all versions of iotkinesisfirehoses3 Show documentation
package software.amazon.awsconstructs.services.iotkinesisfirehoses3;
/**
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.102.0 (build e354887)", date = "2024-08-11T02:36:56.156Z")
@software.amazon.jsii.Jsii(module = software.amazon.awsconstructs.services.iotkinesisfirehoses3.$Module.class, fqn = "@aws-solutions-constructs/aws-iot-kinesisfirehose-s3.IotToKinesisFirehoseToS3Props")
@software.amazon.jsii.Jsii.Proxy(IotToKinesisFirehoseToS3Props.Jsii$Proxy.class)
public interface IotToKinesisFirehoseToS3Props extends software.amazon.jsii.JsiiSerializable {
/**
* User provided CfnTopicRuleProps to override the defaults.
*
* Default: - Default props are used
*/
@org.jetbrains.annotations.NotNull software.amazon.awscdk.services.iot.CfnTopicRuleProps getIotTopicRuleProps();
/**
* User provided props to override the default props for the S3 Bucket.
*
* Default: - Default props are used
*/
default @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.s3.BucketProps getBucketProps() {
return null;
}
/**
* Existing instance of S3 Bucket object, providing both this and bucketProps
will cause an error.
*
* Default: - None
*/
default @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.s3.IBucket getExistingBucketObj() {
return null;
}
/**
* Optional user provided props to override the default props.
*
* Default: - Default props are used
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getKinesisFirehoseProps() {
return null;
}
/**
* Optional user provided props to override the default props for the S3 Logging Bucket.
*
* Default: - Default props are used
*/
default @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.s3.BucketProps getLoggingBucketProps() {
return null;
}
/**
* User provided props to override the default props for the CloudWatchLogs LogGroup.
*
* Default: - Default props are used
*/
default @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.logs.LogGroupProps getLogGroupProps() {
return null;
}
/**
* Whether to turn on Access Logs for the S3 bucket with the associated storage costs.
*
* Enabling Access Logging is a best practice.
*
* Default: - true
*/
default @org.jetbrains.annotations.Nullable java.lang.Boolean getLogS3AccessLogs() {
return null;
}
/**
* @return a {@link Builder} of {@link IotToKinesisFirehoseToS3Props}
*/
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link IotToKinesisFirehoseToS3Props}
*/
public static final class Builder implements software.amazon.jsii.Builder {
software.amazon.awscdk.services.iot.CfnTopicRuleProps iotTopicRuleProps;
software.amazon.awscdk.services.s3.BucketProps bucketProps;
software.amazon.awscdk.services.s3.IBucket existingBucketObj;
java.lang.Object kinesisFirehoseProps;
software.amazon.awscdk.services.s3.BucketProps loggingBucketProps;
software.amazon.awscdk.services.logs.LogGroupProps logGroupProps;
java.lang.Boolean logS3AccessLogs;
/**
* Sets the value of {@link IotToKinesisFirehoseToS3Props#getIotTopicRuleProps}
* @param iotTopicRuleProps User provided CfnTopicRuleProps to override the defaults. This parameter is required.
* @return {@code this}
*/
public Builder iotTopicRuleProps(software.amazon.awscdk.services.iot.CfnTopicRuleProps iotTopicRuleProps) {
this.iotTopicRuleProps = iotTopicRuleProps;
return this;
}
/**
* Sets the value of {@link IotToKinesisFirehoseToS3Props#getBucketProps}
* @param bucketProps User provided props to override the default props for the S3 Bucket.
* @return {@code this}
*/
public Builder bucketProps(software.amazon.awscdk.services.s3.BucketProps bucketProps) {
this.bucketProps = bucketProps;
return this;
}
/**
* Sets the value of {@link IotToKinesisFirehoseToS3Props#getExistingBucketObj}
* @param existingBucketObj Existing instance of S3 Bucket object, providing both this and bucketProps
will cause an error.
* @return {@code this}
*/
public Builder existingBucketObj(software.amazon.awscdk.services.s3.IBucket existingBucketObj) {
this.existingBucketObj = existingBucketObj;
return this;
}
/**
* Sets the value of {@link IotToKinesisFirehoseToS3Props#getKinesisFirehoseProps}
* @param kinesisFirehoseProps Optional user provided props to override the default props.
* @return {@code this}
*/
public Builder kinesisFirehoseProps(java.lang.Object kinesisFirehoseProps) {
this.kinesisFirehoseProps = kinesisFirehoseProps;
return this;
}
/**
* Sets the value of {@link IotToKinesisFirehoseToS3Props#getLoggingBucketProps}
* @param loggingBucketProps Optional user provided props to override the default props for the S3 Logging Bucket.
* @return {@code this}
*/
public Builder loggingBucketProps(software.amazon.awscdk.services.s3.BucketProps loggingBucketProps) {
this.loggingBucketProps = loggingBucketProps;
return this;
}
/**
* Sets the value of {@link IotToKinesisFirehoseToS3Props#getLogGroupProps}
* @param logGroupProps User provided props to override the default props for the CloudWatchLogs LogGroup.
* @return {@code this}
*/
public Builder logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps) {
this.logGroupProps = logGroupProps;
return this;
}
/**
* Sets the value of {@link IotToKinesisFirehoseToS3Props#getLogS3AccessLogs}
* @param logS3AccessLogs Whether to turn on Access Logs for the S3 bucket with the associated storage costs.
* Enabling Access Logging is a best practice.
* @return {@code this}
*/
public Builder logS3AccessLogs(java.lang.Boolean logS3AccessLogs) {
this.logS3AccessLogs = logS3AccessLogs;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link IotToKinesisFirehoseToS3Props}
* @throws NullPointerException if any required attribute was not provided
*/
@Override
public IotToKinesisFirehoseToS3Props build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link IotToKinesisFirehoseToS3Props}
*/
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements IotToKinesisFirehoseToS3Props {
private final software.amazon.awscdk.services.iot.CfnTopicRuleProps iotTopicRuleProps;
private final software.amazon.awscdk.services.s3.BucketProps bucketProps;
private final software.amazon.awscdk.services.s3.IBucket existingBucketObj;
private final java.lang.Object kinesisFirehoseProps;
private final software.amazon.awscdk.services.s3.BucketProps loggingBucketProps;
private final software.amazon.awscdk.services.logs.LogGroupProps logGroupProps;
private final java.lang.Boolean logS3AccessLogs;
/**
* 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.iotTopicRuleProps = software.amazon.jsii.Kernel.get(this, "iotTopicRuleProps", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.iot.CfnTopicRuleProps.class));
this.bucketProps = software.amazon.jsii.Kernel.get(this, "bucketProps", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.s3.BucketProps.class));
this.existingBucketObj = software.amazon.jsii.Kernel.get(this, "existingBucketObj", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.s3.IBucket.class));
this.kinesisFirehoseProps = software.amazon.jsii.Kernel.get(this, "kinesisFirehoseProps", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.loggingBucketProps = software.amazon.jsii.Kernel.get(this, "loggingBucketProps", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.s3.BucketProps.class));
this.logGroupProps = software.amazon.jsii.Kernel.get(this, "logGroupProps", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.logs.LogGroupProps.class));
this.logS3AccessLogs = software.amazon.jsii.Kernel.get(this, "logS3AccessLogs", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.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.iotTopicRuleProps = java.util.Objects.requireNonNull(builder.iotTopicRuleProps, "iotTopicRuleProps is required");
this.bucketProps = builder.bucketProps;
this.existingBucketObj = builder.existingBucketObj;
this.kinesisFirehoseProps = builder.kinesisFirehoseProps;
this.loggingBucketProps = builder.loggingBucketProps;
this.logGroupProps = builder.logGroupProps;
this.logS3AccessLogs = builder.logS3AccessLogs;
}
@Override
public final software.amazon.awscdk.services.iot.CfnTopicRuleProps getIotTopicRuleProps() {
return this.iotTopicRuleProps;
}
@Override
public final software.amazon.awscdk.services.s3.BucketProps getBucketProps() {
return this.bucketProps;
}
@Override
public final software.amazon.awscdk.services.s3.IBucket getExistingBucketObj() {
return this.existingBucketObj;
}
@Override
public final java.lang.Object getKinesisFirehoseProps() {
return this.kinesisFirehoseProps;
}
@Override
public final software.amazon.awscdk.services.s3.BucketProps getLoggingBucketProps() {
return this.loggingBucketProps;
}
@Override
public final software.amazon.awscdk.services.logs.LogGroupProps getLogGroupProps() {
return this.logGroupProps;
}
@Override
public final java.lang.Boolean getLogS3AccessLogs() {
return this.logS3AccessLogs;
}
@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("iotTopicRuleProps", om.valueToTree(this.getIotTopicRuleProps()));
if (this.getBucketProps() != null) {
data.set("bucketProps", om.valueToTree(this.getBucketProps()));
}
if (this.getExistingBucketObj() != null) {
data.set("existingBucketObj", om.valueToTree(this.getExistingBucketObj()));
}
if (this.getKinesisFirehoseProps() != null) {
data.set("kinesisFirehoseProps", om.valueToTree(this.getKinesisFirehoseProps()));
}
if (this.getLoggingBucketProps() != null) {
data.set("loggingBucketProps", om.valueToTree(this.getLoggingBucketProps()));
}
if (this.getLogGroupProps() != null) {
data.set("logGroupProps", om.valueToTree(this.getLogGroupProps()));
}
if (this.getLogS3AccessLogs() != null) {
data.set("logS3AccessLogs", om.valueToTree(this.getLogS3AccessLogs()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@aws-solutions-constructs/aws-iot-kinesisfirehose-s3.IotToKinesisFirehoseToS3Props"));
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;
IotToKinesisFirehoseToS3Props.Jsii$Proxy that = (IotToKinesisFirehoseToS3Props.Jsii$Proxy) o;
if (!iotTopicRuleProps.equals(that.iotTopicRuleProps)) return false;
if (this.bucketProps != null ? !this.bucketProps.equals(that.bucketProps) : that.bucketProps != null) return false;
if (this.existingBucketObj != null ? !this.existingBucketObj.equals(that.existingBucketObj) : that.existingBucketObj != null) return false;
if (this.kinesisFirehoseProps != null ? !this.kinesisFirehoseProps.equals(that.kinesisFirehoseProps) : that.kinesisFirehoseProps != null) return false;
if (this.loggingBucketProps != null ? !this.loggingBucketProps.equals(that.loggingBucketProps) : that.loggingBucketProps != null) return false;
if (this.logGroupProps != null ? !this.logGroupProps.equals(that.logGroupProps) : that.logGroupProps != null) return false;
return this.logS3AccessLogs != null ? this.logS3AccessLogs.equals(that.logS3AccessLogs) : that.logS3AccessLogs == null;
}
@Override
public final int hashCode() {
int result = this.iotTopicRuleProps.hashCode();
result = 31 * result + (this.bucketProps != null ? this.bucketProps.hashCode() : 0);
result = 31 * result + (this.existingBucketObj != null ? this.existingBucketObj.hashCode() : 0);
result = 31 * result + (this.kinesisFirehoseProps != null ? this.kinesisFirehoseProps.hashCode() : 0);
result = 31 * result + (this.loggingBucketProps != null ? this.loggingBucketProps.hashCode() : 0);
result = 31 * result + (this.logGroupProps != null ? this.logGroupProps.hashCode() : 0);
result = 31 * result + (this.logS3AccessLogs != null ? this.logS3AccessLogs.hashCode() : 0);
return result;
}
}
}