Package software.amazon.awscdk.services.glue

Class CfnConnection

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.glue.CfnConnection
All Implemented Interfaces:
IInspectable, IConnectionRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:37.441Z") @Stability(Stable) public class CfnConnection extends CfnResource implements IInspectable, IConnectionRef
The AWS::Glue::Connection resource specifies an AWS Glue connection to a data source.

For more information, see Adding a Connection to Your Data Store and Connection Structure in the AWS Glue Developer Guide .

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 athenaProperties;
 Object connectionProperties;
 Object customAuthenticationCredentials;
 Object pythonProperties;
 Object sparkProperties;
 Object tokenUrlParametersMap;
 CfnConnection cfnConnection = CfnConnection.Builder.create(this, "MyCfnConnection")
         .catalogId("catalogId")
         .connectionInput(ConnectionInputProperty.builder()
                 .connectionType("connectionType")
                 // the properties below are optional
                 .athenaProperties(athenaProperties)
                 .authenticationConfiguration(AuthenticationConfigurationInputProperty.builder()
                         .authenticationType("authenticationType")
                         // the properties below are optional
                         .basicAuthenticationCredentials(BasicAuthenticationCredentialsProperty.builder()
                                 .password("password")
                                 .username("username")
                                 .build())
                         .customAuthenticationCredentials(customAuthenticationCredentials)
                         .kmsKeyArn("kmsKeyArn")
                         .oAuth2Properties(OAuth2PropertiesInputProperty.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())
                 .connectionProperties(connectionProperties)
                 .description("description")
                 .matchCriteria(List.of("matchCriteria"))
                 .name("name")
                 .physicalConnectionRequirements(PhysicalConnectionRequirementsProperty.builder()
                         .availabilityZone("availabilityZone")
                         .securityGroupIdList(List.of("securityGroupIdList"))
                         .subnetId("subnetId")
                         .build())
                 .pythonProperties(pythonProperties)
                 .sparkProperties(sparkProperties)
                 .validateCredentials(false)
                 .validateForComputeEnvironments(List.of("validateForComputeEnvironments"))
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnConnection

      protected CfnConnection(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnConnection

      protected CfnConnection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnConnection

      @Stability(Stable) public CfnConnection(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnConnectionProps props)
      Create a new AWS::Glue::Connection.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnConnection

      @Stability(Stable) @NotNull public static Boolean isCfnConnection(@NotNull Object x)
      Checks whether the given object is a CfnConnection.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getConnectionRef

      @Stability(Stable) @NotNull public ConnectionReference getConnectionRef()
      A reference to a Connection resource.
      Specified by:
      getConnectionRef in interface IConnectionRef

    • getCatalogId

      @Stability(Stable) @NotNull public String getCatalogId()
      The ID of the data catalog to create the catalog object in.

    • setCatalogId

      @Stability(Stable) public void setCatalogId(@NotNull String value)
      The ID of the data catalog to create the catalog object in.

    • getConnectionInput

      @Stability(Stable) @NotNull public Object getConnectionInput()
      The connection that you want to create.

      Returns union: either IResolvable or CfnConnection.ConnectionInputProperty

    • setConnectionInput

      @Stability(Stable) public void setConnectionInput(@NotNull IResolvable value)
      The connection that you want to create.

    • setConnectionInput

      @Stability(Stable) public void setConnectionInput(@NotNull CfnConnection.ConnectionInputProperty value)
      The connection that you want to create.