CfnSoftwarePackageVersionPropsMixin

class aws_cdk.mixins_preview.aws_iot.mixins.CfnSoftwarePackageVersionPropsMixin(props, *, strategy=None)

Bases: Mixin

Use the AWS::IoT::SoftwarePackageVersion resource to create a software package version.

For information about working with software package versions, see AWS IoT Device Management Software Package Catalog and Creating a software package and package version in the AWS IoT Developer Guide . See also, CreatePackageVersion in the API Guide . .. epigraph:

The associated software package must exist before the package version is created. If you create a software package and package version in the same CloudFormation template, set the software package as a `dependency <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html>`_ of the package version. If they are created out of sequence, you will receive an error.

Package versions and created in a ``draft`` state, for more information, see `Package version lifecycle <https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle>`_ . To change the package version state after it’s created, use the `UpdatePackageVersionAPI <https://docs.aws.amazon.com/iot/latest/apireference/API_UpdatePackageVersion.html>`_ command.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html
CloudformationResource:: AWS::IoT::SoftwarePackageVersion
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_iot import mixins as iot_mixins

cfn_software_package_version_props_mixin = iot_mixins.CfnSoftwarePackageVersionPropsMixin(iot_mixins.CfnSoftwarePackageVersionMixinProps(
    artifact=iot_mixins.CfnSoftwarePackageVersionPropsMixin.PackageVersionArtifactProperty(
        s3_location=iot_mixins.CfnSoftwarePackageVersionPropsMixin.S3LocationProperty(
            bucket="bucket",
            key="key",
            version="version"
        )
    ),
    attributes={
        "attributes_key": "attributes"
    },
    description="description",
    package_name="packageName",
    recipe="recipe",
    sbom=iot_mixins.CfnSoftwarePackageVersionPropsMixin.SbomProperty(
        s3_location=iot_mixins.CfnSoftwarePackageVersionPropsMixin.S3LocationProperty(
            bucket="bucket",
            key="key",
            version="version"
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    version_name="versionName"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoT::SoftwarePackageVersion.

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['artifact', 'attributes', 'description', 'packageName', 'recipe', 'sbom', 'tags', 'versionName']

Static Methods

classmethod is_mixin(x)

(experimental) 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.
Stability:: experimental

PackageVersionArtifactProperty

class CfnSoftwarePackageVersionPropsMixin.PackageVersionArtifactProperty(*, s3_location=None)

Bases: object

The artifact location of the package version.

Parameters:: s3_location (Union[IResolvable, S3LocationProperty, Dict[str, Any], None]) – The Amazon S3 location.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-packageversionartifact.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.mixins_preview.aws_iot import mixins as iot_mixins

package_version_artifact_property = iot_mixins.CfnSoftwarePackageVersionPropsMixin.PackageVersionArtifactProperty(
    s3_location=iot_mixins.CfnSoftwarePackageVersionPropsMixin.S3LocationProperty(
        bucket="bucket",
        key="key",
        version="version"
    )
)

Attributes

s3_location

The Amazon S3 location.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-packageversionartifact.html#cfn-iot-softwarepackageversion-packageversionartifact-s3location

S3LocationProperty

class CfnSoftwarePackageVersionPropsMixin.S3LocationProperty(*, bucket=None, key=None, version=None)

Bases: object

The Amazon S3 location.

Parameters:

bucket (Optional[str]) – The S3 bucket.
key (Optional[str]) – The S3 key.
version (Optional[str]) – The S3 version.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-s3location.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.mixins_preview.aws_iot import mixins as iot_mixins

s3_location_property = iot_mixins.CfnSoftwarePackageVersionPropsMixin.S3LocationProperty(
    bucket="bucket",
    key="key",
    version="version"
)

Attributes

bucket

The S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-s3location.html#cfn-iot-softwarepackageversion-s3location-bucket

key

The S3 key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-s3location.html#cfn-iot-softwarepackageversion-s3location-key

version

The S3 version.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-s3location.html#cfn-iot-softwarepackageversion-s3location-version

SbomProperty

class CfnSoftwarePackageVersionPropsMixin.SbomProperty(*, s3_location=None)

Bases: object

The sbom zip archive location of the package version.

Parameters:: s3_location (Union[IResolvable, S3LocationProperty, Dict[str, Any], None]) – The Amazon S3 location.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-sbom.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.mixins_preview.aws_iot import mixins as iot_mixins

sbom_property = iot_mixins.CfnSoftwarePackageVersionPropsMixin.SbomProperty(
    s3_location=iot_mixins.CfnSoftwarePackageVersionPropsMixin.S3LocationProperty(
        bucket="bucket",
        key="key",
        version="version"
    )
)

Attributes

s3_location

The Amazon S3 location.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-sbom.html#cfn-iot-softwarepackageversion-sbom-s3location