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

Inherits:

Struct

• Object
• Struct
• Aws::CloudFormation::Types::GetTemplateSummaryOutput

Includes:

Structure

Defined in:

lib/aws-sdk-cloudformation/types.rb

Overview

The output for the GetTemplateSummary action.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #capabilities ⇒ Array<String>

  The capabilities found within the template.

• #capabilities_reason ⇒ String

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

• #declared_transforms ⇒ Array<String>

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

• #description ⇒ String

  The value that’s defined in the ‘Description` property of the template.

• #metadata ⇒ String

  The value that’s defined for the ‘Metadata` property of the template.

• #parameters ⇒ Array<Types::ParameterDeclaration>

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

• #resource_identifier_summaries ⇒ Array<Types::ResourceIdentifierSummary>

  A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources.

• #resource_types ⇒ Array<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`.

• #version ⇒ String

  The Amazon Web Services template format version, which identifies the capabilities of the template.

• #warnings ⇒ Types::Warnings

  An object containing any warnings returned.

Instance Attribute Details

#capabilities ⇒ Array<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 CloudFormation Templates].

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities

Returns:

• (Array<String>)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4494

class GetTemplateSummaryOutput < Struct.new(
  :parameters,
  :description,
  :capabilities,
  :capabilities_reason,
  :resource_types,
  :version,
  :metadata,
  :declared_transforms,
  :resource_identifier_summaries,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#capabilities_reason ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4494

class GetTemplateSummaryOutput < Struct.new(
  :parameters,
  :description,
  :capabilities,
  :capabilities_reason,
  :resource_types,
  :version,
  :metadata,
  :declared_transforms,
  :resource_identifier_summaries,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#declared_transforms ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4494

class GetTemplateSummaryOutput < Struct.new(
  :parameters,
  :description,
  :capabilities,
  :capabilities_reason,
  :resource_types,
  :version,
  :metadata,
  :declared_transforms,
  :resource_identifier_summaries,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The value that’s defined in the ‘Description` property of the template.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4494

class GetTemplateSummaryOutput < Struct.new(
  :parameters,
  :description,
  :capabilities,
  :capabilities_reason,
  :resource_types,
  :version,
  :metadata,
  :declared_transforms,
  :resource_identifier_summaries,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#metadata ⇒ String

The value that’s defined for the ‘Metadata` property of the template.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4494

class GetTemplateSummaryOutput < Struct.new(
  :parameters,
  :description,
  :capabilities,
  :capabilities_reason,
  :resource_types,
  :version,
  :metadata,
  :declared_transforms,
  :resource_identifier_summaries,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Array<Types::ParameterDeclaration>

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

Returns:

• (Array<Types::ParameterDeclaration>)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4494

class GetTemplateSummaryOutput < Struct.new(
  :parameters,
  :description,
  :capabilities,
  :capabilities_reason,
  :resource_types,
  :version,
  :metadata,
  :declared_transforms,
  :resource_identifier_summaries,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#resource_identifier_summaries ⇒ Array<Types::ResourceIdentifierSummary>

A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources. For example, ‘BucketName` is a possible identifier property for an `AWS::S3::Bucket` resource.

Returns:

• (Array<Types::ResourceIdentifierSummary>)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4494

class GetTemplateSummaryOutput < Struct.new(
  :parameters,
  :description,
  :capabilities,
  :capabilities_reason,
  :resource_types,
  :version,
  :metadata,
  :declared_transforms,
  :resource_identifier_summaries,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#resource_types ⇒ Array<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>)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4494

class GetTemplateSummaryOutput < Struct.new(
  :parameters,
  :description,
  :capabilities,
  :capabilities_reason,
  :resource_types,
  :version,
  :metadata,
  :declared_transforms,
  :resource_identifier_summaries,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

The Amazon Web Services template format version, which identifies the capabilities of the template.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4494

class GetTemplateSummaryOutput < Struct.new(
  :parameters,
  :description,
  :capabilities,
  :capabilities_reason,
  :resource_types,
  :version,
  :metadata,
  :declared_transforms,
  :resource_identifier_summaries,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#warnings ⇒ Types::Warnings

An object containing any warnings returned.

Returns:

• (Types::Warnings)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4494

class GetTemplateSummaryOutput < Struct.new(
  :parameters,
  :description,
  :capabilities,
  :capabilities_reason,
  :resource_types,
  :version,
  :metadata,
  :declared_transforms,
  :resource_identifier_summaries,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end