@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:35.306Z") public class CfnEnvironment extends CfnResource implements IInspectable
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:
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnEnvironment(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnEnvironment(Construct scope, java.lang.String id, CfnEnvironmentProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getApplicationId()
public void setApplicationId(java.lang.String value)
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.Object getMonitors()
public void setMonitors(IResolvable value)
public void setMonitors(java.util.List<java.lang.Object> value)
public java.util.List<CfnEnvironment.TagsProperty> getTags()
Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
public void setTags(java.util.List<CfnEnvironment.TagsProperty> value)
Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.