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:
- Environment
Id string Unique identifier for representing FinSpace Environment
- Environment
Id string Unique identifier for representing FinSpace Environment
- environment
Id String Unique identifier for representing FinSpace Environment
- environment
Id string Unique identifier for representing FinSpace Environment
- environment_
id str Unique identifier for representing FinSpace Environment
- environment
Id String Unique identifier for representing FinSpace Environment
getEnvironment Result
The following output properties are available:
- Aws
Account stringId AWS account ID associated with the Environment
- Dedicated
Service stringAccount Id ID for FinSpace created account used to store Environment artifacts
- Description string
Description of the Environment
- 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
- Federation
Mode Pulumi.Aws Native. Fin Space. Environment Federation Mode Federation mode used with the Environment
- Federation
Parameters Pulumi.Aws Native. Fin Space. Outputs. Environment Federation Parameters - Name string
Name of the Environment
- 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
- Description string
Description of the Environment
- 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
- Federation
Mode EnvironmentFederation Mode Federation mode used with the Environment
- Federation
Parameters EnvironmentFederation Parameters - Name string
Name of the Environment
- 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
- description String
Description of the Environment
- 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
- federation
Mode EnvironmentFederation Mode Federation mode used with the Environment
- federation
Parameters EnvironmentFederation Parameters - name String
Name of the Environment
- 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
- description string
Description of the Environment
- 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
- federation
Mode EnvironmentFederation Mode Federation mode used with the Environment
- federation
Parameters EnvironmentFederation Parameters - name string
Name of the Environment
- 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
- 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 EnvironmentFederation Mode Federation mode used with the Environment
- federation_
parameters EnvironmentFederation Parameters - name str
Name of the Environment
- 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
- description String
Description of the Environment
- 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
- federation
Mode "LOCAL" | "FEDERATED" Federation mode used with the Environment
- federation
Parameters Property Map - name String
Name of the Environment
- 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
EnvironmentFederationMode
EnvironmentFederationParameters
- Application
Call stringBack URL SAML metadata URL to link with the Environment
- Attribute
Map object 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 interface{} 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 Object 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 any 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 Any 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 Any 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
EnvironmentStatus
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0