Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. appconfig
  5. getEnvironment

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.appconfig.getEnvironment

Explore with Pulumi AI

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::AppConfig::Environment

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(application_id: Optional[str] = None,
                    environment_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEnvironmentResult
def get_environment_output(application_id: Optional[pulumi.Input[str]] = None,
                    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:appconfig:getEnvironment
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ApplicationId This property is required. string
The application ID.
EnvironmentId This property is required. string
The environment ID.
ApplicationId This property is required. string
The application ID.
EnvironmentId This property is required. string
The environment ID.
applicationId This property is required. String
The application ID.
environmentId This property is required. String
The environment ID.
applicationId This property is required. string
The application ID.
environmentId This property is required. string
The environment ID.
application_id This property is required. str
The application ID.
environment_id This property is required. str
The environment ID.
applicationId This property is required. String
The application ID.
environmentId This property is required. String
The environment ID.

getEnvironment Result

The following output properties are available:

Description string
A description of the environment.
EnvironmentId string
The environment ID.
Monitors List<Pulumi.AwsNative.AppConfig.Outputs.EnvironmentMonitor>
Amazon CloudWatch alarms to monitor during the deployment process.
Name string
A name for the environment.
Tags List<Pulumi.AwsNative.Outputs.Tag>
Metadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
Description string
A description of the environment.
EnvironmentId string
The environment ID.
Monitors []EnvironmentMonitor
Amazon CloudWatch alarms to monitor during the deployment process.
Name string
A name for the environment.
Tags Tag
Metadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
description String
A description of the environment.
environmentId String
The environment ID.
monitors List<EnvironmentMonitor>
Amazon CloudWatch alarms to monitor during the deployment process.
name String
A name for the environment.
tags List<Tag>
Metadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
description string
A description of the environment.
environmentId string
The environment ID.
monitors EnvironmentMonitor[]
Amazon CloudWatch alarms to monitor during the deployment process.
name string
A name for the environment.
tags Tag[]
Metadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
description str
A description of the environment.
environment_id str
The environment ID.
monitors Sequence[EnvironmentMonitor]
Amazon CloudWatch alarms to monitor during the deployment process.
name str
A name for the environment.
tags Sequence[root_Tag]
Metadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
description String
A description of the environment.
environmentId String
The environment ID.
monitors List<Property Map>
Amazon CloudWatch alarms to monitor during the deployment process.
name String
A name for the environment.
tags List<Property Map>
Metadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

Supporting Types

EnvironmentMonitor

AlarmArn This property is required. string
Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
AlarmRoleArn string
ARN of an AWS Identity and Access Management (IAM) role for AWS AppConfig to monitor AlarmArn.
AlarmArn This property is required. string
Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
AlarmRoleArn string
ARN of an AWS Identity and Access Management (IAM) role for AWS AppConfig to monitor AlarmArn.
alarmArn This property is required. String
Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
alarmRoleArn String
ARN of an AWS Identity and Access Management (IAM) role for AWS AppConfig to monitor AlarmArn.
alarmArn This property is required. string
Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
alarmRoleArn string
ARN of an AWS Identity and Access Management (IAM) role for AWS AppConfig to monitor AlarmArn.
alarm_arn This property is required. str
Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
alarm_role_arn str
ARN of an AWS Identity and Access Management (IAM) role for AWS AppConfig to monitor AlarmArn.
alarmArn This property is required. String
Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
alarmRoleArn String
ARN of an AWS Identity and Access Management (IAM) role for AWS AppConfig to monitor AlarmArn.

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

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.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native