[ aws . appintegrations ]
create-data-integration¶
Description¶
Creates and persists a DataIntegration resource.
Note
You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
create-data-integration
--name <value>
[--description <value>]
[--kms-key <value>]
[--source-uri <value>]
[--schedule-config <value>]
[--tags <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--name (string)
The name of the DataIntegration.
--description (string)
A description of the DataIntegration.
--kms-key (string)
The KMS key for the DataIntegration.
--source-uri (string)
The URI of the data source.
--schedule-config (structure)
The name of the data and how often it should be pulled from the source.
FirstExecutionFrom -> (string)
The start date for objects to import in the first flow run.
Object -> (string)
The name of the object to pull from the data source.
ScheduleExpression -> (string)
How often the data should be pulled from data source.
Shorthand Syntax:
FirstExecutionFrom=string,Object=string,ScheduleExpression=string
JSON Syntax:
{
"FirstExecutionFrom": "string",
"Object": "string",
"ScheduleExpression": "string"
}
--tags (map)
One or more tags.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--client-token (string)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
--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.
See ‘aws help’ for descriptions of global parameters.
Output¶
Arn -> (string)
The Amazon Resource Name (ARN)
Id -> (string)
A unique identifier.
Name -> (string)
The name of the DataIntegration.
Description -> (string)
A description of the DataIntegration.
KmsKey -> (string)
The KMS key for the DataIntegration.
SourceURI -> (string)
The URI of the data source.
ScheduleConfiguration -> (structure)
The name of the data and how often it should be pulled from the source.
FirstExecutionFrom -> (string)
The start date for objects to import in the first flow run.
Object -> (string)
The name of the object to pull from the data source.
ScheduleExpression -> (string)
How often the data should be pulled from data source.
Tags -> (map)
One or more tags.
key -> (string)
value -> (string)
ClientToken -> (string)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.