Package software.amazon.awscdk.services.glue

Class CfnConnection

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.glue.CfnConnection
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.335Z") @Stability(Stable) public class CfnConnection extends CfnResource implements IInspectable
A CloudFormation AWS::Glue::Connection.

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 connectionProperties;
 CfnConnection cfnConnection = CfnConnection.Builder.create(this, "MyCfnConnection")
         .catalogId("catalogId")
         .connectionInput(ConnectionInputProperty.builder()
                 .connectionType("connectionType")
                 // the properties below are optional
                 .connectionProperties(connectionProperties)
                 .description("description")
                 .matchCriteria(List.of("matchCriteria"))
                 .name("name")
                 .physicalConnectionRequirements(PhysicalConnectionRequirementsProperty.builder()
                         .availabilityZone("availabilityZone")
                         .securityGroupIdList(List.of("securityGroupIdList"))
                         .subnetId("subnetId")
                         .build())
                 .build())
         .build();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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.

    • getCfnProperties

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

    • getCatalogId

      @Stability(Stable) @NotNull public String getCatalogId()
      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 .

    • setCatalogId

      @Stability(Stable) public void setCatalogId(@NotNull String value)
      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 .

    • getConnectionInput

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

    • 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.