import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Resource for managing an AWS FinSpace Kx Dataview. * * ## Example Usage * * ### Basic Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = new aws.finspace.KxDataview("example", { * segmentConfigurations: [{ * volumeName: exampleAwsFinspaceKxVolume.name, * dbPaths: ["/*"], * }], * name: "my-tf-kx-dataview", * environmentId: exampleAwsFinspaceKxEnvironment.id, * databaseName: exampleAwsFinspaceKxDatabase.name, * availabilityZoneId: "use1-az2", * description: "Terraform managed Kx Dataview", * azMode: "SINGLE", * autoUpdate: true, * }, { * customTimeouts: { * create: "24h", * update: "24h", * "delete": "12h", * }, * }); * ``` * * ## Import * * Using `pulumi import`, import an AWS FinSpace Kx Cluster using the `id` (environment ID and cluster name, comma-delimited). For example: * * ```sh * $ pulumi import aws:finspace/kxDataview:KxDataview example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-database,my-tf-kx-dataview * ``` */ export declare class KxDataview extends pulumi.CustomResource { /** * Get an existing KxDataview resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: KxDataviewState, opts?: pulumi.CustomResourceOptions): KxDataview; /** * Returns true if the given object is an instance of KxDataview. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is KxDataview; /** * ARN identifier of the KX dataview. */ readonly arn: pulumi.Output; /** * Whether to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. Defaults to `false`. */ readonly autoUpdate: pulumi.Output; /** * Identifier of the availability zones. If attaching a volume, the volume must be in the same availability zone as the dataview that you are attaching to. */ readonly availabilityZoneId: pulumi.Output; /** * Number of availability zones you want to assign per cluster. Valid values are `SINGLE` (assigns one availability zone per cluster) and `MULTI` (assigns all the availability zones per cluster). */ readonly azMode: pulumi.Output; /** * Unique identifier of the changeset of the database that you want to use to ingest data. */ readonly changesetId: pulumi.Output; /** * Timestamp at which the dataview was created in FinSpace. Value determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. */ readonly createdTimestamp: pulumi.Output; /** * Name of the database where you want to create a dataview. */ readonly databaseName: pulumi.Output; /** * Description for the dataview. */ readonly description: pulumi.Output; /** * Unique identifier for the KX environment. */ readonly environmentId: pulumi.Output; /** * Last time that the dataview was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. */ readonly lastModifiedTimestamp: pulumi.Output; /** * Unique identifier for the dataview. * * The following arguments are optional: */ readonly name: pulumi.Output; /** * Whether to make the dataview writable to perform database maintenance. You cannot create partial writable dataviews; you must provide the entire database path and cannot perform updates, so `autoUpdate` must be `false` when `readWrite` is `true`. You must also use a unique volume, and once a dataview is writable you cannot change it to read-only. */ readonly readWrite: pulumi.Output; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ readonly region: pulumi.Output; /** * Configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment. See `segmentConfigurations` below. */ readonly segmentConfigurations: pulumi.Output; /** * Status of the dataview. */ readonly status: pulumi.Output; /** * Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ readonly tagsAll: pulumi.Output<{ [key: string]: string; }>; /** * Create a KxDataview resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: KxDataviewArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering KxDataview resources. */ export interface KxDataviewState { /** * ARN identifier of the KX dataview. */ arn?: pulumi.Input; /** * Whether to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. Defaults to `false`. */ autoUpdate?: pulumi.Input; /** * Identifier of the availability zones. If attaching a volume, the volume must be in the same availability zone as the dataview that you are attaching to. */ availabilityZoneId?: pulumi.Input; /** * Number of availability zones you want to assign per cluster. Valid values are `SINGLE` (assigns one availability zone per cluster) and `MULTI` (assigns all the availability zones per cluster). */ azMode?: pulumi.Input; /** * Unique identifier of the changeset of the database that you want to use to ingest data. */ changesetId?: pulumi.Input; /** * Timestamp at which the dataview was created in FinSpace. Value determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. */ createdTimestamp?: pulumi.Input; /** * Name of the database where you want to create a dataview. */ databaseName?: pulumi.Input; /** * Description for the dataview. */ description?: pulumi.Input; /** * Unique identifier for the KX environment. */ environmentId?: pulumi.Input; /** * Last time that the dataview was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. */ lastModifiedTimestamp?: pulumi.Input; /** * Unique identifier for the dataview. * * The following arguments are optional: */ name?: pulumi.Input; /** * Whether to make the dataview writable to perform database maintenance. You cannot create partial writable dataviews; you must provide the entire database path and cannot perform updates, so `autoUpdate` must be `false` when `readWrite` is `true`. You must also use a unique volume, and once a dataview is writable you cannot change it to read-only. */ readWrite?: pulumi.Input; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * Configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment. See `segmentConfigurations` below. */ segmentConfigurations?: pulumi.Input[] | undefined>; /** * Status of the dataview. */ status?: pulumi.Input; /** * Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ tagsAll?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; } /** * The set of arguments for constructing a KxDataview resource. */ export interface KxDataviewArgs { /** * Whether to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. Defaults to `false`. */ autoUpdate: pulumi.Input; /** * Identifier of the availability zones. If attaching a volume, the volume must be in the same availability zone as the dataview that you are attaching to. */ availabilityZoneId?: pulumi.Input; /** * Number of availability zones you want to assign per cluster. Valid values are `SINGLE` (assigns one availability zone per cluster) and `MULTI` (assigns all the availability zones per cluster). */ azMode: pulumi.Input; /** * Unique identifier of the changeset of the database that you want to use to ingest data. */ changesetId?: pulumi.Input; /** * Name of the database where you want to create a dataview. */ databaseName: pulumi.Input; /** * Description for the dataview. */ description?: pulumi.Input; /** * Unique identifier for the KX environment. */ environmentId: pulumi.Input; /** * Unique identifier for the dataview. * * The following arguments are optional: */ name?: pulumi.Input; /** * Whether to make the dataview writable to perform database maintenance. You cannot create partial writable dataviews; you must provide the entire database path and cannot perform updates, so `autoUpdate` must be `false` when `readWrite` is `true`. You must also use a unique volume, and once a dataview is writable you cannot change it to read-only. */ readWrite?: pulumi.Input; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * Configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment. See `segmentConfigurations` below. */ segmentConfigurations?: pulumi.Input[] | undefined>; /** * Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; } //# sourceMappingURL=kxDataview.d.ts.map