Package software.amazon.awscdk.services.glue

Class CfnIntegration

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.CfnIntegration
All Implemented Interfaces:
IInspectable, IIntegrationRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)", date="2026-01-08T14:57:06.410Z") @Stability(Stable) public class CfnIntegration extends CfnResource implements IInspectable, IIntegrationRef, ITaggableV2
The AWS::Glue::Integration resource specifies an AWS Glue zero-ETL integration from a data source to a target.

For more information, see zero-ETL integration supported by AWS Glue and integration 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.*;
 CfnIntegration cfnIntegration = CfnIntegration.Builder.create(this, "MyCfnIntegration")
         .integrationName("integrationName")
         .sourceArn("sourceArn")
         .targetArn("targetArn")
         // the properties below are optional
         .additionalEncryptionContext(Map.of(
                 "additionalEncryptionContextKey", "additionalEncryptionContext"))
         .dataFilter("dataFilter")
         .description("description")
         .integrationConfig(IntegrationConfigProperty.builder()
                 .continuousSync(false)
                 .refreshInterval("refreshInterval")
                 .sourceProperties(Map.of(
                         "sourcePropertiesKey", "sourceProperties"))
                 .build())
         .kmsKeyId("kmsKeyId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .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

    • CfnIntegration

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

    • CfnIntegration

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

    • CfnIntegration

      @Stability(Stable) public CfnIntegration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIntegrationProps props)
      Create a new AWS::Glue::Integration.

      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

    • arnForIntegration

      @Stability(Stable) @NotNull public static String arnForIntegration(@NotNull IIntegrationRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnIntegration

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

      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.

    • getAttrCreateTime

      @Stability(Stable) @NotNull public String getAttrCreateTime()
      The time when the integration was created, in UTC.

    • getAttrIntegrationArn

      @Stability(Stable) @NotNull public String getAttrIntegrationArn()
      The Amazon Resource Name (ARN) for the created integration.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the integration being created.

      The possible statuses are:

      • CREATING: The integration is being created.
      • ACTIVE: The integration creation succeeds.
      • MODIFYING: The integration is being modified.
      • FAILED: The integration creation fails.
      • DELETING: The integration is deleted.
      • SYNCING: The integration is synchronizing.
      • NEEDS_ATTENTION: The integration needs attention, such as synchronization.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

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

    • getIntegrationRef

      @Stability(Stable) @NotNull public IntegrationReference getIntegrationRef()
      A reference to a Integration resource.
      Specified by:
      getIntegrationRef in interface IIntegrationRef

    • getIntegrationName

      @Stability(Stable) @NotNull public String getIntegrationName()
      A unique name for the integration.

    • setIntegrationName

      @Stability(Stable) public void setIntegrationName(@NotNull String value)
      A unique name for the integration.

    • getSourceArn

      @Stability(Stable) @NotNull public String getSourceArn()
      The ARN for the source of the integration.

    • setSourceArn

      @Stability(Stable) public void setSourceArn(@NotNull String value)
      The ARN for the source of the integration.

    • getTargetArn

      @Stability(Stable) @NotNull public String getTargetArn()
      The ARN for the target of the integration.

    • setTargetArn

      @Stability(Stable) public void setTargetArn(@NotNull String value)
      The ARN for the target of the integration.

    • getAdditionalEncryptionContext

      @Stability(Stable) @Nullable public Object getAdditionalEncryptionContext()
      An optional set of non-secret key–value pairs that contains additional contextual information for encryption.

      Returns union: either Mapinvalid input: '<'String, String> or IResolvable

    • setAdditionalEncryptionContext

      @Stability(Stable) public void setAdditionalEncryptionContext(@Nullable Map<String,String> value)
      An optional set of non-secret key–value pairs that contains additional contextual information for encryption.

    • setAdditionalEncryptionContext

      @Stability(Stable) public void setAdditionalEncryptionContext(@Nullable IResolvable value)
      An optional set of non-secret key–value pairs that contains additional contextual information for encryption.

    • getDataFilter

      @Stability(Stable) @Nullable public String getDataFilter()
      Selects source tables for the integration using Maxwell filter syntax.

    • setDataFilter

      @Stability(Stable) public void setDataFilter(@Nullable String value)
      Selects source tables for the integration using Maxwell filter syntax.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description for the integration.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description for the integration.

    • getIntegrationConfig

      @Stability(Stable) @Nullable public Object getIntegrationConfig()
      The structure used to define properties associated with the zero-ETL integration.

      Returns union: either IResolvable or CfnIntegration.IntegrationConfigProperty

    • setIntegrationConfig

      @Stability(Stable) public void setIntegrationConfig(@Nullable IResolvable value)
      The structure used to define properties associated with the zero-ETL integration.

    • setIntegrationConfig

      @Stability(Stable) public void setIntegrationConfig(@Nullable CfnIntegration.IntegrationConfigProperty value)
      The structure used to define properties associated with the zero-ETL integration.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The ARN of a KMS key used for encrypting the channel.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The ARN of a KMS key used for encrypting the channel.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Metadata assigned to the resource consisting of a list of key-value pairs.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Metadata assigned to the resource consisting of a list of key-value pairs.