Skip to content

Create Integration

rds_create_integration R Documentation

Creates a zero-ETL integration with Amazon Redshift

Description

Creates a zero-ETL integration with Amazon Redshift.

Usage

rds_create_integration(SourceArn, TargetArn, IntegrationName, KMSKeyId,
  AdditionalEncryptionContext, Tags, DataFilter, Description)

Arguments

SourceArn

[required] The Amazon Resource Name (ARN) of the database to use as the source for replication.

TargetArn

[required] The ARN of the Redshift data warehouse to use as the target for replication.

IntegrationName

[required] The name of the integration.

KMSKeyId

The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default Amazon Web Services owned key.

AdditionalEncryptionContext

An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.

You can only include this parameter if you specify the KMSKeyId parameter.

Tags
DataFilter

Data filtering options for the integration. For more information, see Data filtering for Aurora zero-ETL integrations with Amazon Redshift.

Valid for: Integrations with Aurora MySQL source DB clusters only

Description

A description of the integration.

Value

A list with the following syntax:

list(
  SourceArn = "string",
  TargetArn = "string",
  IntegrationName = "string",
  IntegrationArn = "string",
  KMSKeyId = "string",
  AdditionalEncryptionContext = list(
    "string"
  ),
  Status = "creating"|"active"|"modifying"|"failed"|"deleting"|"syncing"|"needs_attention",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  CreateTime = as.POSIXct(
    "2015-01-01"
  ),
  Errors = list(
    list(
      ErrorCode = "string",
      ErrorMessage = "string"
    )
  ),
  DataFilter = "string",
  Description = "string"
)

Request syntax

svc$create_integration(
  SourceArn = "string",
  TargetArn = "string",
  IntegrationName = "string",
  KMSKeyId = "string",
  AdditionalEncryptionContext = list(
    "string"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  DataFilter = "string",
  Description = "string"
)