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

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.Environment

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

Create Environment Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Environment(name: string, args: EnvironmentArgs, opts?: CustomResourceOptions);
@overload
def Environment(resource_name: str,
                args: EnvironmentArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def Environment(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                application_id: Optional[str] = None,
                deletion_protection_check: Optional[EnvironmentDeletionProtectionCheck] = None,
                description: Optional[str] = None,
                monitors: Optional[Sequence[EnvironmentMonitorArgs]] = None,
                name: Optional[str] = None,
                tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)
public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)

type: aws-native:appconfig:Environment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EnvironmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EnvironmentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EnvironmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EnvironmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EnvironmentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Environment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Environment resource accepts the following input properties:

ApplicationId This property is required. string
The application ID.
DeletionProtectionCheck Pulumi.AwsNative.AppConfig.EnvironmentDeletionProtectionCheck
On resource deletion this controls whether the Deletion Protection check should be applied, bypassed, or (the default) whether the behavior should be controlled by the account-level Deletion Protection setting. See https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html
Description string
A description of the environment.
Monitors List<Pulumi.AwsNative.AppConfig.Inputs.EnvironmentMonitor>
Amazon CloudWatch alarms to monitor during the deployment process.
Name string
A name for the environment.
Tags List<Pulumi.AwsNative.Inputs.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.
ApplicationId This property is required. string
The application ID.
DeletionProtectionCheck EnvironmentDeletionProtectionCheck
On resource deletion this controls whether the Deletion Protection check should be applied, bypassed, or (the default) whether the behavior should be controlled by the account-level Deletion Protection setting. See https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html
Description string
A description of the environment.
Monitors []EnvironmentMonitorArgs
Amazon CloudWatch alarms to monitor during the deployment process.
Name string
A name for the environment.
Tags TagArgs
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.
applicationId This property is required. String
The application ID.
deletionProtectionCheck EnvironmentDeletionProtectionCheck
On resource deletion this controls whether the Deletion Protection check should be applied, bypassed, or (the default) whether the behavior should be controlled by the account-level Deletion Protection setting. See https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html
description String
A description of the environment.
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.
applicationId This property is required. string
The application ID.
deletionProtectionCheck EnvironmentDeletionProtectionCheck
On resource deletion this controls whether the Deletion Protection check should be applied, bypassed, or (the default) whether the behavior should be controlled by the account-level Deletion Protection setting. See https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html
description string
A description of the environment.
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.
application_id This property is required. str
The application ID.
deletion_protection_check EnvironmentDeletionProtectionCheck
On resource deletion this controls whether the Deletion Protection check should be applied, bypassed, or (the default) whether the behavior should be controlled by the account-level Deletion Protection setting. See https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html
description str
A description of the environment.
monitors Sequence[EnvironmentMonitorArgs]
Amazon CloudWatch alarms to monitor during the deployment process.
name str
A name for the environment.
tags Sequence[TagArgs]
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.
applicationId This property is required. String
The application ID.
deletionProtectionCheck "ACCOUNT_DEFAULT" | "APPLY" | "BYPASS"
On resource deletion this controls whether the Deletion Protection check should be applied, bypassed, or (the default) whether the behavior should be controlled by the account-level Deletion Protection setting. See https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html
description String
A description of the environment.
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Environment resource produces the following output properties:

EnvironmentId string
The environment ID.
Id string
The provider-assigned unique ID for this managed resource.
EnvironmentId string
The environment ID.
Id string
The provider-assigned unique ID for this managed resource.
environmentId String
The environment ID.
id String
The provider-assigned unique ID for this managed resource.
environmentId string
The environment ID.
id string
The provider-assigned unique ID for this managed resource.
environment_id str
The environment ID.
id str
The provider-assigned unique ID for this managed resource.
environmentId String
The environment ID.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

EnvironmentDeletionProtectionCheck
, EnvironmentDeletionProtectionCheckArgs

AccountDefault
ACCOUNT_DEFAULT
Apply
APPLY
Bypass
BYPASS
EnvironmentDeletionProtectionCheckAccountDefault
ACCOUNT_DEFAULT
EnvironmentDeletionProtectionCheckApply
APPLY
EnvironmentDeletionProtectionCheckBypass
BYPASS
AccountDefault
ACCOUNT_DEFAULT
Apply
APPLY
Bypass
BYPASS
AccountDefault
ACCOUNT_DEFAULT
Apply
APPLY
Bypass
BYPASS
ACCOUNT_DEFAULT
ACCOUNT_DEFAULT
APPLY
APPLY
BYPASS
BYPASS
"ACCOUNT_DEFAULT"
ACCOUNT_DEFAULT
"APPLY"
APPLY
"BYPASS"
BYPASS

EnvironmentMonitor
, EnvironmentMonitorArgs

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
, TagArgs

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