create-integration¶

Description¶

Creates a Zero-ETL integration in the caller’s account between two resources with Amazon Resource Names (ARNs): the SourceArn and TargetArn .

Synopsis¶

  create-integration
--integration-name <value>
--source-arn <value>
--target-arn <value>
[--description <value>]
[--data-filter <value>]
[--kms-key-id <value>]
[--additional-encryption-context <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--integration-name (string)

A unique name for an integration in Glue.

--source-arn (string)

The ARN of the source resource for the integration.

--target-arn (string)

The ARN of the target resource for the integration.

--description (string)

A description of the integration.

--data-filter (string)

Selects source tables for the integration using Maxwell filter syntax.

--kms-key-id (string)

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

--additional-encryption-context (map)

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.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--tags (list)

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

(structure)

The Tag object represents a label that you can assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.

For more information about tags, and controlling access to resources in Glue, see Amazon Web Services Tags in Glue and Specifying Glue Resource ARNs in the developer guide.

key -> (string)

The tag key. The key is required when you create a tag on an object. The key is case-sensitive, and must not contain the prefix aws.

value -> (string)

The tag value. The value is optional when you create a tag on an object. The value is case-sensitive, and must not contain the prefix aws.

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

SourceArn -> (string)

The ARN of the source resource for the integration.

TargetArn -> (string)

The ARN of the target resource for the integration.

IntegrationName -> (string)

A unique name for an integration in Glue.

Description -> (string)

A description of the integration.

IntegrationArn -> (string)

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

KmsKeyId -> (string)

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

AdditionalEncryptionContext -> (map)

An optional set of non-secret key–value pairs that contains additional contextual information for encryption.

key -> (string)

value -> (string)

Tags -> (list)

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

(structure)

The Tag object represents a label that you can assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.

For more information about tags, and controlling access to resources in Glue, see Amazon Web Services Tags in Glue and Specifying Glue Resource ARNs in the developer guide.

key -> (string)

The tag key. The key is required when you create a tag on an object. The key is case-sensitive, and must not contain the prefix aws.

value -> (string)

The tag value. The value is optional when you create a tag on an object. The value is case-sensitive, and must not contain the prefix aws.

Status -> (string)

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.

CreateTime -> (timestamp)

The time when the integration was created, in UTC.

Errors -> (list)

A list of errors associated with the integration creation.

(structure)

An error associated with a zero-ETL integration.

ErrorCode -> (string)

The code associated with this error.

ErrorMessage -> (string)

A message describing the error.

DataFilter -> (string)