Package software.amazon.awscdk.services.appintegrations

Interface CfnDataIntegrationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataIntegrationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:09:58.387Z")
@Stability(Stable)
public interface CfnDataIntegrationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDataIntegration.

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.appintegrations.*;
 Object filters;
 Object objectConfiguration;
 CfnDataIntegrationProps cfnDataIntegrationProps = CfnDataIntegrationProps.builder()
         .kmsKey("kmsKey")
         .name("name")
         .sourceUri("sourceUri")
         // the properties below are optional
         .description("description")
         .fileConfiguration(FileConfigurationProperty.builder()
                 .folders(List.of("folders"))
                 // the properties below are optional
                 .filters(filters)
                 .build())
         .objectConfiguration(objectConfiguration)
         .scheduleConfig(ScheduleConfigProperty.builder()
                 .scheduleExpression("scheduleExpression")
                 // the properties below are optional
                 .firstExecutionFrom("firstExecutionFrom")
                 .object("object")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appintegrations-dataintegration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataIntegrationProps.Builder	builder()
default String	getDescription()	A description of the DataIntegration.
default Object	getFileConfiguration()	The configuration for what files should be pulled from the source.
String	getKmsKey()	The KMS key for the DataIntegration.
String	getName()	The name of the DataIntegration.
default Object	getObjectConfiguration()	The configuration for what data should be pulled from the source.
default Object	getScheduleConfig()	The name of the data and how often it should be pulled from the source.
String	getSourceUri()	The URI of the data source.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKmsKey

@Stability(Stable)
@NotNull
String getKmsKey()

The KMS key for the DataIntegration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appintegrations-dataintegration.html#cfn-appintegrations-dataintegration-kmskey

getName

@Stability(Stable)
@NotNull
String getName()

The name of the DataIntegration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appintegrations-dataintegration.html#cfn-appintegrations-dataintegration-name

getSourceUri

@Stability(Stable)
@NotNull
String getSourceUri()

The URI of the data source.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appintegrations-dataintegration.html#cfn-appintegrations-dataintegration-sourceuri

getDescription

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

A description of the DataIntegration.

See Also:

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

getFileConfiguration

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

The configuration for what files should be pulled from the source.

Returns union: either IResolvable or CfnDataIntegration.FileConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appintegrations-dataintegration.html#cfn-appintegrations-dataintegration-fileconfiguration

getObjectConfiguration

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

The configuration for what data should be pulled from the source.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appintegrations-dataintegration.html#cfn-appintegrations-dataintegration-objectconfiguration

getScheduleConfig

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

The name of the data and how often it should be pulled from the source.

Returns union: either IResolvable or CfnDataIntegration.ScheduleConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appintegrations-dataintegration.html#cfn-appintegrations-dataintegration-scheduleconfig

getTags

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

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

For more information, see Tag .

See Also:

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

builder

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

Returns:

a CfnDataIntegrationProps.Builder of CfnDataIntegrationProps