AWS Classic v5.33.0, Mar 24 23

aws.appconfig.getEnvironment

Provides access to an AppConfig Environment.

Example Usage

Basic Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.AppConfig.GetEnvironment.Invoke(new()
    {
        ApplicationId = "b5d5gpj",
        EnvironmentId = "qrbb1c1",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/appconfig"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := appconfig.LookupEnvironment(ctx, &appconfig.LookupEnvironmentArgs{
			ApplicationId: "b5d5gpj",
			EnvironmentId: "qrbb1c1",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.appconfig.AppconfigFunctions;
import com.pulumi.aws.appconfig.inputs.GetEnvironmentArgs;
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 = AppconfigFunctions.getEnvironment(GetEnvironmentArgs.builder()
            .applicationId("b5d5gpj")
            .environmentId("qrbb1c1")
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.appconfig.get_environment(application_id="b5d5gpj",
    environment_id="qrbb1c1")

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

const example = aws.appconfig.getEnvironment({
    applicationId: "b5d5gpj",
    environmentId: "qrbb1c1",
});

variables:
  example:
    fn::invoke:
      Function: aws:appconfig:getEnvironment
      Arguments:
        applicationId: b5d5gpj
        environmentId: qrbb1c1

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(application_id: Optional[str] = None,
                    environment_id: Optional[str] = None,
                    tags: Optional[Mapping[str, 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,
                    tags: Optional[pulumi.Input[Mapping[str, 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:appconfig/getEnvironment:getEnvironment
  arguments:
    # arguments dictionary

The following arguments are supported:

ApplicationId string: ID of the AppConfig Application to which this Environment belongs.
EnvironmentId string: ID of the AppConfig Environment.
Tags Dictionary<string, string>: Map of tags for the resource.

ApplicationId string: ID of the AppConfig Application to which this Environment belongs.
EnvironmentId string: ID of the AppConfig Environment.
Tags map[string]string: Map of tags for the resource.

applicationId String: ID of the AppConfig Application to which this Environment belongs.
environmentId String: ID of the AppConfig Environment.
tags Map<String,String>: Map of tags for the resource.

applicationId string: ID of the AppConfig Application to which this Environment belongs.
environmentId string: ID of the AppConfig Environment.
tags {[key: string]: string}: Map of tags for the resource.

application_id str: ID of the AppConfig Application to which this Environment belongs.
environment_id str: ID of the AppConfig Environment.
tags Mapping[str, str]: Map of tags for the resource.

applicationId String: ID of the AppConfig Application to which this Environment belongs.
environmentId String: ID of the AppConfig Environment.
tags Map<String>: Map of tags for the resource.

getEnvironment Result

The following output properties are available:

ApplicationId string
Arn string: ARN of the environment.
Description string: Name of the environment.
EnvironmentId string
Id string: The provider-assigned unique ID for this managed resource.
Monitors List<GetEnvironmentMonitor>: Set of Amazon CloudWatch alarms to monitor during the deployment process.
Name string: Name of the environment.
State string: State of the environment. Possible values are READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK or ROLLED_BACK.
Tags Dictionary<string, string>: Map of tags for the resource.

ApplicationId string
Arn string: ARN of the environment.
Description string: Name of the environment.
EnvironmentId string
Id string: The provider-assigned unique ID for this managed resource.
Monitors []GetEnvironmentMonitor: Set of Amazon CloudWatch alarms to monitor during the deployment process.
Name string: Name of the environment.
State string: State of the environment. Possible values are READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK or ROLLED_BACK.
Tags map[string]string: Map of tags for the resource.

applicationId String
arn String: ARN of the environment.
description String: Name of the environment.
environmentId String
id String: The provider-assigned unique ID for this managed resource.
monitors List<GetEnvironmentMonitor>: Set of Amazon CloudWatch alarms to monitor during the deployment process.
name String: Name of the environment.
state String: State of the environment. Possible values are READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK or ROLLED_BACK.
tags Map<String,String>: Map of tags for the resource.

applicationId string
arn string: ARN of the environment.
description string: Name of the environment.
environmentId string
id string: The provider-assigned unique ID for this managed resource.
monitors GetEnvironmentMonitor[]: Set of Amazon CloudWatch alarms to monitor during the deployment process.
name string: Name of the environment.
state string: State of the environment. Possible values are READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK or ROLLED_BACK.
tags {[key: string]: string}: Map of tags for the resource.

application_id str
arn str: ARN of the environment.
description str: Name of the environment.
environment_id str
id str: The provider-assigned unique ID for this managed resource.
monitors Sequence[GetEnvironmentMonitor]: Set of Amazon CloudWatch alarms to monitor during the deployment process.
name str: Name of the environment.
state str: State of the environment. Possible values are READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK or ROLLED_BACK.
tags Mapping[str, str]: Map of tags for the resource.

applicationId String
arn String: ARN of the environment.
description String: Name of the environment.
environmentId String
id String: The provider-assigned unique ID for this managed resource.
monitors List<Property Map>: Set of Amazon CloudWatch alarms to monitor during the deployment process.
name String: Name of the environment.
state String: State of the environment. Possible values are READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK or ROLLED_BACK.
tags Map<String>: Map of tags for the resource.

Supporting Types

GetEnvironmentMonitor

AlarmArn string: ARN of the Amazon CloudWatch alarm.
AlarmRoleArn string: ARN of an IAM role for AWS AppConfig to monitor.

AlarmArn string: ARN of the Amazon CloudWatch alarm.
AlarmRoleArn string: ARN of an IAM role for AWS AppConfig to monitor.

alarmArn String: ARN of the Amazon CloudWatch alarm.
alarmRoleArn String: ARN of an IAM role for AWS AppConfig to monitor.

alarmArn string: ARN of the Amazon CloudWatch alarm.
alarmRoleArn string: ARN of an IAM role for AWS AppConfig to monitor.

alarm_arn str: ARN of the Amazon CloudWatch alarm.
alarm_role_arn str: ARN of an IAM role for AWS AppConfig to monitor.

alarmArn String: ARN of the Amazon CloudWatch alarm.
alarmRoleArn String: ARN of an IAM role for AWS AppConfig to monitor.

Package Details

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