1. Packages
  2. AWS
  3. API Docs
  4. codecatalyst
  5. getDevEnvironment
AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi

aws.codecatalyst.getDevEnvironment

Explore with Pulumi AI

Data source for managing an AWS CodeCatalyst Dev Environment.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.codecatalyst.getDevEnvironment({
    spaceName: "myspace",
    projectName: "myproject",
    envId: exampleAwsCodecatalystDevEnvironment.id,
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.codecatalyst.get_dev_environment(space_name="myspace",
    project_name="myproject",
    env_id=example_aws_codecatalyst_dev_environment["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/codecatalyst"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := codecatalyst.LookupDevEnvironment(ctx, &codecatalyst.LookupDevEnvironmentArgs{
			SpaceName:   "myspace",
			ProjectName: "myproject",
			EnvId:       exampleAwsCodecatalystDevEnvironment.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.CodeCatalyst.GetDevEnvironment.Invoke(new()
    {
        SpaceName = "myspace",
        ProjectName = "myproject",
        EnvId = exampleAwsCodecatalystDevEnvironment.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.codecatalyst.CodecatalystFunctions;
import com.pulumi.aws.codecatalyst.inputs.GetDevEnvironmentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = CodecatalystFunctions.getDevEnvironment(GetDevEnvironmentArgs.builder()
            .spaceName("myspace")
            .projectName("myproject")
            .envId(exampleAwsCodecatalystDevEnvironment.id())
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: aws:codecatalyst:getDevEnvironment
      arguments:
        spaceName: myspace
        projectName: myproject
        envId: ${exampleAwsCodecatalystDevEnvironment.id}
Copy

Using getDevEnvironment

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 getDevEnvironment(args: GetDevEnvironmentArgs, opts?: InvokeOptions): Promise<GetDevEnvironmentResult>
function getDevEnvironmentOutput(args: GetDevEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetDevEnvironmentResult>
Copy
def get_dev_environment(alias: Optional[str] = None,
                        creator_id: Optional[str] = None,
                        env_id: Optional[str] = None,
                        project_name: Optional[str] = None,
                        repositories: Optional[Sequence[GetDevEnvironmentRepository]] = None,
                        space_name: Optional[str] = None,
                        tags: Optional[Mapping[str, str]] = None,
                        opts: Optional[InvokeOptions] = None) -> GetDevEnvironmentResult
def get_dev_environment_output(alias: Optional[pulumi.Input[str]] = None,
                        creator_id: Optional[pulumi.Input[str]] = None,
                        env_id: Optional[pulumi.Input[str]] = None,
                        project_name: Optional[pulumi.Input[str]] = None,
                        repositories: Optional[pulumi.Input[Sequence[pulumi.Input[GetDevEnvironmentRepositoryArgs]]]] = None,
                        space_name: Optional[pulumi.Input[str]] = None,
                        tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetDevEnvironmentResult]
Copy
func LookupDevEnvironment(ctx *Context, args *LookupDevEnvironmentArgs, opts ...InvokeOption) (*LookupDevEnvironmentResult, error)
func LookupDevEnvironmentOutput(ctx *Context, args *LookupDevEnvironmentOutputArgs, opts ...InvokeOption) LookupDevEnvironmentResultOutput
Copy

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

public static class GetDevEnvironment 
{
    public static Task<GetDevEnvironmentResult> InvokeAsync(GetDevEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetDevEnvironmentResult> Invoke(GetDevEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDevEnvironmentResult> getDevEnvironment(GetDevEnvironmentArgs args, InvokeOptions options)
public static Output<GetDevEnvironmentResult> getDevEnvironment(GetDevEnvironmentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:codecatalyst/getDevEnvironment:getDevEnvironment
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

EnvId This property is required. string
  • (Required) The system-generated unique ID of the Dev Environment for which you want to view information. To retrieve a list of Dev Environment IDs, use ListDevEnvironments.
ProjectName This property is required. string
The name of the project in the space.
SpaceName This property is required. string
The name of the space.
Alias string
The user-specified alias for the Dev Environment.
CreatorId string
The system-generated unique ID of the user who created the Dev Environment.
Repositories List<GetDevEnvironmentRepository>
The source repository that contains the branch to clone into the Dev Environment.
Tags Dictionary<string, string>
EnvId This property is required. string
  • (Required) The system-generated unique ID of the Dev Environment for which you want to view information. To retrieve a list of Dev Environment IDs, use ListDevEnvironments.
ProjectName This property is required. string
The name of the project in the space.
SpaceName This property is required. string
The name of the space.
Alias string
The user-specified alias for the Dev Environment.
CreatorId string
The system-generated unique ID of the user who created the Dev Environment.
Repositories []GetDevEnvironmentRepository
The source repository that contains the branch to clone into the Dev Environment.
Tags map[string]string
envId This property is required. String
  • (Required) The system-generated unique ID of the Dev Environment for which you want to view information. To retrieve a list of Dev Environment IDs, use ListDevEnvironments.
projectName This property is required. String
The name of the project in the space.
spaceName This property is required. String
The name of the space.
alias String
The user-specified alias for the Dev Environment.
creatorId String
The system-generated unique ID of the user who created the Dev Environment.
repositories List<GetDevEnvironmentRepository>
The source repository that contains the branch to clone into the Dev Environment.
tags Map<String,String>
envId This property is required. string
  • (Required) The system-generated unique ID of the Dev Environment for which you want to view information. To retrieve a list of Dev Environment IDs, use ListDevEnvironments.
projectName This property is required. string
The name of the project in the space.
spaceName This property is required. string
The name of the space.
alias string
The user-specified alias for the Dev Environment.
creatorId string
The system-generated unique ID of the user who created the Dev Environment.
repositories GetDevEnvironmentRepository[]
The source repository that contains the branch to clone into the Dev Environment.
tags {[key: string]: string}
env_id This property is required. str
  • (Required) The system-generated unique ID of the Dev Environment for which you want to view information. To retrieve a list of Dev Environment IDs, use ListDevEnvironments.
project_name This property is required. str
The name of the project in the space.
space_name This property is required. str
The name of the space.
alias str
The user-specified alias for the Dev Environment.
creator_id str
The system-generated unique ID of the user who created the Dev Environment.
repositories Sequence[GetDevEnvironmentRepository]
The source repository that contains the branch to clone into the Dev Environment.
tags Mapping[str, str]
envId This property is required. String
  • (Required) The system-generated unique ID of the Dev Environment for which you want to view information. To retrieve a list of Dev Environment IDs, use ListDevEnvironments.
projectName This property is required. String
The name of the project in the space.
spaceName This property is required. String
The name of the space.
alias String
The user-specified alias for the Dev Environment.
creatorId String
The system-generated unique ID of the user who created the Dev Environment.
repositories List<Property Map>
The source repository that contains the branch to clone into the Dev Environment.
tags Map<String>

getDevEnvironment Result

The following output properties are available:

EnvId string
Id string
The provider-assigned unique ID for this managed resource.
Ides List<GetDevEnvironmentIde>
Information about the integrated development environment (IDE) configured for a Dev Environment.
InactivityTimeoutMinutes int
The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.
InstanceType string
The Amazon EC2 instace type to use for the Dev Environment.
LastUpdatedTime string
The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
PersistentStorages List<GetDevEnvironmentPersistentStorage>
Information about the amount of storage allocated to the Dev Environment.
ProjectName string
SpaceName string
Status string
The current status of the Dev Environment. From: PENDING | RUNNING | STARTING | STOPPING | STOPPED | FAILED | DELETING | DELETED.
StatusReason string
The reason for the status.
Tags Dictionary<string, string>
Alias string
The user-specified alias for the Dev Environment.
CreatorId string
The system-generated unique ID of the user who created the Dev Environment.
Repositories List<GetDevEnvironmentRepository>
The source repository that contains the branch to clone into the Dev Environment.
EnvId string
Id string
The provider-assigned unique ID for this managed resource.
Ides []GetDevEnvironmentIde
Information about the integrated development environment (IDE) configured for a Dev Environment.
InactivityTimeoutMinutes int
The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.
InstanceType string
The Amazon EC2 instace type to use for the Dev Environment.
LastUpdatedTime string
The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
PersistentStorages []GetDevEnvironmentPersistentStorage
Information about the amount of storage allocated to the Dev Environment.
ProjectName string
SpaceName string
Status string
The current status of the Dev Environment. From: PENDING | RUNNING | STARTING | STOPPING | STOPPED | FAILED | DELETING | DELETED.
StatusReason string
The reason for the status.
Tags map[string]string
Alias string
The user-specified alias for the Dev Environment.
CreatorId string
The system-generated unique ID of the user who created the Dev Environment.
Repositories []GetDevEnvironmentRepository
The source repository that contains the branch to clone into the Dev Environment.
envId String
id String
The provider-assigned unique ID for this managed resource.
ides List<GetDevEnvironmentIde>
Information about the integrated development environment (IDE) configured for a Dev Environment.
inactivityTimeoutMinutes Integer
The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.
instanceType String
The Amazon EC2 instace type to use for the Dev Environment.
lastUpdatedTime String
The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
persistentStorages List<GetDevEnvironmentPersistentStorage>
Information about the amount of storage allocated to the Dev Environment.
projectName String
spaceName String
status String
The current status of the Dev Environment. From: PENDING | RUNNING | STARTING | STOPPING | STOPPED | FAILED | DELETING | DELETED.
statusReason String
The reason for the status.
tags Map<String,String>
alias String
The user-specified alias for the Dev Environment.
creatorId String
The system-generated unique ID of the user who created the Dev Environment.
repositories List<GetDevEnvironmentRepository>
The source repository that contains the branch to clone into the Dev Environment.
envId string
id string
The provider-assigned unique ID for this managed resource.
ides GetDevEnvironmentIde[]
Information about the integrated development environment (IDE) configured for a Dev Environment.
inactivityTimeoutMinutes number
The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.
instanceType string
The Amazon EC2 instace type to use for the Dev Environment.
lastUpdatedTime string
The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
persistentStorages GetDevEnvironmentPersistentStorage[]
Information about the amount of storage allocated to the Dev Environment.
projectName string
spaceName string
status string
The current status of the Dev Environment. From: PENDING | RUNNING | STARTING | STOPPING | STOPPED | FAILED | DELETING | DELETED.
statusReason string
The reason for the status.
tags {[key: string]: string}
alias string
The user-specified alias for the Dev Environment.
creatorId string
The system-generated unique ID of the user who created the Dev Environment.
repositories GetDevEnvironmentRepository[]
The source repository that contains the branch to clone into the Dev Environment.
env_id str
id str
The provider-assigned unique ID for this managed resource.
ides Sequence[GetDevEnvironmentIde]
Information about the integrated development environment (IDE) configured for a Dev Environment.
inactivity_timeout_minutes int
The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.
instance_type str
The Amazon EC2 instace type to use for the Dev Environment.
last_updated_time str
The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
persistent_storages Sequence[GetDevEnvironmentPersistentStorage]
Information about the amount of storage allocated to the Dev Environment.
project_name str
space_name str
status str
The current status of the Dev Environment. From: PENDING | RUNNING | STARTING | STOPPING | STOPPED | FAILED | DELETING | DELETED.
status_reason str
The reason for the status.
tags Mapping[str, str]
alias str
The user-specified alias for the Dev Environment.
creator_id str
The system-generated unique ID of the user who created the Dev Environment.
repositories Sequence[GetDevEnvironmentRepository]
The source repository that contains the branch to clone into the Dev Environment.
envId String
id String
The provider-assigned unique ID for this managed resource.
ides List<Property Map>
Information about the integrated development environment (IDE) configured for a Dev Environment.
inactivityTimeoutMinutes Number
The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.
instanceType String
The Amazon EC2 instace type to use for the Dev Environment.
lastUpdatedTime String
The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
persistentStorages List<Property Map>
Information about the amount of storage allocated to the Dev Environment.
projectName String
spaceName String
status String
The current status of the Dev Environment. From: PENDING | RUNNING | STARTING | STOPPING | STOPPED | FAILED | DELETING | DELETED.
statusReason String
The reason for the status.
tags Map<String>
alias String
The user-specified alias for the Dev Environment.
creatorId String
The system-generated unique ID of the user who created the Dev Environment.
repositories List<Property Map>
The source repository that contains the branch to clone into the Dev Environment.

Supporting Types

GetDevEnvironmentIde

Name This property is required. string
Runtime This property is required. string
Name This property is required. string
Runtime This property is required. string
name This property is required. String
runtime This property is required. String
name This property is required. string
runtime This property is required. string
name This property is required. str
runtime This property is required. str
name This property is required. String
runtime This property is required. String

GetDevEnvironmentPersistentStorage

Size This property is required. int
Size This property is required. int
size This property is required. Integer
size This property is required. number
size This property is required. int
size This property is required. Number

GetDevEnvironmentRepository

BranchName This property is required. string
RepositoryName This property is required. string
BranchName This property is required. string
RepositoryName This property is required. string
branchName This property is required. String
repositoryName This property is required. String
branchName This property is required. string
repositoryName This property is required. string
branch_name This property is required. str
repository_name This property is required. str
branchName This property is required. String
repositoryName This property is required. String

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.