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 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 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 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
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:
- Data
Bundles List<string> - ARNs of FinSpace Data Bundles to install
- Description string
- Description of the Environment
- Federation
Mode Pulumi.Aws Native. Fin Space. Environment Federation Mode - Federation mode used with the Environment
- Federation
Parameters Pulumi.Aws Native. Fin Space. Inputs. Environment Federation Parameters - Configuration information when authentication mode is FEDERATED.
- Kms
Key stringId - KMS key used to encrypt customer data within FinSpace Environment infrastructure
- Name string
- Name of the Environment
- Superuser
Parameters 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.
- Data
Bundles []string - ARNs of FinSpace Data Bundles to install
- Description string
- 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 stringId - KMS key used to encrypt customer data within FinSpace Environment infrastructure
- Name string
- Name of the Environment
- Superuser
Parameters EnvironmentSuperuser Parameters Args - Configuration information for the superuser.
- Create
Only Tag Args - An array of key-value pairs to apply to this resource.
- data
Bundles List<String> - ARNs of FinSpace Data Bundles to install
- description String
- Description of the Environment
- federation
Mode EnvironmentFederation Mode - Federation mode used with the Environment
- federation
Parameters EnvironmentFederation Parameters - Configuration information when authentication mode is FEDERATED.
- kms
Key StringId - KMS key used to encrypt customer data within FinSpace Environment infrastructure
- name String
- Name of the Environment
- superuser
Parameters EnvironmentSuperuser Parameters - Configuration information for the superuser.
- List<Create
Only Tag> - An array of key-value pairs to apply to this resource.
- data
Bundles string[] - ARNs of FinSpace Data Bundles to install
- description string
- Description of the Environment
- federation
Mode EnvironmentFederation Mode - Federation mode used with the Environment
- federation
Parameters EnvironmentFederation Parameters - Configuration information when authentication mode is FEDERATED.
- kms
Key stringId - KMS key used to encrypt customer data within FinSpace Environment infrastructure
- name string
- Name of the Environment
- superuser
Parameters EnvironmentSuperuser Parameters - Configuration information for the superuser.
- Create
Only 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[Create
Only Tag Args] - An array of key-value pairs to apply to this resource.
- data
Bundles List<String> - ARNs of FinSpace Data Bundles to install
- description String
- Description of the Environment
- federation
Mode "LOCAL" | "FEDERATED" - Federation mode used with the Environment
- federation
Parameters Property Map - Configuration information when authentication mode is FEDERATED.
- kms
Key StringId - KMS key used to encrypt customer data within FinSpace Environment infrastructure
- name String
- Name of the Environment
- superuser
Parameters 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:
- Aws
Account stringId - AWS account ID associated with the Environment
- Dedicated
Service stringAccount Id - ID for FinSpace created account used to store Environment artifacts
- Environment
Arn string - ARN of the Environment
- Environment
Id string - Unique identifier for representing FinSpace Environment
- Environment
Url string - URL used to login to the Environment
- Id string
- The provider-assigned unique ID for this managed resource.
- Sage
Maker stringStudio Domain Url - SageMaker Studio Domain URL associated with the Environment
- Status
Pulumi.
Aws Native. Fin Space. Environment Status - State of the Environment
- Aws
Account stringId - AWS account ID associated with the Environment
- Dedicated
Service stringAccount Id - ID for FinSpace created account used to store Environment artifacts
- Environment
Arn string - ARN of the Environment
- Environment
Id string - Unique identifier for representing FinSpace Environment
- Environment
Url string - URL used to login to the Environment
- Id string
- The provider-assigned unique ID for this managed resource.
- Sage
Maker stringStudio Domain Url - SageMaker Studio Domain URL associated with the Environment
- Status
Environment
Status - State of the Environment
- aws
Account StringId - AWS account ID associated with the Environment
- dedicated
Service StringAccount Id - ID for FinSpace created account used to store Environment artifacts
- environment
Arn String - ARN of the Environment
- environment
Id String - Unique identifier for representing FinSpace Environment
- environment
Url String - URL used to login to the Environment
- id String
- The provider-assigned unique ID for this managed resource.
- sage
Maker StringStudio Domain Url - SageMaker Studio Domain URL associated with the Environment
- status
Environment
Status - State of the Environment
- aws
Account stringId - AWS account ID associated with the Environment
- dedicated
Service stringAccount Id - ID for FinSpace created account used to store Environment artifacts
- environment
Arn string - ARN of the Environment
- environment
Id string - Unique identifier for representing FinSpace Environment
- environment
Url string - URL used to login to the Environment
- id string
- The provider-assigned unique ID for this managed resource.
- sage
Maker stringStudio Domain Url - SageMaker Studio Domain URL associated with the Environment
- status
Environment
Status - 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
Environment
Status - State of the Environment
- aws
Account StringId - AWS account ID associated with the Environment
- dedicated
Service StringAccount Id - ID for FinSpace created account used to store Environment artifacts
- environment
Arn String - ARN of the Environment
- environment
Id String - Unique identifier for representing FinSpace Environment
- environment
Url String - URL used to login to the Environment
- id String
- The provider-assigned unique ID for this managed resource.
- sage
Maker 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
- Environment
Federation Mode Local - LOCAL
- Environment
Federation Mode Federated - FEDERATED
- Local
- LOCAL
- Federated
- FEDERATED
- Local
- LOCAL
- Federated
- FEDERATED
- LOCAL
- LOCAL
- FEDERATED
- FEDERATED
- "LOCAL"
- LOCAL
- "FEDERATED"
- FEDERATED
EnvironmentFederationParameters, EnvironmentFederationParametersArgs
- Application
Call stringBack Url - SAML metadata URL to link with the Environment
- Attribute
Map List<Pulumi.Aws Native. Fin Space. Inputs. Environment Federation Parameters Attribute Map Item Properties> - Attribute map for SAML configuration
- Federation
Provider stringName - Federation provider name to link with the Environment
- Federation
Urn string - SAML metadata URL to link with the Environment
- Saml
Metadata stringDocument - SAML metadata document to link the federation provider to the Environment
- Saml
Metadata stringUrl - SAML metadata URL to link with the Environment
- Application
Call stringBack Url - SAML metadata URL to link with the Environment
- Attribute
Map []EnvironmentFederation Parameters Attribute Map Item Properties - Attribute map for SAML configuration
- Federation
Provider stringName - Federation provider name to link with the Environment
- Federation
Urn string - SAML metadata URL to link with the Environment
- Saml
Metadata stringDocument - SAML metadata document to link the federation provider to the Environment
- Saml
Metadata stringUrl - SAML metadata URL to link with the Environment
- application
Call StringBack Url - SAML metadata URL to link with the Environment
- attribute
Map List<EnvironmentFederation Parameters Attribute Map Item Properties> - Attribute map for SAML configuration
- federation
Provider StringName - Federation provider name to link with the Environment
- federation
Urn String - SAML metadata URL to link with the Environment
- saml
Metadata StringDocument - SAML metadata document to link the federation provider to the Environment
- saml
Metadata StringUrl - SAML metadata URL to link with the Environment
- application
Call stringBack Url - SAML metadata URL to link with the Environment
- attribute
Map EnvironmentFederation Parameters Attribute Map Item Properties[] - Attribute map for SAML configuration
- federation
Provider stringName - Federation provider name to link with the Environment
- federation
Urn string - SAML metadata URL to link with the Environment
- saml
Metadata stringDocument - SAML metadata document to link the federation provider to the Environment
- saml
Metadata 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
- application
Call StringBack Url - SAML metadata URL to link with the Environment
- attribute
Map List<Property Map> - Attribute map for SAML configuration
- federation
Provider StringName - Federation provider name to link with the Environment
- federation
Urn String - SAML metadata URL to link with the Environment
- saml
Metadata StringDocument - SAML metadata document to link the federation provider to the Environment
- saml
Metadata 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
- 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
- Environment
Status Create Requested - CREATE_REQUESTED
- Environment
Status Creating - CREATING
- Environment
Status Created - CREATED
- Environment
Status Delete Requested - DELETE_REQUESTED
- Environment
Status Deleting - DELETING
- Environment
Status Deleted - DELETED
- Environment
Status Failed Creation - FAILED_CREATION
- Environment
Status Failed Deletion - FAILED_DELETION
- Environment
Status Retry Deletion - RETRY_DELETION
- Environment
Status 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
- 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
- Email
Address string - Email address
- First
Name string - First name
- Last
Name string - Last name
- Email
Address string - Email address
- First
Name string - First name
- Last
Name string - Last name
- email
Address String - Email address
- first
Name String - First name
- last
Name String - Last name
- email
Address string - Email address
- first
Name string - First name
- last
Name string - Last name
- email_
address str - Email address
- first_
name str - First name
- last_
name str - Last name
- email
Address String - Email address
- first
Name String - First name
- last
Name 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.