class Amazonite::CloudFormation::TypeSummary

Overview

Contains summary information about the specified CloudFormation extension.

Defined in:

cloudformation/type_summary.cr

Constructors

.from_xml(node : XML::Node) : self
.new(type : RegistryType | Nil = nil, type_name : String | Nil = nil, default_version_id : String | Nil = nil, type_arn : String | Nil = nil, last_updated : Time | Nil = nil, description : String | Nil = nil, publisher_id : String | Nil = nil, original_type_name : String | Nil = nil, public_version_number : String | Nil = nil, latest_public_version : String | Nil = nil, publisher_identity : IdentityProvider | Nil = nil, publisher_name : String | Nil = nil, is_activated : Bool | Nil = nil)

Instance Method Summary

#==(other : self)
Returns true if this reference is the same as other.
#default_version_id : String | Nil
The ID of the default version of the extension.
#default_version_id=(default_version_id : String | Nil)
The ID of the default version of the extension.
#description : String | Nil
The description of the extension.
#description=(description : String | Nil)
The description of the extension.
#hash(hasher)
See Object#hash(hasher)
#is_activated : Bool | Nil
Whether the extension is activated for this account and Region.
#is_activated=(is_activated : Bool | Nil)
Whether the extension is activated for this account and Region.
#last_updated : Time | Nil
When the specified extension version was registered.
#last_updated=(last_updated : Time | Nil)
When the specified extension version was registered.
#latest_public_version : String | Nil
For public extensions that have been activated for this account and Region, the latest version of the public extension that is available.
#latest_public_version=(latest_public_version : String | Nil)
For public extensions that have been activated for this account and Region, the latest version of the public extension that is available.
#original_type_name : String | Nil
For public extensions that have been activated for this account and Region, the type name of the public extension.
#original_type_name=(original_type_name : String | Nil)
For public extensions that have been activated for this account and Region, the type name of the public extension.
#public_version_number : String | Nil
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.
#public_version_number=(public_version_number : String | Nil)
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.
#publisher_id : String | Nil
The ID of the extension publisher, if the extension is published by a third party.
#publisher_id=(publisher_id : String | Nil)
The ID of the extension publisher, if the extension is published by a third party.
#publisher_identity : IdentityProvider | Nil
The service used to verify the publisher identity.
#publisher_identity=(publisher_identity : IdentityProvider | Nil)
The service used to verify the publisher identity.
#publisher_name : String | Nil
The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.
#publisher_name=(publisher_name : String | Nil)
The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.
#to_query_params(prefix : String) : Array(Tuple(String, String))
#type : RegistryType | Nil
The kind of extension.
#type=(type : RegistryType | Nil)
The kind of extension.
#type_arn : String | Nil
The ARN of the extension.
#type_arn=(type_arn : String | Nil)
The ARN of the extension.
#type_name : String | Nil
The name of the extension.
#type_name=(type_name : String | Nil)
The name of the extension.
#validate! : Nil

Constructor Detail

def self.from_xml(node : XML::Node) : self #

[View source]

[View source]

Instance Method Detail

def ==(other : self) #

Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.

def default_version_id : String | Nil #

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.

[View source]

def default_version_id=(default_version_id : String | Nil) #

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

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

[View source]

def description : String | Nil #

The description of the extension.

[View source]

def description=(description : String | Nil) #

The description of the extension.

[View source]

def hash(hasher) #

Description copied from class Reference

See Object#hash(hasher)

def is_activated : Bool | Nil #

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.

[View source]

def is_activated=(is_activated : Bool | Nil) #

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.

[View source]

def last_updated : Time | Nil #

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.

[View source]

def last_updated=(last_updated : Time | Nil) #

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.

[View source]

def latest_public_version : String | Nil #

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-party 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 Automatically use new versions of extensions in the CloudFormation User Guide.

[View source]

def latest_public_version=(latest_public_version : String | Nil) #

[View source]

def original_type_name : String | Nil #

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 Use aliases to refer to extensions in the CloudFormation User Guide.

[View source]

def original_type_name=(original_type_name : String | Nil) #

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

[View source]

def public_version_number : String | Nil #

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.

[View source]

def public_version_number=(public_version_number : String | Nil) #

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.

[View source]

def publisher_id : String | Nil #

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.

[View source]

def publisher_id=(publisher_id : String | Nil) #

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.

[View source]

def publisher_identity : IdentityProvider | Nil #

The service used to verify the publisher identity.

For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.

[View source]

def publisher_identity=(publisher_identity : IdentityProvider | Nil) #

The service used to verify the publisher identity.

For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.

[View source]

def publisher_name : String | Nil #

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

[View source]

def publisher_name=(publisher_name : String | Nil) #

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

[View source]

def to_query_params(prefix : String) : Array(Tuple(String, String)) #

[View source]

def type : RegistryType | Nil #

The kind of extension.

[View source]

def type=(type : RegistryType | Nil) #

The kind of extension.

[View source]

def type_arn : String | Nil #

The ARN of the extension.

[View source]

def type_arn=(type_arn : String | Nil) #

The ARN of the extension.

[View source]

def type_name : String | Nil #

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.

[View source]

def type_name=(type_name : String | Nil) #

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.

[View source]

def validate! : Nil #

[View source]