AWS::Glue::Integration - AWS CloudFormation
SyntaxPropertiesReturn values

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.

AWS::Glue::Integration

The AWS::Glue::Integration resource specifies an AWS Glue zero-ETL integration from a data source to a target. For more information, see zero-ETL integration supported by AWS Glue and integration structure in the AWS Glue developer guide.

Syntax

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

JSON

{
  "Type" : "AWS::Glue::Integration",
  "Properties" : {
      "AdditionalEncryptionContext" : {Key: Value, ...},
      "DataFilter" : String,
      "Description" : String,
      "IntegrationConfig" : IntegrationConfig,
      "IntegrationName" : String,
      "KmsKeyId" : String,
      "SourceArn" : String,
      "Tags" : [ Tag, ... ],
      "TargetArn" : String
    }
}

YAML

Type: AWS::Glue::Integration
Properties:
  AdditionalEncryptionContext: 
    Key: Value
  DataFilter: String
  Description: String
  IntegrationConfig: 
    IntegrationConfig
  IntegrationName: String
  KmsKeyId: String
  SourceArn: String
  Tags: 
    - Tag
  TargetArn: String

Properties

AdditionalEncryptionContext

An optional set of non-secret key–value pairs that contains additional contextual information for encryption. This can only be provided if KMSKeyId is provided.

Required: No

Type: Object of String

Pattern: ^[\s\S]*$

Minimum: 0

Maximum: 131072

Update requires: Replacement

DataFilter

Selects source tables for the integration using Maxwell filter syntax.

Required: No

Type: String

Maximum: 2048

Update requires: No interruption

Description

A description for the integration.

Required: No

Type: String

Maximum: 1000

Update requires: No interruption

IntegrationConfig

The structure used to define properties associated with the zero-ETL integration. For more information, see IntegrationConfig structure.

Required: No

Type: IntegrationConfig

Update requires: Replacement

IntegrationName

A unique name for the integration.

Required: Yes

Type: String

Minimum: 1

Maximum: 128

Update requires: Replacement

KmsKeyId

The ARN of a KMS key used for encrypting the channel.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Update requires: Replacement

SourceArn

The ARN for the source of the integration.

Required: Yes

Type: String

Pattern: arn:aws:.*:.*:[0-9]+:.*

Maximum: 512

Update requires: Replacement

Tags

Metadata assigned to the resource consisting of a list of key-value pairs.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

TargetArn

The ARN for the target of the integration.

Required: Yes

Type: String

Pattern: arn:aws:.*:.*:[0-9]+:.*

Maximum: 512

Update requires: Replacement

Return values

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.

CreateTime

The time when the integration was created, in UTC.

IntegrationArn

The Amazon Resource Name (ARN) for the created integration.

Status

The status of the integration being created.

The possible statuses are:

  • CREATING: The integration is being created.

  • ACTIVE: The integration creation succeeds.

  • MODIFYING: The integration is being modified.

  • FAILED: The integration creation fails.

  • DELETING: The integration is deleted.

  • SYNCING: The integration is synchronizing.

  • NEEDS_ATTENTION: The integration needs attention, such as synchronization.