Class CfnConnection.ConnectionInputProperty

A structure that is used to specify a connection to create or update.

Inheritance
System.Object
CfnConnection.ConnectionInputProperty
Namespace: Amazon.CDK.AWS.Glue
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ConnectionInputProperty : Object, CfnConnection.IConnectionInputProperty
Syntax (vb)
Public Class ConnectionInputProperty
    Inherits Object
    Implements CfnConnection.IConnectionInputProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html

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;

var athenaProperties;
var connectionProperties;
var customAuthenticationCredentials;
var pythonProperties;
var sparkProperties;
var tokenUrlParametersMap;

var connectionInputProperty = new ConnectionInputProperty {
    ConnectionType = "connectionType",

    // the properties below are optional
    AthenaProperties = athenaProperties,
    AuthenticationConfiguration = new AuthenticationConfigurationInputProperty {
        AuthenticationType = "authenticationType",

        // the properties below are optional
        BasicAuthenticationCredentials = new BasicAuthenticationCredentialsProperty {
            Password = "password",
            Username = "username"
        },
        CustomAuthenticationCredentials = customAuthenticationCredentials,
        KmsKeyArn = "kmsKeyArn",
        OAuth2Properties = new OAuth2PropertiesInputProperty {
            AuthorizationCodeProperties = new AuthorizationCodePropertiesProperty {
                AuthorizationCode = "authorizationCode",
                RedirectUri = "redirectUri"
            },
            OAuth2ClientApplication = new OAuth2ClientApplicationProperty {
                AwsManagedClientApplicationReference = "awsManagedClientApplicationReference",
                UserManagedClientApplicationClientId = "userManagedClientApplicationClientId"
            },
            OAuth2Credentials = new OAuth2CredentialsProperty {
                AccessToken = "accessToken",
                JwtToken = "jwtToken",
                RefreshToken = "refreshToken",
                UserManagedClientApplicationClientSecret = "userManagedClientApplicationClientSecret"
            },
            OAuth2GrantType = "oAuth2GrantType",
            TokenUrl = "tokenUrl",
            TokenUrlParametersMap = tokenUrlParametersMap
        },
        SecretArn = "secretArn"
    },
    ConnectionProperties = connectionProperties,
    Description = "description",
    MatchCriteria = new [] { "matchCriteria" },
    Name = "name",
    PhysicalConnectionRequirements = new PhysicalConnectionRequirementsProperty {
        AvailabilityZone = "availabilityZone",
        SecurityGroupIdList = new [] { "securityGroupIdList" },
        SubnetId = "subnetId"
    },
    PythonProperties = pythonProperties,
    SparkProperties = sparkProperties,
    ValidateCredentials = false,
    ValidateForComputeEnvironments = new [] { "validateForComputeEnvironments" }
};

Synopsis

Constructors

ConnectionInputProperty()

Properties

AthenaProperties

Connection properties specific to the Athena compute environment.
AuthenticationConfiguration

The authentication properties of the connection.
ConnectionProperties

These key-value pairs define parameters for the connection.
ConnectionType

The type of the connection. Currently, these types are supported:.
Description

The description of the connection.
MatchCriteria

A list of criteria that can be used in selecting this connection.
Name

The name of the connection.
PhysicalConnectionRequirements

The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup , that are needed to successfully make this connection.
PythonProperties

Connection properties specific to the Python compute environment.
SparkProperties

Connection properties specific to the Spark compute environment.
ValidateCredentials

A flag to validate the credentials during create connection.
ValidateForComputeEnvironments

The compute environments that the specified connection properties are validated against.

Constructors

ConnectionInputProperty()

public ConnectionInputProperty()

Properties

AthenaProperties

Connection properties specific to the Athena compute environment.

public object AthenaProperties { get; set; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-athenaproperties

AuthenticationConfiguration

The authentication properties of the connection.

public object AuthenticationConfiguration { get; set; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-authenticationconfiguration

ConnectionProperties

These key-value pairs define parameters for the connection.

public object ConnectionProperties { get; set; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-connectionproperties

ConnectionType

The type of the connection. Currently, these types are supported:.

public string ConnectionType { get; set; }
Property Value

System.String

Remarks

    JDBC Connections use the following ConnectionParameters.

      KAFKA Connections use the following ConnectionParameters.

        MONGODB Connections use the following ConnectionParameters.

          NETWORK Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.

            MARKETPLACE Connections use the following ConnectionParameters.

              Additionally, a ConnectionType for the following SaaS connectors is supported:

                For more information on the connection parameters needed for a particular connector, see the documentation for the connector in Adding an AWS Glue connection in the AWS Glue User Guide.

                SFTP is not supported.

                For more information about how optional ConnectionProperties are used to configure features in AWS Glue , consult AWS Glue connection properties .

                For more information about how optional ConnectionProperties are used to configure features in AWS Glue Studio, consult Using connectors and connections .

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-connectiontype

                Description

                The description of the connection.

                public string Description { get; set; }
                Property Value

                System.String

                Remarks

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-description

                MatchCriteria

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

                public string[] MatchCriteria { get; set; }
                Property Value

                System.String[]

                Remarks

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-matchcriteria

                Name

                The name of the connection.

                public string Name { get; set; }
                Property Value

                System.String

                Remarks

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-name

                PhysicalConnectionRequirements

                The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup , that are needed to successfully make this connection.

                public object PhysicalConnectionRequirements { get; set; }
                Property Value

                System.Object

                Remarks

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-physicalconnectionrequirements

                PythonProperties

                Connection properties specific to the Python compute environment.

                public object PythonProperties { get; set; }
                Property Value

                System.Object

                Remarks

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-pythonproperties

                SparkProperties

                Connection properties specific to the Spark compute environment.

                public object SparkProperties { get; set; }
                Property Value

                System.Object

                Remarks

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-sparkproperties

                ValidateCredentials

                A flag to validate the credentials during create connection.

                public object ValidateCredentials { get; set; }
                Property Value

                System.Object

                Remarks

                Default is true.

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-validatecredentials

                ValidateForComputeEnvironments

                The compute environments that the specified connection properties are validated against.

                public string[] ValidateForComputeEnvironments { get; set; }
                Property Value

                System.String[]

                Remarks

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-validateforcomputeenvironments

                Implements