Docs Home
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
aws.finspace.KxDataview
Explore with Pulumi AI
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:
- 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 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.
- Database
Name string - The name of the database where you want to create a dataview.
- Environment
Id string - Unique identifier for the KX environment.
- Availability
Zone stringId - 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 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:
- 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_updatemust be set asfalseifread_writeistruefor 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_writeparameter later.
- 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,
- Segment
Configurations List<KxDataview Segment Configuration> - 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.
- Dictionary<string, string>
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration 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 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.
- Database
Name string - The name of the database where you want to create a dataview.
- Environment
Id string - Unique identifier for the KX environment.
- Availability
Zone stringId - 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 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:
- 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_updatemust be set asfalseifread_writeistruefor 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_writeparameter later.
- 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,
- Segment
Configurations []KxDataview Segment Configuration Args - 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.
- map[string]string
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- auto
Update 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.
- az
Mode 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.
- database
Name String - The name of the database where you want to create a dataview.
- environment
Id String - Unique identifier for the KX environment.
- availability
Zone StringId - 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 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:
- read
Write 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_updatemust be set asfalseifread_writeistruefor 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_writeparameter later.
- 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,
- segment
Configurations List<KxDataview Segment Configuration> - 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.
- Map<String,String>
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- auto
Update 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.
- az
Mode 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.
- database
Name string - The name of the database where you want to create a dataview.
- environment
Id string - Unique identifier for the KX environment.
- availability
Zone stringId - 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 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:
- read
Write 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_updatemust be set asfalseifread_writeistruefor 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_writeparameter later.
- 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,
- segment
Configurations KxDataview Segment Configuration[] - 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.
- {[key: string]: string}
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration 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_ strid - 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_updatemust be set asfalseifread_writeistruefor 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_writeparameter later.
- 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,
- segment_
configurations Sequence[KxDataview Segment Configuration Args] - 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.
- Mapping[str, str]
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- auto
Update 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.
- az
Mode 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.
- database
Name String - The name of the database where you want to create a dataview.
- environment
Id String - Unique identifier for the KX environment.
- availability
Zone StringId - 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 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:
- read
Write 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_updatemust be set asfalseifread_writeistruefor 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_writeparameter later.
- 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,
- segment
Configurations 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.
- Map<String>
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration 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.
- Created
Timestamp 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.
- Last
Modified stringTimestamp - 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
- Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- Arn string
- Amazon Resource Name (ARN) identifier of the KX dataview.
- Created
Timestamp 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.
- Last
Modified stringTimestamp - 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
- map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn String
- Amazon Resource Name (ARN) identifier of the KX dataview.
- created
Timestamp 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.
- last
Modified StringTimestamp - 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
- Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn string
- Amazon Resource Name (ARN) identifier of the KX dataview.
- created
Timestamp 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.
- last
Modified stringTimestamp - 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
- {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- 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_ strtimestamp - 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
- Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn String
- Amazon Resource Name (ARN) identifier of the KX dataview.
- created
Timestamp 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.
- last
Modified StringTimestamp - 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
- Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
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) -> KxDataviewfunc 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)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
- 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 stringId - 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 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.
- Changeset
Id string - A unique identifier of the changeset of the database that you want to use to ingest data.
- Created
Timestamp 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.
- Database
Name string - The name of the database where you want to create a dataview.
- Description string
- A description for the dataview.
- Environment
Id string - Unique identifier for the KX environment.
- Last
Modified stringTimestamp - 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:
- 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_updatemust be set asfalseifread_writeistruefor 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_writeparameter later.
- 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,
- Segment
Configurations List<KxDataview Segment Configuration> - 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
- Dictionary<string, string>
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- Arn string
- 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 stringId - 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 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.
- Changeset
Id string - A unique identifier of the changeset of the database that you want to use to ingest data.
- Created
Timestamp 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.
- Database
Name string - The name of the database where you want to create a dataview.
- Description string
- A description for the dataview.
- Environment
Id string - Unique identifier for the KX environment.
- Last
Modified stringTimestamp - 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:
- 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_updatemust be set asfalseifread_writeistruefor 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_writeparameter later.
- 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,
- Segment
Configurations []KxDataview Segment Configuration Args - 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
- map[string]string
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn String
- Amazon Resource Name (ARN) identifier of the KX dataview.
- auto
Update 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.
- availability
Zone StringId - 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 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.
- changeset
Id String - A unique identifier of the changeset of the database that you want to use to ingest data.
- created
Timestamp 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.
- database
Name String - The name of the database where you want to create a dataview.
- description String
- A description for the dataview.
- environment
Id String - Unique identifier for the KX environment.
- last
Modified StringTimestamp - 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:
- read
Write 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_updatemust be set asfalseifread_writeistruefor 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_writeparameter later.
- 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,
- segment
Configurations List<KxDataview Segment Configuration> - 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
- Map<String,String>
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn string
- Amazon Resource Name (ARN) identifier of the KX dataview.
- auto
Update 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.
- availability
Zone stringId - 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 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.
- changeset
Id string - A unique identifier of the changeset of the database that you want to use to ingest data.
- created
Timestamp 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.
- database
Name string - The name of the database where you want to create a dataview.
- description string
- A description for the dataview.
- environment
Id string - Unique identifier for the KX environment.
- last
Modified stringTimestamp - 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:
- read
Write 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_updatemust be set asfalseifread_writeistruefor 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_writeparameter later.
- 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,
- segment
Configurations KxDataview Segment Configuration[] - 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
- {[key: string]: string}
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- 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_ strid - 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_ strtimestamp - 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_updatemust be set asfalseifread_writeistruefor 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_writeparameter later.
- 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,
- segment_
configurations Sequence[KxDataview Segment Configuration Args] - 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
- Mapping[str, str]
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn String
- Amazon Resource Name (ARN) identifier of the KX dataview.
- auto
Update 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.
- availability
Zone StringId - 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 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.
- changeset
Id String - A unique identifier of the changeset of the database that you want to use to ingest data.
- created
Timestamp 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.
- database
Name String - The name of the database where you want to create a dataview.
- description String
- A description for the dataview.
- environment
Id String - Unique identifier for the KX environment.
- last
Modified StringTimestamp - 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:
- read
Write 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_updatemust be set asfalseifread_writeistruefor 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_writeparameter later.
- 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,
- segment
Configurations 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
- Map<String>
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
Supporting Types
KxDataviewSegmentConfiguration, KxDataviewSegmentConfigurationArgs
- Db
Paths 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.
- Volume
Name 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.
- 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.
- Db
Paths []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.
- Volume
Name 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.
- 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.
- db
Paths 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.
- volume
Name 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.
- on
Demand 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 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.
- volume
Name 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.
- on
Demand 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.
- db
Paths 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.
- volume
Name 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.
- on
Demand 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
awsTerraform Provider.