software.amazon.awscdk.services.glue

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.67.0 (build 2c027f5)",
           date="2022-09-07T23:47:07.705Z")
 @Stability(value=Experimental)
public interface ConnectionOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) 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.ec2.*;
 import software.amazon.awscdk.services.glue.*;
 SecurityGroup securityGroup;
 Subnet subnet;
 ConnectionOptions connectionOptions = ConnectionOptions.builder()
         .connectionName("connectionName")
         .description("description")
         .matchCriteria(List.of("matchCriteria"))
         .properties(Map.of(
                 "propertiesKey", "properties"))
         .securityGroups(List.of(securityGroup))
         .subnet(subnet)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ConnectionOptions.Builder A builder for ConnectionOptions
static class	ConnectionOptions.Jsii$Proxy An implementation for ConnectionOptions

Method Summary

Modifier and Type	Method and Description
static ConnectionOptions.Builder	builder()
default String	getConnectionName() (experimental) The name of the connection.
default String	getDescription() (experimental) The description of the connection.
default List<String>	getMatchCriteria() (experimental) A list of criteria that can be used in selecting this connection.
default Map<String,String>	getProperties() (experimental) Key-Value pairs that define parameters for the connection.
default List<ISecurityGroup>	getSecurityGroups() (experimental) The list of security groups needed to successfully make this connection e.g.
default ISubnet	getSubnet() (experimental) The VPC subnet to connect to resources within a VPC.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getConnectionName

@Stability(value=Experimental)
 @Nullable
default String getConnectionName()

(experimental) The name of the connection.

Default: cloudformation generated name

getDescription

@Stability(value=Experimental)
 @Nullable
default String getDescription()

(experimental) The description of the connection.

Default: no description

getMatchCriteria

@Stability(value=Experimental)
 @Nullable
default List<String> getMatchCriteria()

(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

getProperties

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getProperties()

(experimental) Key-Value pairs that define parameters for the connection.

Default: empty properties

See Also:

https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-connect.html

getSecurityGroups

@Stability(value=Experimental)
 @Nullable
default List<ISecurityGroup> getSecurityGroups()

(experimental) The list of security groups needed to successfully make this connection e.g. to successfully connect to VPC.

Default: no security group

getSubnet

@Stability(value=Experimental)
 @Nullable
default ISubnet getSubnet()

(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

builder

@Stability(value=Experimental)
static ConnectionOptions.Builder builder()

Returns:

a ConnectionOptions.Builder of ConnectionOptions