Package software.amazon.awscdk.services.glue

Class ConnectionOptions.Builder

java.lang.Object

software.amazon.awscdk.services.glue.ConnectionOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ConnectionOptions>

Enclosing interface:

ConnectionOptions

@Stability(Stable)
public static final class ConnectionOptions.Builder
extends Object
implements software.amazon.jsii.Builder<ConnectionOptions>

A builder for ConnectionOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ConnectionOptions	build()	Builds the configured instance.
ConnectionOptions.Builder	connectionName(String connectionName)	Sets the value of ConnectionOptions.getConnectionName()
ConnectionOptions.Builder	description(String description)	Sets the value of ConnectionOptions.getDescription()
ConnectionOptions.Builder	matchCriteria(List<String> matchCriteria)	Sets the value of ConnectionOptions.getMatchCriteria()
ConnectionOptions.Builder	network(ConnectionNetwork network)	Sets the value of ConnectionOptions.getNetwork()
ConnectionOptions.Builder	properties(Map<String,String> properties)	Sets the value of ConnectionOptions.getProperties()
ConnectionOptions.Builder	secret(ISecretRef secret)	Sets the value of ConnectionOptions.getSecret()
ConnectionOptions.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups)	Sets the value of ConnectionOptions.getSecurityGroups()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

connectionName

@Stability(Stable)
public ConnectionOptions.Builder connectionName(String connectionName)

Sets the value of ConnectionOptions.getConnectionName()

Parameters:

connectionName - The name of the connection.

Returns:

this

description

@Stability(Stable)
public ConnectionOptions.Builder description(String description)

Sets the value of ConnectionOptions.getDescription()

Parameters:

description - The description of the connection.

Returns:

this

matchCriteria

@Stability(Stable)
public ConnectionOptions.Builder matchCriteria(List<String> matchCriteria)

Sets the value of ConnectionOptions.getMatchCriteria()

Parameters:

matchCriteria - 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

Returns:

this

network

@Stability(Stable)
public ConnectionOptions.Builder network(ConnectionNetwork network)

Sets the value of ConnectionOptions.getNetwork()

Parameters:

network - 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.

Returns:

this

properties

@Stability(Stable)
public ConnectionOptions.Builder properties(Map<String,String> properties)

Sets the value of ConnectionOptions.getProperties()

Parameters:

properties - Key-Value pairs that define parameters for the connection.

Returns:

this

secret

@Stability(Stable)
public ConnectionOptions.Builder secret(ISecretRef secret)

Sets the value of ConnectionOptions.getSecret()

Parameters:

secret - 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.

Returns:

this

securityGroups

@Stability(Stable)
public ConnectionOptions.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)

Sets the value of ConnectionOptions.getSecurityGroups()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public ConnectionOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ConnectionOptions>

Returns:

a new instance of ConnectionOptions

Throws:

NullPointerException - if any required attribute was not provided