software.amazon.awscdk.services.glue

Interface ConnectionOptions

All Known Subinterfaces:

ConnectionProps

All Known Implementing Classes:

ConnectionOptions.Jsii$Proxy, ConnectionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-13T01:13:35.140Z")
public interface ConnectionOptions

(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 java.lang.String	getConnectionName() (experimental) The name of the connection.
default java.lang.String	getDescription() (experimental) The description of the connection.
default java.util.List<java.lang.String>	getMatchCriteria() (experimental) A list of criteria that can be used in selecting this connection.
default java.util.Map<java.lang.String,java.lang.String>	getProperties() (experimental) Key-Value pairs that define parameters for the connection.
default java.util.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.

Method Detail

getConnectionName

default java.lang.String getConnectionName()

(experimental) The name of the connection.

Default: cloudformation generated name

getDescription

default java.lang.String getDescription()

(experimental) The description of the connection.

Default: no description

getMatchCriteria

default java.util.List<java.lang.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

default java.util.Map<java.lang.String,java.lang.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

default java.util.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

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

static ConnectionOptions.Builder builder()

Returns:

a ConnectionOptions.Builder of ConnectionOptions