Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. quicksight
  5. Ingestion
AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-aws

aws.quicksight.Ingestion

Explore with Pulumi AI

AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-aws

Resource for managing an AWS QuickSight Ingestion.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.quicksight.Ingestion("example", {
    dataSetId: exampleAwsQuicksightDataSet.dataSetId,
    ingestionId: "example-id",
    ingestionType: "FULL_REFRESH",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.quicksight.Ingestion("example",
    data_set_id=example_aws_quicksight_data_set["dataSetId"],
    ingestion_id="example-id",
    ingestion_type="FULL_REFRESH")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/quicksight"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := quicksight.NewIngestion(ctx, "example", &quicksight.IngestionArgs{
			DataSetId:     pulumi.Any(exampleAwsQuicksightDataSet.DataSetId),
			IngestionId:   pulumi.String("example-id"),
			IngestionType: pulumi.String("FULL_REFRESH"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Quicksight.Ingestion("example", new()
    {
        DataSetId = exampleAwsQuicksightDataSet.DataSetId,
        IngestionId = "example-id",
        IngestionType = "FULL_REFRESH",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.Ingestion;
import com.pulumi.aws.quicksight.IngestionArgs;
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 Ingestion("example", IngestionArgs.builder()
            .dataSetId(exampleAwsQuicksightDataSet.dataSetId())
            .ingestionId("example-id")
            .ingestionType("FULL_REFRESH")
            .build());

    }
}
Copy
resources:
  example:
    type: aws:quicksight:Ingestion
    properties:
      dataSetId: ${exampleAwsQuicksightDataSet.dataSetId}
      ingestionId: example-id
      ingestionType: FULL_REFRESH
Copy

Create Ingestion Resource

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

Constructor syntax

new Ingestion(name: string, args: IngestionArgs, opts?: CustomResourceOptions);
@overload
def Ingestion(resource_name: str,
              args: IngestionArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Ingestion(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              data_set_id: Optional[str] = None,
              ingestion_id: Optional[str] = None,
              ingestion_type: Optional[str] = None,
              aws_account_id: Optional[str] = None)
func NewIngestion(ctx *Context, name string, args IngestionArgs, opts ...ResourceOption) (*Ingestion, error)
public Ingestion(string name, IngestionArgs args, CustomResourceOptions? opts = null)
public Ingestion(String name, IngestionArgs args)
public Ingestion(String name, IngestionArgs args, CustomResourceOptions options)

type: aws:quicksight:Ingestion
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IngestionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IngestionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IngestionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IngestionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IngestionArgs
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 awsIngestionResource = new Aws.Quicksight.Ingestion("awsIngestionResource", new()
{
    DataSetId = "string",
    IngestionId = "string",
    IngestionType = "string",
    AwsAccountId = "string",
});
Copy
example, err := quicksight.NewIngestion(ctx, "awsIngestionResource", &quicksight.IngestionArgs{
	DataSetId:     pulumi.String("string"),
	IngestionId:   pulumi.String("string"),
	IngestionType: pulumi.String("string"),
	AwsAccountId:  pulumi.String("string"),
})
Copy
var awsIngestionResource = new Ingestion("awsIngestionResource", IngestionArgs.builder()
    .dataSetId("string")
    .ingestionId("string")
    .ingestionType("string")
    .awsAccountId("string")
    .build());
Copy
aws_ingestion_resource = aws.quicksight.Ingestion("awsIngestionResource",
    data_set_id="string",
    ingestion_id="string",
    ingestion_type="string",
    aws_account_id="string")
Copy
const awsIngestionResource = new aws.quicksight.Ingestion("awsIngestionResource", {
    dataSetId: "string",
    ingestionId: "string",
    ingestionType: "string",
    awsAccountId: "string",
});
Copy
type: aws:quicksight:Ingestion
properties:
    awsAccountId: string
    dataSetId: string
    ingestionId: string
    ingestionType: string
Copy

Ingestion 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 Ingestion resource accepts the following input properties:

DataSetId This property is required. string
ID of the dataset used in the ingestion.
IngestionId This property is required. string
ID for the ingestion.
IngestionType This property is required. string

Type of ingestion to be created. Valid values are INCREMENTAL_REFRESH and FULL_REFRESH.

The following arguments are optional:

AwsAccountId string
AWS account ID.
DataSetId This property is required. string
ID of the dataset used in the ingestion.
IngestionId This property is required. string
ID for the ingestion.
IngestionType This property is required. string

Type of ingestion to be created. Valid values are INCREMENTAL_REFRESH and FULL_REFRESH.

The following arguments are optional:

AwsAccountId string
AWS account ID.
dataSetId This property is required. String
ID of the dataset used in the ingestion.
ingestionId This property is required. String
ID for the ingestion.
ingestionType This property is required. String

Type of ingestion to be created. Valid values are INCREMENTAL_REFRESH and FULL_REFRESH.

The following arguments are optional:

awsAccountId String
AWS account ID.
dataSetId This property is required. string
ID of the dataset used in the ingestion.
ingestionId This property is required. string
ID for the ingestion.
ingestionType This property is required. string

Type of ingestion to be created. Valid values are INCREMENTAL_REFRESH and FULL_REFRESH.

The following arguments are optional:

awsAccountId string
AWS account ID.
data_set_id This property is required. str
ID of the dataset used in the ingestion.
ingestion_id This property is required. str
ID for the ingestion.
ingestion_type This property is required. str

Type of ingestion to be created. Valid values are INCREMENTAL_REFRESH and FULL_REFRESH.

The following arguments are optional:

aws_account_id str
AWS account ID.
dataSetId This property is required. String
ID of the dataset used in the ingestion.
ingestionId This property is required. String
ID for the ingestion.
ingestionType This property is required. String

Type of ingestion to be created. Valid values are INCREMENTAL_REFRESH and FULL_REFRESH.

The following arguments are optional:

awsAccountId String
AWS account ID.

Outputs

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

Arn string
ARN of the Ingestion.
Id string
The provider-assigned unique ID for this managed resource.
IngestionStatus string
Ingestion status.
Arn string
ARN of the Ingestion.
Id string
The provider-assigned unique ID for this managed resource.
IngestionStatus string
Ingestion status.
arn String
ARN of the Ingestion.
id String
The provider-assigned unique ID for this managed resource.
ingestionStatus String
Ingestion status.
arn string
ARN of the Ingestion.
id string
The provider-assigned unique ID for this managed resource.
ingestionStatus string
Ingestion status.
arn str
ARN of the Ingestion.
id str
The provider-assigned unique ID for this managed resource.
ingestion_status str
Ingestion status.
arn String
ARN of the Ingestion.
id String
The provider-assigned unique ID for this managed resource.
ingestionStatus String
Ingestion status.

Look up Existing Ingestion Resource

Get an existing Ingestion 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?: IngestionState, opts?: CustomResourceOptions): Ingestion
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        aws_account_id: Optional[str] = None,
        data_set_id: Optional[str] = None,
        ingestion_id: Optional[str] = None,
        ingestion_status: Optional[str] = None,
        ingestion_type: Optional[str] = None) -> Ingestion
func GetIngestion(ctx *Context, name string, id IDInput, state *IngestionState, opts ...ResourceOption) (*Ingestion, error)
public static Ingestion Get(string name, Input<string> id, IngestionState? state, CustomResourceOptions? opts = null)
public static Ingestion get(String name, Output<String> id, IngestionState state, CustomResourceOptions options)
resources:  _:    type: aws:quicksight:Ingestion    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
ARN of the Ingestion.
AwsAccountId string
AWS account ID.
DataSetId string
ID of the dataset used in the ingestion.
IngestionId string
ID for the ingestion.
IngestionStatus string
Ingestion status.
IngestionType string

Type of ingestion to be created. Valid values are INCREMENTAL_REFRESH and FULL_REFRESH.

The following arguments are optional:

Arn string
ARN of the Ingestion.
AwsAccountId string
AWS account ID.
DataSetId string
ID of the dataset used in the ingestion.
IngestionId string
ID for the ingestion.
IngestionStatus string
Ingestion status.
IngestionType string

Type of ingestion to be created. Valid values are INCREMENTAL_REFRESH and FULL_REFRESH.

The following arguments are optional:

arn String
ARN of the Ingestion.
awsAccountId String
AWS account ID.
dataSetId String
ID of the dataset used in the ingestion.
ingestionId String
ID for the ingestion.
ingestionStatus String
Ingestion status.
ingestionType String

Type of ingestion to be created. Valid values are INCREMENTAL_REFRESH and FULL_REFRESH.

The following arguments are optional:

arn string
ARN of the Ingestion.
awsAccountId string
AWS account ID.
dataSetId string
ID of the dataset used in the ingestion.
ingestionId string
ID for the ingestion.
ingestionStatus string
Ingestion status.
ingestionType string

Type of ingestion to be created. Valid values are INCREMENTAL_REFRESH and FULL_REFRESH.

The following arguments are optional:

arn str
ARN of the Ingestion.
aws_account_id str
AWS account ID.
data_set_id str
ID of the dataset used in the ingestion.
ingestion_id str
ID for the ingestion.
ingestion_status str
Ingestion status.
ingestion_type str

Type of ingestion to be created. Valid values are INCREMENTAL_REFRESH and FULL_REFRESH.

The following arguments are optional:

arn String
ARN of the Ingestion.
awsAccountId String
AWS account ID.
dataSetId String
ID of the dataset used in the ingestion.
ingestionId String
ID for the ingestion.
ingestionStatus String
Ingestion status.
ingestionType String

Type of ingestion to be created. Valid values are INCREMENTAL_REFRESH and FULL_REFRESH.

The following arguments are optional:

Import

Using pulumi import, import QuickSight Ingestion using the AWS account ID, data set ID, and ingestion ID separated by commas (,). For example:

$ pulumi import aws:quicksight/ingestion:Ingestion example 123456789012,example-dataset-id,example-ingestion-id
Copy

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

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-aws