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.119.0 (build 1634eac)",
           date="2025-11-20T23:37:22.592Z")
@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 about the data.
default String	getDataFilter()
default String	getDescription()
default Object	getIntegrationConfig()	The configuration settings for the integration.
String	getIntegrationName()	The name of the integration.
default String	getKmsKeyId()	An KMS key identifier for the key to use to encrypt the integration.
String	getSourceArn()	The Amazon Resource Name (ARN) of the database to use as the source for replication.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
String	getTargetArn()	The Amazon Resource Name (ARN) of the Glue data warehouse to use as the target for replication.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIntegrationName

@Stability(Stable)
@NotNull
String getIntegrationName()

The name of 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 Amazon Resource Name (ARN) of the database to use as the source for replication.

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 Amazon Resource Name (ARN) of the Glue data warehouse to use as the target for replication.

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 about the data.

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

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

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 configuration settings for the integration.

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

An KMS key identifier for the key to use to encrypt the integration.

If you don't specify an encryption key, the default AWS owned KMS key is used.

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

An array of key-value pairs to apply to this resource.

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