CfnApplicationVersionPropsMixin

class aws_cdk.cfn_property_mixins.aws_elasticbeanstalk.CfnApplicationVersionPropsMixin(props, *, strategy=None)

Bases: Mixin

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

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-applicationversion.html
CloudformationResource:: AWS::ElasticBeanstalk::ApplicationVersion
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

# merge_strategy: cdk.IMergeStrategy

cfn_application_version_props_mixin = elasticbeanstalk.CfnApplicationVersionPropsMixin(elasticbeanstalk.CfnApplicationVersionMixinProps(
    application_name="applicationName",
    build_configuration=elasticbeanstalk.CfnApplicationVersionPropsMixin.BuildConfigurationProperty(
        artifact_name="artifactName",
        code_build_service_role="codeBuildServiceRole",
        compute_type="computeType",
        image="image",
        timeout_in_minutes=123
    ),
    description="description",
    image_configuration=elasticbeanstalk.CfnApplicationVersionPropsMixin.ImageConfigurationProperty(
        build_property=elasticbeanstalk.CfnApplicationVersionPropsMixin.ImageBuildConfigurationProperty(
            architecture="architecture",
            buildpack="buildpack",
            code_build_service_role="codeBuildServiceRole",
            compute_type="computeType",
            dockerfile_location="dockerfileLocation",
            timeout_in_minutes=123,
            type="type"
        ),
        source=elasticbeanstalk.CfnApplicationVersionPropsMixin.ImageSourceProperty(
            uri="uri"
        )
    ),
    process=False,
    source_bundle=elasticbeanstalk.CfnApplicationVersionPropsMixin.SourceBundleProperty(
        s3_bucket="s3Bucket",
        s3_key="s3Key"
    )
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::ElasticBeanstalk::ApplicationVersion.

Parameters:

props (Union[CfnApplicationVersionMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['applicationName', 'buildConfiguration', 'description', 'imageConfiguration', 'process', 'sourceBundle']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

BuildConfigurationProperty

class CfnApplicationVersionPropsMixin.BuildConfigurationProperty(*, artifact_name=None, code_build_service_role=None, compute_type=None, image=None, timeout_in_minutes=None)

Bases: object

Parameters:

artifact_name (Optional[str]) – The name of the build artifact.
code_build_service_role (Optional[str]) – The ARN of the IAM role that AWS CodeBuild assumes to build the application version.
compute_type (Optional[str]) – The compute type for the CodeBuild build environment.
image (Optional[str]) – The CodeBuild image used for the build environment.
timeout_in_minutes (Union[int, float, None]) – The timeout for the CodeBuild build, in minutes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-buildconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

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

build_configuration_property = elasticbeanstalk.CfnApplicationVersionPropsMixin.BuildConfigurationProperty(
    artifact_name="artifactName",
    code_build_service_role="codeBuildServiceRole",
    compute_type="computeType",
    image="image",
    timeout_in_minutes=123
)

Attributes

artifact_name

The name of the build artifact.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-buildconfiguration.html#cfn-elasticbeanstalk-applicationversion-buildconfiguration-artifactname

code_build_service_role

The ARN of the IAM role that AWS CodeBuild assumes to build the application version.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-buildconfiguration.html#cfn-elasticbeanstalk-applicationversion-buildconfiguration-codebuildservicerole

compute_type

The compute type for the CodeBuild build environment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-buildconfiguration.html#cfn-elasticbeanstalk-applicationversion-buildconfiguration-computetype

image

The CodeBuild image used for the build environment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-buildconfiguration.html#cfn-elasticbeanstalk-applicationversion-buildconfiguration-image

timeout_in_minutes

The timeout for the CodeBuild build, in minutes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-buildconfiguration.html#cfn-elasticbeanstalk-applicationversion-buildconfiguration-timeoutinminutes

ImageBuildConfigurationProperty

class CfnApplicationVersionPropsMixin.ImageBuildConfigurationProperty(*, architecture=None, buildpack=None, code_build_service_role=None, compute_type=None, dockerfile_location=None, timeout_in_minutes=None, type=None)

Bases: object

Parameters:

architecture (Optional[str]) – The target architecture for the built container image.
buildpack (Optional[str]) – The buildpack to use for building the image.
code_build_service_role (Optional[str]) – The ARN of the IAM role that AWS CodeBuild assumes to build the application version.
compute_type (Optional[str]) – The compute type for the CodeBuild build environment.
dockerfile_location (Optional[str]) – The path to the Dockerfile, relative to the source root.
timeout_in_minutes (Union[int, float, None]) – The timeout for the CodeBuild build, in minutes.
type (Optional[str]) – The type of image build: docker or buildpack.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-imagebuildconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

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

image_build_configuration_property = elasticbeanstalk.CfnApplicationVersionPropsMixin.ImageBuildConfigurationProperty(
    architecture="architecture",
    buildpack="buildpack",
    code_build_service_role="codeBuildServiceRole",
    compute_type="computeType",
    dockerfile_location="dockerfileLocation",
    timeout_in_minutes=123,
    type="type"
)

Attributes

architecture

The target architecture for the built container image.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-imagebuildconfiguration.html#cfn-elasticbeanstalk-applicationversion-imagebuildconfiguration-architecture

buildpack

The buildpack to use for building the image.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-imagebuildconfiguration.html#cfn-elasticbeanstalk-applicationversion-imagebuildconfiguration-buildpack

code_build_service_role

The ARN of the IAM role that AWS CodeBuild assumes to build the application version.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-imagebuildconfiguration.html#cfn-elasticbeanstalk-applicationversion-imagebuildconfiguration-codebuildservicerole

compute_type

The compute type for the CodeBuild build environment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-imagebuildconfiguration.html#cfn-elasticbeanstalk-applicationversion-imagebuildconfiguration-computetype

dockerfile_location

The path to the Dockerfile, relative to the source root.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-imagebuildconfiguration.html#cfn-elasticbeanstalk-applicationversion-imagebuildconfiguration-dockerfilelocation

timeout_in_minutes

The timeout for the CodeBuild build, in minutes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-imagebuildconfiguration.html#cfn-elasticbeanstalk-applicationversion-imagebuildconfiguration-timeoutinminutes

type

docker or buildpack.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-imagebuildconfiguration.html#cfn-elasticbeanstalk-applicationversion-imagebuildconfiguration-type
Type:: The type of image build

ImageConfigurationProperty

class CfnApplicationVersionPropsMixin.ImageConfigurationProperty(*, build_property=None, source=None)

Bases: object

Parameters:

build_property (Union[IResolvable, ImageBuildConfigurationProperty, Dict[str, Any], None])
source (Union[IResolvable, ImageSourceProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-imageconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

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

image_configuration_property = elasticbeanstalk.CfnApplicationVersionPropsMixin.ImageConfigurationProperty(
    build_property=elasticbeanstalk.CfnApplicationVersionPropsMixin.ImageBuildConfigurationProperty(
        architecture="architecture",
        buildpack="buildpack",
        code_build_service_role="codeBuildServiceRole",
        compute_type="computeType",
        dockerfile_location="dockerfileLocation",
        timeout_in_minutes=123,
        type="type"
    ),
    source=elasticbeanstalk.CfnApplicationVersionPropsMixin.ImageSourceProperty(
        uri="uri"
    )
)

Attributes

build_property

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-imageconfiguration.html#cfn-elasticbeanstalk-applicationversion-imageconfiguration-build

Type:: see

source

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-imageconfiguration.html#cfn-elasticbeanstalk-applicationversion-imageconfiguration-source

Type:: see

ImageSourceProperty

class CfnApplicationVersionPropsMixin.ImageSourceProperty(*, uri=None)

Bases: object

Parameters:: uri (Optional[str]) – The URI of the container image, e.g. an ECR image URI.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-imagesource.html
ExampleMetadata:: fixture=_generated

Example:

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

image_source_property = elasticbeanstalk.CfnApplicationVersionPropsMixin.ImageSourceProperty(
    uri="uri"
)

Attributes

uri

The URI of the container image, e.g. an ECR image URI.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-imagesource.html#cfn-elasticbeanstalk-applicationversion-imagesource-uri

SourceBundleProperty

class CfnApplicationVersionPropsMixin.SourceBundleProperty(*, s3_bucket=None, s3_key=None)

Bases: object

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.

The SourceBundle property is an embedded property of the AWS::ElasticBeanstalk::ApplicationVersion resource. It specifies the Amazon S3 location of the source bundle for an AWS Elastic Beanstalk application version.

Parameters:

s3_bucket (Optional[str]) – The Amazon S3 bucket where the data is located.
s3_key (Optional[str]) – The Amazon S3 key where the data is located.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-sourcebundle.html

ExampleMetadata:

fixture=_generated

Example:

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

source_bundle_property = elasticbeanstalk.CfnApplicationVersionPropsMixin.SourceBundleProperty(
    s3_bucket="s3Bucket",
    s3_key="s3Key"
)

Attributes

s3_bucket

The Amazon S3 bucket where the data is located.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-sourcebundle.html#cfn-elasticbeanstalk-applicationversion-sourcebundle-s3bucket

s3_key

The Amazon S3 key where the data is located.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-sourcebundle.html#cfn-elasticbeanstalk-applicationversion-sourcebundle-s3key