Struct aws_sdk_cloudformation::types::TypeSummary

#[non_exhaustive]
pub struct TypeSummary {

    pub type: Option<RegistryType>,
    pub type_name: Option<String>,
    pub default_version_id: Option<String>,
    pub type_arn: Option<String>,
    pub last_updated: Option<DateTime>,
    pub description: Option<String>,
    pub publisher_id: Option<String>,
    pub original_type_name: Option<String>,
    pub public_version_number: Option<String>,
    pub latest_public_version: Option<String>,
    pub publisher_identity: Option<IdentityProvider>,
    pub publisher_name: Option<String>,
    pub is_activated: Option<bool>,
}

Contains summary information about the specified CloudFormation extension.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

type: Option<RegistryType>

The kind of extension.

type_name: Option<String>

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.

default_version_id: Option<String>

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.

type_arn: Option<String>

The Amazon Resource Name (ARN) of the extension.

last_updated: Option<DateTime>

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.

description: Option<String>

The description of the extension.

publisher_id: Option<String>

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.

original_type_name: Option<String>

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_version_number: Option<String>

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.

latest_public_version: Option<String>

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.

publisher_identity: Option<IdentityProvider>

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.

publisher_name: Option<String>

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

is_activated: Option<bool>

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.

Implementations

impl TypeSummary

pub fn type(&self) -> Option<&RegistryType>

The kind of extension.

pub fn type_name(&self) -> Option<&str>

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.

pub fn default_version_id(&self) -> Option<&str>

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.

pub fn type_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the extension.

pub fn last_updated(&self) -> Option<&DateTime>

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.

pub fn description(&self) -> Option<&str>

The description of the extension.

pub fn publisher_id(&self) -> Option<&str>

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.

pub fn original_type_name(&self) -> Option<&str>

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.

pub fn public_version_number(&self) -> Option<&str>

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.

pub fn latest_public_version(&self) -> Option<&str>

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.

pub fn publisher_identity(&self) -> Option<&IdentityProvider>

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.

pub fn publisher_name(&self) -> Option<&str>

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

pub fn is_activated(&self) -> Option<bool>

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.

impl TypeSummary

pub fn builder() -> TypeSummaryBuilder

Creates a new builder-style object to manufacture TypeSummary.

Trait Implementations

impl Clone for TypeSummary

fn clone(&self) -> TypeSummary

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TypeSummary

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for TypeSummary

fn eq(&self, other: &TypeSummary) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TypeSummary