io.github.cdklabs.cdk.appflow.SnowflakeConnectorProfile Maven / Gradle / Ivy
package io.github.cdklabs.cdk.appflow;
/**
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-23T07:35:38.285Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = io.github.cdklabs.cdk.appflow.$Module.class, fqn = "@cdklabs/cdk-appflow.SnowflakeConnectorProfile")
public class SnowflakeConnectorProfile extends io.github.cdklabs.cdk.appflow.ConnectorProfileBase {
protected SnowflakeConnectorProfile(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected SnowflakeConnectorProfile(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param scope This parameter is required.
* @param id This parameter is required.
* @param props This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public SnowflakeConnectorProfile(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdk.appflow.SnowflakeConnectorProfileProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* @param scope This parameter is required.
* @param id This parameter is required.
* @param arn This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull io.github.cdklabs.cdk.appflow.SnowflakeConnectorProfile fromConnectionProfileArn(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull java.lang.String arn) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(io.github.cdklabs.cdk.appflow.SnowflakeConnectorProfile.class, "fromConnectionProfileArn", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdk.appflow.SnowflakeConnectorProfile.class), new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(arn, "arn is required") });
}
/**
* @param scope This parameter is required.
* @param id This parameter is required.
* @param name This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull io.github.cdklabs.cdk.appflow.SnowflakeConnectorProfile fromConnectionProfileName(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull java.lang.String name) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(io.github.cdklabs.cdk.appflow.SnowflakeConnectorProfile.class, "fromConnectionProfileName", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdk.appflow.SnowflakeConnectorProfile.class), new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(name, "name is required") });
}
/**
* @param props This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
protected @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.appflow.CfnConnectorProfile.ConnectorProfileCredentialsProperty buildConnectorProfileCredentials(final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdk.appflow.ConnectorProfileProps props) {
return software.amazon.jsii.Kernel.call(this, "buildConnectorProfileCredentials", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.appflow.CfnConnectorProfile.ConnectorProfileCredentialsProperty.class), new Object[] { java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* @param props This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
protected @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.appflow.CfnConnectorProfile.ConnectorProfilePropertiesProperty buildConnectorProfileProperties(final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdk.appflow.ConnectorProfileProps props) {
return software.amazon.jsii.Kernel.call(this, "buildConnectorProfileProperties", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.appflow.CfnConnectorProfile.ConnectorProfilePropertiesProperty.class), new Object[] { java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* (experimental) The AWS IAM Role for the storage integration with Snowflake.
*
* Available only if [SnowflakeConnectorProfileProps's integration property]{@link SnowflakeConnectorProfileProps#integration } is provided.
* For more details see {@link https://docs.snowflake.com/en/user-guide/data-load-s3-config-storage-integration}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.iam.IRole getIntegrationRole() {
return software.amazon.jsii.Kernel.get(this, "integrationRole", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.iam.IRole.class));
}
/**
* (experimental) A fluent builder for {@link io.github.cdklabs.cdk.appflow.SnowflakeConnectorProfile}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param scope This parameter is required.
* @param id This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static Builder create(final software.constructs.Construct scope, final java.lang.String id) {
return new Builder(scope, id);
}
private final software.constructs.Construct scope;
private final java.lang.String id;
private final io.github.cdklabs.cdk.appflow.SnowflakeConnectorProfileProps.Builder props;
private Builder(final software.constructs.Construct scope, final java.lang.String id) {
this.scope = scope;
this.id = id;
this.props = new io.github.cdklabs.cdk.appflow.SnowflakeConnectorProfileProps.Builder();
}
/**
* (experimental) TODO: think if this should be here as not all connector profiles have that.
*
* @return {@code this}
* @param key TODO: think if this should be here as not all connector profiles have that. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder key(final software.amazon.awscdk.services.kms.IKey key) {
this.props.key(key);
return this;
}
/**
* @return {@code this}
* @param name This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder name(final java.lang.String name) {
this.props.name(name);
return this;
}
/**
* @return {@code this}
* @param account This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder account(final java.lang.String account) {
this.props.account(account);
return this;
}
/**
* @return {@code this}
* @param basicAuth This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder basicAuth(final io.github.cdklabs.cdk.appflow.SnowflakeBasicAuthSettings basicAuth) {
this.props.basicAuth(basicAuth);
return this;
}
/**
* (experimental) The name of the Snowflake database.
*
* @return {@code this}
* @param database The name of the Snowflake database. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder database(final java.lang.String database) {
this.props.database(database);
return this;
}
/**
* @return {@code this}
* @param location This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder location(final io.github.cdklabs.cdk.appflow.S3Location location) {
this.props.location(location);
return this;
}
/**
* (experimental) The name of the Snowflake stage.
*
* @return {@code this}
* @param stage The name of the Snowflake stage. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder stage(final java.lang.String stage) {
this.props.stage(stage);
return this;
}
/**
* (experimental) The name of the Snowflake warehouse.
*
* @return {@code this}
* @param warehouse The name of the Snowflake warehouse. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder warehouse(final java.lang.String warehouse) {
this.props.warehouse(warehouse);
return this;
}
/**
* (experimental) Details of the Snowflake Storage Integration.
*
* When provided, this construct will automatically create an IAM Role allowing access to the S3 Bucket which will be available as a [integrationROle property]{@link SnowflakeConnectorProfile#integrationRole }
* For details of the integration see {@link https://docs.snowflake.com/en/user-guide/data-load-s3-config-storage-integration}
*
* @return {@code this}
* @param integration Details of the Snowflake Storage Integration. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder integration(final io.github.cdklabs.cdk.appflow.SnowflakeStorageIntegration integration) {
this.props.integration(integration);
return this;
}
/**
* @return {@code this}
* @param region This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder region(final java.lang.String region) {
this.props.region(region);
return this;
}
/**
* (experimental) The name of the Snowflake schema.
*
* Default: PUBLIC
*
* @return {@code this}
* @param schema The name of the Snowflake schema. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder schema(final java.lang.String schema) {
this.props.schema(schema);
return this;
}
/**
* @return a newly built instance of {@link io.github.cdklabs.cdk.appflow.SnowflakeConnectorProfile}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public io.github.cdklabs.cdk.appflow.SnowflakeConnectorProfile build() {
return new io.github.cdklabs.cdk.appflow.SnowflakeConnectorProfile(
this.scope,
this.id,
this.props.build()
);
}
}
}