Package software.amazon.awscdk.services.glue

Interface CfnIntegrationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIntegrationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-23T11:19:47.771Z")
@Stability(Stable)
public interface CfnIntegrationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnIntegration.

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.*;
 CfnIntegrationProps cfnIntegrationProps = CfnIntegrationProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnIntegrationProps.Builder	builder()
default Object	getAdditionalEncryptionContext()	An optional set of non-secret key–value pairs that contains additional contextual information for encryption.
default String	getDataFilter()	Selects source tables for the integration using Maxwell filter syntax.
default String	getDescription()	A description for the integration.
default Object	getIntegrationConfig()	The structure used to define properties associated with the zero-ETL integration.
String	getIntegrationName()	A unique name for the integration.
default String	getKmsKeyId()	The ARN of a KMS key used for encrypting the channel.
String	getSourceArn()	The ARN for the source of the integration.
default List<CfnTag>	getTags()	Metadata assigned to the resource consisting of a list of key-value pairs.
String	getTargetArn()	The ARN for the target of the integration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIntegrationName

@Stability(Stable)
@NotNull
String getIntegrationName()

A unique name for the integration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#cfn-glue-integration-integrationname

getSourceArn

@Stability(Stable)
@NotNull
String getSourceArn()

The ARN for the source of the integration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#cfn-glue-integration-sourcearn

getTargetArn

@Stability(Stable)
@NotNull
String getTargetArn()

The ARN for the target of the integration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#cfn-glue-integration-targetarn

getAdditionalEncryptionContext

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

An optional set of non-secret key–value pairs that contains additional contextual information for encryption.

This can only be provided if KMSKeyId is provided.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#cfn-glue-integration-additionalencryptioncontext

getDataFilter

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

Selects source tables for the integration using Maxwell filter syntax.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#cfn-glue-integration-datafilter

getDescription

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

A description for the integration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#cfn-glue-integration-description

getIntegrationConfig

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

The structure used to define properties associated with the zero-ETL integration.

For more information, see IntegrationConfig structure.

Returns union: either IResolvable or CfnIntegration.IntegrationConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#cfn-glue-integration-integrationconfig

getKmsKeyId

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

The ARN of a KMS key used for encrypting the channel.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#cfn-glue-integration-kmskeyid

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Metadata assigned to the resource consisting of a list of key-value pairs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integration.html#cfn-glue-integration-tags

builder

@Stability(Stable)
static CfnIntegrationProps.Builder builder()

Returns:

a CfnIntegrationProps.Builder of CfnIntegrationProps