AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . redshift ]

create-integration

Description

Creates a zero-ETL integration or S3 event integration with Amazon Redshift.

See also: AWS API Documentation

Synopsis

  create-integration
--source-arn <value>
--target-arn <value>
--integration-name <value>
[--kms-key-id <value>]
[--tag-list <value>]
[--additional-encryption-context <value>]
[--description <value>]
[--cli-input-json <value>]
[--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>]

Options

--source-arn (string)

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

--target-arn (string)

The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.

--integration-name (string)

The name of the integration.

--kms-key-id (string)

An Key Management Service (KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, the default Amazon Web Services owned key is used.

--tag-list (list)

A list of tags.

(structure)

A tag consisting of a name/value pair for a resource.

Key -> (string)

The key, or name, for the resource tag.

Value -> (string)

The value for the resource tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--additional-encryption-context (map)

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.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--description (string)

A description of the integration.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

Output

IntegrationArn -> (string)

The Amazon Resource Name (ARN) of the integration.

IntegrationName -> (string)

The name of the integration.

SourceArn -> (string)

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

TargetArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.

Status -> (string)

The current status of the integration.

Errors -> (list)

Any errors associated with the integration.

(structure)

The error of an inbound integration.

ErrorCode -> (string)

The error code of an inbound integration error.

ErrorMessage -> (string)

The error message of an inbound integration error.

CreateTime -> (timestamp)

The time (UTC) when the integration was created.

Description -> (string)

The description of the integration.

KMSKeyId -> (string)

The Key Management Service (KMS) key identifier for the key used to encrypt the integration.

AdditionalEncryptionContext -> (map)

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

key -> (string)

value -> (string)

Tags -> (list)

The list of tags associated with the integration.

(structure)

A tag consisting of a name/value pair for a resource.

Key -> (string)

The key, or name, for the resource tag.

Value -> (string)

The value for the resource tag.