Docs Home Pulumi IaC Pulumi ESC 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

aws-native logo

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>
    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]
    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)
public static Output<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ApplicationId string
    The application ID.
    EnvironmentId string
    The environment ID.
    ApplicationId string
    The application ID.
    EnvironmentId string
    The environment ID.
    applicationId String
    The application ID.
    environmentId String
    The environment ID.
    applicationId string
    The application ID.
    environmentId string
    The environment ID.
    application_id str
    The application ID.
    environment_id str
    The environment ID.
    applicationId String
    The application ID.
    environmentId 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 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 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 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 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 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 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 string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    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