AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Contains summary information about the specified CloudFormation extension.

Inheritance Hierarchy

System.Object
  Amazon.CloudFormation.Model.TypeSummary

Namespace: Amazon.CloudFormation.Model
Assembly: AWSSDK.CloudFormation.dll
Version: 3.x.y.z

Syntax

C#
public class TypeSummary

The TypeSummary type exposes the following members

Constructors

NameDescription
Public Method TypeSummary()

Properties

NameTypeDescription
Public Property DefaultVersionId System.String

Gets and sets the property DefaultVersionId.

The ID of the default version of the extension. The default version is used when the extension version isn't specified.

This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns null. For more information, see RegisterType.

To set the default version of an extension, use SetTypeDefaultVersion.

Public Property Description System.String

Gets and sets the property Description.

The description of the extension.

Public Property IsActivated System.Boolean

Gets and sets the property IsActivated.

Whether the extension is activated for this account and Region.

This applies only to third-party public extensions. Extensions published by Amazon are activated by default.

Public Property LastUpdated System.DateTime

Gets and sets the property LastUpdated.

When the specified extension version was registered. This applies only to:

  • Private extensions you have registered in your account. For more information, see RegisterType.

  • Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.

For all other extension types, CloudFormation returns null.

Public Property LatestPublicVersion System.String

Gets and sets the property LatestPublicVersion.

For public extensions that have been activated for this account and Region, the latest version of the public extension that is available. For any extensions other than activated third-arty extensions, CloudFormation returns null.

How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.

Public Property OriginalTypeName System.String

Gets and sets the property OriginalTypeName.

For public extensions that have been activated for this account and Region, the type name of the public extension.

If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.

Public Property PublicVersionNumber System.String

Gets and sets the property PublicVersionNumber.

For public extensions that have been activated for this account and Region, the version of the public extension to be used for CloudFormation operations in this account and Region.

How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.

Public Property PublisherId System.String

Gets and sets the property PublisherId.

The ID of the extension publisher, if the extension is published by a third party. Extensions published by Amazon don't return a publisher ID.

Public Property PublisherIdentity Amazon.CloudFormation.IdentityProvider

Gets and sets the property PublisherIdentity.

The service used to verify the publisher identity.

For more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development.

Public Property PublisherName System.String

Gets and sets the property PublisherName.

The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.

Public Property Type Amazon.CloudFormation.RegistryType

Gets and sets the property Type.

The kind of extension.

Public Property TypeArn System.String

Gets and sets the property TypeArn.

The Amazon Resource Name (ARN) of the extension.

Public Property TypeName System.String

Gets and sets the property TypeName.

The name of the extension.

If you specified a TypeNameAlias when you call the ActivateType API operation in your account and Region, CloudFormation considers that alias as the type name.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5