AuthenticationConfigurationProperty Struct

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

Example

// 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 customAuthenticationCredentials: any;
declare const tokenUrlParametersMap: any;
const authenticationConfigurationProperty: glue.CfnConnection.AuthenticationConfigurationProperty = {
  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',
};

python

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_glue as glue

# custom_authentication_credentials: Any
# token_url_parameters_map: Any

authentication_configuration_property = glue.CfnConnection.AuthenticationConfigurationProperty(
    authentication_type="authenticationType",

    # the properties below are optional
    basic_authentication_credentials=glue.CfnConnection.BasicAuthenticationCredentialsProperty(
        password="password",
        username="username"
    ),
    custom_authentication_credentials=custom_authentication_credentials,
    kms_key_arn="kmsKeyArn",
    o_auth2_properties=glue.CfnConnection.OAuth2PropertiesProperty(
        authorization_code_properties=glue.CfnConnection.AuthorizationCodePropertiesProperty(
            authorization_code="authorizationCode",
            redirect_uri="redirectUri"
        ),
        o_auth2_client_application=glue.CfnConnection.OAuth2ClientApplicationProperty(
            aws_managed_client_application_reference="awsManagedClientApplicationReference",
            user_managed_client_application_client_id="userManagedClientApplicationClientId"
        ),
        o_auth2_credentials=glue.CfnConnection.OAuth2CredentialsProperty(
            access_token="accessToken",
            jwt_token="jwtToken",
            refresh_token="refreshToken",
            user_managed_client_application_client_secret="userManagedClientApplicationClientSecret"
        ),
        o_auth2_grant_type="oAuth2GrantType",
        token_url="tokenUrl",
        token_url_parameters_map=token_url_parameters_map
    ),
    secret_arn="secretArn"
)

java

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.glue.*;

Object customAuthenticationCredentials;
Object tokenUrlParametersMap;

AuthenticationConfigurationProperty authenticationConfigurationProperty = AuthenticationConfigurationProperty.builder()
        .authenticationType("authenticationType")

        // the properties below are optional
        .basicAuthenticationCredentials(BasicAuthenticationCredentialsProperty.builder()
                .password("password")
                .username("username")
                .build())
        .customAuthenticationCredentials(customAuthenticationCredentials)
        .kmsKeyArn("kmsKeyArn")
        .oAuth2Properties(OAuth2PropertiesProperty.builder()
                .authorizationCodeProperties(AuthorizationCodePropertiesProperty.builder()
                        .authorizationCode("authorizationCode")
                        .redirectUri("redirectUri")
                        .build())
                .oAuth2ClientApplication(OAuth2ClientApplicationProperty.builder()
                        .awsManagedClientApplicationReference("awsManagedClientApplicationReference")
                        .userManagedClientApplicationClientId("userManagedClientApplicationClientId")
                        .build())
                .oAuth2Credentials(OAuth2CredentialsProperty.builder()
                        .accessToken("accessToken")
                        .jwtToken("jwtToken")
                        .refreshToken("refreshToken")
                        .userManagedClientApplicationClientSecret("userManagedClientApplicationClientSecret")
                        .build())
                .oAuth2GrantType("oAuth2GrantType")
                .tokenUrl("tokenUrl")
                .tokenUrlParametersMap(tokenUrlParametersMap)
                .build())
        .secretArn("secretArn")
        .build();

csharp

// Install: dotnet add package Amazon.CDK.Lib
// 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 customAuthenticationCredentials;
var tokenUrlParametersMap;

var authenticationConfigurationProperty = new AuthenticationConfigurationProperty {
    AuthenticationType = "authenticationType",

    // the properties below are optional
    BasicAuthenticationCredentials = new BasicAuthenticationCredentialsProperty {
        Password = "password",
        Username = "username"
    },
    CustomAuthenticationCredentials = customAuthenticationCredentials,
    KmsKeyArn = "kmsKeyArn",
    OAuth2Properties = new OAuth2PropertiesProperty {
        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"
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var customAuthenticationCredentials interface{}
var tokenUrlParametersMap interface{}

authenticationConfigurationProperty := &AuthenticationConfigurationProperty{
	AuthenticationType: jsii.String("authenticationType"),

	// the properties below are optional
	BasicAuthenticationCredentials: &BasicAuthenticationCredentialsProperty{
		Password: jsii.String("password"),
		Username: jsii.String("username"),
	},
	CustomAuthenticationCredentials: customAuthenticationCredentials,
	KmsKeyArn: jsii.String("kmsKeyArn"),
	OAuth2Properties: &OAuth2PropertiesProperty{
		AuthorizationCodeProperties: &AuthorizationCodePropertiesProperty{
			AuthorizationCode: jsii.String("authorizationCode"),
			RedirectUri: jsii.String("redirectUri"),
		},
		OAuth2ClientApplication: &OAuth2ClientApplicationProperty{
			AwsManagedClientApplicationReference: jsii.String("awsManagedClientApplicationReference"),
			UserManagedClientApplicationClientId: jsii.String("userManagedClientApplicationClientId"),
		},
		OAuth2Credentials: &OAuth2CredentialsProperty{
			AccessToken: jsii.String("accessToken"),
			JwtToken: jsii.String("jwtToken"),
			RefreshToken: jsii.String("refreshToken"),
			UserManagedClientApplicationClientSecret: jsii.String("userManagedClientApplicationClientSecret"),
		},
		OAuth2GrantType: jsii.String("oAuth2GrantType"),
		TokenUrl: jsii.String("tokenUrl"),
		TokenUrlParametersMap: tokenUrlParametersMap,
	},
	SecretArn: jsii.String("secretArn"),
}

Properties

authenticationTypestringauthentication_typestrauthenticationTypeStringAuthenticationTypestringAuthenticationType*stringrequired#

A structure containing the authentication configuration in the CreateConnection request.

basicAuthenticationCredentialsoptionalIResolvable | CfnConnection.BasicAuthenticationCredentialsPropertybasic_authentication_credentialsoptionaltyping.Union[IResolvable, BasicAuthenticationCredentialsProperty]basicAuthenticationCredentialsoptionalIResolvableBasicAuthenticationCredentialsoptionalIResolvableBasicAuthenticationCredentialsoptionalinterface{}#

A structure containing the authentication credentials in the CreateConnection request.

customAuthenticationCredentialsoptionalanycustom_authentication_credentialsoptionalAnycustomAuthenticationCredentialsoptionalObjectCustomAuthenticationCredentialsoptionalobjectCustomAuthenticationCredentialsoptionalinterface{}#

A structure containing the authentication credentials in the CreateConnection request.

kmsKeyArnoptionalstringkms_key_arnoptionalstrkmsKeyArnoptionalStringKmsKeyArnoptionalstringKmsKeyArnoptional*string#

The Amazon Resource Name (ARN) of the KMS key used in the authentication configuration.

oAuth2PropertiesoptionalIResolvable | CfnConnection.OAuth2PropertiesPropertyo_auth2_propertiesoptionaltyping.Union[IResolvable, OAuth2PropertiesProperty]oAuth2PropertiesoptionalIResolvableOAuth2PropertiesoptionalIResolvableOAuth2Propertiesoptionalinterface{}#

A structure containing the authentication credentials in the CreateConnection request.

secretArnoptionalstringsecret_arnoptionalstrsecretArnoptionalStringSecretArnoptionalstringSecretArnoptional*string#

The secret manager ARN to store credentials in the CreateConnection request.

AuthenticationConfigurationProperty Struct ​

Example ​

Properties ​

AuthenticationConfigurationProperty Struct

Example

Properties