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

Class: Aws::CloudFormation::Types::GetTemplateSummaryOutput

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

Overview

The output for the GetTemplateSummary action.

Instance Attribute Summary collapse

Instance Attribute Details

#capabilitiesArray<String>

The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

Returns:

  • (Array<String>)


2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2298

class GetTemplateSummaryOutput < Struct.new(
  :parameters,
  :description,
  :capabilities,
  :capabilities_reason,
  :resource_types,
  :version,
  :metadata,
  :declared_transforms)
  include Aws::Structure
end

#capabilities_reasonString

The list of resources that generated the values in the Capabilities response element.

Returns:

  • (String)


2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2298

class GetTemplateSummaryOutput < Struct.new(
  :parameters,
  :description,
  :capabilities,
  :capabilities_reason,
  :resource_types,
  :version,
  :metadata,
  :declared_transforms)
  include Aws::Structure
end

#declared_transformsArray<String>

A list of the transforms that are declared in the template.

Returns:

  • (Array<String>)


2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2298

class GetTemplateSummaryOutput < Struct.new(
  :parameters,
  :description,
  :capabilities,
  :capabilities_reason,
  :resource_types,
  :version,
  :metadata,
  :declared_transforms)
  include Aws::Structure
end

#descriptionString

The value that is defined in the Description property of the template.

Returns:

  • (String)


2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2298

class GetTemplateSummaryOutput < Struct.new(
  :parameters,
  :description,
  :capabilities,
  :capabilities_reason,
  :resource_types,
  :version,
  :metadata,
  :declared_transforms)
  include Aws::Structure
end

#metadataString

The value that is defined for the Metadata property of the template.

Returns:

  • (String)


2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2298

class GetTemplateSummaryOutput < Struct.new(
  :parameters,
  :description,
  :capabilities,
  :capabilities_reason,
  :resource_types,
  :version,
  :metadata,
  :declared_transforms)
  include Aws::Structure
end

#parametersArray<Types::ParameterDeclaration>

A list of parameter declarations that describe various properties for each parameter.

Returns:



2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2298

class GetTemplateSummaryOutput < Struct.new(
  :parameters,
  :description,
  :capabilities,
  :capabilities_reason,
  :resource_types,
  :version,
  :metadata,
  :declared_transforms)
  include Aws::Structure
end

#resource_typesArray<String>

A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

Returns:

  • (Array<String>)


2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2298

class GetTemplateSummaryOutput < Struct.new(
  :parameters,
  :description,
  :capabilities,
  :capabilities_reason,
  :resource_types,
  :version,
  :metadata,
  :declared_transforms)
  include Aws::Structure
end

#versionString

The AWS template format version, which identifies the capabilities of the template.

Returns:

  • (String)


2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2298

class GetTemplateSummaryOutput < Struct.new(
  :parameters,
  :description,
  :capabilities,
  :capabilities_reason,
  :resource_types,
  :version,
  :metadata,
  :declared_transforms)
  include Aws::Structure
end