Environment class

Provides an AppConfig Environment resource for an aws.appconfig.Application resource. One or more environments can be defined for an application.

Example Usage

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

const exampleApplication = new aws.appconfig.Application("example", {
    name: "example-application-tf",
    description: "Example AppConfig Application",
    tags: {
        Type: "AppConfig Application",
    },
});
const example = new aws.appconfig.Environment("example", {
    monitors: [{
        alarmArn: exampleAwsCloudwatchMetricAlarm.arn,
        alarmRoleArn: exampleAwsIamRole.arn,
    }],
    name: "example-environment-tf",
    description: "Example AppConfig Environment",
    applicationId: exampleApplication.id,
    tags: {
        Type: "AppConfig Environment",
    },
});
import pulumi
import pulumi_aws as aws

example_application = aws.appconfig.Application("example",
    name="example-application-tf",
    description="Example AppConfig Application",
    tags={
        "Type": "AppConfig Application",
    })
example = aws.appconfig.Environment("example",
    monitors=[{
        "alarm_arn": example_aws_cloudwatch_metric_alarm["arn"],
        "alarm_role_arn": example_aws_iam_role["arn"],
    }],
    name="example-environment-tf",
    description="Example AppConfig Environment",
    application_id=example_application.id,
    tags={
        "Type": "AppConfig Environment",
    })
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var exampleApplication = new Aws.AppConfig.Application("example", new()
    {
        Name = "example-application-tf",
        Description = "Example AppConfig Application",
        Tags =
        {
            { "Type", "AppConfig Application" },
        },
    });

    var example = new Aws.AppConfig.Environment("example", new()
    {
        Monitors = new[]
        {
            new Aws.AppConfig.Inputs.EnvironmentMonitorArgs
            {
                AlarmArn = exampleAwsCloudwatchMetricAlarm.Arn,
                AlarmRoleArn = exampleAwsIamRole.Arn,
            },
        },
        Name = "example-environment-tf",
        Description = "Example AppConfig Environment",
        ApplicationId = exampleApplication.Id,
        Tags =
        {
            { "Type", "AppConfig Environment" },
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleApplication, err := appconfig.NewApplication(ctx, "example", &appconfig.ApplicationArgs{
			Name:        pulumi.String("example-application-tf"),
			Description: pulumi.String("Example AppConfig Application"),
			Tags: pulumi.StringMap{
				"Type": pulumi.String("AppConfig Application"),
			},
		})
		if err != nil {
			return err
		}
		_, err = appconfig.NewEnvironment(ctx, "example", &appconfig.EnvironmentArgs{
			Monitors: appconfig.EnvironmentMonitorArray{
				&appconfig.EnvironmentMonitorArgs{
					AlarmArn:     pulumi.Any(exampleAwsCloudwatchMetricAlarm.Arn),
					AlarmRoleArn: pulumi.Any(exampleAwsIamRole.Arn),
				},
			},
			Name:          pulumi.String("example-environment-tf"),
			Description:   pulumi.String("Example AppConfig Environment"),
			ApplicationId: exampleApplication.ID().ToIDOutput().ToStringOutput(),
			Tags: pulumi.StringMap{
				"Type": pulumi.String("AppConfig Environment"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_appconfig_environment" "example" {
  monitors {
    alarm_arn      = exampleAwsCloudwatchMetricAlarm.arn
    alarm_role_arn = exampleAwsIamRole.arn
  }
  name           = "example-environment-tf"
  description    = "Example AppConfig Environment"
  application_id = aws_appconfig_application.example.id
  tags = {
    "Type" = "AppConfig Environment"
  }
}
resource "aws_appconfig_application" "example" {
  name        = "example-application-tf"
  description = "Example AppConfig Application"
  tags = {
    "Type" = "AppConfig Application"
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.appconfig.Application;
import com.pulumi.aws.appconfig.ApplicationArgs;
import com.pulumi.aws.appconfig.Environment;
import com.pulumi.aws.appconfig.EnvironmentArgs;
import com.pulumi.aws.appconfig.inputs.EnvironmentMonitorArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        var exampleApplication = new Application("exampleApplication", ApplicationArgs.builder()
            .name("example-application-tf")
            .description("Example AppConfig Application")
            .tags(Map.of("Type", "AppConfig Application"))
            .build());

        var example = new Environment("example", EnvironmentArgs.builder()
            .monitors(EnvironmentMonitorArgs.builder()
                .alarmArn(exampleAwsCloudwatchMetricAlarm.arn())
                .alarmRoleArn(exampleAwsIamRole.arn())
                .build())
            .name("example-environment-tf")
            .description("Example AppConfig Environment")
            .applicationId(exampleApplication.id())
            .tags(Map.of("Type", "AppConfig Environment"))
            .build());

    }
}
resources:
  example:
    type: aws:appconfig:Environment
    properties:
      monitors:
        - alarmArn: ${exampleAwsCloudwatchMetricAlarm.arn}
          alarmRoleArn: ${exampleAwsIamRole.arn}
      name: example-environment-tf
      description: Example AppConfig Environment
      applicationId: ${exampleApplication.id}
      tags:
        Type: AppConfig Environment
  exampleApplication:
    type: aws:appconfig:Application
    name: example
    properties:
      name: example-application-tf
      description: Example AppConfig Application
      tags:
        Type: AppConfig Application

Import

Using pulumi import, import AppConfig Environments using the environment ID and application ID separated by a colon (:). For example:

$ pulumi import aws:appconfig/environment:Environment example 71abcde:11xxxxx

Constructors

Environment(String name, {EnvironmentArgs? args, CustomResourceOptions? options})
Creates a new Environment. name The Pulumi resource name. args Arguments used to configure this Environment. The set of arguments for Environment. options Resource options controlling this resource's behavior.
Environment.reference(String urn)
Creates a typed reference to an existing Environment resource.

Properties

applicationId ↔ Output<String>
AppConfig application ID. Must be between 4 and 7 characters in length.
latefinal
arn ↔ Output<String>
ARN of the AppConfig Environment.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
description ↔ Output<String>
Description of the environment. Can be at most 1024 characters.
latefinal
environmentId ↔ Output<String>
AppConfig environment ID.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
monitors ↔ Output<List<EnvironmentMonitor>?>
Set of Amazon CloudWatch alarms to monitor during the deployment process. Maximum of 5. See Monitor below for more details.
latefinal
name ↔ Output<String>
Name for the environment. Must be between 1 and 64 characters in length.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state ↔ Output<String>
State of the environment. Possible values are READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK or ROLLED_BACK.
latefinal
tags ↔ Output<Map<String, String>?>
Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {EnvironmentState? state, CustomResourceOptions? options}) → Environment
Gets an existing Environment resource's state with the given name and id.