1. Packages
  2. AWS Classic
  3. API Docs
  4. appintegrations
  5. DataIntegration

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi

aws.appintegrations.DataIntegration

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi

    Provides an Amazon AppIntegrations Data Integration resource.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.AppIntegrations.DataIntegration("example", new()
        {
            Description = "example",
            KmsKey = aws_kms_key.Test.Arn,
            SourceUri = "Salesforce://AppFlow/example",
            ScheduleConfig = new Aws.AppIntegrations.Inputs.DataIntegrationScheduleConfigArgs
            {
                FirstExecutionFrom = "1439788442681",
                Object = "Account",
                ScheduleExpression = "rate(1 hour)",
            },
            Tags = 
            {
                { "Key1", "Value1" },
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/appintegrations"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := appintegrations.NewDataIntegration(ctx, "example", &appintegrations.DataIntegrationArgs{
    			Description: pulumi.String("example"),
    			KmsKey:      pulumi.Any(aws_kms_key.Test.Arn),
    			SourceUri:   pulumi.String("Salesforce://AppFlow/example"),
    			ScheduleConfig: &appintegrations.DataIntegrationScheduleConfigArgs{
    				FirstExecutionFrom: pulumi.String("1439788442681"),
    				Object:             pulumi.String("Account"),
    				ScheduleExpression: pulumi.String("rate(1 hour)"),
    			},
    			Tags: pulumi.StringMap{
    				"Key1": pulumi.String("Value1"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.appintegrations.DataIntegration;
    import com.pulumi.aws.appintegrations.DataIntegrationArgs;
    import com.pulumi.aws.appintegrations.inputs.DataIntegrationScheduleConfigArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new DataIntegration("example", DataIntegrationArgs.builder()        
                .description("example")
                .kmsKey(aws_kms_key.test().arn())
                .sourceUri("Salesforce://AppFlow/example")
                .scheduleConfig(DataIntegrationScheduleConfigArgs.builder()
                    .firstExecutionFrom("1439788442681")
                    .object("Account")
                    .scheduleExpression("rate(1 hour)")
                    .build())
                .tags(Map.of("Key1", "Value1"))
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.appintegrations.DataIntegration("example",
        description="example",
        kms_key=aws_kms_key["test"]["arn"],
        source_uri="Salesforce://AppFlow/example",
        schedule_config=aws.appintegrations.DataIntegrationScheduleConfigArgs(
            first_execution_from="1439788442681",
            object="Account",
            schedule_expression="rate(1 hour)",
        ),
        tags={
            "Key1": "Value1",
        })
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.appintegrations.DataIntegration("example", {
        description: "example",
        kmsKey: aws_kms_key.test.arn,
        sourceUri: "Salesforce://AppFlow/example",
        scheduleConfig: {
            firstExecutionFrom: "1439788442681",
            object: "Account",
            scheduleExpression: "rate(1 hour)",
        },
        tags: {
            Key1: "Value1",
        },
    });
    
    resources:
      example:
        type: aws:appintegrations:DataIntegration
        properties:
          description: example
          kmsKey: ${aws_kms_key.test.arn}
          sourceUri: Salesforce://AppFlow/example
          scheduleConfig:
            firstExecutionFrom: '1439788442681'
            object: Account
            scheduleExpression: rate(1 hour)
          tags:
            Key1: Value1
    

    Create DataIntegration Resource

    new DataIntegration(name: string, args: DataIntegrationArgs, opts?: CustomResourceOptions);
    @overload
    def DataIntegration(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        description: Optional[str] = None,
                        kms_key: Optional[str] = None,
                        name: Optional[str] = None,
                        schedule_config: Optional[DataIntegrationScheduleConfigArgs] = None,
                        source_uri: Optional[str] = None,
                        tags: Optional[Mapping[str, str]] = None)
    @overload
    def DataIntegration(resource_name: str,
                        args: DataIntegrationArgs,
                        opts: Optional[ResourceOptions] = None)
    func NewDataIntegration(ctx *Context, name string, args DataIntegrationArgs, opts ...ResourceOption) (*DataIntegration, error)
    public DataIntegration(string name, DataIntegrationArgs args, CustomResourceOptions? opts = null)
    public DataIntegration(String name, DataIntegrationArgs args)
    public DataIntegration(String name, DataIntegrationArgs args, CustomResourceOptions options)
    
    type: aws:appintegrations:DataIntegration
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args DataIntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DataIntegrationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DataIntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataIntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataIntegrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DataIntegration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DataIntegration resource accepts the following input properties:

    KmsKey string

    Specifies the KMS key Amazon Resource Name (ARN) for the Data Integration.

    ScheduleConfig DataIntegrationScheduleConfig

    A block that defines the name of the data and how often it should be pulled from the source. The Schedule Config block is documented below.

    SourceUri string

    Specifies the URI of the data source. Create an AppFlow Connector Profile and reference the name of the profile in the URL. An example of this value for Salesforce is Salesforce://AppFlow/example where example is the name of the AppFlow Connector Profile.

    Description string

    Specifies the description of the Data Integration.

    Name string

    Specifies the name of the Data Integration.

    Tags Dictionary<string, string>

    Tags to apply to the Data Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    KmsKey string

    Specifies the KMS key Amazon Resource Name (ARN) for the Data Integration.

    ScheduleConfig DataIntegrationScheduleConfigArgs

    A block that defines the name of the data and how often it should be pulled from the source. The Schedule Config block is documented below.

    SourceUri string

    Specifies the URI of the data source. Create an AppFlow Connector Profile and reference the name of the profile in the URL. An example of this value for Salesforce is Salesforce://AppFlow/example where example is the name of the AppFlow Connector Profile.

    Description string

    Specifies the description of the Data Integration.

    Name string

    Specifies the name of the Data Integration.

    Tags map[string]string

    Tags to apply to the Data Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    kmsKey String

    Specifies the KMS key Amazon Resource Name (ARN) for the Data Integration.

    scheduleConfig DataIntegrationScheduleConfig

    A block that defines the name of the data and how often it should be pulled from the source. The Schedule Config block is documented below.

    sourceUri String

    Specifies the URI of the data source. Create an AppFlow Connector Profile and reference the name of the profile in the URL. An example of this value for Salesforce is Salesforce://AppFlow/example where example is the name of the AppFlow Connector Profile.

    description String

    Specifies the description of the Data Integration.

    name String

    Specifies the name of the Data Integration.

    tags Map<String,String>

    Tags to apply to the Data Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    kmsKey string

    Specifies the KMS key Amazon Resource Name (ARN) for the Data Integration.

    scheduleConfig DataIntegrationScheduleConfig

    A block that defines the name of the data and how often it should be pulled from the source. The Schedule Config block is documented below.

    sourceUri string

    Specifies the URI of the data source. Create an AppFlow Connector Profile and reference the name of the profile in the URL. An example of this value for Salesforce is Salesforce://AppFlow/example where example is the name of the AppFlow Connector Profile.

    description string

    Specifies the description of the Data Integration.

    name string

    Specifies the name of the Data Integration.

    tags {[key: string]: string}

    Tags to apply to the Data Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    kms_key str

    Specifies the KMS key Amazon Resource Name (ARN) for the Data Integration.

    schedule_config DataIntegrationScheduleConfigArgs

    A block that defines the name of the data and how often it should be pulled from the source. The Schedule Config block is documented below.

    source_uri str

    Specifies the URI of the data source. Create an AppFlow Connector Profile and reference the name of the profile in the URL. An example of this value for Salesforce is Salesforce://AppFlow/example where example is the name of the AppFlow Connector Profile.

    description str

    Specifies the description of the Data Integration.

    name str

    Specifies the name of the Data Integration.

    tags Mapping[str, str]

    Tags to apply to the Data Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    kmsKey String

    Specifies the KMS key Amazon Resource Name (ARN) for the Data Integration.

    scheduleConfig Property Map

    A block that defines the name of the data and how often it should be pulled from the source. The Schedule Config block is documented below.

    sourceUri String

    Specifies the URI of the data source. Create an AppFlow Connector Profile and reference the name of the profile in the URL. An example of this value for Salesforce is Salesforce://AppFlow/example where example is the name of the AppFlow Connector Profile.

    description String

    Specifies the description of the Data Integration.

    name String

    Specifies the name of the Data Integration.

    tags Map<String>

    Tags to apply to the Data Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DataIntegration resource produces the following output properties:

    Arn string

    The Amazon Resource Name (ARN) of the Data Integration.

    Id string

    The provider-assigned unique ID for this managed resource.

    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Arn string

    The Amazon Resource Name (ARN) of the Data Integration.

    Id string

    The provider-assigned unique ID for this managed resource.

    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    The Amazon Resource Name (ARN) of the Data Integration.

    id String

    The provider-assigned unique ID for this managed resource.

    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn string

    The Amazon Resource Name (ARN) of the Data Integration.

    id string

    The provider-assigned unique ID for this managed resource.

    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn str

    The Amazon Resource Name (ARN) of the Data Integration.

    id str

    The provider-assigned unique ID for this managed resource.

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    The Amazon Resource Name (ARN) of the Data Integration.

    id String

    The provider-assigned unique ID for this managed resource.

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Look up Existing DataIntegration Resource

    Get an existing DataIntegration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DataIntegrationState, opts?: CustomResourceOptions): DataIntegration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            description: Optional[str] = None,
            kms_key: Optional[str] = None,
            name: Optional[str] = None,
            schedule_config: Optional[DataIntegrationScheduleConfigArgs] = None,
            source_uri: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> DataIntegration
    func GetDataIntegration(ctx *Context, name string, id IDInput, state *DataIntegrationState, opts ...ResourceOption) (*DataIntegration, error)
    public static DataIntegration Get(string name, Input<string> id, DataIntegrationState? state, CustomResourceOptions? opts = null)
    public static DataIntegration get(String name, Output<String> id, DataIntegrationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string

    The Amazon Resource Name (ARN) of the Data Integration.

    Description string

    Specifies the description of the Data Integration.

    KmsKey string

    Specifies the KMS key Amazon Resource Name (ARN) for the Data Integration.

    Name string

    Specifies the name of the Data Integration.

    ScheduleConfig DataIntegrationScheduleConfig

    A block that defines the name of the data and how often it should be pulled from the source. The Schedule Config block is documented below.

    SourceUri string

    Specifies the URI of the data source. Create an AppFlow Connector Profile and reference the name of the profile in the URL. An example of this value for Salesforce is Salesforce://AppFlow/example where example is the name of the AppFlow Connector Profile.

    Tags Dictionary<string, string>

    Tags to apply to the Data Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Arn string

    The Amazon Resource Name (ARN) of the Data Integration.

    Description string

    Specifies the description of the Data Integration.

    KmsKey string

    Specifies the KMS key Amazon Resource Name (ARN) for the Data Integration.

    Name string

    Specifies the name of the Data Integration.

    ScheduleConfig DataIntegrationScheduleConfigArgs

    A block that defines the name of the data and how often it should be pulled from the source. The Schedule Config block is documented below.

    SourceUri string

    Specifies the URI of the data source. Create an AppFlow Connector Profile and reference the name of the profile in the URL. An example of this value for Salesforce is Salesforce://AppFlow/example where example is the name of the AppFlow Connector Profile.

    Tags map[string]string

    Tags to apply to the Data Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    The Amazon Resource Name (ARN) of the Data Integration.

    description String

    Specifies the description of the Data Integration.

    kmsKey String

    Specifies the KMS key Amazon Resource Name (ARN) for the Data Integration.

    name String

    Specifies the name of the Data Integration.

    scheduleConfig DataIntegrationScheduleConfig

    A block that defines the name of the data and how often it should be pulled from the source. The Schedule Config block is documented below.

    sourceUri String

    Specifies the URI of the data source. Create an AppFlow Connector Profile and reference the name of the profile in the URL. An example of this value for Salesforce is Salesforce://AppFlow/example where example is the name of the AppFlow Connector Profile.

    tags Map<String,String>

    Tags to apply to the Data Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn string

    The Amazon Resource Name (ARN) of the Data Integration.

    description string

    Specifies the description of the Data Integration.

    kmsKey string

    Specifies the KMS key Amazon Resource Name (ARN) for the Data Integration.

    name string

    Specifies the name of the Data Integration.

    scheduleConfig DataIntegrationScheduleConfig

    A block that defines the name of the data and how often it should be pulled from the source. The Schedule Config block is documented below.

    sourceUri string

    Specifies the URI of the data source. Create an AppFlow Connector Profile and reference the name of the profile in the URL. An example of this value for Salesforce is Salesforce://AppFlow/example where example is the name of the AppFlow Connector Profile.

    tags {[key: string]: string}

    Tags to apply to the Data Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn str

    The Amazon Resource Name (ARN) of the Data Integration.

    description str

    Specifies the description of the Data Integration.

    kms_key str

    Specifies the KMS key Amazon Resource Name (ARN) for the Data Integration.

    name str

    Specifies the name of the Data Integration.

    schedule_config DataIntegrationScheduleConfigArgs

    A block that defines the name of the data and how often it should be pulled from the source. The Schedule Config block is documented below.

    source_uri str

    Specifies the URI of the data source. Create an AppFlow Connector Profile and reference the name of the profile in the URL. An example of this value for Salesforce is Salesforce://AppFlow/example where example is the name of the AppFlow Connector Profile.

    tags Mapping[str, str]

    Tags to apply to the Data Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    The Amazon Resource Name (ARN) of the Data Integration.

    description String

    Specifies the description of the Data Integration.

    kmsKey String

    Specifies the KMS key Amazon Resource Name (ARN) for the Data Integration.

    name String

    Specifies the name of the Data Integration.

    scheduleConfig Property Map

    A block that defines the name of the data and how often it should be pulled from the source. The Schedule Config block is documented below.

    sourceUri String

    Specifies the URI of the data source. Create an AppFlow Connector Profile and reference the name of the profile in the URL. An example of this value for Salesforce is Salesforce://AppFlow/example where example is the name of the AppFlow Connector Profile.

    tags Map<String>

    Tags to apply to the Data Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Supporting Types

    DataIntegrationScheduleConfig, DataIntegrationScheduleConfigArgs

    FirstExecutionFrom string

    The start date for objects to import in the first flow run as an Unix/epoch timestamp in milliseconds or in ISO-8601 format. This needs to be a time in the past, meaning that the data created or updated before this given date will not be downloaded.

    Object string

    The name of the object to pull from the data source. Examples of objects in Salesforce include Case, Account, or Lead.

    ScheduleExpression string

    How often the data should be pulled from data source. Examples include rate(1 hour), rate(3 hours), rate(1 day).

    FirstExecutionFrom string

    The start date for objects to import in the first flow run as an Unix/epoch timestamp in milliseconds or in ISO-8601 format. This needs to be a time in the past, meaning that the data created or updated before this given date will not be downloaded.

    Object string

    The name of the object to pull from the data source. Examples of objects in Salesforce include Case, Account, or Lead.

    ScheduleExpression string

    How often the data should be pulled from data source. Examples include rate(1 hour), rate(3 hours), rate(1 day).

    firstExecutionFrom String

    The start date for objects to import in the first flow run as an Unix/epoch timestamp in milliseconds or in ISO-8601 format. This needs to be a time in the past, meaning that the data created or updated before this given date will not be downloaded.

    object String

    The name of the object to pull from the data source. Examples of objects in Salesforce include Case, Account, or Lead.

    scheduleExpression String

    How often the data should be pulled from data source. Examples include rate(1 hour), rate(3 hours), rate(1 day).

    firstExecutionFrom string

    The start date for objects to import in the first flow run as an Unix/epoch timestamp in milliseconds or in ISO-8601 format. This needs to be a time in the past, meaning that the data created or updated before this given date will not be downloaded.

    object string

    The name of the object to pull from the data source. Examples of objects in Salesforce include Case, Account, or Lead.

    scheduleExpression string

    How often the data should be pulled from data source. Examples include rate(1 hour), rate(3 hours), rate(1 day).

    first_execution_from str

    The start date for objects to import in the first flow run as an Unix/epoch timestamp in milliseconds or in ISO-8601 format. This needs to be a time in the past, meaning that the data created or updated before this given date will not be downloaded.

    object str

    The name of the object to pull from the data source. Examples of objects in Salesforce include Case, Account, or Lead.

    schedule_expression str

    How often the data should be pulled from data source. Examples include rate(1 hour), rate(3 hours), rate(1 day).

    firstExecutionFrom String

    The start date for objects to import in the first flow run as an Unix/epoch timestamp in milliseconds or in ISO-8601 format. This needs to be a time in the past, meaning that the data created or updated before this given date will not be downloaded.

    object String

    The name of the object to pull from the data source. Examples of objects in Salesforce include Case, Account, or Lead.

    scheduleExpression String

    How often the data should be pulled from data source. Examples include rate(1 hour), rate(3 hours), rate(1 day).

    Import

    Using pulumi import, import Amazon AppIntegrations Data Integrations using the id. For example:

     $ pulumi import aws:appintegrations/dataIntegration:DataIntegration example 12345678-1234-1234-1234-123456789123
    

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi