Amazonka.CloudFormation.Types.TypeSummary

Documentation

data TypeSummary

Contains summary information about the specified CloudFormation extension.

See: newTypeSummary smart constructor.

Constructors

TypeSummary'

Fields

• defaultVersionId :: Maybe Text

  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 .

• description :: Maybe Text

  The description of the extension.

• isActivated :: Maybe 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.

• lastUpdated :: Maybe ISO8601

  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.

• latestPublicVersion :: Maybe Text

  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.

• originalTypeName :: Maybe Text

  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.

• publicVersionNumber :: Maybe Text

  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.

• publisherId :: Maybe Text

  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.

• publisherIdentity :: Maybe 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.

• publisherName :: Maybe Text

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

• type' :: Maybe RegistryType

  The kind of extension.

• typeArn :: Maybe Text

  The Amazon Resource Name (ARN) of the extension.

• typeName :: Maybe Text

  The name of the extension.

  If you specified a TypeNameAlias when you activate this extension in your account and region, CloudFormation considers that alias as the type name.

Instances

FromXML TypeSummary

Defined in Amazonka.CloudFormation.Types.TypeSummary

Methods

parseXML :: [Node] -> Either String TypeSummary

Generic TypeSummary

Defined in Amazonka.CloudFormation.Types.TypeSummary

Associated Types

type Rep TypeSummary :: Type -> Type

Methods

from :: TypeSummary -> Rep TypeSummary x

to :: Rep TypeSummary x -> TypeSummary

Read TypeSummary

Defined in Amazonka.CloudFormation.Types.TypeSummary

Methods

readsPrec :: Int -> ReadS TypeSummary

readList :: ReadS [TypeSummary]

readPrec :: ReadPrec TypeSummary

readListPrec :: ReadPrec [TypeSummary]

Show TypeSummary

Defined in Amazonka.CloudFormation.Types.TypeSummary

Methods

showsPrec :: Int -> TypeSummary -> ShowS

show :: TypeSummary -> String

showList :: [TypeSummary] -> ShowS

NFData TypeSummary

Defined in Amazonka.CloudFormation.Types.TypeSummary

Methods

rnf :: TypeSummary -> ()

Eq TypeSummary

Defined in Amazonka.CloudFormation.Types.TypeSummary

Methods

(==) :: TypeSummary -> TypeSummary -> Bool

(/=) :: TypeSummary -> TypeSummary -> Bool

Hashable TypeSummary

Defined in Amazonka.CloudFormation.Types.TypeSummary

Methods

hashWithSalt :: Int -> TypeSummary -> Int

hash :: TypeSummary -> Int

type Rep TypeSummary

Defined in Amazonka.CloudFormation.Types.TypeSummary

type Rep TypeSummary = D1 ('MetaData "TypeSummary" "Amazonka.CloudFormation.Types.TypeSummary" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "TypeSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "defaultVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "isActivated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "lastUpdated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "latestPublicVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "originalTypeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "publicVersionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "publisherId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "publisherIdentity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityProvider)))) :*: ((S1 ('MetaSel ('Just "publisherName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegistryType))) :*: (S1 ('MetaSel ('Just "typeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newTypeSummary :: TypeSummary

Create a value of TypeSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:defaultVersionId:TypeSummary', typeSummary_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 .

$sel:description:TypeSummary', typeSummary_description - The description of the extension.

$sel:isActivated:TypeSummary', typeSummary_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.

$sel:lastUpdated:TypeSummary', typeSummary_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.

$sel:latestPublicVersion:TypeSummary', typeSummary_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.

$sel:originalTypeName:TypeSummary', typeSummary_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.

$sel:publicVersionNumber:TypeSummary', typeSummary_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.

$sel:publisherId:TypeSummary', typeSummary_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.

$sel:publisherIdentity:TypeSummary', typeSummary_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.

$sel:publisherName:TypeSummary', typeSummary_publisherName - The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.

$sel:type':TypeSummary', typeSummary_type - The kind of extension.

$sel:typeArn:TypeSummary', typeSummary_typeArn - The Amazon Resource Name (ARN) of the extension.

$sel:typeName:TypeSummary', typeSummary_typeName - The name of the extension.

If you specified a TypeNameAlias when you activate this extension in your account and region, CloudFormation considers that alias as the type name.

typeSummary_defaultVersionId :: Lens' TypeSummary (Maybe Text)

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 .

typeSummary_description :: Lens' TypeSummary (Maybe Text)

The description of the extension.

typeSummary_isActivated :: Lens' TypeSummary (Maybe 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.

typeSummary_lastUpdated :: Lens' TypeSummary (Maybe UTCTime)

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.

typeSummary_latestPublicVersion :: Lens' TypeSummary (Maybe Text)

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.

typeSummary_originalTypeName :: Lens' TypeSummary (Maybe Text)

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.

typeSummary_publicVersionNumber :: Lens' TypeSummary (Maybe Text)

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.

typeSummary_publisherId :: Lens' TypeSummary (Maybe Text)

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.

typeSummary_publisherIdentity :: Lens' TypeSummary (Maybe 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.

typeSummary_publisherName :: Lens' TypeSummary (Maybe Text)

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

typeSummary_type :: Lens' TypeSummary (Maybe RegistryType)

The kind of extension.

typeSummary_typeArn :: Lens' TypeSummary (Maybe Text)

The Amazon Resource Name (ARN) of the extension.

typeSummary_typeName :: Lens' TypeSummary (Maybe Text)

The name of the extension.

If you specified a TypeNameAlias when you activate this extension in your account and region, CloudFormation considers that alias as the type name.