software.amazon.awscdk.services.elasticbeanstalk

Class CfnApplication

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.CfnApplication

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:39.014Z")
 @Stability(value=Stable)
public class CfnApplication
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ElasticBeanstalk::Application`.

Specify an AWS Elastic Beanstalk application by using the AWS::ElasticBeanstalk::Application resource in an AWS CloudFormation template.

The AWS::ElasticBeanstalk::Application resource is an AWS Elastic Beanstalk Beanstalk resource type that specifies an Elastic Beanstalk application.

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.*;
 CfnApplication cfnApplication = CfnApplication.Builder.create(this, "MyCfnApplication")
         .applicationName("applicationName")
         .description("description")
         .resourceLifecycleConfig(ApplicationResourceLifecycleConfigProperty.builder()
                 .serviceRole("serviceRole")
                 .versionLifecycleConfig(ApplicationVersionLifecycleConfigProperty.builder()
                         .maxAgeRule(MaxAgeRuleProperty.builder()
                                 .deleteSourceFromS3(false)
                                 .enabled(false)
                                 .maxAgeInDays(123)
                                 .build())
                         .maxCountRule(MaxCountRuleProperty.builder()
                                 .deleteSourceFromS3(false)
                                 .enabled(false)
                                 .maxCount(123)
                                 .build())
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnApplication.ApplicationResourceLifecycleConfigProperty Use the `ApplicationResourceLifecycleConfig` property type to specify lifecycle settings for resources that belong to an AWS Elastic Beanstalk application when defining an AWS::ElasticBeanstalk::Application resource in an AWS CloudFormation template.
static interface	CfnApplication.ApplicationVersionLifecycleConfigProperty Use the `ApplicationVersionLifecycleConfig` property type to specify application version lifecycle settings for an AWS Elastic Beanstalk application when defining an AWS::ElasticBeanstalk::Application resource in an AWS CloudFormation template.
static class	CfnApplication.Builder A fluent builder for CfnApplication.
static interface	CfnApplication.MaxAgeRuleProperty Use the `MaxAgeRule` property type to specify a max age rule to restrict the length of time that application versions are retained for an AWS Elastic Beanstalk application when defining an AWS::ElasticBeanstalk::Application resource in an AWS CloudFormation template.
static interface	CfnApplication.MaxCountRuleProperty Use the `MaxAgeRule` property type to specify a max count rule to restrict the number of application versions that are retained for an AWS Elastic Beanstalk application when defining an AWS::ElasticBeanstalk::Application resource in an AWS CloudFormation template.

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
	CfnApplication(software.constructs.Construct scope, String id) Create a new `AWS::ElasticBeanstalk::Application`.
	CfnApplication(software.constructs.Construct scope, String id, CfnApplicationProps props) Create a new `AWS::ElasticBeanstalk::Application`.
protected	CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApplication(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getApplicationName() A name for the Elastic Beanstalk application.
protected Map<String,Object>	getCfnProperties()
String	getDescription() Your description of the application.
Object	getResourceLifecycleConfig() Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationName(String value) A name for the Elastic Beanstalk application.
void	setDescription(String value) Your description of the application.
void	setResourceLifecycleConfig(CfnApplication.ApplicationResourceLifecycleConfigProperty value) Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.
void	setResourceLifecycleConfig(IResolvable value) Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.

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

CfnApplication

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

CfnApplication

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

CfnApplication

@Stability(value=Stable)
public CfnApplication(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @Nullable
                                               CfnApplicationProps props)

Create a new `AWS::ElasticBeanstalk::Application`.

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.

CfnApplication

@Stability(value=Stable)
public CfnApplication(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id)

Create a new `AWS::ElasticBeanstalk::Application`.

Parameters:

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

id - - scoped id of the resource. 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

getApplicationName

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

A name for the Elastic Beanstalk application.

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application 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.

setApplicationName

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

A name for the Elastic Beanstalk application.

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application 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.

getDescription

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

Your description of the application.

setDescription

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

Your description of the application.

getResourceLifecycleConfig

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

Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.

setResourceLifecycleConfig

@Stability(value=Stable)
public void setResourceLifecycleConfig(@Nullable
                                                                CfnApplication.ApplicationResourceLifecycleConfigProperty value)

Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.

setResourceLifecycleConfig

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

Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.