Try AWS Native preview for resources not in the classic version.
aws.finspace.KxDatabase
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Resource for managing an AWS FinSpace Kx Database.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.kms.Key("example", {
description: "Example KMS Key",
deletionWindowInDays: 7,
});
const exampleKxEnvironment = new aws.finspace.KxEnvironment("example", {
name: "my-tf-kx-environment",
kmsKeyId: example.arn,
});
const exampleKxDatabase = new aws.finspace.KxDatabase("example", {
environmentId: exampleKxEnvironment.id,
name: "my-tf-kx-database",
description: "Example database description",
});
import pulumi
import pulumi_aws as aws
example = aws.kms.Key("example",
description="Example KMS Key",
deletion_window_in_days=7)
example_kx_environment = aws.finspace.KxEnvironment("example",
name="my-tf-kx-environment",
kms_key_id=example.arn)
example_kx_database = aws.finspace.KxDatabase("example",
environment_id=example_kx_environment.id,
name="my-tf-kx-database",
description="Example database description")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/finspace"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kms"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := kms.NewKey(ctx, "example", &kms.KeyArgs{
Description: pulumi.String("Example KMS Key"),
DeletionWindowInDays: pulumi.Int(7),
})
if err != nil {
return err
}
exampleKxEnvironment, err := finspace.NewKxEnvironment(ctx, "example", &finspace.KxEnvironmentArgs{
Name: pulumi.String("my-tf-kx-environment"),
KmsKeyId: example.Arn,
})
if err != nil {
return err
}
_, err = finspace.NewKxDatabase(ctx, "example", &finspace.KxDatabaseArgs{
EnvironmentId: exampleKxEnvironment.ID(),
Name: pulumi.String("my-tf-kx-database"),
Description: pulumi.String("Example database description"),
})
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.Kms.Key("example", new()
{
Description = "Example KMS Key",
DeletionWindowInDays = 7,
});
var exampleKxEnvironment = new Aws.FinSpace.KxEnvironment("example", new()
{
Name = "my-tf-kx-environment",
KmsKeyId = example.Arn,
});
var exampleKxDatabase = new Aws.FinSpace.KxDatabase("example", new()
{
EnvironmentId = exampleKxEnvironment.Id,
Name = "my-tf-kx-database",
Description = "Example database description",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kms.Key;
import com.pulumi.aws.kms.KeyArgs;
import com.pulumi.aws.finspace.KxEnvironment;
import com.pulumi.aws.finspace.KxEnvironmentArgs;
import com.pulumi.aws.finspace.KxDatabase;
import com.pulumi.aws.finspace.KxDatabaseArgs;
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 Key("example", KeyArgs.builder()
.description("Example KMS Key")
.deletionWindowInDays(7)
.build());
var exampleKxEnvironment = new KxEnvironment("exampleKxEnvironment", KxEnvironmentArgs.builder()
.name("my-tf-kx-environment")
.kmsKeyId(example.arn())
.build());
var exampleKxDatabase = new KxDatabase("exampleKxDatabase", KxDatabaseArgs.builder()
.environmentId(exampleKxEnvironment.id())
.name("my-tf-kx-database")
.description("Example database description")
.build());
}
}
resources:
example:
type: aws:kms:Key
properties:
description: Example KMS Key
deletionWindowInDays: 7
exampleKxEnvironment:
type: aws:finspace:KxEnvironment
name: example
properties:
name: my-tf-kx-environment
kmsKeyId: ${example.arn}
exampleKxDatabase:
type: aws:finspace:KxDatabase
name: example
properties:
environmentId: ${exampleKxEnvironment.id}
name: my-tf-kx-database
description: Example database description
Create KxDatabase Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new KxDatabase(name: string, args: KxDatabaseArgs, opts?: CustomResourceOptions);
@overload
def KxDatabase(resource_name: str,
args: KxDatabaseArgs,
opts: Optional[ResourceOptions] = None)
@overload
def KxDatabase(resource_name: str,
opts: Optional[ResourceOptions] = None,
environment_id: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewKxDatabase(ctx *Context, name string, args KxDatabaseArgs, opts ...ResourceOption) (*KxDatabase, error)
public KxDatabase(string name, KxDatabaseArgs args, CustomResourceOptions? opts = null)
public KxDatabase(String name, KxDatabaseArgs args)
public KxDatabase(String name, KxDatabaseArgs args, CustomResourceOptions options)
type: aws:finspace:KxDatabase
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 KxDatabaseArgs
- 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 KxDatabaseArgs
- 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 KxDatabaseArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KxDatabaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args KxDatabaseArgs
- 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 kxDatabaseResource = new Aws.FinSpace.KxDatabase("kxDatabaseResource", new()
{
EnvironmentId = "string",
Description = "string",
Name = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := finspace.NewKxDatabase(ctx, "kxDatabaseResource", &finspace.KxDatabaseArgs{
EnvironmentId: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var kxDatabaseResource = new KxDatabase("kxDatabaseResource", KxDatabaseArgs.builder()
.environmentId("string")
.description("string")
.name("string")
.tags(Map.of("string", "string"))
.build());
kx_database_resource = aws.finspace.KxDatabase("kxDatabaseResource",
environment_id="string",
description="string",
name="string",
tags={
"string": "string",
})
const kxDatabaseResource = new aws.finspace.KxDatabase("kxDatabaseResource", {
environmentId: "string",
description: "string",
name: "string",
tags: {
string: "string",
},
});
type: aws:finspace:KxDatabase
properties:
description: string
environmentId: string
name: string
tags:
string: string
KxDatabase Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The KxDatabase resource accepts the following input properties:
- Environment
Id string - Unique identifier for the KX environment.
- Description string
- Description of the KX database.
- Name string
Name of the KX database.
The following arguments are optional:
- 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.
- Environment
Id string - Unique identifier for the KX environment.
- Description string
- Description of the KX database.
- Name string
Name of the KX database.
The following arguments are optional:
- 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.
- environment
Id String - Unique identifier for the KX environment.
- description String
- Description of the KX database.
- name String
Name of the KX database.
The following arguments are optional:
- 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.
- environment
Id string - Unique identifier for the KX environment.
- description string
- Description of the KX database.
- name string
Name of the KX database.
The following arguments are optional:
- {[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.
- environment_
id str - Unique identifier for the KX environment.
- description str
- Description of the KX database.
- name str
Name of the KX database.
The following arguments are optional:
- 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.
- environment
Id String - Unique identifier for the KX environment.
- description String
- Description of the KX database.
- name String
Name of the KX database.
The following arguments are optional:
- 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 KxDatabase resource produces the following output properties:
- Arn string
- Amazon Resource Name (ARN) identifier of the KX database.
- Created
Timestamp string - Timestamp at which the databse is created in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringTimestamp - Last timestamp at which the database was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
- Amazon Resource Name (ARN) identifier of the KX database.
- Created
Timestamp string - Timestamp at which the databse is created in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringTimestamp - Last timestamp at which the database was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- Amazon Resource Name (ARN) identifier of the KX database.
- created
Timestamp String - Timestamp at which the databse is created in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringTimestamp - Last timestamp at which the database was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
- Amazon Resource Name (ARN) identifier of the KX database.
- created
Timestamp string - Timestamp at which the databse is created in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Modified stringTimestamp - Last timestamp at which the database was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn str
- Amazon Resource Name (ARN) identifier of the KX database.
- created_
timestamp str - Timestamp at which the databse is created in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
modified_ strtimestamp - Last timestamp at which the database was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- Amazon Resource Name (ARN) identifier of the KX database.
- created
Timestamp String - Timestamp at which the databse is created in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringTimestamp - Last timestamp at which the database was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Look up Existing KxDatabase Resource
Get an existing KxDatabase 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?: KxDatabaseState, opts?: CustomResourceOptions): KxDatabase
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
created_timestamp: Optional[str] = None,
description: Optional[str] = None,
environment_id: Optional[str] = None,
last_modified_timestamp: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None) -> KxDatabase
func GetKxDatabase(ctx *Context, name string, id IDInput, state *KxDatabaseState, opts ...ResourceOption) (*KxDatabase, error)
public static KxDatabase Get(string name, Input<string> id, KxDatabaseState? state, CustomResourceOptions? opts = null)
public static KxDatabase get(String name, Output<String> id, KxDatabaseState 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 database.
- Created
Timestamp string - Timestamp at which the databse is created in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- Description string
- Description of the KX database.
- Environment
Id string - Unique identifier for the KX environment.
- Last
Modified stringTimestamp - Last timestamp at which the database was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- Name string
Name of the KX database.
The following arguments are optional:
- 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. - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
- Amazon Resource Name (ARN) identifier of the KX database.
- Created
Timestamp string - Timestamp at which the databse is created in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- Description string
- Description of the KX database.
- Environment
Id string - Unique identifier for the KX environment.
- Last
Modified stringTimestamp - Last timestamp at which the database was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- Name string
Name of the KX database.
The following arguments are optional:
- 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. - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- Amazon Resource Name (ARN) identifier of the KX database.
- created
Timestamp String - Timestamp at which the databse is created in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- description String
- Description of the KX database.
- environment
Id String - Unique identifier for the KX environment.
- last
Modified StringTimestamp - Last timestamp at which the database was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- name String
Name of the KX database.
The following arguments are optional:
- 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. - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
- Amazon Resource Name (ARN) identifier of the KX database.
- created
Timestamp string - Timestamp at which the databse is created in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- description string
- Description of the KX database.
- environment
Id string - Unique identifier for the KX environment.
- last
Modified stringTimestamp - Last timestamp at which the database was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- name string
Name of the KX database.
The following arguments are optional:
- {[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. - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn str
- Amazon Resource Name (ARN) identifier of the KX database.
- created_
timestamp str - Timestamp at which the databse is created in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- description str
- Description of the KX database.
- environment_
id str - Unique identifier for the KX environment.
- last_
modified_ strtimestamp - Last timestamp at which the database was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- name str
Name of the KX database.
The following arguments are optional:
- 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. - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- Amazon Resource Name (ARN) identifier of the KX database.
- created
Timestamp String - Timestamp at which the databse is created in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- description String
- Description of the KX database.
- environment
Id String - Unique identifier for the KX environment.
- last
Modified StringTimestamp - Last timestamp at which the database was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
- name String
Name of the KX database.
The following arguments are optional:
- 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. - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Import
Using pulumi import
, import an AWS FinSpace Kx Database using the id
(environment ID and database name, comma-delimited). For example:
$ pulumi import aws:finspace/kxDatabase:KxDatabase example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-database
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.
Try AWS Native preview for resources not in the classic version.