software.amazon.awscdk.services.appconfig

Class CfnEnvironment

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.appconfig.CfnEnvironment

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.305Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEnvironment(software.constructs.Construct scope, 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
String	getApplicationId() The application ID.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description of the environment.
Object	getMonitors() Amazon CloudWatch alarms to monitor during the deployment process.
String	getName() A name for the environment.
List<CfnEnvironment.TagsProperty>	getTags() Metadata to assign to the environment.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationId(String value) The application ID.
void	setDescription(String value) A description of the environment.
void	setMonitors(IResolvable value) Amazon CloudWatch alarms to monitor during the deployment process.
void	setMonitors(List<Object> value) Amazon CloudWatch alarms to monitor during the deployment process.
void	setName(String value) A name for the environment.
void	setTags(List<CfnEnvironment.TagsProperty> value) Metadata to assign to the environment.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnEnvironment(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApplicationId

@Stability(value=Stable)
 @NotNull
public String getApplicationId()

The application ID.

setApplicationId

@Stability(value=Stable)
public void setApplicationId(@NotNull
                                                      String value)

The application ID.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

A name for the environment.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

A name for the environment.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description of the environment.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the environment.

getMonitors

@Stability(value=Stable)
 @Nullable
public Object getMonitors()

Amazon CloudWatch alarms to monitor during the deployment process.

setMonitors

@Stability(value=Stable)
public void setMonitors(@Nullable
                                                 IResolvable value)

Amazon CloudWatch alarms to monitor during the deployment process.

setMonitors

@Stability(value=Stable)
public void setMonitors(@Nullable
                                                 List<Object> value)

Amazon CloudWatch alarms to monitor during the deployment process.

getTags

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setTags(@Nullable
                                             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.