We recommend new projects start with resources from the AWS provider.
aws-native.finspace.Environment
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
An example resource schema demonstrating some basic constructs and validation rules.
Example Usage
Example
using System.Collections.Generic;
using System.Linq;
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 * 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,
});
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)
Coming soon!
Example
using System.Collections.Generic;
using System.Linq;
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 * 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,
});
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)
Coming soon!
Create Environment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Environment(name: string, args?: EnvironmentArgs, opts?: CustomResourceOptions);@overload
def Environment(resource_name: str,
                args: Optional[EnvironmentArgs] = None,
                opts: Optional[ResourceOptions] = None)
@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,
                tags: Optional[Sequence[_root_inputs.CreateOnlyTagArgs]] = 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.
Parameters
- 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
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.Aws Native. Fin Space. Environment Federation Mode 
- Federation mode used with the Environment
- FederationParameters Pulumi.Aws Native. Fin Space. Inputs. Environment Federation Parameters 
- Configuration information when authentication mode is FEDERATED.
- KmsKey stringId 
- KMS key used to encrypt customer data within FinSpace Environment infrastructure
- Name string
- Name of the Environment
- SuperuserParameters Pulumi.Aws Native. Fin Space. Inputs. Environment Superuser Parameters 
- Configuration information for the superuser.
- 
List<Pulumi.Aws Native. Inputs. Create Only Tag> 
- An array of key-value pairs to apply to this resource.
- DataBundles []string
- ARNs of FinSpace Data Bundles to install
- Description string
- Description of the Environment
- FederationMode EnvironmentFederation Mode 
- Federation mode used with the Environment
- FederationParameters EnvironmentFederation Parameters Args 
- Configuration information when authentication mode is FEDERATED.
- KmsKey stringId 
- KMS key used to encrypt customer data within FinSpace Environment infrastructure
- Name string
- Name of the Environment
- SuperuserParameters EnvironmentSuperuser Parameters Args 
- Configuration information for the superuser.
- 
CreateOnly Tag Args 
- An array of key-value pairs to apply to this resource.
- dataBundles List<String>
- ARNs of FinSpace Data Bundles to install
- description String
- Description of the Environment
- federationMode EnvironmentFederation Mode 
- Federation mode used with the Environment
- federationParameters EnvironmentFederation Parameters 
- Configuration information when authentication mode is FEDERATED.
- kmsKey StringId 
- KMS key used to encrypt customer data within FinSpace Environment infrastructure
- name String
- Name of the Environment
- superuserParameters EnvironmentSuperuser Parameters 
- Configuration information for the superuser.
- 
List<CreateOnly Tag> 
- An array of key-value pairs to apply to this resource.
- dataBundles string[]
- ARNs of FinSpace Data Bundles to install
- description string
- Description of the Environment
- federationMode EnvironmentFederation Mode 
- Federation mode used with the Environment
- federationParameters EnvironmentFederation Parameters 
- Configuration information when authentication mode is FEDERATED.
- kmsKey stringId 
- KMS key used to encrypt customer data within FinSpace Environment infrastructure
- name string
- Name of the Environment
- superuserParameters EnvironmentSuperuser Parameters 
- Configuration information for the superuser.
- 
CreateOnly Tag[] 
- An array of key-value pairs to apply to this resource.
- data_bundles Sequence[str]
- ARNs of FinSpace Data Bundles to install
- description str
- Description of the Environment
- federation_mode EnvironmentFederation Mode 
- Federation mode used with the Environment
- federation_parameters EnvironmentFederation Parameters Args 
- Configuration information when authentication mode is FEDERATED.
- kms_key_ strid 
- KMS key used to encrypt customer data within FinSpace Environment infrastructure
- name str
- Name of the Environment
- superuser_parameters EnvironmentSuperuser Parameters Args 
- Configuration information for the superuser.
- 
Sequence[CreateOnly Tag Args] 
- An array of key-value pairs to apply to this resource.
- 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
- Configuration information when authentication mode is FEDERATED.
- kmsKey StringId 
- KMS key used to encrypt customer data within FinSpace Environment infrastructure
- name String
- Name of the Environment
- superuserParameters Property Map
- Configuration information for the superuser.
- List<Property Map>
- An array of key-value pairs to apply to this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the Environment resource produces the following output properties:
- AwsAccount stringId 
- AWS account ID associated with the Environment
- DedicatedService stringAccount Id 
- 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.
- SageMaker stringStudio Domain Url 
- SageMaker Studio Domain URL associated with the Environment
- Status
Pulumi.Aws Native. Fin Space. Environment Status 
- State of the Environment
- AwsAccount stringId 
- AWS account ID associated with the Environment
- DedicatedService stringAccount Id 
- 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.
- SageMaker stringStudio Domain Url 
- SageMaker Studio Domain URL associated with the Environment
- Status
EnvironmentStatus 
- State of the Environment
- awsAccount StringId 
- AWS account ID associated with the Environment
- dedicatedService StringAccount Id 
- 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.
- sageMaker StringStudio Domain Url 
- SageMaker Studio Domain URL associated with the Environment
- status
EnvironmentStatus 
- State of the Environment
- awsAccount stringId 
- AWS account ID associated with the Environment
- dedicatedService stringAccount Id 
- 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.
- sageMaker stringStudio Domain Url 
- SageMaker Studio Domain URL associated with the Environment
- status
EnvironmentStatus 
- State of the Environment
- aws_account_ strid 
- AWS account ID associated with the Environment
- dedicated_service_ straccount_ id 
- 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_ strstudio_ domain_ url 
- SageMaker Studio Domain URL associated with the Environment
- status
EnvironmentStatus 
- State of the Environment
- awsAccount StringId 
- AWS account ID associated with the Environment
- dedicatedService StringAccount Id 
- 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.
- sageMaker StringStudio Domain Url 
- 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
CreateOnlyTag, CreateOnlyTagArgs      
EnvironmentFederationMode, EnvironmentFederationModeArgs      
- Local
- LOCAL
- Federated
- FEDERATED
- EnvironmentFederation Mode Local 
- LOCAL
- EnvironmentFederation Mode Federated 
- FEDERATED
- Local
- LOCAL
- Federated
- FEDERATED
- Local
- LOCAL
- Federated
- FEDERATED
- LOCAL
- LOCAL
- FEDERATED
- FEDERATED
- "LOCAL"
- LOCAL
- "FEDERATED"
- FEDERATED
EnvironmentFederationParameters, EnvironmentFederationParametersArgs      
- ApplicationCall stringBack Url 
- SAML metadata URL to link with the Environment
- AttributeMap List<Pulumi.Aws Native. Fin Space. Inputs. Environment Federation Parameters Attribute Map Item Properties> 
- Attribute map for SAML configuration
- FederationProvider stringName 
- Federation provider name to link with the Environment
- FederationUrn string
- SAML metadata URL to link with the Environment
- SamlMetadata stringDocument 
- SAML metadata document to link the federation provider to the Environment
- SamlMetadata stringUrl 
- SAML metadata URL to link with the Environment
- ApplicationCall stringBack Url 
- SAML metadata URL to link with the Environment
- AttributeMap []EnvironmentFederation Parameters Attribute Map Item Properties 
- Attribute map for SAML configuration
- FederationProvider stringName 
- Federation provider name to link with the Environment
- FederationUrn string
- SAML metadata URL to link with the Environment
- SamlMetadata stringDocument 
- SAML metadata document to link the federation provider to the Environment
- SamlMetadata stringUrl 
- SAML metadata URL to link with the Environment
- applicationCall StringBack Url 
- SAML metadata URL to link with the Environment
- attributeMap List<EnvironmentFederation Parameters Attribute Map Item Properties> 
- Attribute map for SAML configuration
- federationProvider StringName 
- Federation provider name to link with the Environment
- federationUrn String
- SAML metadata URL to link with the Environment
- samlMetadata StringDocument 
- SAML metadata document to link the federation provider to the Environment
- samlMetadata StringUrl 
- SAML metadata URL to link with the Environment
- applicationCall stringBack Url 
- SAML metadata URL to link with the Environment
- attributeMap EnvironmentFederation Parameters Attribute Map Item Properties[] 
- Attribute map for SAML configuration
- federationProvider stringName 
- Federation provider name to link with the Environment
- federationUrn string
- SAML metadata URL to link with the Environment
- samlMetadata stringDocument 
- SAML metadata document to link the federation provider to the Environment
- samlMetadata stringUrl 
- SAML metadata URL to link with the Environment
- application_call_ strback_ url 
- SAML metadata URL to link with the Environment
- attribute_map Sequence[EnvironmentFederation Parameters Attribute Map Item Properties] 
- Attribute map for SAML configuration
- federation_provider_ strname 
- Federation provider name to link with the Environment
- federation_urn str
- SAML metadata URL to link with the Environment
- saml_metadata_ strdocument 
- SAML metadata document to link the federation provider to the Environment
- saml_metadata_ strurl 
- SAML metadata URL to link with the Environment
- applicationCall StringBack Url 
- SAML metadata URL to link with the Environment
- attributeMap List<Property Map>
- Attribute map for SAML configuration
- federationProvider StringName 
- Federation provider name to link with the Environment
- federationUrn String
- SAML metadata URL to link with the Environment
- samlMetadata StringDocument 
- SAML metadata document to link the federation provider to the Environment
- samlMetadata StringUrl 
- SAML metadata URL to link with the Environment
EnvironmentFederationParametersAttributeMapItemProperties, EnvironmentFederationParametersAttributeMapItemPropertiesArgs              
- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key str
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value str
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
EnvironmentStatus, EnvironmentStatusArgs    
- 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
- EnvironmentStatus Create Requested 
- CREATE_REQUESTED
- EnvironmentStatus Creating 
- CREATING
- EnvironmentStatus Created 
- CREATED
- EnvironmentStatus Delete Requested 
- DELETE_REQUESTED
- EnvironmentStatus Deleting 
- DELETING
- EnvironmentStatus Deleted 
- DELETED
- EnvironmentStatus Failed Creation 
- FAILED_CREATION
- EnvironmentStatus Failed Deletion 
- FAILED_DELETION
- EnvironmentStatus Retry Deletion 
- RETRY_DELETION
- EnvironmentStatus 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
- 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, EnvironmentSuperuserParametersArgs      
- 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
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.