software.amazon.awscdk.services.glue.alpha.Connection Maven / Gradle / Ivy
Show all versions of glue-alpha Show documentation
package software.amazon.awscdk.services.glue.alpha;
/**
* (experimental) An AWS Glue connection to a data source.
*
* Example:
*
*
* SecurityGroup securityGroup;
* Subnet subnet;
* Connection.Builder.create(this, "MyConnection")
* .type(ConnectionType.NETWORK)
* // The security groups granting AWS Glue inbound access to the data source within the VPC
* .securityGroups(List.of(securityGroup))
* // The VPC subnet which contains the data source
* .subnet(subnet)
* .build();
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.104.0 (build e79254c)", date = "2024-11-15T10:25:09.317Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.glue.alpha.$Module.class, fqn = "@aws-cdk/aws-glue-alpha.Connection")
public class Connection extends software.amazon.awscdk.Resource implements software.amazon.awscdk.services.glue.alpha.IConnection {
protected Connection(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected Connection(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 Connection(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.glue.alpha.ConnectionProps 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") });
}
/**
* (experimental) Creates a Connection construct that represents an external connection.
*
* @param scope The scope creating construct (usually this). This parameter is required.
* @param id The construct's id. This parameter is required.
* @param connectionArn arn of external connection. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.glue.alpha.IConnection fromConnectionArn(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 connectionArn) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(software.amazon.awscdk.services.glue.alpha.Connection.class, "fromConnectionArn", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.glue.alpha.IConnection.class), new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(connectionArn, "connectionArn is required") });
}
/**
* (experimental) Creates a Connection construct that represents an external connection.
*
* @param scope The scope creating construct (usually this). This parameter is required.
* @param id The construct's id. This parameter is required.
* @param connectionName name of external connection. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.glue.alpha.IConnection fromConnectionName(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 connectionName) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(software.amazon.awscdk.services.glue.alpha.Connection.class, "fromConnectionName", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.glue.alpha.IConnection.class), new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(connectionName, "connectionName is required") });
}
/**
* (experimental) Add additional connection parameters.
*
* @param key parameter key. This parameter is required.
* @param value parameter value. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void addProperty(final @org.jetbrains.annotations.NotNull java.lang.String key, final @org.jetbrains.annotations.NotNull java.lang.String value) {
software.amazon.jsii.Kernel.call(this, "addProperty", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(key, "key is required"), java.util.Objects.requireNonNull(value, "value is required") });
}
/**
* (experimental) The ARN of the connection.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getConnectionArn() {
return software.amazon.jsii.Kernel.get(this, "connectionArn", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) The name of the connection.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getConnectionName() {
return software.amazon.jsii.Kernel.get(this, "connectionName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) A fluent builder for {@link software.amazon.awscdk.services.glue.alpha.Connection}.
*/
@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 software.amazon.awscdk.services.glue.alpha.ConnectionProps.Builder props;
private Builder(final software.constructs.Construct scope, final java.lang.String id) {
this.scope = scope;
this.id = id;
this.props = new software.amazon.awscdk.services.glue.alpha.ConnectionProps.Builder();
}
/**
* (experimental) The name of the connection.
*
* Default: cloudformation generated name
*
* @return {@code this}
* @param connectionName The name of the connection. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder connectionName(final java.lang.String connectionName) {
this.props.connectionName(connectionName);
return this;
}
/**
* (experimental) The description of the connection.
*
* Default: no description
*
* @return {@code this}
* @param description The description of the connection. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder description(final java.lang.String description) {
this.props.description(description);
return this;
}
/**
* (experimental) A list of criteria that can be used in selecting this connection.
*
* This is useful for filtering the results of https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/get-connections.html
*
* Default: no match criteria
*
* @return {@code this}
* @param matchCriteria A list of criteria that can be used in selecting this connection. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder matchCriteria(final java.util.List matchCriteria) {
this.props.matchCriteria(matchCriteria);
return this;
}
/**
* (experimental) Key-Value pairs that define parameters for the connection.
*
* Default: empty properties
*
* @return {@code this}
* @see https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-connect.html
* @param properties Key-Value pairs that define parameters for the connection. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder properties(final java.util.Map properties) {
this.props.properties(properties);
return this;
}
/**
* (experimental) The list of security groups needed to successfully make this connection e.g. to successfully connect to VPC.
*
* Default: no security group
*
* @return {@code this}
* @param securityGroups The list of security groups needed to successfully make this connection e.g. to successfully connect to VPC. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder securityGroups(final java.util.List securityGroups) {
this.props.securityGroups(securityGroups);
return this;
}
/**
* (experimental) The VPC subnet to connect to resources within a VPC.
*
* See more at https://docs.aws.amazon.com/glue/latest/dg/start-connecting.html.
*
* Default: no subnet
*
* @return {@code this}
* @param subnet The VPC subnet to connect to resources within a VPC. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder subnet(final software.amazon.awscdk.services.ec2.ISubnet subnet) {
this.props.subnet(subnet);
return this;
}
/**
* (experimental) The type of the connection.
*
* @return {@code this}
* @param type The type of the connection. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder type(final software.amazon.awscdk.services.glue.alpha.ConnectionType type) {
this.props.type(type);
return this;
}
/**
* @return a newly built instance of {@link software.amazon.awscdk.services.glue.alpha.Connection}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public software.amazon.awscdk.services.glue.alpha.Connection build() {
return new software.amazon.awscdk.services.glue.alpha.Connection(
this.scope,
this.id,
this.props.build()
);
}
}
}