Package com.pulumi.aws.finspace

Class KxDataview

  • public class KxDataview
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS FinSpace Kx Dataview. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.finspace.KxDataview;
 import com.pulumi.aws.finspace.KxDataviewArgs;
 import com.pulumi.aws.finspace.inputs.KxDataviewSegmentConfigurationArgs;
 import com.pulumi.resources.CustomResourceOptions;
 import com.pulumi.resources.CustomTimeouts;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new KxDataview("example", KxDataviewArgs.builder()
             .segmentConfigurations(KxDataviewSegmentConfigurationArgs.builder()
                 .volumeName(exampleAwsFinspaceKxVolume.name())
                 .dbPaths("/*")
                 .build())
             .name("my-tf-kx-dataview")
             .environmentId(exampleAwsFinspaceKxEnvironment.id())
             .databaseName(exampleAwsFinspaceKxDatabase.name())
             .availabilityZoneId("use1-az2")
             .description("Terraform managed Kx Dataview")
             .azMode("SINGLE")
             .autoUpdate(true)
             .build(), CustomResourceOptions.builder()
                 .customTimeouts(CustomTimeouts.builder()
                     .create(CustomTimeouts.parseTimeoutString("24h"))
                     .update(CustomTimeouts.parseTimeoutString("24h"))
                     .delete(CustomTimeouts.parseTimeoutString("12h"))
                 .build())
                 .build());
 
     }
 }
    ## Import Using `pulumi import`, import an AWS FinSpace Kx Cluster using the `id` (environment ID and cluster name, comma-delimited). For example: ```sh $ pulumi import aws:finspace/kxDataview:KxDataview example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-database,my-tf-kx-dataview ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.Boolean> autoUpdate()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> availabilityZoneId()  
      com.pulumi.core.Output<java.lang.String> azMode()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> changesetId()  
      com.pulumi.core.Output<java.lang.String> createdTimestamp()  
      com.pulumi.core.Output<java.lang.String> databaseName()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.lang.String> environmentId()  
      static KxDataview get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, KxDataviewState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> lastModifiedTimestamp()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> readWrite()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<KxDataviewSegmentConfiguration>>> segmentConfigurations()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • KxDataview

        public KxDataview​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • KxDataview

        public KxDataview​(java.lang.String name,
                  KxDataviewArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • KxDataview

        public KxDataview​(java.lang.String name,
                  KxDataviewArgs args,
                  @Nullable
                  com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN identifier of the KX dataview.

      • autoUpdate

        public com.pulumi.core.Output<java.lang.Boolean> autoUpdate()
        Returns:
        Whether to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. Defaults to `false`.

      • availabilityZoneId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> availabilityZoneId()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> azMode()
        Returns:
        Number of availability zones you want to assign per cluster. Valid values are `SINGLE` (assigns one availability zone per cluster) and `MULTI` (assigns all the availability zones per cluster).

      • changesetId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> changesetId()
        Returns:
        Unique identifier of the changeset of the database that you want to use to ingest data.

      • createdTimestamp

        public com.pulumi.core.Output<java.lang.String> createdTimestamp()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> databaseName()
        Returns:
        Name of the database where you want to create a dataview.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description for the dataview.

      • environmentId

        public com.pulumi.core.Output<java.lang.String> environmentId()
        Returns:
        Unique identifier for the KX environment.

      • lastModifiedTimestamp

        public com.pulumi.core.Output<java.lang.String> lastModifiedTimestamp()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Unique identifier for the dataview. The following arguments are optional:

      • readWrite

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> readWrite()
        Returns:
        Whether to make the dataview writable to perform database maintenance. You cannot create partial writable dataviews; you must provide the entire database path and cannot perform updates, so `autoUpdate` must be `false` when `readWrite` is `true`. You must also use a unique volume, and once a dataview is writable you cannot change it to read-only.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • segmentConfigurations

        public com.pulumi.core.Output<java.util.Optional<java.util.List<KxDataviewSegmentConfiguration>>> segmentConfigurations()
        Returns:
        Configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment. See `segmentConfigurations` below.

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Status of the dataview.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static KxDataview get​(java.lang.String name,
                             com.pulumi.core.Output<java.lang.String> id,
                             @Nullable
                             KxDataviewState state,
                             @Nullable
                             com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.