AWS Native v0.55.0, Mar 28 23

aws-native.finspace.getEnvironment

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>

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]

func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput

> 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)
}

public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:finspace:getEnvironment
  arguments:
    # arguments dictionary

The following arguments are supported:

EnvironmentId string: Unique identifier for representing FinSpace Environment

EnvironmentId string: Unique identifier for representing FinSpace Environment

environmentId String: Unique identifier for representing FinSpace Environment

environmentId string: Unique identifier for representing FinSpace Environment

environment_id str: Unique identifier for representing FinSpace Environment

environmentId 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
FederationParameters Pulumi.AwsNative.FinSpace.Outputs.EnvironmentFederationParameters
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
FederationParameters EnvironmentFederationParameters
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
federationParameters EnvironmentFederationParameters
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
federationParameters EnvironmentFederationParameters
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
federation_parameters EnvironmentFederationParameters
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
federationParameters Property Map
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

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

Package Details

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