AWS::AppIntegrations::DataIntegration

Creates and persists a DataIntegration resource.

Syntax

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

JSON

{
  "Type" : "AWS::AppIntegrations::DataIntegration",
  "Properties" : {
      "Description" : String,
      "FileConfiguration" : FileConfiguration,
      "KmsKey" : String,
      "Name" : String,
      "ObjectConfiguration" : {Key: Value, ...},
      "ScheduleConfig" : ScheduleConfig,
      "SourceURI" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::AppIntegrations::DataIntegration
Properties:
  Description: String
  FileConfiguration: 
    FileConfiguration
  KmsKey: String
  Name: String
  ObjectConfiguration: 
    Key: Value
  ScheduleConfig: 
    ScheduleConfig
  SourceURI: String
  Tags: 
    - Tag

Properties

Description

A description of the DataIntegration.

Required: No

Type: String

Minimum: 1

Maximum: 1000

Update requires: No interruption

FileConfiguration

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

Required: No

Type: FileConfiguration

Update requires: No interruption

KmsKey

The KMS key for the DataIntegration.

Required: Yes

Type: String

Pattern: .*\S.*

Minimum: 1

Maximum: 255

Update requires: Replacement

Name

The name of the DataIntegration.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9/\._\-]+$

Minimum: 1

Maximum: 255

Update requires: No interruption

ObjectConfiguration

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

Required: No

Type: Object of Object

Pattern: ^.+$

Update requires: No interruption

ScheduleConfig

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

Required: No

Type: ScheduleConfig

Update requires: Replacement

SourceURI

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

Tags

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

For more information, see Tag.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Return values

Ref

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 Ref.

Fn::GetAtt

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 Fn::GetAtt.

DataIntegrationArn

The Amazon Resource Name (ARN) for the DataIntegration.

Id

A unique identifier.