Skip to content
v2.278.0

CfnDataIntegrationProps Struct ​

Properties for defining a CfnDataIntegration.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appintegrations as appintegrations } from 'aws-cdk-lib';

declare const filters: any;
declare const objectConfiguration: any;
const cfnDataIntegrationProps: appintegrations.CfnDataIntegrationProps = {
  kmsKey: 'kmsKey',
  name: 'name',
  sourceUri: 'sourceUri',

  // the properties below are optional
  description: 'description',
  fileConfiguration: {
    folders: ['folders'],

    // the properties below are optional
    filters: filters,
  },
  objectConfiguration: objectConfiguration,
  scheduleConfig: {
    scheduleExpression: 'scheduleExpression',

    // the properties below are optional
    firstExecutionFrom: 'firstExecutionFrom',
    object: 'object',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appintegrations as appintegrations

# filters: Any
# object_configuration: Any

cfn_data_integration_props = appintegrations.CfnDataIntegrationProps(
    kms_key="kmsKey",
    name="name",
    source_uri="sourceUri",

    # the properties below are optional
    description="description",
    file_configuration=appintegrations.CfnDataIntegration.FileConfigurationProperty(
        folders=["folders"],

        # the properties below are optional
        filters=filters
    ),
    object_configuration=object_configuration,
    schedule_config=appintegrations.CfnDataIntegration.ScheduleConfigProperty(
        schedule_expression="scheduleExpression",

        # the properties below are optional
        first_execution_from="firstExecutionFrom",
        object="object"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppIntegrations;

var filters;
var objectConfiguration;

var cfnDataIntegrationProps = new CfnDataIntegrationProps {
    KmsKey = "kmsKey",
    Name = "name",
    SourceUri = "sourceUri",

    // the properties below are optional
    Description = "description",
    FileConfiguration = new FileConfigurationProperty {
        Folders = new [] { "folders" },

        // the properties below are optional
        Filters = filters
    },
    ObjectConfiguration = objectConfiguration,
    ScheduleConfig = new ScheduleConfigProperty {
        ScheduleExpression = "scheduleExpression",

        // the properties below are optional
        FirstExecutionFrom = "firstExecutionFrom",
        Object = "object"
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var filters interface{}
var objectConfiguration interface{}

cfnDataIntegrationProps := &CfnDataIntegrationProps{
	KmsKey: jsii.String("kmsKey"),
	Name: jsii.String("name"),
	SourceUri: jsii.String("sourceUri"),

	// the properties below are optional
	Description: jsii.String("description"),
	FileConfiguration: &FileConfigurationProperty{
		Folders: []*string{
			jsii.String("folders"),
		},

		// the properties below are optional
		Filters: filters,
	},
	ObjectConfiguration: objectConfiguration,
	ScheduleConfig: &ScheduleConfigProperty{
		ScheduleExpression: jsii.String("scheduleExpression"),

		// the properties below are optional
		FirstExecutionFrom: jsii.String("firstExecutionFrom"),
		Object: jsii.String("object"),
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #
A description of the DataIntegration.
fileConfigurationoptionalIResolvable | CfnDataIntegration.FileConfigurationPropertyfile_configurationoptionaltyping.Union[IResolvable, FileConfigurationProperty]fileConfigurationoptionalIResolvableFileConfigurationoptionalIResolvableFileConfigurationoptionalinterface{} #
The configuration for what files should be pulled from the source.
kmsKeystringkms_keystrkmsKeyStringKmsKeystringKmsKey*string required #
The KMS key for the DataIntegration.
namestringnamestrnameStringNamestringName*string required #
The name of the DataIntegration.
objectConfigurationoptionalanyobject_configurationoptionalAnyobjectConfigurationoptionalObjectObjectConfigurationoptionalobjectObjectConfigurationoptionalinterface{} #
The configuration for what data should be pulled from the source.
scheduleConfigoptionalIResolvable | CfnDataIntegration.ScheduleConfigPropertyschedule_configoptionaltyping.Union[IResolvable, ScheduleConfigProperty]scheduleConfigoptionalIResolvableScheduleConfigoptionalIResolvableScheduleConfigoptionalinterface{} #
The name of the data and how often it should be pulled from the source.
sourceUristringsource_uristrsourceUriStringSourceUristringSourceUri*string required #
The URI of the data source.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
An array of key-value pairs to apply to this resource.

For more information, see Tag .