1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. finspace
  5. getEnvironment

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.finspace.getEnvironment

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

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

Using getEnvironment

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEnvironment(args: GetEnvironmentArgs, opts?: InvokeOptions): Promise<GetEnvironmentResult>
function getEnvironmentOutput(args: GetEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentResult>
Copy
def get_environment(environment_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEnvironmentResult
def get_environment_output(environment_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentResult]
Copy
func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput
Copy

> Note: This function is named LookupEnvironment in the Go SDK.

public static class GetEnvironment 
{
    public static Task<GetEnvironmentResult> InvokeAsync(GetEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetEnvironmentResult> Invoke(GetEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
public static Output<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:finspace:getEnvironment
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

EnvironmentId This property is required. string
Unique identifier for representing FinSpace Environment
EnvironmentId This property is required. string
Unique identifier for representing FinSpace Environment
environmentId This property is required. String
Unique identifier for representing FinSpace Environment
environmentId This property is required. string
Unique identifier for representing FinSpace Environment
environment_id This property is required. str
Unique identifier for representing FinSpace Environment
environmentId This property is required. String
Unique identifier for representing FinSpace Environment

getEnvironment Result

The following output properties are available:

AwsAccountId string
AWS account ID associated with the Environment
DedicatedServiceAccountId string
ID for FinSpace created account used to store Environment artifacts
Description string
Description of the Environment
EnvironmentArn string
ARN of the Environment
EnvironmentId string
Unique identifier for representing FinSpace Environment
EnvironmentUrl string
URL used to login to the Environment
FederationMode Pulumi.AwsNative.FinSpace.EnvironmentFederationMode
Federation mode used with the Environment
Name string
Name of the Environment
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
Description string
Description of the Environment
EnvironmentArn string
ARN of the Environment
EnvironmentId string
Unique identifier for representing FinSpace Environment
EnvironmentUrl string
URL used to login to the Environment
FederationMode EnvironmentFederationMode
Federation mode used with the Environment
Name string
Name of the Environment
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
description String
Description of the Environment
environmentArn String
ARN of the Environment
environmentId String
Unique identifier for representing FinSpace Environment
environmentUrl String
URL used to login to the Environment
federationMode EnvironmentFederationMode
Federation mode used with the Environment
name String
Name of the Environment
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
description string
Description of the Environment
environmentArn string
ARN of the Environment
environmentId string
Unique identifier for representing FinSpace Environment
environmentUrl string
URL used to login to the Environment
federationMode EnvironmentFederationMode
Federation mode used with the Environment
name string
Name of the Environment
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
description str
Description of the Environment
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
federation_mode EnvironmentFederationMode
Federation mode used with the Environment
name str
Name of the Environment
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
description String
Description of the Environment
environmentArn String
ARN of the Environment
environmentId String
Unique identifier for representing FinSpace Environment
environmentUrl String
URL used to login to the Environment
federationMode "LOCAL" | "FEDERATED"
Federation mode used with the Environment
name String
Name of the Environment
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

EnvironmentStatus

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi