CfnApplication

class aws_cdk.aws_elasticbeanstalk.CfnApplication(scope, id, *, application_name=None, description=None, resource_lifecycle_config=None)

Bases: CfnResource

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.

CloudformationResource

AWS::ElasticBeanstalk::Application

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-application.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_elasticbeanstalk as elasticbeanstalk

cfn_application = elasticbeanstalk.CfnApplication(self, "MyCfnApplication",
    application_name="applicationName",
    description="description",
    resource_lifecycle_config=elasticbeanstalk.CfnApplication.ApplicationResourceLifecycleConfigProperty(
        service_role="serviceRole",
        version_lifecycle_config=elasticbeanstalk.CfnApplication.ApplicationVersionLifecycleConfigProperty(
            max_age_rule=elasticbeanstalk.CfnApplication.MaxAgeRuleProperty(
                delete_source_from_s3=False,
                enabled=False,
                max_age_in_days=123
            ),
            max_count_rule=elasticbeanstalk.CfnApplication.MaxCountRuleProperty(
                delete_source_from_s3=False,
                enabled=False,
                max_count=123
            )
        )
    )
)

Create a new AWS::ElasticBeanstalk::Application.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • application_name (Optional[str]) – 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 . .. epigraph:: 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.

  • description (Optional[str]) – Your description of the application.

  • resource_lifecycle_config (Union[ApplicationResourceLifecycleConfigProperty, Dict[str, Any], IResolvable, None]) – Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

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:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"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
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

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

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::ElasticBeanstalk::Application'
application_name

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 . .. epigraph:

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

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-application.html#cfn-elasticbeanstalk-application-applicationname

Return type

Optional[str]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

description

Your description of the application.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-application.html#cfn-elasticbeanstalk-application-description

Return type

Optional[str]

logical_id

The logical ID for this CloudFormation stack element.

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

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

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 }).

Return type

str

resource_lifecycle_config

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-application.html#cfn-elasticbeanstalk-application-resourcelifecycleconfig

Return type

Union[ApplicationResourceLifecycleConfigProperty, IResolvable, None]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

ApplicationResourceLifecycleConfigProperty

class CfnApplication.ApplicationResourceLifecycleConfigProperty(*, service_role=None, version_lifecycle_config=None)

Bases: object

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.

The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions.

ApplicationResourceLifecycleConfig is a property of the AWS::ElasticBeanstalk::Application resource.

Parameters
  • service_role (Optional[str]) – The ARN of an IAM service role that Elastic Beanstalk has permission to assume. The ServiceRole property is required the first time that you provide a ResourceLifecycleConfig for the application. After you provide it once, Elastic Beanstalk persists the Service Role with the application, and you don’t need to specify it again. You can, however, specify it in subsequent updates to change the Service Role to another value.

  • version_lifecycle_config (Union[IResolvable, ApplicationVersionLifecycleConfigProperty, Dict[str, Any], None]) – Defines lifecycle settings for application versions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationresourcelifecycleconfig.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_elasticbeanstalk as elasticbeanstalk

application_resource_lifecycle_config_property = elasticbeanstalk.CfnApplication.ApplicationResourceLifecycleConfigProperty(
    service_role="serviceRole",
    version_lifecycle_config=elasticbeanstalk.CfnApplication.ApplicationVersionLifecycleConfigProperty(
        max_age_rule=elasticbeanstalk.CfnApplication.MaxAgeRuleProperty(
            delete_source_from_s3=False,
            enabled=False,
            max_age_in_days=123
        ),
        max_count_rule=elasticbeanstalk.CfnApplication.MaxCountRuleProperty(
            delete_source_from_s3=False,
            enabled=False,
            max_count=123
        )
    )
)

Attributes

service_role

The ARN of an IAM service role that Elastic Beanstalk has permission to assume.

The ServiceRole property is required the first time that you provide a ResourceLifecycleConfig for the application. After you provide it once, Elastic Beanstalk persists the Service Role with the application, and you don’t need to specify it again. You can, however, specify it in subsequent updates to change the Service Role to another value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationresourcelifecycleconfig.html#cfn-elasticbeanstalk-application-applicationresourcelifecycleconfig-servicerole

Return type

Optional[str]

version_lifecycle_config

Defines lifecycle settings for application versions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationresourcelifecycleconfig.html#cfn-elasticbeanstalk-application-applicationresourcelifecycleconfig-versionlifecycleconfig

Return type

Union[IResolvable, ApplicationVersionLifecycleConfigProperty, None]

ApplicationVersionLifecycleConfigProperty

class CfnApplication.ApplicationVersionLifecycleConfigProperty(*, max_age_rule=None, max_count_rule=None)

Bases: object

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.

The application version lifecycle settings for an application. Defines the rules that Elastic Beanstalk applies to an application’s versions in order to avoid hitting the per-region limit for application versions.

When Elastic Beanstalk deletes an application version from its database, you can no longer deploy that version to an environment. The source bundle remains in S3 unless you configure the rule to delete it.

ApplicationVersionLifecycleConfig is a property of the ApplicationResourceLifecycleConfig property type.

Parameters
  • max_age_rule (Union[IResolvable, MaxAgeRuleProperty, Dict[str, Any], None]) – Specify a max age rule to restrict the length of time that application versions are retained for an application.

  • max_count_rule (Union[IResolvable, MaxCountRuleProperty, Dict[str, Any], None]) – Specify a max count rule to restrict the number of application versions that are retained for an application.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_elasticbeanstalk as elasticbeanstalk

application_version_lifecycle_config_property = elasticbeanstalk.CfnApplication.ApplicationVersionLifecycleConfigProperty(
    max_age_rule=elasticbeanstalk.CfnApplication.MaxAgeRuleProperty(
        delete_source_from_s3=False,
        enabled=False,
        max_age_in_days=123
    ),
    max_count_rule=elasticbeanstalk.CfnApplication.MaxCountRuleProperty(
        delete_source_from_s3=False,
        enabled=False,
        max_count=123
    )
)

Attributes

max_age_rule

Specify a max age rule to restrict the length of time that application versions are retained for an application.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html#cfn-elasticbeanstalk-application-applicationversionlifecycleconfig-maxagerule

Return type

Union[IResolvable, MaxAgeRuleProperty, None]

max_count_rule

Specify a max count rule to restrict the number of application versions that are retained for an application.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html#cfn-elasticbeanstalk-application-applicationversionlifecycleconfig-maxcountrule

Return type

Union[IResolvable, MaxCountRuleProperty, None]

MaxAgeRuleProperty

class CfnApplication.MaxAgeRuleProperty(*, delete_source_from_s3=None, enabled=None, max_age_in_days=None)

Bases: object

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.

A lifecycle rule that deletes application versions after the specified number of days.

MaxAgeRule is a property of the ApplicationVersionLifecycleConfig property type.

Parameters
  • delete_source_from_s3 (Union[bool, IResolvable, None]) – Set to true to delete a version’s source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

  • enabled (Union[bool, IResolvable, None]) – Specify true to apply the rule, or false to disable it.

  • max_age_in_days (Union[int, float, None]) – Specify the number of days to retain an application versions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxagerule.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_elasticbeanstalk as elasticbeanstalk

max_age_rule_property = elasticbeanstalk.CfnApplication.MaxAgeRuleProperty(
    delete_source_from_s3=False,
    enabled=False,
    max_age_in_days=123
)

Attributes

delete_source_from_s3

Set to true to delete a version’s source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxagerule.html#cfn-elasticbeanstalk-application-maxagerule-deletesourcefroms3

Return type

Union[bool, IResolvable, None]

enabled

Specify true to apply the rule, or false to disable it.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxagerule.html#cfn-elasticbeanstalk-application-maxagerule-enabled

Return type

Union[bool, IResolvable, None]

max_age_in_days

Specify the number of days to retain an application versions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxagerule.html#cfn-elasticbeanstalk-application-maxagerule-maxageindays

Return type

Union[int, float, None]

MaxCountRuleProperty

class CfnApplication.MaxCountRuleProperty(*, delete_source_from_s3=None, enabled=None, max_count=None)

Bases: object

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.

A lifecycle rule that deletes the oldest application version when the maximum count is exceeded.

MaxCountRule is a property of the ApplicationVersionLifecycleConfig property type.

Parameters
  • delete_source_from_s3 (Union[bool, IResolvable, None]) – Set to true to delete a version’s source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

  • enabled (Union[bool, IResolvable, None]) – Specify true to apply the rule, or false to disable it.

  • max_count (Union[int, float, None]) – Specify the maximum number of application versions to retain.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxcountrule.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_elasticbeanstalk as elasticbeanstalk

max_count_rule_property = elasticbeanstalk.CfnApplication.MaxCountRuleProperty(
    delete_source_from_s3=False,
    enabled=False,
    max_count=123
)

Attributes

delete_source_from_s3

Set to true to delete a version’s source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxcountrule.html#cfn-elasticbeanstalk-application-maxcountrule-deletesourcefroms3

Return type

Union[bool, IResolvable, None]

enabled

Specify true to apply the rule, or false to disable it.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxcountrule.html#cfn-elasticbeanstalk-application-maxcountrule-enabled

Return type

Union[bool, IResolvable, None]

max_count

Specify the maximum number of application versions to retain.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxcountrule.html#cfn-elasticbeanstalk-application-maxcountrule-maxcount

Return type

Union[int, float, None]