software.amazon.awscdk.services.elasticbeanstalk

Class CfnApplicationVersion

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.elasticbeanstalk.CfnApplicationVersion

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.997Z")
public class CfnApplicationVersion
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ElasticBeanstalk::ApplicationVersion`.

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

The AWS::ElasticBeanstalk::ApplicationVersion resource is an AWS Elastic Beanstalk resource type that specifies an application version, an iteration of deployable code, for an Elastic Beanstalk application.

After you create an application version with a specified Amazon S3 bucket and key location, you can't change that Amazon S3 location. If you change the Amazon S3 location, an attempt to launch an environment from the application version will fail.

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.*;
 CfnApplicationVersion cfnApplicationVersion = CfnApplicationVersion.Builder.create(this, "MyCfnApplicationVersion")
         .applicationName("applicationName")
         .sourceBundle(SourceBundleProperty.builder()
                 .s3Bucket("s3Bucket")
                 .s3Key("s3Key")
                 .build())
         // the properties below are optional
         .description("description")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnApplicationVersion.Builder A fluent builder for CfnApplicationVersion.
static interface	CfnApplicationVersion.SourceBundleProperty Use the `SourceBundle` property type to specify the Amazon S3 location of the source bundle for an AWS Elastic Beanstalk application version when defining an AWS::ElasticBeanstalk::ApplicationVersion resource in an AWS CloudFormation template.

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnApplicationVersion(Construct scope, java.lang.String id, CfnApplicationVersionProps props) Create a new `AWS::ElasticBeanstalk::ApplicationVersion`.
protected	CfnApplicationVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApplicationVersion(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApplicationName() The name of the Elastic Beanstalk application that is associated with this application version.
java.lang.String	getAttrId()
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() A description of this application version.
java.lang.Object	getSourceBundle() The Amazon S3 bucket and key that identify the location of the source bundle for this version.
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	setApplicationName(java.lang.String value) The name of the Elastic Beanstalk application that is associated with this application version.
void	setDescription(java.lang.String value) A description of this application version.
void	setSourceBundle(CfnApplicationVersion.SourceBundleProperty value) The Amazon S3 bucket and key that identify the location of the source bundle for this version.
void	setSourceBundle(IResolvable value) The Amazon S3 bucket and key that identify the location of the source bundle for this version.

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

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnApplicationVersion

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

CfnApplicationVersion

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

CfnApplicationVersion

public CfnApplicationVersion(Construct scope,
                             java.lang.String id,
                             CfnApplicationVersionProps props)

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

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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

public java.lang.String getAttrId()

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApplicationName

public java.lang.String getApplicationName()

The name of the Elastic Beanstalk application that is associated with this application version.

setApplicationName

public void setApplicationName(java.lang.String value)

The name of the Elastic Beanstalk application that is associated with this application version.

getSourceBundle

public java.lang.Object getSourceBundle()

The Amazon S3 bucket and key that identify the location of the source bundle for this version.

The Amazon S3 bucket must be in the same region as the environment.

setSourceBundle

public void setSourceBundle(IResolvable value)

The Amazon S3 bucket and key that identify the location of the source bundle for this version.

The Amazon S3 bucket must be in the same region as the environment.

setSourceBundle

public void setSourceBundle(CfnApplicationVersion.SourceBundleProperty value)

The Amazon S3 bucket and key that identify the location of the source bundle for this version.

The Amazon S3 bucket must be in the same region as the environment.

getDescription

public java.lang.String getDescription()

A description of this application version.

setDescription

public void setDescription(java.lang.String value)

A description of this application version.