software.amazon.awscdk.services.glue

Class Connection.Builder

java.lang.Object

software.amazon.awscdk.services.glue.Connection.Builder

Enclosing class:

Connection

public static final class Connection.Builder
extends java.lang.Object

(experimental) A fluent builder for Connection.

Method Summary

Modifier and Type	Method and Description
Connection	build()
Connection.Builder	connectionName(java.lang.String connectionName) (experimental) The name of the connection.
static Connection.Builder	create(software.constructs.Construct scope, java.lang.String id)
Connection.Builder	description(java.lang.String description) (experimental) The description of the connection.
Connection.Builder	matchCriteria(java.util.List<java.lang.String> matchCriteria) (experimental) A list of criteria that can be used in selecting this connection.
Connection.Builder	properties(java.util.Map<java.lang.String,java.lang.String> properties) (experimental) Key-Value pairs that define parameters for the connection.
Connection.Builder	securityGroups(java.util.List<? extends ISecurityGroup> securityGroups) (experimental) The list of security groups needed to successfully make this connection e.g.
Connection.Builder	subnet(ISubnet subnet) (experimental) The VPC subnet to connect to resources within a VPC.
Connection.Builder	type(ConnectionType type) (experimental) The type of the connection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Connection.Builder create(software.constructs.Construct scope,
                                        java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Connection.Builder.

connectionName

public Connection.Builder connectionName(java.lang.String connectionName)

(experimental) The name of the connection.

Default: cloudformation generated name

Parameters:

connectionName - The name of the connection. This parameter is required.

Returns:

this

description

public Connection.Builder description(java.lang.String description)

(experimental) The description of the connection.

Default: no description

Parameters:

description - The description of the connection. This parameter is required.

Returns:

this

matchCriteria

public Connection.Builder matchCriteria(java.util.List<java.lang.String> matchCriteria)

(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

Parameters:

matchCriteria - A list of criteria that can be used in selecting this connection. This parameter is required.

Returns:

this

properties

public Connection.Builder properties(java.util.Map<java.lang.String,java.lang.String> properties)

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

Default: empty properties

Parameters:

properties - Key-Value pairs that define parameters for the connection. This parameter is required.

Returns:

this

See Also:

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

securityGroups

public Connection.Builder securityGroups(java.util.List<? extends ISecurityGroup> securityGroups)

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

Default: no security group

Parameters:

securityGroups - The list of security groups needed to successfully make this connection e.g. to successfully connect to VPC. This parameter is required.

Returns:

this

subnet

public Connection.Builder subnet(ISubnet subnet)

(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

Parameters:

subnet - The VPC subnet to connect to resources within a VPC. This parameter is required.

Returns:

this

type

public Connection.Builder type(ConnectionType type)

(experimental) The type of the connection.

Parameters:

type - The type of the connection. This parameter is required.

Returns:

this

build

public Connection build()