KxDataview

class KxDataview : KotlinCustomResource

Resource for managing an AWS FinSpace Kx Dataview.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.finspace.KxDataview("example", {
name: "my-tf-kx-dataview",
environmentId: exampleAwsFinspaceKxEnvironment.id,
databaseName: exampleAwsFinspaceKxDatabase.name,
availabilityZoneId: "use1-az2",
description: "Terraform managed Kx Dataview",
azMode: "SINGLE",
autoUpdate: true,
segmentConfigurations: [{
volumeName: exampleAwsFinspaceKxVolume.name,
dbPaths: ["/*"],
}],
});
import pulumi
import pulumi_aws as aws
example = aws.finspace.KxDataview("example",
name="my-tf-kx-dataview",
environment_id=example_aws_finspace_kx_environment["id"],
database_name=example_aws_finspace_kx_database["name"],
availability_zone_id="use1-az2",
description="Terraform managed Kx Dataview",
az_mode="SINGLE",
auto_update=True,
segment_configurations=[{
"volume_name": example_aws_finspace_kx_volume["name"],
"db_paths": ["/*"],
}])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.FinSpace.KxDataview("example", new()
{
Name = "my-tf-kx-dataview",
EnvironmentId = exampleAwsFinspaceKxEnvironment.Id,
DatabaseName = exampleAwsFinspaceKxDatabase.Name,
AvailabilityZoneId = "use1-az2",
Description = "Terraform managed Kx Dataview",
AzMode = "SINGLE",
AutoUpdate = true,
SegmentConfigurations = new[]
{
new Aws.FinSpace.Inputs.KxDataviewSegmentConfigurationArgs
{
VolumeName = exampleAwsFinspaceKxVolume.Name,
DbPaths = new[]
{
"/*",
},
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/finspace"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := finspace.NewKxDataview(ctx, "example", &finspace.KxDataviewArgs{
Name: pulumi.String("my-tf-kx-dataview"),
EnvironmentId: pulumi.Any(exampleAwsFinspaceKxEnvironment.Id),
DatabaseName: pulumi.Any(exampleAwsFinspaceKxDatabase.Name),
AvailabilityZoneId: pulumi.String("use1-az2"),
Description: pulumi.String("Terraform managed Kx Dataview"),
AzMode: pulumi.String("SINGLE"),
AutoUpdate: pulumi.Bool(true),
SegmentConfigurations: finspace.KxDataviewSegmentConfigurationArray{
&finspace.KxDataviewSegmentConfigurationArgs{
VolumeName: pulumi.Any(exampleAwsFinspaceKxVolume.Name),
DbPaths: pulumi.StringArray{
pulumi.String("/*"),
},
},
},
})
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.finspace.KxDataview;
import com.pulumi.aws.finspace.KxDataviewArgs;
import com.pulumi.aws.finspace.inputs.KxDataviewSegmentConfigurationArgs;
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 KxDataview("example", KxDataviewArgs.builder()
.name("my-tf-kx-dataview")
.environmentId(exampleAwsFinspaceKxEnvironment.id())
.databaseName(exampleAwsFinspaceKxDatabase.name())
.availabilityZoneId("use1-az2")
.description("Terraform managed Kx Dataview")
.azMode("SINGLE")
.autoUpdate(true)
.segmentConfigurations(KxDataviewSegmentConfigurationArgs.builder()
.volumeName(exampleAwsFinspaceKxVolume.name())
.dbPaths("/*")
.build())
.build());
}
}
resources:
example:
type: aws:finspace:KxDataview
properties:
name: my-tf-kx-dataview
environmentId: ${exampleAwsFinspaceKxEnvironment.id}
databaseName: ${exampleAwsFinspaceKxDatabase.name}
availabilityZoneId: use1-az2
description: Terraform managed Kx Dataview
azMode: SINGLE
autoUpdate: true
segmentConfigurations:
- volumeName: ${exampleAwsFinspaceKxVolume.name}
dbPaths:
- /*

Import

Using pulumi import, import an AWS FinSpace Kx Cluster using the id (environment ID and cluster name, comma-delimited). For example:

$ pulumi import aws:finspace/kxDataview:KxDataview example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-database,my-tf-kx-dataview

//////

Properties

Link copied to clipboard
val arn: Output<String>

Amazon Resource Name (ARN) identifier of the KX dataview.

Link copied to clipboard
val autoUpdate: Output<Boolean>

The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets. The default value is false.

Link copied to clipboard

The 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.

Link copied to clipboard
val azMode: Output<String>

The number of availability zones you want to assign per cluster. This can be one of the following:

Link copied to clipboard
val changesetId: Output<String>?

A unique identifier of the changeset of the database that you want to use to ingest data.

Link copied to clipboard

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.

Link copied to clipboard
val databaseName: Output<String>

The name of the database where you want to create a dataview.

Link copied to clipboard
val description: Output<String>?

A description for the dataview.

Link copied to clipboard
val environmentId: Output<String>

Unique identifier for the KX environment.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

The 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.

Link copied to clipboard
val name: Output<String>

A unique identifier for the dataview. The following arguments are optional:

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val readWrite: Output<Boolean>?

The option to specify whether you want to make the dataview writable to perform database maintenance. The following are some considerations related to writable dataviews.

Link copied to clipboard

The 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 segment_configurations below.

Link copied to clipboard
val status: Output<String>
Link copied to clipboard
val tags: Output<Map<String, String>>?

Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val tagsAll: Output<Map<String, String>>

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

Link copied to clipboard
val urn: Output<String>