airbyte 0.7.0-beta2, Mar 7 25

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbyte.SourceAmazonAds

Explore with Pulumi AI

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceAmazonAds;
import com.pulumi.airbyte.SourceAmazonAdsArgs;
import com.pulumi.airbyte.inputs.SourceAmazonAdsConfigurationArgs;
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 mySourceAmazonads = new SourceAmazonAds("mySourceAmazonads", SourceAmazonAdsArgs.builder()
            .configuration(SourceAmazonAdsConfigurationArgs.builder()
                .client_id("...my_client_id...")
                .client_secret("...my_client_secret...")
                .look_back_window(3)
                .marketplace_ids("...")
                .profiles(1)
                .refresh_token("...my_refresh_token...")
                .region("FE")
                .start_date("2022-10-10")
                .build())
            .definitionId("af6454d1-eef9-48c7-951f-d90f8c67b58a")
            .secretId("...my_secret_id...")
            .workspaceId("a6beec71-8c3b-4cf7-87f9-463dd8bf8f4e")
            .build());

    }
}

resources:
  mySourceAmazonads:
    type: airbyte:SourceAmazonAds
    properties:
      configuration:
        client_id: '...my_client_id...'
        client_secret: '...my_client_secret...'
        look_back_window: 3
        marketplace_ids:
          - '...'
        profiles:
          - 1
        refresh_token: '...my_refresh_token...'
        region: FE
        start_date: 2022-10-10
      definitionId: af6454d1-eef9-48c7-951f-d90f8c67b58a
      secretId: '...my_secret_id...'
      workspaceId: a6beec71-8c3b-4cf7-87f9-463dd8bf8f4e

Create SourceAmazonAds Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SourceAmazonAds(name: string, args: SourceAmazonAdsArgs, opts?: CustomResourceOptions);

@overload
def SourceAmazonAds(resource_name: str,
                    args: SourceAmazonAdsArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def SourceAmazonAds(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    configuration: Optional[SourceAmazonAdsConfigurationArgs] = None,
                    workspace_id: Optional[str] = None,
                    definition_id: Optional[str] = None,
                    name: Optional[str] = None,
                    secret_id: Optional[str] = None)

func NewSourceAmazonAds(ctx *Context, name string, args SourceAmazonAdsArgs, opts ...ResourceOption) (*SourceAmazonAds, error)

public SourceAmazonAds(string name, SourceAmazonAdsArgs args, CustomResourceOptions? opts = null)

public SourceAmazonAds(String name, SourceAmazonAdsArgs args)
public SourceAmazonAds(String name, SourceAmazonAdsArgs args, CustomResourceOptions options)

type: airbyte:SourceAmazonAds
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args SourceAmazonAdsArgs: 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 SourceAmazonAdsArgs: 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 SourceAmazonAdsArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SourceAmazonAdsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SourceAmazonAdsArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var sourceAmazonAdsResource = new Airbyte.SourceAmazonAds("sourceAmazonAdsResource", new()
{
    Configuration = new Airbyte.Inputs.SourceAmazonAdsConfigurationArgs
    {
        ClientId = "string",
        ClientSecret = "string",
        RefreshToken = "string",
        LookBackWindow = 0,
        MarketplaceIds = new[]
        {
            "string",
        },
        Profiles = new[]
        {
            0,
        },
        Region = "string",
        StartDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceAmazonAds(ctx, "sourceAmazonAdsResource", &airbyte.SourceAmazonAdsArgs{
Configuration: &.SourceAmazonAdsConfigurationArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
RefreshToken: pulumi.String("string"),
LookBackWindow: pulumi.Float64(0),
MarketplaceIds: pulumi.StringArray{
pulumi.String("string"),
},
Profiles: pulumi.Float64Array{
pulumi.Float64(0),
},
Region: pulumi.String("string"),
StartDate: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceAmazonAdsResource = new SourceAmazonAds("sourceAmazonAdsResource", SourceAmazonAdsArgs.builder()
    .configuration(SourceAmazonAdsConfigurationArgs.builder()
        .clientId("string")
        .clientSecret("string")
        .refreshToken("string")
        .lookBackWindow(0)
        .marketplaceIds("string")
        .profiles(0)
        .region("string")
        .startDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_amazon_ads_resource = airbyte.SourceAmazonAds("sourceAmazonAdsResource",
    configuration={
        "client_id": "string",
        "client_secret": "string",
        "refresh_token": "string",
        "look_back_window": 0,
        "marketplace_ids": ["string"],
        "profiles": [0],
        "region": "string",
        "start_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceAmazonAdsResource = new airbyte.SourceAmazonAds("sourceAmazonAdsResource", {
    configuration: {
        clientId: "string",
        clientSecret: "string",
        refreshToken: "string",
        lookBackWindow: 0,
        marketplaceIds: ["string"],
        profiles: [0],
        region: "string",
        startDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceAmazonAds
properties:
    configuration:
        clientId: string
        clientSecret: string
        lookBackWindow: 0
        marketplaceIds:
            - string
        profiles:
            - 0
        refreshToken: string
        region: string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

SourceAmazonAds Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SourceAmazonAds resource accepts the following input properties:

Configuration SourceAmazonAdsConfiguration
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Configuration SourceAmazonAdsConfigurationArgs
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceAmazonAdsConfiguration
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceAmazonAdsConfiguration
workspaceId string
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceAmazonAdsConfigurationArgs
workspace_id str
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration Property Map
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Outputs

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

CreatedAt double
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

CreatedAt float64
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

createdAt Double
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

createdAt number
id string: The provider-assigned unique ID for this managed resource.
sourceId string
sourceType string

created_at float
id str: The provider-assigned unique ID for this managed resource.
source_id str
source_type str

createdAt Number
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

Look up Existing SourceAmazonAds Resource

Get an existing SourceAmazonAds 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?: SourceAmazonAdsState, opts?: CustomResourceOptions): SourceAmazonAds

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceAmazonAdsConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceAmazonAds

func GetSourceAmazonAds(ctx *Context, name string, id IDInput, state *SourceAmazonAdsState, opts ...ResourceOption) (*SourceAmazonAds, error)

public static SourceAmazonAds Get(string name, Input<string> id, SourceAmazonAdsState? state, CustomResourceOptions? opts = null)

public static SourceAmazonAds get(String name, Output<String> id, SourceAmazonAdsState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceAmazonAds    get:      id: ${id}

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:

Configuration SourceAmazonAdsConfiguration
CreatedAt double
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

Configuration SourceAmazonAdsConfigurationArgs
CreatedAt float64
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

configuration SourceAmazonAdsConfiguration
createdAt Double
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

configuration SourceAmazonAdsConfiguration
createdAt number
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string

configuration SourceAmazonAdsConfigurationArgs
created_at float
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
source_id str
source_type str
workspace_id str

configuration Property Map
createdAt Number
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceAmazonAdsConfiguration, SourceAmazonAdsConfigurationArgs

ClientId string: The client ID of your Amazon Ads developer application. See the \n\ndocs\n\n for more information.
ClientSecret string: The client secret of your Amazon Ads developer application. See the \n\ndocs\n\n for more information.
RefreshToken string: Amazon Ads refresh token. See the \n\ndocs\n\n for more information on how to obtain this token.
LookBackWindow double: The amount of days to go back in time to get the updated data from Amazon Ads. Default: 3
MarketplaceIds List<string>: Marketplace IDs you want to fetch data for. Note: If Profile IDs are also selected, profiles will be selected if they match the Profile ID OR the Marketplace ID.
Profiles List<double>: Profile IDs you want to fetch data for. The Amazon Ads source connector supports only profiles with seller and vendor type, profiles with agency type will be ignored. See \n\ndocs\n\n for more details. Note: If Marketplace IDs are also selected, profiles will be selected if they match the Profile ID OR the Marketplace ID.
Region string: Region to pull data from (EU/NA/FE). See \n\ndocs\n\n for more details. Default: "NA"; must be one of ["NA", "EU", "FE"]
StartDate string: The Start date for collecting reports, should not be more than 60 days in the past. In YYYY-MM-DD format

ClientId string: The client ID of your Amazon Ads developer application. See the \n\ndocs\n\n for more information.
ClientSecret string: The client secret of your Amazon Ads developer application. See the \n\ndocs\n\n for more information.
RefreshToken string: Amazon Ads refresh token. See the \n\ndocs\n\n for more information on how to obtain this token.
LookBackWindow float64: The amount of days to go back in time to get the updated data from Amazon Ads. Default: 3
MarketplaceIds []string: Marketplace IDs you want to fetch data for. Note: If Profile IDs are also selected, profiles will be selected if they match the Profile ID OR the Marketplace ID.
Profiles []float64: Profile IDs you want to fetch data for. The Amazon Ads source connector supports only profiles with seller and vendor type, profiles with agency type will be ignored. See \n\ndocs\n\n for more details. Note: If Marketplace IDs are also selected, profiles will be selected if they match the Profile ID OR the Marketplace ID.
Region string: Region to pull data from (EU/NA/FE). See \n\ndocs\n\n for more details. Default: "NA"; must be one of ["NA", "EU", "FE"]
StartDate string: The Start date for collecting reports, should not be more than 60 days in the past. In YYYY-MM-DD format

clientId String: The client ID of your Amazon Ads developer application. See the \n\ndocs\n\n for more information.
clientSecret String: The client secret of your Amazon Ads developer application. See the \n\ndocs\n\n for more information.
refreshToken String: Amazon Ads refresh token. See the \n\ndocs\n\n for more information on how to obtain this token.
lookBackWindow Double: The amount of days to go back in time to get the updated data from Amazon Ads. Default: 3
marketplaceIds List<String>: Marketplace IDs you want to fetch data for. Note: If Profile IDs are also selected, profiles will be selected if they match the Profile ID OR the Marketplace ID.
profiles List<Double>: Profile IDs you want to fetch data for. The Amazon Ads source connector supports only profiles with seller and vendor type, profiles with agency type will be ignored. See \n\ndocs\n\n for more details. Note: If Marketplace IDs are also selected, profiles will be selected if they match the Profile ID OR the Marketplace ID.
region String: Region to pull data from (EU/NA/FE). See \n\ndocs\n\n for more details. Default: "NA"; must be one of ["NA", "EU", "FE"]
startDate String: The Start date for collecting reports, should not be more than 60 days in the past. In YYYY-MM-DD format

clientId string: The client ID of your Amazon Ads developer application. See the \n\ndocs\n\n for more information.
clientSecret string: The client secret of your Amazon Ads developer application. See the \n\ndocs\n\n for more information.
refreshToken string: Amazon Ads refresh token. See the \n\ndocs\n\n for more information on how to obtain this token.
lookBackWindow number: The amount of days to go back in time to get the updated data from Amazon Ads. Default: 3
marketplaceIds string[]: Marketplace IDs you want to fetch data for. Note: If Profile IDs are also selected, profiles will be selected if they match the Profile ID OR the Marketplace ID.
profiles number[]: Profile IDs you want to fetch data for. The Amazon Ads source connector supports only profiles with seller and vendor type, profiles with agency type will be ignored. See \n\ndocs\n\n for more details. Note: If Marketplace IDs are also selected, profiles will be selected if they match the Profile ID OR the Marketplace ID.
region string: Region to pull data from (EU/NA/FE). See \n\ndocs\n\n for more details. Default: "NA"; must be one of ["NA", "EU", "FE"]
startDate string: The Start date for collecting reports, should not be more than 60 days in the past. In YYYY-MM-DD format

client_id str: The client ID of your Amazon Ads developer application. See the \n\ndocs\n\n for more information.
client_secret str: The client secret of your Amazon Ads developer application. See the \n\ndocs\n\n for more information.
refresh_token str: Amazon Ads refresh token. See the \n\ndocs\n\n for more information on how to obtain this token.
look_back_window float: The amount of days to go back in time to get the updated data from Amazon Ads. Default: 3
marketplace_ids Sequence[str]: Marketplace IDs you want to fetch data for. Note: If Profile IDs are also selected, profiles will be selected if they match the Profile ID OR the Marketplace ID.
profiles Sequence[float]: Profile IDs you want to fetch data for. The Amazon Ads source connector supports only profiles with seller and vendor type, profiles with agency type will be ignored. See \n\ndocs\n\n for more details. Note: If Marketplace IDs are also selected, profiles will be selected if they match the Profile ID OR the Marketplace ID.
region str: Region to pull data from (EU/NA/FE). See \n\ndocs\n\n for more details. Default: "NA"; must be one of ["NA", "EU", "FE"]
start_date str: The Start date for collecting reports, should not be more than 60 days in the past. In YYYY-MM-DD format

clientId String: The client ID of your Amazon Ads developer application. See the \n\ndocs\n\n for more information.
clientSecret String: The client secret of your Amazon Ads developer application. See the \n\ndocs\n\n for more information.
refreshToken String: Amazon Ads refresh token. See the \n\ndocs\n\n for more information on how to obtain this token.
lookBackWindow Number: The amount of days to go back in time to get the updated data from Amazon Ads. Default: 3
marketplaceIds List<String>: Marketplace IDs you want to fetch data for. Note: If Profile IDs are also selected, profiles will be selected if they match the Profile ID OR the Marketplace ID.
profiles List<Number>: Profile IDs you want to fetch data for. The Amazon Ads source connector supports only profiles with seller and vendor type, profiles with agency type will be ignored. See \n\ndocs\n\n for more details. Note: If Marketplace IDs are also selected, profiles will be selected if they match the Profile ID OR the Marketplace ID.
region String: Region to pull data from (EU/NA/FE). See \n\ndocs\n\n for more details. Default: "NA"; must be one of ["NA", "EU", "FE"]
startDate String: The Start date for collecting reports, should not be more than 60 days in the past. In YYYY-MM-DD format

Import

$ pulumi import airbyte:index/sourceAmazonAds:SourceAmazonAds my_airbyte_source_amazon_ads ""

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: airbyte airbytehq/terraform-provider-airbyte
License
Notes: This Pulumi package is based on the airbyte Terraform Provider.

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.SourceAmazonAds

On this page

On this page

Example Usage

Create SourceAmazonAds Resource

Constructor syntax

Parameters

Constructor example

SourceAmazonAds Resource Properties

Inputs

Outputs

Look up Existing SourceAmazonAds Resource

Supporting Types

SourceAmazonAdsConfiguration, SourceAmazonAdsConfigurationArgs

Import

Package Details

On this page

On this page