AWS::AppIntegrations::DataIntegration - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::AppIntegrations::DataIntegration

Creates and persists a DataIntegration resource.

Syntax

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

JSON

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

YAML

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

Properties

Description

A description of the DataIntegration.

Required: No

Type: String

Update requires: No interruption

FileConfiguration

Property description not available.

Required: No

Type: FileConfiguration

Update requires: No interruption

KmsKey

The KMS key for the DataIntegration.

Required: Yes

Type: String

Update requires: Replacement

Name

The name of the DataIntegration.

Required: Yes

Type: String

Update requires: No interruption

ObjectConfiguration

Property description not available.

Required: No

Type: Json

Update requires: No interruption

ScheduleConfig

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

Required: Yes

Type: ScheduleConfig

Update requires: Replacement

SourceURI

The URI of the data source.

Required: Yes

Type: String

Update requires: Replacement

Tags

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

For more information, see Tag.

Required: No

Type: List of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the DataIntegration name. For example:

{ "Ref": "myDataIntegrationName" }

For more information about using the Reffunction, see Ref.

Fn::GetAtt

The Fn::GetAttintrinsic 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::GetAttintrinsic function, see Fn::GetAtt.

DataIntegrationArn

The Amazon Resource Name (ARN) for the DataIntegration.

Id

A unique identifier.