aws.quicksight.Ingestion
Explore with Pulumi AI
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",
});
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")
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
})
}
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",
});
});
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());
}
}
resources:
example:
type: aws:quicksight:Ingestion
properties:
dataSetId: ${exampleAwsQuicksightDataSet.dataSetId}
ingestionId: example-id
ingestionType: FULL_REFRESH
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 string
- The unique name of the resource.
- args IngestionArgs
- 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 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 string
- The unique name of the resource.
- args IngestionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IngestionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
});
example, err := quicksight.NewIngestion(ctx, "awsIngestionResource", &quicksight.IngestionArgs{
DataSetId: pulumi.String("string"),
IngestionId: pulumi.String("string"),
IngestionType: pulumi.String("string"),
AwsAccountId: pulumi.String("string"),
})
var awsIngestionResource = new Ingestion("awsIngestionResource", IngestionArgs.builder()
.dataSetId("string")
.ingestionId("string")
.ingestionType("string")
.awsAccountId("string")
.build());
aws_ingestion_resource = aws.quicksight.Ingestion("awsIngestionResource",
data_set_id="string",
ingestion_id="string",
ingestion_type="string",
aws_account_id="string")
const awsIngestionResource = new aws.quicksight.Ingestion("awsIngestionResource", {
dataSetId: "string",
ingestionId: "string",
ingestionType: "string",
awsAccountId: "string",
});
type: aws:quicksight:Ingestion
properties:
awsAccountId: string
dataSetId: string
ingestionId: string
ingestionType: string
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
The Ingestion resource accepts the following input properties:
- Data
Set stringId - ID of the dataset used in the ingestion.
- Ingestion
Id string - ID for the ingestion.
- Ingestion
Type string Type of ingestion to be created. Valid values are
INCREMENTAL_REFRESH
andFULL_REFRESH
.The following arguments are optional:
- Aws
Account stringId - AWS account ID.
- Data
Set stringId - ID of the dataset used in the ingestion.
- Ingestion
Id string - ID for the ingestion.
- Ingestion
Type string Type of ingestion to be created. Valid values are
INCREMENTAL_REFRESH
andFULL_REFRESH
.The following arguments are optional:
- Aws
Account stringId - AWS account ID.
- data
Set StringId - ID of the dataset used in the ingestion.
- ingestion
Id String - ID for the ingestion.
- ingestion
Type String Type of ingestion to be created. Valid values are
INCREMENTAL_REFRESH
andFULL_REFRESH
.The following arguments are optional:
- aws
Account StringId - AWS account ID.
- data
Set stringId - ID of the dataset used in the ingestion.
- ingestion
Id string - ID for the ingestion.
- ingestion
Type string Type of ingestion to be created. Valid values are
INCREMENTAL_REFRESH
andFULL_REFRESH
.The following arguments are optional:
- aws
Account stringId - AWS account ID.
- data_
set_ strid - ID of the dataset used in the ingestion.
- ingestion_
id str - ID for the ingestion.
- ingestion_
type str Type of ingestion to be created. Valid values are
INCREMENTAL_REFRESH
andFULL_REFRESH
.The following arguments are optional:
- aws_
account_ strid - AWS account ID.
- data
Set StringId - ID of the dataset used in the ingestion.
- ingestion
Id String - ID for the ingestion.
- ingestion
Type String Type of ingestion to be created. Valid values are
INCREMENTAL_REFRESH
andFULL_REFRESH
.The following arguments are optional:
- aws
Account StringId - 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.
- Ingestion
Status string - Ingestion status.
- Arn string
- ARN of the Ingestion.
- Id string
- The provider-assigned unique ID for this managed resource.
- Ingestion
Status string - Ingestion status.
- arn String
- ARN of the Ingestion.
- id String
- The provider-assigned unique ID for this managed resource.
- ingestion
Status String - Ingestion status.
- arn string
- ARN of the Ingestion.
- id string
- The provider-assigned unique ID for this managed resource.
- ingestion
Status 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.
- ingestion
Status 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)
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.
- Arn string
- ARN of the Ingestion.
- Aws
Account stringId - AWS account ID.
- Data
Set stringId - ID of the dataset used in the ingestion.
- Ingestion
Id string - ID for the ingestion.
- Ingestion
Status string - Ingestion status.
- Ingestion
Type string Type of ingestion to be created. Valid values are
INCREMENTAL_REFRESH
andFULL_REFRESH
.The following arguments are optional:
- Arn string
- ARN of the Ingestion.
- Aws
Account stringId - AWS account ID.
- Data
Set stringId - ID of the dataset used in the ingestion.
- Ingestion
Id string - ID for the ingestion.
- Ingestion
Status string - Ingestion status.
- Ingestion
Type string Type of ingestion to be created. Valid values are
INCREMENTAL_REFRESH
andFULL_REFRESH
.The following arguments are optional:
- arn String
- ARN of the Ingestion.
- aws
Account StringId - AWS account ID.
- data
Set StringId - ID of the dataset used in the ingestion.
- ingestion
Id String - ID for the ingestion.
- ingestion
Status String - Ingestion status.
- ingestion
Type String Type of ingestion to be created. Valid values are
INCREMENTAL_REFRESH
andFULL_REFRESH
.The following arguments are optional:
- arn string
- ARN of the Ingestion.
- aws
Account stringId - AWS account ID.
- data
Set stringId - ID of the dataset used in the ingestion.
- ingestion
Id string - ID for the ingestion.
- ingestion
Status string - Ingestion status.
- ingestion
Type string Type of ingestion to be created. Valid values are
INCREMENTAL_REFRESH
andFULL_REFRESH
.The following arguments are optional:
- arn str
- ARN of the Ingestion.
- aws_
account_ strid - AWS account ID.
- data_
set_ strid - 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
andFULL_REFRESH
.The following arguments are optional:
- arn String
- ARN of the Ingestion.
- aws
Account StringId - AWS account ID.
- data
Set StringId - ID of the dataset used in the ingestion.
- ingestion
Id String - ID for the ingestion.
- ingestion
Status String - Ingestion status.
- ingestion
Type String Type of ingestion to be created. Valid values are
INCREMENTAL_REFRESH
andFULL_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
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.