software.amazon.awscdk.services.elasticbeanstalk

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.elasticbeanstalk.CfnEnvironment

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:17.497Z")
 @Stability(value=Stable)
public class CfnEnvironment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ElasticBeanstalk::Environment`.

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.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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnEnvironment.Builder A fluent builder for CfnEnvironment.
static interface	CfnEnvironment.OptionSettingProperty Example:
static interface	CfnEnvironment.TierProperty Example:

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::ElasticBeanstalk::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	getApplicationName() `AWS::ElasticBeanstalk::Environment.ApplicationName`.
String	getAttrEndpointUrl()
protected Map<String,Object>	getCfnProperties()
String	getCnamePrefix() `AWS::ElasticBeanstalk::Environment.CNAMEPrefix`.
String	getDescription() `AWS::ElasticBeanstalk::Environment.Description`.
String	getEnvironmentName() `AWS::ElasticBeanstalk::Environment.EnvironmentName`.
String	getOperationsRole() `AWS::ElasticBeanstalk::Environment.OperationsRole`.
Object	getOptionSettings() `AWS::ElasticBeanstalk::Environment.OptionSettings`.
String	getPlatformArn() `AWS::ElasticBeanstalk::Environment.PlatformArn`.
String	getSolutionStackName() `AWS::ElasticBeanstalk::Environment.SolutionStackName`.
TagManager	getTags() `AWS::ElasticBeanstalk::Environment.Tags`.
String	getTemplateName() `AWS::ElasticBeanstalk::Environment.TemplateName`.
Object	getTier() `AWS::ElasticBeanstalk::Environment.Tier`.
String	getVersionLabel() `AWS::ElasticBeanstalk::Environment.VersionLabel`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationName(String value) `AWS::ElasticBeanstalk::Environment.ApplicationName`.
void	setCnamePrefix(String value) `AWS::ElasticBeanstalk::Environment.CNAMEPrefix`.
void	setDescription(String value) `AWS::ElasticBeanstalk::Environment.Description`.
void	setEnvironmentName(String value) `AWS::ElasticBeanstalk::Environment.EnvironmentName`.
void	setOperationsRole(String value) `AWS::ElasticBeanstalk::Environment.OperationsRole`.
void	setOptionSettings(IResolvable value) `AWS::ElasticBeanstalk::Environment.OptionSettings`.
void	setOptionSettings(List<Object> value) `AWS::ElasticBeanstalk::Environment.OptionSettings`.
void	setPlatformArn(String value) `AWS::ElasticBeanstalk::Environment.PlatformArn`.
void	setSolutionStackName(String value) `AWS::ElasticBeanstalk::Environment.SolutionStackName`.
void	setTemplateName(String value) `AWS::ElasticBeanstalk::Environment.TemplateName`.
void	setTier(CfnEnvironment.TierProperty value) `AWS::ElasticBeanstalk::Environment.Tier`.
void	setTier(IResolvable value) `AWS::ElasticBeanstalk::Environment.Tier`.
void	setVersionLabel(String value) `AWS::ElasticBeanstalk::Environment.VersionLabel`.

Methods inherited from class software.amazon.awscdk.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.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::ElasticBeanstalk::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.

getApplicationName

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

`AWS::ElasticBeanstalk::Environment.ApplicationName`.

setApplicationName

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

`AWS::ElasticBeanstalk::Environment.ApplicationName`.

getAttrEndpointUrl

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getCnamePrefix

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

`AWS::ElasticBeanstalk::Environment.CNAMEPrefix`.

setCnamePrefix

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

`AWS::ElasticBeanstalk::Environment.CNAMEPrefix`.

getDescription

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

`AWS::ElasticBeanstalk::Environment.Description`.

setDescription

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

`AWS::ElasticBeanstalk::Environment.Description`.

getEnvironmentName

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

`AWS::ElasticBeanstalk::Environment.EnvironmentName`.

setEnvironmentName

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

`AWS::ElasticBeanstalk::Environment.EnvironmentName`.

getOperationsRole

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

`AWS::ElasticBeanstalk::Environment.OperationsRole`.

setOperationsRole

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

`AWS::ElasticBeanstalk::Environment.OperationsRole`.

getOptionSettings

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

`AWS::ElasticBeanstalk::Environment.OptionSettings`.

setOptionSettings

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

`AWS::ElasticBeanstalk::Environment.OptionSettings`.

setOptionSettings

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

`AWS::ElasticBeanstalk::Environment.OptionSettings`.

getPlatformArn

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

`AWS::ElasticBeanstalk::Environment.PlatformArn`.

setPlatformArn

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

`AWS::ElasticBeanstalk::Environment.PlatformArn`.

getSolutionStackName

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

`AWS::ElasticBeanstalk::Environment.SolutionStackName`.

setSolutionStackName

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

`AWS::ElasticBeanstalk::Environment.SolutionStackName`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::ElasticBeanstalk::Environment.Tags`.

getTemplateName

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

`AWS::ElasticBeanstalk::Environment.TemplateName`.

setTemplateName

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

`AWS::ElasticBeanstalk::Environment.TemplateName`.

getTier

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

`AWS::ElasticBeanstalk::Environment.Tier`.

setTier

@Stability(value=Stable)
public void setTier(@Nullable
                                             CfnEnvironment.TierProperty value)

`AWS::ElasticBeanstalk::Environment.Tier`.

setTier

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

`AWS::ElasticBeanstalk::Environment.Tier`.

getVersionLabel

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

`AWS::ElasticBeanstalk::Environment.VersionLabel`.

setVersionLabel

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

`AWS::ElasticBeanstalk::Environment.VersionLabel`.