aws.finspace.KxUser
Explore with Pulumi AI
Resource for managing an AWS FinSpace Kx User.
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 exampleRole = new aws.iam.Role("example", {
name: "example-role",
assumeRolePolicy: JSON.stringify({
Version: "2012-10-17",
Statement: [{
Action: "sts:AssumeRole",
Effect: "Allow",
Sid: "",
Principal: {
Service: "ec2.amazonaws.com",
},
}],
}),
});
const exampleKxUser = new aws.finspace.KxUser("example", {
name: "my-tf-kx-user",
environmentId: exampleKxEnvironment.id,
iamRole: exampleRole.arn,
});
import pulumi
import json
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_role = aws.iam.Role("example",
name="example-role",
assume_role_policy=json.dumps({
"Version": "2012-10-17",
"Statement": [{
"Action": "sts:AssumeRole",
"Effect": "Allow",
"Sid": "",
"Principal": {
"Service": "ec2.amazonaws.com",
},
}],
}))
example_kx_user = aws.finspace.KxUser("example",
name="my-tf-kx-user",
environment_id=example_kx_environment.id,
iam_role=example_role.arn)
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/finspace"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
"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
}
tmpJSON0, err := json.Marshal(map[string]interface{}{
"Version": "2012-10-17",
"Statement": []map[string]interface{}{
map[string]interface{}{
"Action": "sts:AssumeRole",
"Effect": "Allow",
"Sid": "",
"Principal": map[string]interface{}{
"Service": "ec2.amazonaws.com",
},
},
},
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
exampleRole, err := iam.NewRole(ctx, "example", &iam.RoleArgs{
Name: pulumi.String("example-role"),
AssumeRolePolicy: pulumi.String(json0),
})
if err != nil {
return err
}
_, err = finspace.NewKxUser(ctx, "example", &finspace.KxUserArgs{
Name: pulumi.String("my-tf-kx-user"),
EnvironmentId: exampleKxEnvironment.ID(),
IamRole: exampleRole.Arn,
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
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 exampleRole = new Aws.Iam.Role("example", new()
{
Name = "example-role",
AssumeRolePolicy = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["Version"] = "2012-10-17",
["Statement"] = new[]
{
new Dictionary<string, object?>
{
["Action"] = "sts:AssumeRole",
["Effect"] = "Allow",
["Sid"] = "",
["Principal"] = new Dictionary<string, object?>
{
["Service"] = "ec2.amazonaws.com",
},
},
},
}),
});
var exampleKxUser = new Aws.FinSpace.KxUser("example", new()
{
Name = "my-tf-kx-user",
EnvironmentId = exampleKxEnvironment.Id,
IamRole = exampleRole.Arn,
});
});
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.iam.Role;
import com.pulumi.aws.iam.RoleArgs;
import com.pulumi.aws.finspace.KxUser;
import com.pulumi.aws.finspace.KxUserArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 exampleRole = new Role("exampleRole", RoleArgs.builder()
.name("example-role")
.assumeRolePolicy(serializeJson(
jsonObject(
jsonProperty("Version", "2012-10-17"),
jsonProperty("Statement", jsonArray(jsonObject(
jsonProperty("Action", "sts:AssumeRole"),
jsonProperty("Effect", "Allow"),
jsonProperty("Sid", ""),
jsonProperty("Principal", jsonObject(
jsonProperty("Service", "ec2.amazonaws.com")
))
)))
)))
.build());
var exampleKxUser = new KxUser("exampleKxUser", KxUserArgs.builder()
.name("my-tf-kx-user")
.environmentId(exampleKxEnvironment.id())
.iamRole(exampleRole.arn())
.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}
exampleRole:
type: aws:iam:Role
name: example
properties:
name: example-role
assumeRolePolicy:
fn::toJSON:
Version: 2012-10-17
Statement:
- Action: sts:AssumeRole
Effect: Allow
Sid:
Principal:
Service: ec2.amazonaws.com
exampleKxUser:
type: aws:finspace:KxUser
name: example
properties:
name: my-tf-kx-user
environmentId: ${exampleKxEnvironment.id}
iamRole: ${exampleRole.arn}
Create KxUser Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new KxUser(name: string, args: KxUserArgs, opts?: CustomResourceOptions);
@overload
def KxUser(resource_name: str,
args: KxUserArgs,
opts: Optional[ResourceOptions] = None)
@overload
def KxUser(resource_name: str,
opts: Optional[ResourceOptions] = None,
environment_id: Optional[str] = None,
iam_role: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewKxUser(ctx *Context, name string, args KxUserArgs, opts ...ResourceOption) (*KxUser, error)
public KxUser(string name, KxUserArgs args, CustomResourceOptions? opts = null)
public KxUser(String name, KxUserArgs args)
public KxUser(String name, KxUserArgs args, CustomResourceOptions options)
type: aws:finspace:KxUser
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 KxUserArgs
- 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 KxUserArgs
- 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 KxUserArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KxUserArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args KxUserArgs
- 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 kxUserResource = new Aws.FinSpace.KxUser("kxUserResource", new()
{
EnvironmentId = "string",
IamRole = "string",
Name = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := finspace.NewKxUser(ctx, "kxUserResource", &finspace.KxUserArgs{
EnvironmentId: pulumi.String("string"),
IamRole: pulumi.String("string"),
Name: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var kxUserResource = new KxUser("kxUserResource", KxUserArgs.builder()
.environmentId("string")
.iamRole("string")
.name("string")
.tags(Map.of("string", "string"))
.build());
kx_user_resource = aws.finspace.KxUser("kxUserResource",
environment_id="string",
iam_role="string",
name="string",
tags={
"string": "string",
})
const kxUserResource = new aws.finspace.KxUser("kxUserResource", {
environmentId: "string",
iamRole: "string",
name: "string",
tags: {
string: "string",
},
});
type: aws:finspace:KxUser
properties:
environmentId: string
iamRole: string
name: string
tags:
string: string
KxUser 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 KxUser resource accepts the following input properties:
- Environment
Id string - Unique identifier for the KX environment.
- Iam
Role string IAM role ARN to be associated with the user.
The following arguments are optional:
- Name string
- A unique identifier for the user.
- 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.
- Iam
Role string IAM role ARN to be associated with the user.
The following arguments are optional:
- Name string
- A unique identifier for the user.
- 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.
- iam
Role String IAM role ARN to be associated with the user.
The following arguments are optional:
- name String
- A unique identifier for the user.
- 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.
- iam
Role string IAM role ARN to be associated with the user.
The following arguments are optional:
- name string
- A unique identifier for the user.
- {[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.
- iam_
role str IAM role ARN to be associated with the user.
The following arguments are optional:
- name str
- A unique identifier for the user.
- 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.
- iam
Role String IAM role ARN to be associated with the user.
The following arguments are optional:
- name String
- A unique identifier for the user.
- 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 KxUser resource produces the following output properties:
Look up Existing KxUser Resource
Get an existing KxUser 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?: KxUserState, opts?: CustomResourceOptions): KxUser
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
environment_id: Optional[str] = None,
iam_role: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None) -> KxUser
func GetKxUser(ctx *Context, name string, id IDInput, state *KxUserState, opts ...ResourceOption) (*KxUser, error)
public static KxUser Get(string name, Input<string> id, KxUserState? state, CustomResourceOptions? opts = null)
public static KxUser get(String name, Output<String> id, KxUserState 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 user.
- Environment
Id string - Unique identifier for the KX environment.
- Iam
Role string IAM role ARN to be associated with the user.
The following arguments are optional:
- Name string
- A unique identifier for the user.
- 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 user.
- Environment
Id string - Unique identifier for the KX environment.
- Iam
Role string IAM role ARN to be associated with the user.
The following arguments are optional:
- Name string
- A unique identifier for the user.
- 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 user.
- environment
Id String - Unique identifier for the KX environment.
- iam
Role String IAM role ARN to be associated with the user.
The following arguments are optional:
- name String
- A unique identifier for the user.
- 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 user.
- environment
Id string - Unique identifier for the KX environment.
- iam
Role string IAM role ARN to be associated with the user.
The following arguments are optional:
- name string
- A unique identifier for the user.
- {[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 user.
- environment_
id str - Unique identifier for the KX environment.
- iam_
role str IAM role ARN to be associated with the user.
The following arguments are optional:
- name str
- A unique identifier for the user.
- 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 user.
- environment
Id String - Unique identifier for the KX environment.
- iam
Role String IAM role ARN to be associated with the user.
The following arguments are optional:
- name String
- A unique identifier for the user.
- 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 User using the id
(environment ID and user name, comma-delimited). For example:
$ pulumi import aws:finspace/kxUser:KxUser example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-user
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.