Skip to content

Describe Type

cloudformation_describe_type R Documentation

Returns detailed information about an extension that has been registered

Description

Returns detailed information about an extension that has been registered.

If you specify a VersionId, describe_type returns information about that specific extension version. Otherwise, it returns information about the default extension version.

Usage

cloudformation_describe_type(Type, TypeName, Arn, VersionId,
  PublisherId, PublicVersionNumber)

Arguments

Type

The kind of extension.

Conditional: You must specify either TypeName and Type, or Arn.
TypeName

The name of the extension.

Conditional: You must specify either TypeName and Type, or Arn.
Arn

The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify either TypeName and Type, or Arn.
VersionId

The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

If you specify a VersionId, describe_type returns information about that specific extension version. Otherwise, it returns information about the default extension version.
PublisherId

The publisher ID of the extension publisher.

Extensions provided by Amazon Web Services are not assigned a publisher ID.
PublicVersionNumber

The version number of a public third-party extension.

Value

A list with the following syntax:

list(
  Arn = "string",
  Type = "RESOURCE"|"MODULE"|"HOOK",
  TypeName = "string",
  DefaultVersionId = "string",
  IsDefaultVersion = TRUE|FALSE,
  TypeTestsStatus = "PASSED"|"FAILED"|"IN_PROGRESS"|"NOT_TESTED",
  TypeTestsStatusDescription = "string",
  Description = "string",
  Schema = "string",
  ProvisioningType = "NON_PROVISIONABLE"|"IMMUTABLE"|"FULLY_MUTABLE",
  DeprecatedStatus = "LIVE"|"DEPRECATED",
  LoggingConfig = list(
    LogRoleArn = "string",
    LogGroupName = "string"
  ),
  RequiredActivatedTypes = list(
    list(
      TypeNameAlias = "string",
      OriginalTypeName = "string",
      PublisherId = "string",
      SupportedMajorVersions = list(
        123
      )
    )
  ),
  ExecutionRoleArn = "string",
  Visibility = "PUBLIC"|"PRIVATE",
  SourceUrl = "string",
  DocumentationUrl = "string",
  LastUpdated = as.POSIXct(
    "2015-01-01"
  ),
  TimeCreated = as.POSIXct(
    "2015-01-01"
  ),
  ConfigurationSchema = "string",
  PublisherId = "string",
  OriginalTypeName = "string",
  OriginalTypeArn = "string",
  PublicVersionNumber = "string",
  LatestPublicVersion = "string",
  IsActivated = TRUE|FALSE,
  AutoUpdate = TRUE|FALSE
)

Request syntax

svc$describe_type(
  Type = "RESOURCE"|"MODULE"|"HOOK",
  TypeName = "string",
  Arn = "string",
  VersionId = "string",
  PublisherId = "string",
  PublicVersionNumber = "string"
)