Package software.amazon.awscdk.services.glue.alpha

Interface ConnectionOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
ConnectionProps
All Known Implementing Classes:
ConnectionOptions.Jsii$Proxy, ConnectionProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-17T14:54:30.007Z") @Stability(Deprecated) @Deprecated public interface ConnectionOptions extends software.amazon.jsii.JsiiSerializable
Deprecated.
(deprecated) Base Connection Options.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.glue.alpha.*;
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.interfaces.secretsmanager.*;
 ConnectionNetwork connectionNetwork;
 ISecretRef secretRef;
 SecurityGroup securityGroup;
 ConnectionOptions connectionOptions = ConnectionOptions.builder()
         .connectionName("connectionName")
         .description("description")
         .matchCriteria(List.of("matchCriteria"))
         .network(connectionNetwork)
         .properties(Map.of(
                 "propertiesKey", "properties"))
         .secret(secretRef)
         .securityGroups(List.of(securityGroup))
         .build();

  • Method Details

    • getConnectionName

      @Stability(Deprecated) @Deprecated @Nullable default String getConnectionName()
      Deprecated.
      (deprecated) The name of the connection.

      Default: cloudformation generated name

    • getDescription

      @Stability(Deprecated) @Deprecated @Nullable default String getDescription()
      Deprecated.
      (deprecated) The description of the connection.

      Default: no description

    • getMatchCriteria

      @Stability(Deprecated) @Deprecated @Nullable default List<String> getMatchCriteria()
      Deprecated.
      (deprecated) 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

    • getNetwork

      @Stability(Deprecated) @Deprecated @Nullable default ConnectionNetwork getNetwork()
      Deprecated.
      (deprecated) The VPC network placement for this connection, so it can reach resources inside a VPC. See more at https://docs.aws.amazon.com/glue/latest/dg/start-connecting.html.

      Build it with ConnectionNetwork.subnet(subnet) to pin a specific subnet, or ConnectionNetwork.vpc(vpc, vpcSubnets?) to let the CDK select one.

      Default: - no VPC network placement

    • getProperties

      @Stability(Deprecated) @Deprecated @Nullable default Map<String,String> getProperties()
      Deprecated.
      (deprecated) Key-Value pairs that define parameters for the connection.

      Default: empty properties

      See Also:

    • getSecret

      @Stability(Deprecated) @Deprecated @Nullable default ISecretRef getSecret()
      Deprecated.
      (deprecated) A reference to a Secrets Manager secret holding the credentials for this connection.

      The secret is referenced through the connection's SECRET_ID property, so Glue reads the credentials at runtime and the secret value never appears in the synthesized template. Prefer this over placing credentials directly in properties. Accepts any secretsmanager.ISecret.

      Default: - no secret; any credentials must be supplied via `properties`

    • getSecurityGroups

      @Stability(Deprecated) @Deprecated @Nullable default List<ISecurityGroup> getSecurityGroups()
      Deprecated.
      (deprecated) The list of security groups needed to successfully make this connection e.g. to successfully connect to VPC.

      Default: no security group

    • builder

      @Stability(Deprecated) @Deprecated static ConnectionOptions.Builder builder()
      Deprecated.
      Returns:
      a ConnectionOptions.Builder of ConnectionOptions