

This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::AppIntegrations::DataIntegration
<a name="aws-resource-appintegrations-dataintegration"></a>

Creates and persists a DataIntegration resource.

## Syntax
<a name="aws-resource-appintegrations-dataintegration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-appintegrations-dataintegration-syntax.json"></a>

```
{
  "Type" : "AWS::AppIntegrations::DataIntegration",
  "Properties" : {
      "[Description](#cfn-appintegrations-dataintegration-description)" : String,
      "[FileConfiguration](#cfn-appintegrations-dataintegration-fileconfiguration)" : FileConfiguration,
      "[KmsKey](#cfn-appintegrations-dataintegration-kmskey)" : String,
      "[Name](#cfn-appintegrations-dataintegration-name)" : String,
      "[ObjectConfiguration](#cfn-appintegrations-dataintegration-objectconfiguration)" : {Key: Value, ...},
      "[ScheduleConfig](#cfn-appintegrations-dataintegration-scheduleconfig)" : ScheduleConfig,
      "[SourceURI](#cfn-appintegrations-dataintegration-sourceuri)" : String,
      "[Tags](#cfn-appintegrations-dataintegration-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-appintegrations-dataintegration-syntax.yaml"></a>

```
Type: AWS::AppIntegrations::DataIntegration
Properties:
  [Description](#cfn-appintegrations-dataintegration-description): String
  [FileConfiguration](#cfn-appintegrations-dataintegration-fileconfiguration): 
    FileConfiguration
  [KmsKey](#cfn-appintegrations-dataintegration-kmskey): String
  [Name](#cfn-appintegrations-dataintegration-name): String
  [ObjectConfiguration](#cfn-appintegrations-dataintegration-objectconfiguration): 
    Key: Value
  [ScheduleConfig](#cfn-appintegrations-dataintegration-scheduleconfig): 
    ScheduleConfig
  [SourceURI](#cfn-appintegrations-dataintegration-sourceuri): String
  [Tags](#cfn-appintegrations-dataintegration-tags): 
    - Tag
```

## Properties
<a name="aws-resource-appintegrations-dataintegration-properties"></a>

`Description`  <a name="cfn-appintegrations-dataintegration-description"></a>
A description of the DataIntegration.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FileConfiguration`  <a name="cfn-appintegrations-dataintegration-fileconfiguration"></a>
The configuration for what files should be pulled from the source.  
*Required*: No  
*Type*: [FileConfiguration](aws-properties-appintegrations-dataintegration-fileconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KmsKey`  <a name="cfn-appintegrations-dataintegration-kmskey"></a>
The KMS key for the DataIntegration.  
*Required*: Yes  
*Type*: String  
*Pattern*: `.*\S.*`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-appintegrations-dataintegration-name"></a>
The name of the DataIntegration.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9/\._\-]+$`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ObjectConfiguration`  <a name="cfn-appintegrations-dataintegration-objectconfiguration"></a>
The configuration for what data should be pulled from the source.  
*Required*: No  
*Type*: Object of Object  
*Pattern*: `^.+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ScheduleConfig`  <a name="cfn-appintegrations-dataintegration-scheduleconfig"></a>
The name of the data and how often it should be pulled from the source.  
*Required*: No  
*Type*: [ScheduleConfig](aws-properties-appintegrations-dataintegration-scheduleconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SourceURI`  <a name="cfn-appintegrations-dataintegration-sourceuri"></a>
The URI of the data source.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(\w+\:\/\/[\w.-]+[\w/!@#+=.-]+$)|(\w+\:\/\/[\w.-]+[\w/!@#+=.-]+[\w/!@#+=.-]+[\w/!@#+=.,-]+$)`  
*Minimum*: `1`  
*Maximum*: `1000`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-appintegrations-dataintegration-tags"></a>
An array of key-value pairs to apply to this resource.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Required*: No  
*Type*: Array of [Tag](aws-properties-appintegrations-dataintegration-tag.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-appintegrations-dataintegration-return-values"></a>

### Ref
<a name="aws-resource-appintegrations-dataintegration-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the DataIntegration name. For example:

 `{ "Ref": "myDataIntegrationName" }` 

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-appintegrations-dataintegration-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-appintegrations-dataintegration-return-values-fn--getatt-fn--getatt"></a>

`DataIntegrationArn`  <a name="DataIntegrationArn-fn::getatt"></a>
The Amazon Resource Name (ARN) for the DataIntegration.

`Id`  <a name="Id-fn::getatt"></a>
A unique identifier.

# AWS::AppIntegrations::DataIntegration FileConfiguration
<a name="aws-properties-appintegrations-dataintegration-fileconfiguration"></a>

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

## Syntax
<a name="aws-properties-appintegrations-dataintegration-fileconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-appintegrations-dataintegration-fileconfiguration-syntax.json"></a>

```
{
  "[Filters](#cfn-appintegrations-dataintegration-fileconfiguration-filters)" : {Key: Value, ...},
  "[Folders](#cfn-appintegrations-dataintegration-fileconfiguration-folders)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-appintegrations-dataintegration-fileconfiguration-syntax.yaml"></a>

```
  [Filters](#cfn-appintegrations-dataintegration-fileconfiguration-filters): 
    Key: Value
  [Folders](#cfn-appintegrations-dataintegration-fileconfiguration-folders): 
    - String
```

## Properties
<a name="aws-properties-appintegrations-dataintegration-fileconfiguration-properties"></a>

`Filters`  <a name="cfn-appintegrations-dataintegration-fileconfiguration-filters"></a>
Restrictions for what files should be pulled from the source.  
*Required*: No  
*Type*: Object of Array  
*Pattern*: `^[A-Za-z]`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Folders`  <a name="cfn-appintegrations-dataintegration-fileconfiguration-folders"></a>
Identifiers for the source folders to pull all files from recursively.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1 | 1`  
*Maximum*: `200 | 10`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::AppIntegrations::DataIntegration ScheduleConfig
<a name="aws-properties-appintegrations-dataintegration-scheduleconfig"></a>

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

## Syntax
<a name="aws-properties-appintegrations-dataintegration-scheduleconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-appintegrations-dataintegration-scheduleconfig-syntax.json"></a>

```
{
  "[FirstExecutionFrom](#cfn-appintegrations-dataintegration-scheduleconfig-firstexecutionfrom)" : String,
  "[Object](#cfn-appintegrations-dataintegration-scheduleconfig-object)" : String,
  "[ScheduleExpression](#cfn-appintegrations-dataintegration-scheduleconfig-scheduleexpression)" : String
}
```

### YAML
<a name="aws-properties-appintegrations-dataintegration-scheduleconfig-syntax.yaml"></a>

```
  [FirstExecutionFrom](#cfn-appintegrations-dataintegration-scheduleconfig-firstexecutionfrom): String
  [Object](#cfn-appintegrations-dataintegration-scheduleconfig-object): String
  [ScheduleExpression](#cfn-appintegrations-dataintegration-scheduleconfig-scheduleexpression): String
```

## Properties
<a name="aws-properties-appintegrations-dataintegration-scheduleconfig-properties"></a>

`FirstExecutionFrom`  <a name="cfn-appintegrations-dataintegration-scheduleconfig-firstexecutionfrom"></a>
The start date for objects to import in the first flow run as an Unix/epoch timestamp in milliseconds or in ISO-8601 format.   
*Required*: No  
*Type*: String  
*Pattern*: `.*\S.*`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Object`  <a name="cfn-appintegrations-dataintegration-scheduleconfig-object"></a>
The name of the object to pull from the data source.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9/\._\-]+$`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ScheduleExpression`  <a name="cfn-appintegrations-dataintegration-scheduleconfig-scheduleexpression"></a>
How often the data should be pulled from data source.  
*Required*: Yes  
*Type*: String  
*Pattern*: `.*\S.*`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::AppIntegrations::DataIntegration Tag
<a name="aws-properties-appintegrations-dataintegration-tag"></a>

The tags used to organize, track, or control access for this resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.

## Syntax
<a name="aws-properties-appintegrations-dataintegration-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-appintegrations-dataintegration-tag-syntax.json"></a>

```
{
  "[Key](#cfn-appintegrations-dataintegration-tag-key)" : String,
  "[Value](#cfn-appintegrations-dataintegration-tag-value)" : String
}
```

### YAML
<a name="aws-properties-appintegrations-dataintegration-tag-syntax.yaml"></a>

```
  [Key](#cfn-appintegrations-dataintegration-tag-key): String
  [Value](#cfn-appintegrations-dataintegration-tag-value): String
```

## Properties
<a name="aws-properties-appintegrations-dataintegration-tag-properties"></a>

`Key`  <a name="cfn-appintegrations-dataintegration-tag-key"></a>
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-appintegrations-dataintegration-tag-value"></a>
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)