Class CfnSoftwarePackageVersion
- All Implemented Interfaces:
IInspectable
,ITaggableV2
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
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 .
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 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 . To change the package version state after it’s created, use the UpdatePackageVersionAPI command.
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.iot.*; CfnSoftwarePackageVersion cfnSoftwarePackageVersion = CfnSoftwarePackageVersion.Builder.create(this, "MyCfnSoftwarePackageVersion") .packageName("packageName") // the properties below are optional .attributes(Map.of( "attributesKey", "attributes")) .description("description") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .versionName("versionName") .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnSoftwarePackageVersion
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnSoftwarePackageVersion
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnSoftwarePackageVersion
(software.amazon.jsii.JsiiObjectRef objRef) CfnSoftwarePackageVersion
(software.constructs.Construct scope, String id, CfnSoftwarePackageVersionProps props) -
Method Summary
Modifier and TypeMethodDescriptionError reason for a package version failure during creation or update.Metadata that can be used to define a package version’s configuration.The Amazon Resource Name (ARN) for the package.The status of the package version.Tag Manager which manages the tags for this resource.A summary of the package version being created.The name of the associated software package.getTags()
Metadata that can be used to manage the package version.The name of the new package version.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAttributes
(Map<String, String> value) Metadata that can be used to define a package version’s configuration.void
setAttributes
(IResolvable value) Metadata that can be used to define a package version’s configuration.void
setDescription
(String value) A summary of the package version being created.void
setPackageName
(String value) The name of the associated software package.void
Metadata that can be used to manage the package version.void
setVersionName
(String value) The name of the new package version.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnSoftwarePackageVersion
protected CfnSoftwarePackageVersion(software.amazon.jsii.JsiiObjectRef objRef) -
CfnSoftwarePackageVersion
protected CfnSoftwarePackageVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnSoftwarePackageVersion
@Stability(Stable) public CfnSoftwarePackageVersion(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSoftwarePackageVersionProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrErrorReason
Error reason for a package version failure during creation or update. -
getAttrPackageVersionArn
The Amazon Resource Name (ARN) for the package. -
getAttrStatus
The status of the package version.For more information, see Package version lifecycle .
-
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getPackageName
The name of the associated software package. -
setPackageName
The name of the associated software package. -
getAttributes
Metadata that can be used to define a package version’s configuration. -
setAttributes
Metadata that can be used to define a package version’s configuration. -
setAttributes
Metadata that can be used to define a package version’s configuration. -
getDescription
A summary of the package version being created. -
setDescription
A summary of the package version being created. -
getTags
Metadata that can be used to manage the package version. -
setTags
Metadata that can be used to manage the package version. -
getVersionName
The name of the new package version. -
setVersionName
The name of the new package version.
-