io.github.cdklabs.cdk.appflow.RedshiftConnectorProfileProps Maven / Gradle / Ivy
package io.github.cdklabs.cdk.appflow;
/**
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-10-11T10:39:08.269Z")
@software.amazon.jsii.Jsii(module = io.github.cdklabs.cdk.appflow.$Module.class, fqn = "@cdklabs/cdk-appflow.RedshiftConnectorProfileProps")
@software.amazon.jsii.Jsii.Proxy(RedshiftConnectorProfileProps.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface RedshiftConnectorProfileProps extends software.amazon.jsii.JsiiSerializable, io.github.cdklabs.cdk.appflow.ConnectorProfileProps {
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull io.github.cdklabs.cdk.appflow.RedshiftConnectorBasicCredentials getBasicAuth();
/**
* (experimental) The Redshift cluster to use this connector profile with.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull software.amazon.awscdk.services.redshift.alpha.ICluster getCluster();
/**
* (experimental) The name of the database which the RedshiftConnectorProfile will be working with.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.lang.String getDatabaseName();
/**
* (experimental) An intermediate location for the data retrieved from the flow source that will be further transferred to the Redshfit database.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull io.github.cdklabs.cdk.appflow.S3Location getIntermediateLocation();
/**
* (experimental) An IAM Role that the Redshift cluster will assume to get data from the intermiediate S3 Bucket.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.iam.IRole getBucketAccessRole() {
return null;
}
/**
* (experimental) An IAM Role that AppFlow will assume to interact with the Redshift cluster's Data API.
*
* Default: autogenerated IAM role
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.iam.IRole getDataApiRole() {
return null;
}
/**
* @return a {@link Builder} of {@link RedshiftConnectorProfileProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link RedshiftConnectorProfileProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
io.github.cdklabs.cdk.appflow.RedshiftConnectorBasicCredentials basicAuth;
software.amazon.awscdk.services.redshift.alpha.ICluster cluster;
java.lang.String databaseName;
io.github.cdklabs.cdk.appflow.S3Location intermediateLocation;
software.amazon.awscdk.services.iam.IRole bucketAccessRole;
software.amazon.awscdk.services.iam.IRole dataApiRole;
software.amazon.awscdk.services.kms.IKey key;
java.lang.String name;
/**
* Sets the value of {@link RedshiftConnectorProfileProps#getBasicAuth}
* @param basicAuth the value to be set. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder basicAuth(io.github.cdklabs.cdk.appflow.RedshiftConnectorBasicCredentials basicAuth) {
this.basicAuth = basicAuth;
return this;
}
/**
* Sets the value of {@link RedshiftConnectorProfileProps#getCluster}
* @param cluster The Redshift cluster to use this connector profile with. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder cluster(software.amazon.awscdk.services.redshift.alpha.ICluster cluster) {
this.cluster = cluster;
return this;
}
/**
* Sets the value of {@link RedshiftConnectorProfileProps#getDatabaseName}
* @param databaseName The name of the database which the RedshiftConnectorProfile will be working with. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder databaseName(java.lang.String databaseName) {
this.databaseName = databaseName;
return this;
}
/**
* Sets the value of {@link RedshiftConnectorProfileProps#getIntermediateLocation}
* @param intermediateLocation An intermediate location for the data retrieved from the flow source that will be further transferred to the Redshfit database. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder intermediateLocation(io.github.cdklabs.cdk.appflow.S3Location intermediateLocation) {
this.intermediateLocation = intermediateLocation;
return this;
}
/**
* Sets the value of {@link RedshiftConnectorProfileProps#getBucketAccessRole}
* @param bucketAccessRole An IAM Role that the Redshift cluster will assume to get data from the intermiediate S3 Bucket.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder bucketAccessRole(software.amazon.awscdk.services.iam.IRole bucketAccessRole) {
this.bucketAccessRole = bucketAccessRole;
return this;
}
/**
* Sets the value of {@link RedshiftConnectorProfileProps#getDataApiRole}
* @param dataApiRole An IAM Role that AppFlow will assume to interact with the Redshift cluster's Data API.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder dataApiRole(software.amazon.awscdk.services.iam.IRole dataApiRole) {
this.dataApiRole = dataApiRole;
return this;
}
/**
* Sets the value of {@link RedshiftConnectorProfileProps#getKey}
* @param key TODO: think if this should be here as not all connector profiles have that.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder key(software.amazon.awscdk.services.kms.IKey key) {
this.key = key;
return this;
}
/**
* Sets the value of {@link RedshiftConnectorProfileProps#getName}
* @param name the value to be set.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder name(java.lang.String name) {
this.name = name;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link RedshiftConnectorProfileProps}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public RedshiftConnectorProfileProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link RedshiftConnectorProfileProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements RedshiftConnectorProfileProps {
private final io.github.cdklabs.cdk.appflow.RedshiftConnectorBasicCredentials basicAuth;
private final software.amazon.awscdk.services.redshift.alpha.ICluster cluster;
private final java.lang.String databaseName;
private final io.github.cdklabs.cdk.appflow.S3Location intermediateLocation;
private final software.amazon.awscdk.services.iam.IRole bucketAccessRole;
private final software.amazon.awscdk.services.iam.IRole dataApiRole;
private final software.amazon.awscdk.services.kms.IKey key;
private final java.lang.String name;
/**
* 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.basicAuth = software.amazon.jsii.Kernel.get(this, "basicAuth", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdk.appflow.RedshiftConnectorBasicCredentials.class));
this.cluster = software.amazon.jsii.Kernel.get(this, "cluster", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.redshift.alpha.ICluster.class));
this.databaseName = software.amazon.jsii.Kernel.get(this, "databaseName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.intermediateLocation = software.amazon.jsii.Kernel.get(this, "intermediateLocation", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdk.appflow.S3Location.class));
this.bucketAccessRole = software.amazon.jsii.Kernel.get(this, "bucketAccessRole", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.iam.IRole.class));
this.dataApiRole = software.amazon.jsii.Kernel.get(this, "dataApiRole", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.iam.IRole.class));
this.key = software.amazon.jsii.Kernel.get(this, "key", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.kms.IKey.class));
this.name = software.amazon.jsii.Kernel.get(this, "name", 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.basicAuth = java.util.Objects.requireNonNull(builder.basicAuth, "basicAuth is required");
this.cluster = java.util.Objects.requireNonNull(builder.cluster, "cluster is required");
this.databaseName = java.util.Objects.requireNonNull(builder.databaseName, "databaseName is required");
this.intermediateLocation = java.util.Objects.requireNonNull(builder.intermediateLocation, "intermediateLocation is required");
this.bucketAccessRole = builder.bucketAccessRole;
this.dataApiRole = builder.dataApiRole;
this.key = builder.key;
this.name = builder.name;
}
@Override
public final io.github.cdklabs.cdk.appflow.RedshiftConnectorBasicCredentials getBasicAuth() {
return this.basicAuth;
}
@Override
public final software.amazon.awscdk.services.redshift.alpha.ICluster getCluster() {
return this.cluster;
}
@Override
public final java.lang.String getDatabaseName() {
return this.databaseName;
}
@Override
public final io.github.cdklabs.cdk.appflow.S3Location getIntermediateLocation() {
return this.intermediateLocation;
}
@Override
public final software.amazon.awscdk.services.iam.IRole getBucketAccessRole() {
return this.bucketAccessRole;
}
@Override
public final software.amazon.awscdk.services.iam.IRole getDataApiRole() {
return this.dataApiRole;
}
@Override
public final software.amazon.awscdk.services.kms.IKey getKey() {
return this.key;
}
@Override
public final java.lang.String getName() {
return this.name;
}
@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("basicAuth", om.valueToTree(this.getBasicAuth()));
data.set("cluster", om.valueToTree(this.getCluster()));
data.set("databaseName", om.valueToTree(this.getDatabaseName()));
data.set("intermediateLocation", om.valueToTree(this.getIntermediateLocation()));
if (this.getBucketAccessRole() != null) {
data.set("bucketAccessRole", om.valueToTree(this.getBucketAccessRole()));
}
if (this.getDataApiRole() != null) {
data.set("dataApiRole", om.valueToTree(this.getDataApiRole()));
}
if (this.getKey() != null) {
data.set("key", om.valueToTree(this.getKey()));
}
if (this.getName() != null) {
data.set("name", om.valueToTree(this.getName()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@cdklabs/cdk-appflow.RedshiftConnectorProfileProps"));
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;
RedshiftConnectorProfileProps.Jsii$Proxy that = (RedshiftConnectorProfileProps.Jsii$Proxy) o;
if (!basicAuth.equals(that.basicAuth)) return false;
if (!cluster.equals(that.cluster)) return false;
if (!databaseName.equals(that.databaseName)) return false;
if (!intermediateLocation.equals(that.intermediateLocation)) return false;
if (this.bucketAccessRole != null ? !this.bucketAccessRole.equals(that.bucketAccessRole) : that.bucketAccessRole != null) return false;
if (this.dataApiRole != null ? !this.dataApiRole.equals(that.dataApiRole) : that.dataApiRole != null) return false;
if (this.key != null ? !this.key.equals(that.key) : that.key != null) return false;
return this.name != null ? this.name.equals(that.name) : that.name == null;
}
@Override
public final int hashCode() {
int result = this.basicAuth.hashCode();
result = 31 * result + (this.cluster.hashCode());
result = 31 * result + (this.databaseName.hashCode());
result = 31 * result + (this.intermediateLocation.hashCode());
result = 31 * result + (this.bucketAccessRole != null ? this.bucketAccessRole.hashCode() : 0);
result = 31 * result + (this.dataApiRole != null ? this.dataApiRole.hashCode() : 0);
result = 31 * result + (this.key != null ? this.key.hashCode() : 0);
result = 31 * result + (this.name != null ? this.name.hashCode() : 0);
return result;
}
}
}