KxDataview class

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", {
    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 pulumi
import pulumi_aws as aws

example = aws.finspace.KxDataview("example",
    segment_configurations=[{
        "volume_name": example_aws_finspace_kx_volume["name"],
        "db_paths": ["/*"],
    }],
    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,
    opts = pulumi.ResourceOptions(custom_timeouts=pulumi.CustomTimeouts(create="24h", update="24h", delete="12h")))
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()
    {
        SegmentConfigurations = new[]
        {
            new Aws.FinSpace.Inputs.KxDataviewSegmentConfigurationArgs
            {
                VolumeName = exampleAwsFinspaceKxVolume.Name,
                DbPaths = new[]
                {
                    "/*",
                },
            },
        },
        Name = "my-tf-kx-dataview",
        EnvironmentId = exampleAwsFinspaceKxEnvironment.Id,
        DatabaseName = exampleAwsFinspaceKxDatabase.Name,
        AvailabilityZoneId = "use1-az2",
        Description = "Terraform managed Kx Dataview",
        AzMode = "SINGLE",
        AutoUpdate = true,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			SegmentConfigurations: finspace.KxDataviewSegmentConfigurationArray{
				&finspace.KxDataviewSegmentConfigurationArgs{
					VolumeName: pulumi.Any(exampleAwsFinspaceKxVolume.Name),
					DbPaths: pulumi.StringArray{
						pulumi.String("/*"),
					},
				},
			},
			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),
		}, pulumi.Timeouts(&pulumi.CustomTimeouts{Create: "24h", Update: "24h", Delete: "12h"}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_finspace_kxdataview" "example" {
  timeouts {
    create = "24h"
    update = "24h"
    delete = "12h"
  }
  segment_configurations {
    volume_name = exampleAwsFinspaceKxVolume.name
    db_paths    = ["/*"]
  }
  name                 = "my-tf-kx-dataview"
  environment_id       = exampleAwsFinspaceKxEnvironment.id
  database_name        = exampleAwsFinspaceKxDatabase.name
  availability_zone_id = "use1-az2"
  description          = "Terraform managed Kx Dataview"
  az_mode              = "SINGLE"
  auto_update          = true
}
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 com.pulumi.resources.CustomResourceOptions;
import com.pulumi.resources.CustomTimeouts;
import java.util.ArrayList;
import java.util.Arrays;
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()
            .segmentConfigurations(KxDataviewSegmentConfigurationArgs.builder()
                .volumeName(exampleAwsFinspaceKxVolume.name())
                .dbPaths("/*")
                .build())
            .name("my-tf-kx-dataview")
            .environmentId(exampleAwsFinspaceKxEnvironment.id())
            .databaseName(exampleAwsFinspaceKxDatabase.name())
            .availabilityZoneId("use1-az2")
            .description("Terraform managed Kx Dataview")
            .azMode("SINGLE")
            .autoUpdate(true)
            .build(), CustomResourceOptions.builder()
                .customTimeouts(CustomTimeouts.builder()
                    .create(CustomTimeouts.parseTimeoutString("24h"))
                    .update(CustomTimeouts.parseTimeoutString("24h"))
                    .delete(CustomTimeouts.parseTimeoutString("12h"))
                .build())
                .build());

    }
}
resources:
  example:
    type: aws:finspace:KxDataview
    properties:
      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
    options:
      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:

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

Constructors

KxDataview(String name, {KxDataviewArgs? args, CustomResourceOptions? options})
Creates a new KxDataview. name The Pulumi resource name. args Arguments used to configure this KxDataview. The set of arguments for KxDataview. options Resource options controlling this resource's behavior.
KxDataview.reference(String urn)
Creates a typed reference to an existing KxDataview resource.

Properties

arn ↔ Output<String>
ARN identifier of the KX dataview.
latefinal
autoUpdate ↔ Output<bool>
Whether to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. Defaults to false.
latefinal
availabilityZoneId ↔ Output<String?>
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.
latefinal
azMode ↔ Output<String>
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).
latefinal
changesetId ↔ Output<String?>
Unique identifier of the changeset of the database that you want to use to ingest data.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
createdTimestamp ↔ Output<String>
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.
latefinal
databaseName ↔ Output<String>
Name of the database where you want to create a dataview.
latefinal
description ↔ Output<String?>
Description for the dataview.
latefinal
environmentId ↔ Output<String>
Unique identifier for the KX environment.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
lastModifiedTimestamp ↔ Output<String>
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.
latefinal
name ↔ Output<String>
Unique identifier for the dataview.
latefinal
readWrite ↔ Output<bool?>
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.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
segmentConfigurations ↔ Output<List<KxDataviewSegmentConfiguration>?>
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.
latefinal
status ↔ Output<String>
Status of the dataview.
latefinal
tags ↔ Output<Map<String, String>?>
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.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {KxDataviewState? state, CustomResourceOptions? options}) → KxDataview
Gets an existing KxDataview resource's state with the given name and id.