Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. finspace
  5. KxDataview
AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-aws

aws.finspace.KxDataview

Explore with Pulumi AI

aws logo
AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-aws

    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": ["/*"],
    }])

    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
	})
}

    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 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:
            - /*

    Create KxDataview Resource

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

    Constructor syntax

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

@overload
def KxDataview(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               auto_update: Optional[bool] = None,
               az_mode: Optional[str] = None,
               database_name: Optional[str] = None,
               environment_id: Optional[str] = None,
               availability_zone_id: Optional[str] = None,
               changeset_id: Optional[str] = None,
               description: Optional[str] = None,
               name: Optional[str] = None,
               read_write: Optional[bool] = None,
               segment_configurations: Optional[Sequence[KxDataviewSegmentConfigurationArgs]] = None,
               tags: Optional[Mapping[str, str]] = None)
    func NewKxDataview(ctx *Context, name string, args KxDataviewArgs, opts ...ResourceOption) (*KxDataview, error)
    public KxDataview(string name, KxDataviewArgs args, CustomResourceOptions? opts = null)
    public KxDataview(String name, KxDataviewArgs args)
public KxDataview(String name, KxDataviewArgs args, CustomResourceOptions options)

    type: aws:finspace:KxDataview
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 KxDataviewArgs
    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 KxDataviewArgs
    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 KxDataviewArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KxDataviewArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KxDataviewArgs
    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 kxDataviewResource = new Aws.FinSpace.KxDataview("kxDataviewResource", new()
{
    AutoUpdate = false,
    AzMode = "string",
    DatabaseName = "string",
    EnvironmentId = "string",
    AvailabilityZoneId = "string",
    ChangesetId = "string",
    Description = "string",
    Name = "string",
    ReadWrite = false,
    SegmentConfigurations = new[]
    {
        new Aws.FinSpace.Inputs.KxDataviewSegmentConfigurationArgs
        {
            DbPaths = new[]
            {
                "string",
            },
            VolumeName = "string",
            OnDemand = false,
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := finspace.NewKxDataview(ctx, "kxDataviewResource", &finspace.KxDataviewArgs{
	AutoUpdate:         pulumi.Bool(false),
	AzMode:             pulumi.String("string"),
	DatabaseName:       pulumi.String("string"),
	EnvironmentId:      pulumi.String("string"),
	AvailabilityZoneId: pulumi.String("string"),
	ChangesetId:        pulumi.String("string"),
	Description:        pulumi.String("string"),
	Name:               pulumi.String("string"),
	ReadWrite:          pulumi.Bool(false),
	SegmentConfigurations: finspace.KxDataviewSegmentConfigurationArray{
		&finspace.KxDataviewSegmentConfigurationArgs{
			DbPaths: pulumi.StringArray{
				pulumi.String("string"),
			},
			VolumeName: pulumi.String("string"),
			OnDemand:   pulumi.Bool(false),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var kxDataviewResource = new KxDataview("kxDataviewResource", KxDataviewArgs.builder()
    .autoUpdate(false)
    .azMode("string")
    .databaseName("string")
    .environmentId("string")
    .availabilityZoneId("string")
    .changesetId("string")
    .description("string")
    .name("string")
    .readWrite(false)
    .segmentConfigurations(KxDataviewSegmentConfigurationArgs.builder()
        .dbPaths("string")
        .volumeName("string")
        .onDemand(false)
        .build())
    .tags(Map.of("string", "string"))
    .build());

    kx_dataview_resource = aws.finspace.KxDataview("kxDataviewResource",
    auto_update=False,
    az_mode="string",
    database_name="string",
    environment_id="string",
    availability_zone_id="string",
    changeset_id="string",
    description="string",
    name="string",
    read_write=False,
    segment_configurations=[{
        "db_paths": ["string"],
        "volume_name": "string",
        "on_demand": False,
    }],
    tags={
        "string": "string",
    })

    const kxDataviewResource = new aws.finspace.KxDataview("kxDataviewResource", {
    autoUpdate: false,
    azMode: "string",
    databaseName: "string",
    environmentId: "string",
    availabilityZoneId: "string",
    changesetId: "string",
    description: "string",
    name: "string",
    readWrite: false,
    segmentConfigurations: [{
        dbPaths: ["string"],
        volumeName: "string",
        onDemand: false,
    }],
    tags: {
        string: "string",
    },
});

    type: aws:finspace:KxDataview
properties:
    autoUpdate: false
    availabilityZoneId: string
    azMode: string
    changesetId: string
    databaseName: string
    description: string
    environmentId: string
    name: string
    readWrite: false
    segmentConfigurations:
        - dbPaths:
            - string
          onDemand: false
          volumeName: string
    tags:
        string: string

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

    AutoUpdate bool
    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.
    AzMode string
    The number of availability zones you want to assign per cluster. This can be one of the following:

    • SINGLE - Assigns one availability zone per cluster.
    • MULTI - Assigns all the availability zones per cluster.
    DatabaseName string
    The name of the database where you want to create a dataview.
    EnvironmentId string
    Unique identifier for the KX environment.
    AvailabilityZoneId string
    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.
    ChangesetId string
    A unique identifier of the changeset of the database that you want to use to ingest data.
    Description string
    A description for the dataview.
    Name string

    A unique identifier for the dataview.

    The following arguments are optional:

    ReadWrite bool
    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.

    • You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path. You cannot perform updates on a writeable dataview. Hence, auto_update must be set as false if read_write is true for a dataview.
    • You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.
    • Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the read_write parameter later.
    SegmentConfigurations List<KxDataviewSegmentConfiguration>
    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.
    Tags Dictionary<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.
    AutoUpdate bool
    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.
    AzMode string
    The number of availability zones you want to assign per cluster. This can be one of the following:

    • SINGLE - Assigns one availability zone per cluster.
    • MULTI - Assigns all the availability zones per cluster.
    DatabaseName string
    The name of the database where you want to create a dataview.
    EnvironmentId string
    Unique identifier for the KX environment.
    AvailabilityZoneId string
    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.
    ChangesetId string
    A unique identifier of the changeset of the database that you want to use to ingest data.
    Description string
    A description for the dataview.
    Name string

    A unique identifier for the dataview.

    The following arguments are optional:

    ReadWrite bool
    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.

    • You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path. You cannot perform updates on a writeable dataview. Hence, auto_update must be set as false if read_write is true for a dataview.
    • You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.
    • Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the read_write parameter later.
    SegmentConfigurations []KxDataviewSegmentConfigurationArgs
    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.
    Tags 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.
    autoUpdate 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.
    azMode String
    The number of availability zones you want to assign per cluster. This can be one of the following:

    • SINGLE - Assigns one availability zone per cluster.
    • MULTI - Assigns all the availability zones per cluster.
    databaseName String
    The name of the database where you want to create a dataview.
    environmentId String
    Unique identifier for the KX environment.
    availabilityZoneId String
    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.
    changesetId String
    A unique identifier of the changeset of the database that you want to use to ingest data.
    description String
    A description for the dataview.
    name String

    A unique identifier for the dataview.

    The following arguments are optional:

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

    • You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path. You cannot perform updates on a writeable dataview. Hence, auto_update must be set as false if read_write is true for a dataview.
    • You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.
    • Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the read_write parameter later.
    segmentConfigurations List<KxDataviewSegmentConfiguration>
    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.
    tags 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.
    autoUpdate 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.
    azMode string
    The number of availability zones you want to assign per cluster. This can be one of the following:

    • SINGLE - Assigns one availability zone per cluster.
    • MULTI - Assigns all the availability zones per cluster.
    databaseName string
    The name of the database where you want to create a dataview.
    environmentId string
    Unique identifier for the KX environment.
    availabilityZoneId string
    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.
    changesetId string
    A unique identifier of the changeset of the database that you want to use to ingest data.
    description string
    A description for the dataview.
    name string

    A unique identifier for the dataview.

    The following arguments are optional:

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

    • You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path. You cannot perform updates on a writeable dataview. Hence, auto_update must be set as false if read_write is true for a dataview.
    • You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.
    • Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the read_write parameter later.
    segmentConfigurations KxDataviewSegmentConfiguration[]
    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.
    tags {[key: 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.
    auto_update bool
    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.
    az_mode str
    The number of availability zones you want to assign per cluster. This can be one of the following:

    • SINGLE - Assigns one availability zone per cluster.
    • MULTI - Assigns all the availability zones per cluster.
    database_name str
    The name of the database where you want to create a dataview.
    environment_id str
    Unique identifier for the KX environment.
    availability_zone_id str
    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.
    changeset_id str
    A unique identifier of the changeset of the database that you want to use to ingest data.
    description str
    A description for the dataview.
    name str

    A unique identifier for the dataview.

    The following arguments are optional:

    read_write bool
    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.

    • You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path. You cannot perform updates on a writeable dataview. Hence, auto_update must be set as false if read_write is true for a dataview.
    • You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.
    • Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the read_write parameter later.
    segment_configurations Sequence[KxDataviewSegmentConfigurationArgs]
    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.
    tags Mapping[str, str]
    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.
    autoUpdate 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.
    azMode String
    The number of availability zones you want to assign per cluster. This can be one of the following:

    • SINGLE - Assigns one availability zone per cluster.
    • MULTI - Assigns all the availability zones per cluster.
    databaseName String
    The name of the database where you want to create a dataview.
    environmentId String
    Unique identifier for the KX environment.
    availabilityZoneId String
    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.
    changesetId String
    A unique identifier of the changeset of the database that you want to use to ingest data.
    description String
    A description for the dataview.
    name String

    A unique identifier for the dataview.

    The following arguments are optional:

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

    • You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path. You cannot perform updates on a writeable dataview. Hence, auto_update must be set as false if read_write is true for a dataview.
    • You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.
    • Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the read_write parameter later.
    segmentConfigurations List<Property Map>
    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.
    tags Map<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.

    Outputs

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

    Arn string
    Amazon Resource Name (ARN) identifier of the KX dataview.
    CreatedTimestamp 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTimestamp string
    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.
    Status string
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    Amazon Resource Name (ARN) identifier of the KX dataview.
    CreatedTimestamp 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTimestamp string
    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.
    Status string
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) identifier of the KX dataview.
    createdTimestamp 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.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTimestamp String
    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.
    status String
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    Amazon Resource Name (ARN) identifier of the KX dataview.
    createdTimestamp 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.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedTimestamp string
    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.
    status string
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    Amazon Resource Name (ARN) identifier of the KX dataview.
    created_timestamp str
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified_timestamp str
    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.
    status str
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) identifier of the KX dataview.
    createdTimestamp 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.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTimestamp String
    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.
    status String
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing KxDataview Resource

    Get an existing KxDataview 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?: KxDataviewState, opts?: CustomResourceOptions): KxDataview
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        auto_update: Optional[bool] = None,
        availability_zone_id: Optional[str] = None,
        az_mode: Optional[str] = None,
        changeset_id: Optional[str] = None,
        created_timestamp: Optional[str] = None,
        database_name: Optional[str] = None,
        description: Optional[str] = None,
        environment_id: Optional[str] = None,
        last_modified_timestamp: Optional[str] = None,
        name: Optional[str] = None,
        read_write: Optional[bool] = None,
        segment_configurations: Optional[Sequence[KxDataviewSegmentConfigurationArgs]] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> KxDataview
    func GetKxDataview(ctx *Context, name string, id IDInput, state *KxDataviewState, opts ...ResourceOption) (*KxDataview, error)
    public static KxDataview Get(string name, Input<string> id, KxDataviewState? state, CustomResourceOptions? opts = null)
    public static KxDataview get(String name, Output<String> id, KxDataviewState state, CustomResourceOptions options)
    resources:  _:    type: aws:finspace:KxDataview    get:      id: ${id}
    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.
    The following state arguments are supported:
    Arn string
    Amazon Resource Name (ARN) identifier of the KX dataview.
    AutoUpdate bool
    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.
    AvailabilityZoneId string
    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.
    AzMode string
    The number of availability zones you want to assign per cluster. This can be one of the following:

    • SINGLE - Assigns one availability zone per cluster.
    • MULTI - Assigns all the availability zones per cluster.
    ChangesetId string
    A unique identifier of the changeset of the database that you want to use to ingest data.
    CreatedTimestamp 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.
    DatabaseName string
    The name of the database where you want to create a dataview.
    Description string
    A description for the dataview.
    EnvironmentId string
    Unique identifier for the KX environment.
    LastModifiedTimestamp string
    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.
    Name string

    A unique identifier for the dataview.

    The following arguments are optional:

    ReadWrite bool
    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.

    • You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path. You cannot perform updates on a writeable dataview. Hence, auto_update must be set as false if read_write is true for a dataview.
    • You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.
    • Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the read_write parameter later.
    SegmentConfigurations List<KxDataviewSegmentConfiguration>
    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.
    Status string
    Tags Dictionary<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.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    Amazon Resource Name (ARN) identifier of the KX dataview.
    AutoUpdate bool
    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.
    AvailabilityZoneId string
    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.
    AzMode string
    The number of availability zones you want to assign per cluster. This can be one of the following:

    • SINGLE - Assigns one availability zone per cluster.
    • MULTI - Assigns all the availability zones per cluster.
    ChangesetId string
    A unique identifier of the changeset of the database that you want to use to ingest data.
    CreatedTimestamp 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.
    DatabaseName string
    The name of the database where you want to create a dataview.
    Description string
    A description for the dataview.
    EnvironmentId string
    Unique identifier for the KX environment.
    LastModifiedTimestamp string
    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.
    Name string

    A unique identifier for the dataview.

    The following arguments are optional:

    ReadWrite bool
    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.

    • You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path. You cannot perform updates on a writeable dataview. Hence, auto_update must be set as false if read_write is true for a dataview.
    • You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.
    • Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the read_write parameter later.
    SegmentConfigurations []KxDataviewSegmentConfigurationArgs
    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.
    Status string
    Tags 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.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) identifier of the KX dataview.
    autoUpdate 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.
    availabilityZoneId String
    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.
    azMode String
    The number of availability zones you want to assign per cluster. This can be one of the following:

    • SINGLE - Assigns one availability zone per cluster.
    • MULTI - Assigns all the availability zones per cluster.
    changesetId String
    A unique identifier of the changeset of the database that you want to use to ingest data.
    createdTimestamp 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.
    databaseName String
    The name of the database where you want to create a dataview.
    description String
    A description for the dataview.
    environmentId String
    Unique identifier for the KX environment.
    lastModifiedTimestamp String
    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.
    name String

    A unique identifier for the dataview.

    The following arguments are optional:

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

    • You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path. You cannot perform updates on a writeable dataview. Hence, auto_update must be set as false if read_write is true for a dataview.
    • You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.
    • Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the read_write parameter later.
    segmentConfigurations List<KxDataviewSegmentConfiguration>
    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.
    status String
    tags 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.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    Amazon Resource Name (ARN) identifier of the KX dataview.
    autoUpdate 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.
    availabilityZoneId string
    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.
    azMode string
    The number of availability zones you want to assign per cluster. This can be one of the following:

    • SINGLE - Assigns one availability zone per cluster.
    • MULTI - Assigns all the availability zones per cluster.
    changesetId string
    A unique identifier of the changeset of the database that you want to use to ingest data.
    createdTimestamp 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.
    databaseName string
    The name of the database where you want to create a dataview.
    description string
    A description for the dataview.
    environmentId string
    Unique identifier for the KX environment.
    lastModifiedTimestamp string
    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.
    name string

    A unique identifier for the dataview.

    The following arguments are optional:

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

    • You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path. You cannot perform updates on a writeable dataview. Hence, auto_update must be set as false if read_write is true for a dataview.
    • You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.
    • Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the read_write parameter later.
    segmentConfigurations KxDataviewSegmentConfiguration[]
    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.
    status string
    tags {[key: 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.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    Amazon Resource Name (ARN) identifier of the KX dataview.
    auto_update bool
    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.
    availability_zone_id str
    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.
    az_mode str
    The number of availability zones you want to assign per cluster. This can be one of the following:

    • SINGLE - Assigns one availability zone per cluster.
    • MULTI - Assigns all the availability zones per cluster.
    changeset_id str
    A unique identifier of the changeset of the database that you want to use to ingest data.
    created_timestamp str
    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.
    database_name str
    The name of the database where you want to create a dataview.
    description str
    A description for the dataview.
    environment_id str
    Unique identifier for the KX environment.
    last_modified_timestamp str
    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.
    name str

    A unique identifier for the dataview.

    The following arguments are optional:

    read_write bool
    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.

    • You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path. You cannot perform updates on a writeable dataview. Hence, auto_update must be set as false if read_write is true for a dataview.
    • You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.
    • Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the read_write parameter later.
    segment_configurations Sequence[KxDataviewSegmentConfigurationArgs]
    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.
    status str
    tags Mapping[str, str]
    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.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) identifier of the KX dataview.
    autoUpdate 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.
    availabilityZoneId String
    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.
    azMode String
    The number of availability zones you want to assign per cluster. This can be one of the following:

    • SINGLE - Assigns one availability zone per cluster.
    • MULTI - Assigns all the availability zones per cluster.
    changesetId String
    A unique identifier of the changeset of the database that you want to use to ingest data.
    createdTimestamp 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.
    databaseName String
    The name of the database where you want to create a dataview.
    description String
    A description for the dataview.
    environmentId String
    Unique identifier for the KX environment.
    lastModifiedTimestamp String
    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.
    name String

    A unique identifier for the dataview.

    The following arguments are optional:

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

    • You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path. You cannot perform updates on a writeable dataview. Hence, auto_update must be set as false if read_write is true for a dataview.
    • You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.
    • Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the read_write parameter later.
    segmentConfigurations List<Property Map>
    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.
    status String
    tags Map<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.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    KxDataviewSegmentConfiguration, KxDataviewSegmentConfigurationArgs

    DbPaths List<string>
    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.
    VolumeName string
    The name of the volume that you want to attach to a dataview. This volume must be in the same availability zone as the dataview that you are attaching to.
    OnDemand bool
    Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.
    DbPaths []string
    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.
    VolumeName string
    The name of the volume that you want to attach to a dataview. This volume must be in the same availability zone as the dataview that you are attaching to.
    OnDemand bool
    Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.
    dbPaths List<String>
    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.
    volumeName String
    The name of the volume that you want to attach to a dataview. This volume must be in the same availability zone as the dataview that you are attaching to.
    onDemand Boolean
    Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.
    dbPaths string[]
    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.
    volumeName string
    The name of the volume that you want to attach to a dataview. This volume must be in the same availability zone as the dataview that you are attaching to.
    onDemand boolean
    Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.
    db_paths Sequence[str]
    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.
    volume_name str
    The name of the volume that you want to attach to a dataview. This volume must be in the same availability zone as the dataview that you are attaching to.
    on_demand bool
    Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.
    dbPaths List<String>
    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.
    volumeName String
    The name of the volume that you want to attach to a dataview. This volume must be in the same availability zone as the dataview that you are attaching to.
    onDemand Boolean
    Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.

    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

    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 logo
    AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-aws