AWS CDK Reference

Appearance

v2.275.0

CfnConnectionProps Struct ​

Properties for defining a CfnConnection.

Source
Generated code
Type last changed
v2.268.0 · 2 Sep 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_glue as glue } from 'aws-cdk-lib';

declare const athenaProperties: any;
declare const connectionProperties: any;
declare const customAuthenticationCredentials: any;
declare const pythonProperties: any;
declare const sparkProperties: any;
declare const tags: any;
declare const tokenUrlParametersMap: any;
const cfnConnectionProps: glue.CfnConnectionProps = {
  catalogId: 'catalogId',
  connectionInput: {
    connectionType: 'connectionType',

    // the properties below are optional
    athenaProperties: athenaProperties,
    authenticationConfiguration: {
      authenticationType: 'authenticationType',

      // the properties below are optional
      basicAuthenticationCredentials: {
        password: 'password',
        username: 'username',
      },
      customAuthenticationCredentials: customAuthenticationCredentials,
      kmsKeyArn: 'kmsKeyArn',
      oAuth2Properties: {
        authorizationCodeProperties: {
          authorizationCode: 'authorizationCode',
          redirectUri: 'redirectUri',
        },
        oAuth2ClientApplication: {
          awsManagedClientApplicationReference: 'awsManagedClientApplicationReference',
          userManagedClientApplicationClientId: 'userManagedClientApplicationClientId',
        },
        oAuth2Credentials: {
          accessToken: 'accessToken',
          jwtToken: 'jwtToken',
          refreshToken: 'refreshToken',
          userManagedClientApplicationClientSecret: 'userManagedClientApplicationClientSecret',
        },
        oAuth2GrantType: 'oAuth2GrantType',
        tokenUrl: 'tokenUrl',
        tokenUrlParametersMap: tokenUrlParametersMap,
      },
      secretArn: 'secretArn',
    },
    connectionProperties: connectionProperties,
    description: 'description',
    matchCriteria: ['matchCriteria'],
    name: 'name',
    physicalConnectionRequirements: {
      availabilityZone: 'availabilityZone',
      securityGroupIdList: ['securityGroupIdList'],
      subnetId: 'subnetId',
    },
    pythonProperties: pythonProperties,
    sparkProperties: sparkProperties,
    validateCredentials: false,
    validateForComputeEnvironments: ['validateForComputeEnvironments'],
  },

  // the properties below are optional
  tags: tags,
};

Properties ​

catalogIdstringcatalog_idstrcatalogIdStringCatalogIdstringCatalogId*stringrequired#
The ID of the data catalog to create the catalog object in.

Currently, this should be the AWS account ID.

To specify the account ID, you can use the Ref intrinsic function with the AWS::AccountId pseudo parameter. For example: !Ref AWS::AccountId .

connectionInputIResolvable | CfnConnection.ConnectionInputPropertyconnection_inputtyping.Union[IResolvable, ConnectionInputProperty]connectionInputIResolvableConnectionInputIResolvableConnectionInputinterface{}required#
The connection that you want to create.
tagsoptionalanytagsoptionalAnytagsoptionalObjectTagsoptionalobjectTagsoptionalinterface{}#
The collection of tags.

Each tag element is associated with a given resource.