Package com.pulumi.aws.finspace
Class KxDataview
- java.lang.Object
-
- com.pulumi.resources.Resource
-
- com.pulumi.resources.CustomResource
-
- com.pulumi.aws.finspace.KxDataview
-
public class KxDataview extends com.pulumi.resources.CustomResource
Resource for managing an AWS FinSpace Kx Dataview. ## Example Usage ### Basic Usage <!--Start PulumiCodeChooser -->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()); } }
-
-
Constructor Summary
Constructors Constructor Description KxDataview(java.lang.String name)
KxDataview(java.lang.String name, KxDataviewArgs args)
KxDataview(java.lang.String name, KxDataviewArgs args, com.pulumi.resources.CustomResourceOptions options)
-
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.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()
-
-
-
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:
- Amazon Resource Name (ARN) identifier of the KX dataview.
-
autoUpdate
public com.pulumi.core.Output<java.lang.Boolean> autoUpdate()
- Returns:
- 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
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> availabilityZoneId()
- Returns:
- 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
public com.pulumi.core.Output<java.lang.String> azMode()
- Returns:
- 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
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> changesetId()
- Returns:
- A 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:
- The 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:
- A 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:
- 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
public com.pulumi.core.Output<java.lang.String> name()
- Returns:
- A unique identifier for the dataview. The following arguments are optional:
-
readWrite
public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> readWrite()
- Returns:
- 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
public com.pulumi.core.Output<java.util.Optional<java.util.List<KxDataviewSegmentConfiguration>>> segmentConfigurations()
- Returns:
- 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
public com.pulumi.core.Output<java.lang.String> status()
-
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 `default_tags` 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 `default_tags` 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.
-
-