class Amazonite::CloudFormation::DescribeTypeOutput

Defined in:

cloudformation/describe_type_output.cr

Constructors

Instance Method Summary

Constructor Detail

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

[View source]
def self.new(arn : String | Nil = nil, type : RegistryType | Nil = nil, type_name : String | Nil = nil, default_version_id : String | Nil = nil, is_default_version : Bool | Nil = nil, type_tests_status : TypeTestsStatus | Nil = nil, type_tests_status_description : String | Nil = nil, description : String | Nil = nil, schema : String | Nil = nil, provisioning_type : ProvisioningType | Nil = nil, deprecated_status : DeprecatedStatus | Nil = nil, logging_config : LoggingConfig | Nil = nil, required_activated_types : Array(RequiredActivatedType) | Nil = nil, execution_role_arn : String | Nil = nil, visibility : Visibility | Nil = nil, source_url : String | Nil = nil, documentation_url : String | Nil = nil, last_updated : Time | Nil = nil, time_created : Time | Nil = nil, configuration_schema : String | Nil = nil, publisher_id : String | Nil = nil, original_type_name : String | Nil = nil, original_type_arn : String | Nil = nil, public_version_number : String | Nil = nil, latest_public_version : String | Nil = nil, is_activated : Bool | Nil = nil, auto_update : Bool | Nil = nil) #

[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 arn : String | Nil #

The Amazon Resource Name (ARN) of the extension.


[View source]
def arn=(arn : String | Nil) #

The Amazon Resource Name (ARN) of the extension.


[View source]
def auto_update : Bool | Nil #

Whether CloudFormation automatically updates the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see Automatically use new versions of extensions in the CloudFormation User Guide.


[View source]
def auto_update=(auto_update : Bool | Nil) #

Whether CloudFormation automatically updates the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see Automatically use new versions of extensions in the CloudFormation User Guide.


[View source]
def configuration_schema : String | Nil #

A JSON string that represent the current configuration data for the extension in this account and Region.

To set the configuration data for an extension, use SetTypeConfiguration.


[View source]
def configuration_schema=(configuration_schema : String | Nil) #

A JSON string that represent the current configuration data for the extension in this account and Region.

To set the configuration data for an extension, use SetTypeConfiguration.


[View source]
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 Web Services 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.

This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services 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 deprecated_status : DeprecatedStatus | Nil #

The deprecation status of the extension version.

Valid values include:

  • LIVE: The extension is activated or registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.

  • DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in CloudFormation operations.

For public third-party extensions, CloudFormation returns null.


[View source]
def deprecated_status=(deprecated_status : DeprecatedStatus | Nil) #

The deprecation status of the extension version.

Valid values include:

  • LIVE: The extension is activated or registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.

  • DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in CloudFormation operations.

For public third-party extensions, CloudFormation returns null.


[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 documentation_url : String | Nil #

The URL of a page providing detailed documentation for this extension.


[View source]
def documentation_url=(documentation_url : String | Nil) #

The URL of a page providing detailed documentation for this extension.


[View source]
def execution_role_arn : String | Nil #

The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to private extensions you have registered in your account. For more information, see RegisterType.

If the registered extension calls any Amazon Web Services APIs, you must create an * IAM execution role * that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.


[View source]
def execution_role_arn=(execution_role_arn : String | Nil) #

The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to private extensions you have registered in your account. For more information, see RegisterType.

If the registered extension calls any Amazon Web Services APIs, you must create an * IAM execution role * that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def is_activated : Bool | Nil #

Whether the extension is activated in the account and Region.

This only applies to public third-party extensions. For all other extensions, CloudFormation returns null.


[View source]
def is_activated=(is_activated : Bool | Nil) #

Whether the extension is activated in the account and Region.

This only applies to public third-party extensions. For all other extensions, CloudFormation returns null.


[View source]
def is_default_version : Bool | Nil #

Whether the specified extension version is set as the default version.

This applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation returns null.


[View source]
def is_default_version=(is_default_version : Bool | Nil) #

Whether the specified extension version is set as the default version.

This applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation returns null.


[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.


[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.


[View source]
def latest_public_version : String | Nil #

The latest version of a public extension that is available for use.

This only applies if you specify a public extension, and you don't specify a version. For all other requests, CloudFormation returns null.


[View source]
def latest_public_version=(latest_public_version : String | Nil) #

The latest version of a public extension that is available for use.

This only applies if you specify a public extension, and you don't specify a version. For all other requests, CloudFormation returns null.


[View source]
def logging_config : LoggingConfig | Nil #

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


[View source]
def logging_config=(logging_config : LoggingConfig | Nil) #

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


[View source]
def original_type_arn : String | Nil #

For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the public extension.


[View source]
def original_type_arn=(original_type_arn : String | Nil) #

For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the public extension.


[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.

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 provisioning_type : ProvisioningType | Nil #

For resource type extensions, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

  • FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.

  • IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.

  • NON_PROVISIONABLE: The resource type doesn't include all the following handlers, and therefore can't actually be provisioned.

  • create

  • read

  • delete


[View source]
def provisioning_type=(provisioning_type : ProvisioningType | Nil) #

For resource type extensions, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

  • FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.

  • IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.

  • NON_PROVISIONABLE: The resource type doesn't include all the following handlers, and therefore can't actually be provisioned.

  • create

  • read

  • delete


[View source]
def public_version_number : String | Nil #

The version number of a public third-party extension.

This applies only if you specify a public extension you have activated in your account, or specify a public extension without specifying a version. For all other extensions, CloudFormation returns null.


[View source]
def public_version_number=(public_version_number : String | Nil) #

The version number of a public third-party extension.

This applies only if you specify a public extension you have activated in your account, or specify a public extension without specifying a version. For all other extensions, CloudFormation returns null.


[View source]
def publisher_id : String | Nil #

The publisher ID of the extension publisher.

This applies only to public third-party extensions. For private registered extensions, and extensions provided by Amazon Web Services, CloudFormation returns null.


[View source]
def publisher_id=(publisher_id : String | Nil) #

The publisher ID of the extension publisher.

This applies only to public third-party extensions. For private registered extensions, and extensions provided by Amazon Web Services, CloudFormation returns null.


[View source]
def required_activated_types : Array(RequiredActivatedType) | Nil #

For extensions that are modules, the public third-party extensions that must be activated in your account in order for the module itself to be activated.


[View source]
def required_activated_types=(required_activated_types : Array(RequiredActivatedType) | Nil) #

For extensions that are modules, the public third-party extensions that must be activated in your account in order for the module itself to be activated.


[View source]
def schema : String | Nil #

The schema that defines the extension.

For more information, see Resource type schema in the CloudFormation Command Line Interface (CLI) User Guide and the CloudFormation Hooks User Guide.


[View source]
def schema=(schema : String | Nil) #

The schema that defines the extension.

For more information, see Resource type schema in the CloudFormation Command Line Interface (CLI) User Guide and the CloudFormation Hooks User Guide.


[View source]
def source_url : String | Nil #

The URL of the source code for the extension.


[View source]
def source_url=(source_url : String | Nil) #

The URL of the source code for the extension.


[View source]
def time_created : Time | Nil #

When the specified private extension version was registered or activated in your account.


[View source]
def time_created=(time_created : Time | Nil) #

When the specified private extension version was registered or activated in your account.


[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_name : String | Nil #

The name of the extension.

If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see ActivateType.


[View source]
def type_name=(type_name : String | Nil) #

The name of the extension.

If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see ActivateType.


[View source]
def type_tests_status : TypeTestsStatus | Nil #

The contract test status of the registered extension version. To return the extension test status of a specific extension version, you must specify VersionId.

This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.

  • PASSED: The extension has passed all its contract tests.

An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.

  • FAILED: The extension has failed one or more contract tests.

  • IN_PROGRESS: Contract tests are currently being performed on the extension.

  • NOT_TESTED: Contract tests haven't been performed on the extension.


[View source]
def type_tests_status=(type_tests_status : TypeTestsStatus | Nil) #

The contract test status of the registered extension version. To return the extension test status of a specific extension version, you must specify VersionId.

This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.

  • PASSED: The extension has passed all its contract tests.

An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.

  • FAILED: The extension has failed one or more contract tests.

  • IN_PROGRESS: Contract tests are currently being performed on the extension.

  • NOT_TESTED: Contract tests haven't been performed on the extension.


[View source]
def type_tests_status_description : String | Nil #

The description of the test status. To return the extension test status of a specific extension version, you must specify VersionId.

This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.


[View source]
def type_tests_status_description=(type_tests_status_description : String | Nil) #

The description of the test status. To return the extension test status of a specific extension version, you must specify VersionId.

This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.


[View source]
def validate! : Nil #

[View source]
def visibility : Visibility | Nil #

The scope at which the extension is visible and usable in CloudFormation operations.

Valid values include:

  • PRIVATE: The extension is only visible and usable within the account in which it is registered. CloudFormation marks any extensions you register as PRIVATE.

  • PUBLIC: The extension is publicly visible and usable within any Amazon Web Services account.


[View source]
def visibility=(visibility : Visibility | Nil) #

The scope at which the extension is visible and usable in CloudFormation operations.

Valid values include:

  • PRIVATE: The extension is only visible and usable within the account in which it is registered. CloudFormation marks any extensions you register as PRIVATE.

  • PUBLIC: The extension is publicly visible and usable within any Amazon Web Services account.


[View source]