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",
  publisher_id: "PublisherId",
  public_version_number: "PublicVersionNumber",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the extension.

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

Returns:

  • (String)


3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3151

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

#public_version_numberString

The version number of a public third-party extension.

Returns:

  • (String)


3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3151

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

#publisher_idString

The publisher ID of the extension publisher.

Extensions provided by Amazon are not assigned a publisher ID.

Returns:

  • (String)


3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3151

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

#typeString

The kind of extension.

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

Returns:

  • (String)


3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3151

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

#type_nameString

The name of the extension.

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

Returns:

  • (String)


3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3151

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

#version_idString

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, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

Returns:

  • (String)


3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3151

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