CfnEnvironment L1 construct
Specify an AWS Elastic Beanstalk environment by using the AWS::ElasticBeanstalk::Environment resource in an AWS CloudFormation template.
The AWS::ElasticBeanstalk::Environment resource is an AWS Elastic Beanstalk resource type that specifies an Elastic Beanstalk environment.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_elasticbeanstalk as elasticbeanstalk } from 'aws-cdk-lib';
const cfnEnvironment = new elasticbeanstalk.CfnEnvironment(this, 'MyCfnEnvironment', {
applicationName: 'applicationName',
// the properties below are optional
cnamePrefix: 'cnamePrefix',
description: 'description',
environmentName: 'environmentName',
operationsRole: 'operationsRole',
optionSettings: [{
namespace: 'namespace',
optionName: 'optionName',
// the properties below are optional
resourceName: 'resourceName',
value: 'value',
}],
platformArn: 'platformArn',
solutionStackName: 'solutionStackName',
tags: [{
key: 'key',
value: 'value',
}],
templateName: 'templateName',
tier: {
name: 'name',
type: 'type',
version: 'version',
},
versionLabel: 'versionLabel',
});
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_elasticbeanstalk as elasticbeanstalk
cfn_environment = elasticbeanstalk.CfnEnvironment(self, "MyCfnEnvironment",
application_name="applicationName",
# the properties below are optional
cname_prefix="cnamePrefix",
description="description",
environment_name="environmentName",
operations_role="operationsRole",
option_settings=[elasticbeanstalk.CfnEnvironment.OptionSettingProperty(
namespace="namespace",
option_name="optionName",
# the properties below are optional
resource_name="resourceName",
value="value"
)],
platform_arn="platformArn",
solution_stack_name="solutionStackName",
tags=[CfnTag(
key="key",
value="value"
)],
template_name="templateName",
tier=elasticbeanstalk.CfnEnvironment.TierProperty(
name="name",
type="type",
version="version"
),
version_label="versionLabel"
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.elasticbeanstalk.*;
CfnEnvironment cfnEnvironment = CfnEnvironment.Builder.create(this, "MyCfnEnvironment")
.applicationName("applicationName")
// the properties below are optional
.cnamePrefix("cnamePrefix")
.description("description")
.environmentName("environmentName")
.operationsRole("operationsRole")
.optionSettings(List.of(OptionSettingProperty.builder()
.namespace("namespace")
.optionName("optionName")
// the properties below are optional
.resourceName("resourceName")
.value("value")
.build()))
.platformArn("platformArn")
.solutionStackName("solutionStackName")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.templateName("templateName")
.tier(TierProperty.builder()
.name("name")
.type("type")
.version("version")
.build())
.versionLabel("versionLabel")
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ElasticBeanstalk;
var cfnEnvironment = new CfnEnvironment(this, "MyCfnEnvironment", new CfnEnvironmentProps {
ApplicationName = "applicationName",
// the properties below are optional
CnamePrefix = "cnamePrefix",
Description = "description",
EnvironmentName = "environmentName",
OperationsRole = "operationsRole",
OptionSettings = new [] { new OptionSettingProperty {
Namespace = "namespace",
OptionName = "optionName",
// the properties below are optional
ResourceName = "resourceName",
Value = "value"
} },
PlatformArn = "platformArn",
SolutionStackName = "solutionStackName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TemplateName = "templateName",
Tier = new TierProperty {
Name = "name",
Type = "type",
Version = "version"
},
VersionLabel = "versionLabel"
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnEnvironment := awscdk.Aws_elasticbeanstalk.NewCfnEnvironment(this, jsii.String("MyCfnEnvironment"), &CfnEnvironmentProps{
ApplicationName: jsii.String("applicationName"),
// the properties below are optional
CnamePrefix: jsii.String("cnamePrefix"),
Description: jsii.String("description"),
EnvironmentName: jsii.String("environmentName"),
OperationsRole: jsii.String("operationsRole"),
OptionSettings: []interface{}{
&OptionSettingProperty{
Namespace: jsii.String("namespace"),
OptionName: jsii.String("optionName"),
// the properties below are optional
ResourceName: jsii.String("resourceName"),
Value: jsii.String("value"),
},
},
PlatformArn: jsii.String("platformArn"),
SolutionStackName: jsii.String("solutionStackName"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TemplateName: jsii.String("templateName"),
Tier: &TierProperty{
Name: jsii.String("name"),
Type: jsii.String("type"),
Version: jsii.String("version"),
},
VersionLabel: jsii.String("versionLabel"),
})
Initializer
new CfnEnvironment(scope: Construct, id: string, props: CfnEnvironmentProps)
CfnEnvironment(scope: Construct, id: str, props: CfnEnvironmentProps)
new CfnEnvironment(Construct scope, String id, CfnEnvironmentProps props)
new CfnEnvironment(Construct scope, string id, CfnEnvironmentProps props)
NewCfnEnvironment(Scope Construct, Id *string, Props CfnEnvironmentProps)
Construct Props
applicationNamestring | IApplicationRefapplication_nametyping.Union[str, IApplicationRef]applicationNameStringApplicationNamestringApplicationNameinterface{}required#If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
environmentNamestringenvironment_namestrenvironmentNameStringEnvironmentNamestringEnvironmentName*string#notes
Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It can't start or end with a hyphen. This name must be unique within a region in your account.
If you don't specify the CNAMEPrefix parameter, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
If you don't specify an environment name, AWS CloudFormation generates a unique physical ID and uses that ID for the environment name. For more information, see Name Type .
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
operationsRolestringoperations_rolestroperationsRoleStringOperationsRolestringOperationsRole*string#notes
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. If specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this call and during subsequent calls acting on this environment. To specify an operations role, you must have the iam:PassRole permission for the role.
optionSettingsIResolvable | IResolvable | CfnEnvironment.OptionSettingProperty[]option_settingstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, OptionSettingProperty]]]optionSettingsIResolvableOptionSettingsIResolvableOptionSettingsinterface{}#notes
These options override the values that are defined in the solution stack or the configuration template . If you remove any options during a stack update, the removed options retain their current values.
notes
For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide .
If you specify
PlatformArn, don't specifySolutionStackName.
solutionStackNamestringsolution_stack_namestrsolutionStackNameStringSolutionStackNamestringSolutionStackName*string#notes
If specified, Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. For a list of current solution stacks, see Elastic Beanstalk Supported Platforms in the AWS Elastic Beanstalk Platforms guide.
If you specify
SolutionStackName, don't specifyPlatformArnorTemplateName.
templateNamestring | IConfigurationTemplateReftemplate_nametyping.Union[str, IConfigurationTemplateRef]templateNameStringTemplateNamestringTemplateNameinterface{}#If you specify
TemplateName, then don't specifySolutionStackName.
tierIResolvable | CfnEnvironment.TierPropertytiertyping.Union[IResolvable, TierProperty]tierIResolvableTierIResolvableTierinterface{}#The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
Properties
applicationNamestringapplication_namestrapplicationNameStringApplicationNamestringApplicationName*stringrequired#attrEndpointUrlstringattr_endpoint_urlstrattrEndpointUrlStringAttrEndpointUrlstringAttrEndpointUrl*stringrequired#Example load balancer URL:
Example instance IP address:
192.0.2.0
CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#environmentNamestringenvironment_namestrenvironmentNameStringEnvironmentNamestringEnvironmentName*string#environmentRefEnvironmentReferenceenvironment_refEnvironmentReferenceenvironmentRefEnvironmentReferenceEnvironmentRefEnvironmentReferenceEnvironmentRefEnvironmentReferencerequired#The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId).
operationsRolestringoperations_rolestroperationsRoleStringOperationsRolestringOperationsRole*string#optionSettingsIResolvable | IResolvable | CfnEnvironment.OptionSettingProperty[]option_settingstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, OptionSettingProperty]]]optionSettingsIResolvableOptionSettingsIResolvableOptionSettingsinterface{}#If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
solutionStackNamestringsolution_stack_namestrsolutionStackNameStringSolutionStackNamestringSolutionStackName*string#CfnElements must be defined within a stack scope (directly or indirectly).
tierIResolvable | CfnEnvironment.TierPropertytiertyping.Union[IResolvable, TierProperty]tierIResolvableTierIResolvableTierinterface{}#Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#notes · 2 parameters
To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.
Parameters
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:
cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnEnvironment(x: any): boolean@staticmethod def is_cfn_environment(x: Any) -> boolpublic static Boolean isCfnEnvironment(Object x)public static bool IsCfnEnvironment(object x)func IsCfnEnvironment(X interface{}) *boolstatic#isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.