Package software.amazon.awscdk.services.glue

Interface CfnConnection.AuthenticationConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConnection.AuthenticationConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnConnection

@Stability(Stable)
public static interface CfnConnection.AuthenticationConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Example:

 // 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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConnection.AuthenticationConfigurationProperty.Builder	A builder for CfnConnection.AuthenticationConfigurationProperty
static final class	CfnConnection.AuthenticationConfigurationProperty.Jsii$Proxy	An implementation for CfnConnection.AuthenticationConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnConnection.AuthenticationConfigurationProperty.Builder	builder()
String	getAuthenticationType()	A structure containing the authentication configuration in the CreateConnection request.
default Object	getBasicAuthenticationCredentials()	A structure containing the authentication credentials in the CreateConnection request.
default Object	getCustomAuthenticationCredentials()	A structure containing the authentication credentials in the CreateConnection request.
default String	getKmsKeyArn()	The Amazon Resource Name (ARN) of the KMS key used in the authentication configuration.
default Object	getOAuth2Properties()	A structure containing the authentication credentials in the CreateConnection request.
default String	getSecretArn()	The secret manager ARN to store credentials in the CreateConnection request.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthenticationType

@Stability(Stable)
@NotNull
String getAuthenticationType()

A structure containing the authentication configuration in the CreateConnection request.

See Also:

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

getBasicAuthenticationCredentials

@Stability(Stable)
@Nullable
default Object getBasicAuthenticationCredentials()

A structure containing the authentication credentials in the CreateConnection request.

Returns union: either IResolvable or CfnConnection.BasicAuthenticationCredentialsProperty

See Also:

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

getCustomAuthenticationCredentials

@Stability(Stable)
@Nullable
default Object getCustomAuthenticationCredentials()

A structure containing the authentication credentials in the CreateConnection request.

See Also:

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

getKmsKeyArn

@Stability(Stable)
@Nullable
default String getKmsKeyArn()

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

See Also:

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

getOAuth2Properties

@Stability(Stable)
@Nullable
default Object getOAuth2Properties()

A structure containing the authentication credentials in the CreateConnection request.

Returns union: either IResolvable or CfnConnection.OAuth2PropertiesProperty

See Also:

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

getSecretArn

@Stability(Stable)
@Nullable
default String getSecretArn()

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

See Also:

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

builder

@Stability(Stable)
static CfnConnection.AuthenticationConfigurationProperty.Builder builder()

Returns:

a CfnConnection.AuthenticationConfigurationProperty.Builder of CfnConnection.AuthenticationConfigurationProperty