software.amazon.awscdk.services.appconfig

Class CfnEnvironment

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.appconfig.CfnEnvironment

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.306Z")
public class CfnEnvironment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppConfig::Environment`.

The AWS::AppConfig::Environment resource creates an environment, which is a logical deployment group of AWS AppConfig targets, such as applications in a Beta or Production environment. You define one or more environments for each AWS AppConfig application. You can also define environments for application subcomponents such as the Web , Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

• Create an application
• Create an environment
• Create a configuration profile
• Create a deployment strategy
• Deploy the configuration

For more information, see AWS AppConfig in the AWS AppConfig User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appconfig.*;
 CfnEnvironment cfnEnvironment = CfnEnvironment.Builder.create(this, "MyCfnEnvironment")
         .applicationId("applicationId")
         .name("name")
         // the properties below are optional
         .description("description")
         .monitors(List.of(MonitorsProperty.builder()
                 .alarmArn("alarmArn")
                 .alarmRoleArn("alarmRoleArn")
                 .build()))
         .tags(List.of(TagsProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnEnvironment.Builder A fluent builder for CfnEnvironment.
static interface	CfnEnvironment.MonitorsProperty Amazon CloudWatch alarms to monitor during the deployment process.
static interface	CfnEnvironment.TagsProperty Metadata to assign to the environment.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEnvironment(Construct scope, java.lang.String id, CfnEnvironmentProps props) Create a new `AWS::AppConfig::Environment`.
protected	CfnEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEnvironment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApplicationId() The application ID.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() A description of the environment.
java.lang.Object	getMonitors() Amazon CloudWatch alarms to monitor during the deployment process.
java.lang.String	getName() A name for the environment.
java.util.List<CfnEnvironment.TagsProperty>	getTags() Metadata to assign to the environment.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setApplicationId(java.lang.String value) The application ID.
void	setDescription(java.lang.String value) A description of the environment.
void	setMonitors(IResolvable value) Amazon CloudWatch alarms to monitor during the deployment process.
void	setMonitors(java.util.List<java.lang.Object> value) Amazon CloudWatch alarms to monitor during the deployment process.
void	setName(java.lang.String value) A name for the environment.
void	setTags(java.util.List<CfnEnvironment.TagsProperty> value) Metadata to assign to the environment.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEnvironment

protected CfnEnvironment(software.amazon.jsii.JsiiObjectRef objRef)

CfnEnvironment

protected CfnEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEnvironment

public CfnEnvironment(Construct scope,
                      java.lang.String id,
                      CfnEnvironmentProps props)

Create a new `AWS::AppConfig::Environment`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApplicationId

public java.lang.String getApplicationId()

The application ID.

setApplicationId

public void setApplicationId(java.lang.String value)

The application ID.

getName

public java.lang.String getName()

A name for the environment.

setName

public void setName(java.lang.String value)

A name for the environment.

getDescription

public java.lang.String getDescription()

A description of the environment.

setDescription

public void setDescription(java.lang.String value)

A description of the environment.

getMonitors

public java.lang.Object getMonitors()

Amazon CloudWatch alarms to monitor during the deployment process.

setMonitors

public void setMonitors(IResolvable value)

Amazon CloudWatch alarms to monitor during the deployment process.

setMonitors

public void setMonitors(java.util.List<java.lang.Object> value)

Amazon CloudWatch alarms to monitor during the deployment process.

getTags

public java.util.List<CfnEnvironment.TagsProperty> getTags()

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.

setTags

public void setTags(java.util.List<CfnEnvironment.TagsProperty> value)

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.