You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudFormation::Types::DescribeTypeInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeTypeInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  type: "RESOURCE", # accepts RESOURCE
  type_name: "TypeName",
  arn: "TypeArn",
  version_id: "TypeVersionId",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the type.

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

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the type.

#type ⇒ String

The kind of type.

Currently the only valid value is RESOURCE.

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

Possible values:

  • RESOURCE

Returns:

  • (String) —

    The kind of type.

#type_name ⇒ String

The name of the type.

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

Returns:

  • (String) —

    The name of the type.

#version_id ⇒ String

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

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

Returns:

  • (String) —

    The ID of a specific version of the type.