Class ConnectionOptions

(experimental) Base Connection Options.

Inheritance

object

ConnectionOptions

Implements

IConnectionOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Glue.Alpha

Assembly: Amazon.CDK.AWS.Glue.Alpha.dll

Syntax (csharp)

public class ConnectionOptions : IConnectionOptions

Syntax (vb)

Public Class ConnectionOptions Implements IConnectionOptions

Remarks

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Glue.Alpha;
             using Amazon.CDK.AWS.EC2;
             using Amazon.CDK.Interfaces.SecretsManager;

             ConnectionNetwork connectionNetwork;
             ISecretRef secretRef;
             SecurityGroup securityGroup;

             var connectionOptions = new ConnectionOptions {
                 ConnectionName = "connectionName",
                 Description = "description",
                 MatchCriteria = new [] { "matchCriteria" },
                 Network = connectionNetwork,
                 Properties = new Dictionary<string, string> {
                     { "propertiesKey", "properties" }
                 },
                 Secret = secretRef,
                 SecurityGroups = new [] { securityGroup }
             };

Synopsis

Constructors

ConnectionOptions()

(experimental) Base Connection Options.

Properties

ConnectionName	(experimental) The name of the connection.
Description	(experimental) The description of the connection.
MatchCriteria	(experimental) A list of criteria that can be used in selecting this connection.
Network	(experimental) 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.
Properties	(experimental) Key-Value pairs that define parameters for the connection.
Secret	(experimental) A reference to a Secrets Manager secret holding the credentials for this connection.
SecurityGroups	(experimental) The list of security groups needed to successfully make this connection e.g. to successfully connect to VPC.

Constructors

ConnectionOptions()

(experimental) Base Connection Options.

public ConnectionOptions()

Remarks

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Glue.Alpha;
             using Amazon.CDK.AWS.EC2;
             using Amazon.CDK.Interfaces.SecretsManager;

             ConnectionNetwork connectionNetwork;
             ISecretRef secretRef;
             SecurityGroup securityGroup;

             var connectionOptions = new ConnectionOptions {
                 ConnectionName = "connectionName",
                 Description = "description",
                 MatchCriteria = new [] { "matchCriteria" },
                 Network = connectionNetwork,
                 Properties = new Dictionary<string, string> {
                     { "propertiesKey", "properties" }
                 },
                 Secret = secretRef,
                 SecurityGroups = new [] { securityGroup }
             };

Properties

ConnectionName

(experimental) The name of the connection.

public string? ConnectionName { get; set; }

Property Value

string

Remarks

Default: cloudformation generated name

Stability: Experimental

Description

(experimental) The description of the connection.

public string? Description { get; set; }

Property Value

string

Remarks

Default: no description

Stability: Experimental

MatchCriteria

(experimental) A list of criteria that can be used in selecting this connection.

public string[]? MatchCriteria { get; set; }

Property Value

string[]

Remarks

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

Stability: Experimental

Network

(experimental) 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.

public ConnectionNetwork? Network { get; set; }

Property Value

ConnectionNetwork

Remarks

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

Stability: Experimental

Properties

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

public IDictionary<string, string>? Properties { get; set; }

Property Value

IDictionary<string, string>

Remarks

Default: empty properties

Stability: Experimental

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

Secret

(experimental) A reference to a Secrets Manager secret holding the credentials for this connection.

public ISecretRef? Secret { get; set; }

Property Value

ISecretRef

Remarks

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

Stability: Experimental

SecurityGroups

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

public ISecurityGroup[]? SecurityGroups { get; set; }

Property Value

ISecurityGroup[]

Remarks

Default: no security group

Stability: Experimental

Implements

IConnectionOptions