AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb

Overview

Note:

When making an API call, you may pass DescribeTypeInput data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the type.

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

Returns:

  • (String)


2645
2646
2647
2648
2649
2650
2651
2652
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2645

class DescribeTypeInput < Struct.new(
  :type,
  :type_name,
  :arn,
  :version_id)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The kind of type.

Currently the only valid value is RESOURCE.

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

Returns:

  • (String)


2645
2646
2647
2648
2649
2650
2651
2652
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2645

class DescribeTypeInput < Struct.new(
  :type,
  :type_name,
  :arn,
  :version_id)
  SENSITIVE = []
  include Aws::Structure
end

#type_nameString

The name of the type.

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

Returns:

  • (String)


2645
2646
2647
2648
2649
2650
2651
2652
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2645

class DescribeTypeInput < Struct.new(
  :type,
  :type_name,
  :arn,
  :version_id)
  SENSITIVE = []
  include Aws::Structure
end

#version_idString

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)


2645
2646
2647
2648
2649
2650
2651
2652
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2645

class DescribeTypeInput < Struct.new(
  :type,
  :type_name,
  :arn,
  :version_id)
  SENSITIVE = []
  include Aws::Structure
end