RDS / Client / create_integration

create_integration

RDS.Client.create_integration(**kwargs)

Creates a zero-ETL integration with Amazon Redshift.

See also: AWS API Documentation

Request Syntax

response = client.create_integration(
    SourceArn='string',
    TargetArn='string',
    IntegrationName='string',
    KMSKeyId='string',
    AdditionalEncryptionContext={
        'string': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    DataFilter='string',
    Description='string'
)

Parameters:

• SourceArn (string) –

  [REQUIRED]

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

• TargetArn (string) –

  [REQUIRED]

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

• IntegrationName (string) –

  [REQUIRED]

  The name of the integration.

• KMSKeyId (string) – 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 (dict) –

  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.

  • (string) –

    • (string) –

• Tags (list) –

  A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

  • (dict) –

    Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

    For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

    • Key (string) –

      A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

    • Value (string) –

      A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

• DataFilter (string) –

  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 (string) – A description of the integration.

Return type:

dict

Returns:

Response Syntax

{
    'SourceArn': 'string',
    'TargetArn': 'string',
    'IntegrationName': 'string',
    'IntegrationArn': 'string',
    'KMSKeyId': 'string',
    'AdditionalEncryptionContext': {
        'string': 'string'
    },
    'Status': 'creating'|'active'|'modifying'|'failed'|'deleting'|'syncing'|'needs_attention',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'CreateTime': datetime(2015, 1, 1),
    'Errors': [
        {
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ],
    'DataFilter': 'string',
    'Description': 'string'
}

Response Structure

• (dict) –

  A zero-ETL integration with Amazon Redshift.

  • SourceArn (string) –

    The Amazon Resource Name (ARN) of the database used as the source for replication.

  • TargetArn (string) –

    The ARN of the Redshift data warehouse used as the target for replication.

  • IntegrationName (string) –

    The name of the integration.

  • IntegrationArn (string) –

    The ARN of the integration.

  • KMSKeyId (string) –

    The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to encrypt the integration.

  • AdditionalEncryptionContext (dict) –

    The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.

    • (string) –

      • (string) –

  • Status (string) –

    The current status of the integration.

  • Tags (list) –

    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

    • (dict) –

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

      • Key (string) –

        A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

      • Value (string) –

        A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

  • CreateTime (datetime) –

    The time when the integration was created, in Universal Coordinated Time (UTC).

  • Errors (list) –

    Any errors associated with the integration.

    • (dict) –

      An error associated with a zero-ETL integration with Amazon Redshift.

      • ErrorCode (string) –

        The error code associated with the integration.

      • ErrorMessage (string) –

        A message explaining the error.

  • DataFilter (string) –

    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.

  • Description (string) –

    A description of the integration.

Exceptions

• RDS.Client.exceptions.DBClusterNotFoundFault

• RDS.Client.exceptions.DBInstanceNotFoundFault

• RDS.Client.exceptions.IntegrationAlreadyExistsFault

• RDS.Client.exceptions.IntegrationQuotaExceededFault

• RDS.Client.exceptions.KMSKeyNotAccessibleFault

• RDS.Client.exceptions.IntegrationConflictOperationFault