Environment

An example resource schema demonstrating some basic constructs and validation rules.

Example Usage

Example

using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var finSpaceEnvironment = new AwsNative.FinSpace.Environment("finSpaceEnvironment", new()
    {
        Name = "MyEnvironment",
        KmsKeyId = "arn:aws:kms:us-east-1:123456789012:key/44efed01-30d0-4b39-80e7-165d5ed34524",
        FederationMode = AwsNative.FinSpace.EnvironmentFederationMode.Local,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/finspace"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := finspace.NewEnvironment(ctx, "finSpaceEnvironment", &finspace.EnvironmentArgs{
			Name:           pulumi.String("MyEnvironment"),
			KmsKeyId:       pulumi.String("arn:aws:kms:us-east-1:123456789012:key/44efed01-30d0-4b39-80e7-165d5ed34524"),
			FederationMode: finspace.EnvironmentFederationModeLocal,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

fin_space_environment = aws_native.finspace.Environment("finSpaceEnvironment",
    name="MyEnvironment",
    kms_key_id="arn:aws:kms:us-east-1:123456789012:key/44efed01-30d0-4b39-80e7-165d5ed34524",
    federation_mode=aws_native.finspace.EnvironmentFederationMode.LOCAL)
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const finSpaceEnvironment = new aws_native.finspace.Environment("finSpaceEnvironment", {
    name: "MyEnvironment",
    kmsKeyId: "arn:aws:kms:us-east-1:123456789012:key/44efed01-30d0-4b39-80e7-165d5ed34524",
    federationMode: aws_native.finspace.EnvironmentFederationMode.Local,
});

Coming soon!

Example

using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var finSpaceEnvironment = new AwsNative.FinSpace.Environment("finSpaceEnvironment", new()
    {
        Name = "MyEnvironment",
        KmsKeyId = "arn:aws:kms:us-east-1:123456789012:key/44efed01-30d0-4b39-80e7-165d5ed34524",
        FederationMode = AwsNative.FinSpace.EnvironmentFederationMode.Local,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/finspace"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := finspace.NewEnvironment(ctx, "finSpaceEnvironment", &finspace.EnvironmentArgs{
			Name:           pulumi.String("MyEnvironment"),
			KmsKeyId:       pulumi.String("arn:aws:kms:us-east-1:123456789012:key/44efed01-30d0-4b39-80e7-165d5ed34524"),
			FederationMode: finspace.EnvironmentFederationModeLocal,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

fin_space_environment = aws_native.finspace.Environment("finSpaceEnvironment",
    name="MyEnvironment",
    kms_key_id="arn:aws:kms:us-east-1:123456789012:key/44efed01-30d0-4b39-80e7-165d5ed34524",
    federation_mode=aws_native.finspace.EnvironmentFederationMode.LOCAL)
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const finSpaceEnvironment = new aws_native.finspace.Environment("finSpaceEnvironment", {
    name: "MyEnvironment",
    kmsKeyId: "arn:aws:kms:us-east-1:123456789012:key/44efed01-30d0-4b39-80e7-165d5ed34524",
    federationMode: aws_native.finspace.EnvironmentFederationMode.Local,
});

Coming soon!

Create Environment Resource

new Environment(name: string, args?: EnvironmentArgs, opts?: CustomResourceOptions);
@overload
def Environment(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                data_bundles: Optional[Sequence[str]] = None,
                description: Optional[str] = None,
                federation_mode: Optional[EnvironmentFederationMode] = None,
                federation_parameters: Optional[EnvironmentFederationParametersArgs] = None,
                kms_key_id: Optional[str] = None,
                name: Optional[str] = None,
                superuser_parameters: Optional[EnvironmentSuperuserParametersArgs] = None)
@overload
def Environment(resource_name: str,
                args: Optional[EnvironmentArgs] = None,
                opts: Optional[ResourceOptions] = None)
func NewEnvironment(ctx *Context, name string, args *EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
public Environment(string name, EnvironmentArgs? args = null, CustomResourceOptions? opts = null)
public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)
type: aws-native:finspace:Environment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args EnvironmentArgs
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 EnvironmentArgs
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 EnvironmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EnvironmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args EnvironmentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Environment 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 Environment resource accepts the following input properties:

DataBundles List<string>

ARNs of FinSpace Data Bundles to install

Description string

Description of the Environment

FederationMode Pulumi.AwsNative.FinSpace.EnvironmentFederationMode

Federation mode used with the Environment

FederationParameters Pulumi.AwsNative.FinSpace.Inputs.EnvironmentFederationParametersArgs
KmsKeyId string

KMS key used to encrypt customer data within FinSpace Environment infrastructure

Name string

Name of the Environment

SuperuserParameters Pulumi.AwsNative.FinSpace.Inputs.EnvironmentSuperuserParametersArgs
DataBundles []string

ARNs of FinSpace Data Bundles to install

Description string

Description of the Environment

FederationMode EnvironmentFederationMode

Federation mode used with the Environment

FederationParameters EnvironmentFederationParametersArgs
KmsKeyId string

KMS key used to encrypt customer data within FinSpace Environment infrastructure

Name string

Name of the Environment

SuperuserParameters EnvironmentSuperuserParametersArgs
dataBundles List<String>

ARNs of FinSpace Data Bundles to install

description String

Description of the Environment

federationMode EnvironmentFederationMode

Federation mode used with the Environment

federationParameters EnvironmentFederationParametersArgs
kmsKeyId String

KMS key used to encrypt customer data within FinSpace Environment infrastructure

name String

Name of the Environment

superuserParameters EnvironmentSuperuserParametersArgs
dataBundles string[]

ARNs of FinSpace Data Bundles to install

description string

Description of the Environment

federationMode EnvironmentFederationMode

Federation mode used with the Environment

federationParameters EnvironmentFederationParametersArgs
kmsKeyId string

KMS key used to encrypt customer data within FinSpace Environment infrastructure

name string

Name of the Environment

superuserParameters EnvironmentSuperuserParametersArgs
data_bundles Sequence[str]

ARNs of FinSpace Data Bundles to install

description str

Description of the Environment

federation_mode EnvironmentFederationMode

Federation mode used with the Environment

federation_parameters EnvironmentFederationParametersArgs
kms_key_id str

KMS key used to encrypt customer data within FinSpace Environment infrastructure

name str

Name of the Environment

superuser_parameters EnvironmentSuperuserParametersArgs
dataBundles List<String>

ARNs of FinSpace Data Bundles to install

description String

Description of the Environment

federationMode "LOCAL" | "FEDERATED"

Federation mode used with the Environment

federationParameters Property Map
kmsKeyId String

KMS key used to encrypt customer data within FinSpace Environment infrastructure

name String

Name of the Environment

superuserParameters Property Map

Outputs

All input properties are implicitly available as output properties. Additionally, the Environment resource produces the following output properties:

AwsAccountId string

AWS account ID associated with the Environment

DedicatedServiceAccountId string

ID for FinSpace created account used to store Environment artifacts

EnvironmentArn string

ARN of the Environment

EnvironmentId string

Unique identifier for representing FinSpace Environment

EnvironmentUrl string

URL used to login to the Environment

Id string

The provider-assigned unique ID for this managed resource.

SageMakerStudioDomainUrl string

SageMaker Studio Domain URL associated with the Environment

Status Pulumi.AwsNative.FinSpace.EnvironmentStatus

State of the Environment

AwsAccountId string

AWS account ID associated with the Environment

DedicatedServiceAccountId string

ID for FinSpace created account used to store Environment artifacts

EnvironmentArn string

ARN of the Environment

EnvironmentId string

Unique identifier for representing FinSpace Environment

EnvironmentUrl string

URL used to login to the Environment

Id string

The provider-assigned unique ID for this managed resource.

SageMakerStudioDomainUrl string

SageMaker Studio Domain URL associated with the Environment

Status EnvironmentStatus

State of the Environment

awsAccountId String

AWS account ID associated with the Environment

dedicatedServiceAccountId String

ID for FinSpace created account used to store Environment artifacts

environmentArn String

ARN of the Environment

environmentId String

Unique identifier for representing FinSpace Environment

environmentUrl String

URL used to login to the Environment

id String

The provider-assigned unique ID for this managed resource.

sageMakerStudioDomainUrl String

SageMaker Studio Domain URL associated with the Environment

status EnvironmentStatus

State of the Environment

awsAccountId string

AWS account ID associated with the Environment

dedicatedServiceAccountId string

ID for FinSpace created account used to store Environment artifacts

environmentArn string

ARN of the Environment

environmentId string

Unique identifier for representing FinSpace Environment

environmentUrl string

URL used to login to the Environment

id string

The provider-assigned unique ID for this managed resource.

sageMakerStudioDomainUrl string

SageMaker Studio Domain URL associated with the Environment

status EnvironmentStatus

State of the Environment

aws_account_id str

AWS account ID associated with the Environment

dedicated_service_account_id str

ID for FinSpace created account used to store Environment artifacts

environment_arn str

ARN of the Environment

environment_id str

Unique identifier for representing FinSpace Environment

environment_url str

URL used to login to the Environment

id str

The provider-assigned unique ID for this managed resource.

sage_maker_studio_domain_url str

SageMaker Studio Domain URL associated with the Environment

status EnvironmentStatus

State of the Environment

awsAccountId String

AWS account ID associated with the Environment

dedicatedServiceAccountId String

ID for FinSpace created account used to store Environment artifacts

environmentArn String

ARN of the Environment

environmentId String

Unique identifier for representing FinSpace Environment

environmentUrl String

URL used to login to the Environment

id String

The provider-assigned unique ID for this managed resource.

sageMakerStudioDomainUrl String

SageMaker Studio Domain URL associated with the Environment

status "CREATE_REQUESTED" | "CREATING" | "CREATED" | "DELETE_REQUESTED" | "DELETING" | "DELETED" | "FAILED_CREATION" | "FAILED_DELETION" | "RETRY_DELETION" | "SUSPENDED"

State of the Environment

Supporting Types

EnvironmentFederationMode

Local
LOCAL
Federated
FEDERATED
EnvironmentFederationModeLocal
LOCAL
EnvironmentFederationModeFederated
FEDERATED
Local
LOCAL
Federated
FEDERATED
Local
LOCAL
Federated
FEDERATED
LOCAL
LOCAL
FEDERATED
FEDERATED
"LOCAL"
LOCAL
"FEDERATED"
FEDERATED

EnvironmentFederationParameters

ApplicationCallBackURL string

SAML metadata URL to link with the Environment

AttributeMap object

Attribute map for SAML configuration

FederationProviderName string

Federation provider name to link with the Environment

FederationURN string

SAML metadata URL to link with the Environment

SamlMetadataDocument string

SAML metadata document to link the federation provider to the Environment

SamlMetadataURL string

SAML metadata URL to link with the Environment

ApplicationCallBackURL string

SAML metadata URL to link with the Environment

AttributeMap interface{}

Attribute map for SAML configuration

FederationProviderName string

Federation provider name to link with the Environment

FederationURN string

SAML metadata URL to link with the Environment

SamlMetadataDocument string

SAML metadata document to link the federation provider to the Environment

SamlMetadataURL string

SAML metadata URL to link with the Environment

applicationCallBackURL String

SAML metadata URL to link with the Environment

attributeMap Object

Attribute map for SAML configuration

federationProviderName String

Federation provider name to link with the Environment

federationURN String

SAML metadata URL to link with the Environment

samlMetadataDocument String

SAML metadata document to link the federation provider to the Environment

samlMetadataURL String

SAML metadata URL to link with the Environment

applicationCallBackURL string

SAML metadata URL to link with the Environment

attributeMap any

Attribute map for SAML configuration

federationProviderName string

Federation provider name to link with the Environment

federationURN string

SAML metadata URL to link with the Environment

samlMetadataDocument string

SAML metadata document to link the federation provider to the Environment

samlMetadataURL string

SAML metadata URL to link with the Environment

application_call_back_url str

SAML metadata URL to link with the Environment

attribute_map Any

Attribute map for SAML configuration

federation_provider_name str

Federation provider name to link with the Environment

federation_urn str

SAML metadata URL to link with the Environment

saml_metadata_document str

SAML metadata document to link the federation provider to the Environment

saml_metadata_url str

SAML metadata URL to link with the Environment

applicationCallBackURL String

SAML metadata URL to link with the Environment

attributeMap Any

Attribute map for SAML configuration

federationProviderName String

Federation provider name to link with the Environment

federationURN String

SAML metadata URL to link with the Environment

samlMetadataDocument String

SAML metadata document to link the federation provider to the Environment

samlMetadataURL String

SAML metadata URL to link with the Environment

EnvironmentStatus

CreateRequested
CREATE_REQUESTED
Creating
CREATING
Created
CREATED
DeleteRequested
DELETE_REQUESTED
Deleting
DELETING
Deleted
DELETED
FailedCreation
FAILED_CREATION
FailedDeletion
FAILED_DELETION
RetryDeletion
RETRY_DELETION
Suspended
SUSPENDED
EnvironmentStatusCreateRequested
CREATE_REQUESTED
EnvironmentStatusCreating
CREATING
EnvironmentStatusCreated
CREATED
EnvironmentStatusDeleteRequested
DELETE_REQUESTED
EnvironmentStatusDeleting
DELETING
EnvironmentStatusDeleted
DELETED
EnvironmentStatusFailedCreation
FAILED_CREATION
EnvironmentStatusFailedDeletion
FAILED_DELETION
EnvironmentStatusRetryDeletion
RETRY_DELETION
EnvironmentStatusSuspended
SUSPENDED
CreateRequested
CREATE_REQUESTED
Creating
CREATING
Created
CREATED
DeleteRequested
DELETE_REQUESTED
Deleting
DELETING
Deleted
DELETED
FailedCreation
FAILED_CREATION
FailedDeletion
FAILED_DELETION
RetryDeletion
RETRY_DELETION
Suspended
SUSPENDED
CreateRequested
CREATE_REQUESTED
Creating
CREATING
Created
CREATED
DeleteRequested
DELETE_REQUESTED
Deleting
DELETING
Deleted
DELETED
FailedCreation
FAILED_CREATION
FailedDeletion
FAILED_DELETION
RetryDeletion
RETRY_DELETION
Suspended
SUSPENDED
CREATE_REQUESTED
CREATE_REQUESTED
CREATING
CREATING
CREATED
CREATED
DELETE_REQUESTED
DELETE_REQUESTED
DELETING
DELETING
DELETED
DELETED
FAILED_CREATION
FAILED_CREATION
FAILED_DELETION
FAILED_DELETION
RETRY_DELETION
RETRY_DELETION
SUSPENDED
SUSPENDED
"CREATE_REQUESTED"
CREATE_REQUESTED
"CREATING"
CREATING
"CREATED"
CREATED
"DELETE_REQUESTED"
DELETE_REQUESTED
"DELETING"
DELETING
"DELETED"
DELETED
"FAILED_CREATION"
FAILED_CREATION
"FAILED_DELETION"
FAILED_DELETION
"RETRY_DELETION"
RETRY_DELETION
"SUSPENDED"
SUSPENDED

EnvironmentSuperuserParameters

EmailAddress string

Email address

FirstName string

First name

LastName string

Last name

EmailAddress string

Email address

FirstName string

First name

LastName string

Last name

emailAddress String

Email address

firstName String

First name

lastName String

Last name

emailAddress string

Email address

firstName string

First name

lastName string

Last name

email_address str

Email address

first_name str

First name

last_name str

Last name

emailAddress String

Email address

firstName String

First name

lastName String

Last name

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0