Show / Hide Table of Contents

Class CfnSoftwarePackage

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

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnSoftwarePackage
Implements
IInspectable
ISoftwarePackageRef
IConstruct
IDependable
ITaggableV2
Inherited Members
CfnResource.IsCfnResource(object)
CfnResource.AddDeletionOverride(string)
CfnResource.AddDependency(CfnResource)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(string, object)
CfnResource.AddOverride(string, object)
CfnResource.AddPropertyDeletionOverride(string)
CfnResource.AddPropertyOverride(string, object)
CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)
CfnResource.GetAtt(string, ResolutionTypeHint?)
CfnResource.GetMetadata(string)
CfnResource.ObtainDependencies()
CfnResource.ObtainResourceDependencies()
CfnResource.RemoveDependency(CfnResource)
CfnResource.ReplaceDependency(CfnResource, CfnResource)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(object)
CfnElement.OverrideLogicalId(string)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSoftwarePackage : CfnResource, IInspectable, ISoftwarePackageRef, IConstruct, IDependable, ITaggableV2
Syntax (vb)
Public Class CfnSoftwarePackage Inherits CfnResource Implements IInspectable, ISoftwarePackageRef, IConstruct, IDependable, ITaggableV2
Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackage.html

CloudformationResource: AWS::IoT::SoftwarePackage

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoT;

             var cfnSoftwarePackage = new CfnSoftwarePackage(this, "MyCfnSoftwarePackage", new CfnSoftwarePackageProps {
                 Description = "description",
                 PackageName = "packageName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnSoftwarePackage(Construct, string, ICfnSoftwarePackageProps?)

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

Properties

AttrPackageArn

The Amazon Resource Name (ARN) for the package.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CdkTagManager

Tag Manager which manages the tags for this resource.

CfnProperties

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

Description

A summary of the package being created.

PackageName

The name of the new software package.

SoftwarePackageRef

A reference to a SoftwarePackage resource.

Tags

Metadata that can be used to manage the package.

Methods

FromPackageName(Construct, string, string)

Creates a new ISoftwarePackageRef from a packageName.

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<string, object>)

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

Constructors

CfnSoftwarePackage(Construct, string, ICfnSoftwarePackageProps?)

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

public CfnSoftwarePackage(Construct scope, string id, ICfnSoftwarePackageProps? props = null)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnSoftwarePackageProps

Resource properties.

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackage.html

CloudformationResource: AWS::IoT::SoftwarePackage

ExampleMetadata: fixture=_generated

Properties

AttrPackageArn

The Amazon Resource Name (ARN) for the package.

public virtual string AttrPackageArn { get; }
Property Value

string

Remarks

CloudformationAttribute: PackageArn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackage.html

CloudformationResource: AWS::IoT::SoftwarePackage

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackage.html

CloudformationResource: AWS::IoT::SoftwarePackage

ExampleMetadata: fixture=_generated

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
CfnResource.CfnProperties
Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackage.html

CloudformationResource: AWS::IoT::SoftwarePackage

ExampleMetadata: fixture=_generated

Description

A summary of the package being created.

public virtual string? Description { get; set; }
Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackage.html

CloudformationResource: AWS::IoT::SoftwarePackage

ExampleMetadata: fixture=_generated

PackageName

The name of the new software package.

public virtual string? PackageName { get; set; }
Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackage.html

CloudformationResource: AWS::IoT::SoftwarePackage

ExampleMetadata: fixture=_generated

SoftwarePackageRef

A reference to a SoftwarePackage resource.

public virtual ISoftwarePackageReference SoftwarePackageRef { get; }
Property Value

ISoftwarePackageReference

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackage.html

CloudformationResource: AWS::IoT::SoftwarePackage

ExampleMetadata: fixture=_generated

Tags

Metadata that can be used to manage the package.

public virtual ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackage.html

CloudformationResource: AWS::IoT::SoftwarePackage

ExampleMetadata: fixture=_generated

Methods

FromPackageName(Construct, string, string)

Creates a new ISoftwarePackageRef from a packageName.

public static ISoftwarePackageRef FromPackageName(Construct scope, string id, string packageName)
Parameters
scope Construct
id string
packageName string
Returns

ISoftwarePackageRef

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackage.html

CloudformationResource: AWS::IoT::SoftwarePackage

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackage.html

CloudformationResource: AWS::IoT::SoftwarePackage

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
CfnResource.RenderProperties(IDictionary<string, object>)
Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackage.html

CloudformationResource: AWS::IoT::SoftwarePackage

ExampleMetadata: fixture=_generated

Implements

IInspectable
ISoftwarePackageRef
Constructs.IConstruct
Constructs.IDependable
ITaggableV2
Back to top Generated by DocFX