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

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

Overview

The output for the GetTemplateSummary action.

Constant Summary collapse

SENSITIVE =
[]

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 CloudFormation Templates].

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

Returns:

  • (Array<String>)


4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
# File 'lib/aws-sdk-cloudformation/types.rb', line 4474

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_reasonString

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

Returns:

  • (String)


4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
# File 'lib/aws-sdk-cloudformation/types.rb', line 4474

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_transformsArray<String>

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

Returns:

  • (Array<String>)


4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
# File 'lib/aws-sdk-cloudformation/types.rb', line 4474

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

#descriptionString

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

Returns:

  • (String)


4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
# File 'lib/aws-sdk-cloudformation/types.rb', line 4474

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

#metadataString

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

Returns:

  • (String)


4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
# File 'lib/aws-sdk-cloudformation/types.rb', line 4474

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

#parametersArray<Types::ParameterDeclaration>

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

Returns:



4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
# File 'lib/aws-sdk-cloudformation/types.rb', line 4474

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_summariesArray<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.



4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
# File 'lib/aws-sdk-cloudformation/types.rb', line 4474

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_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>)


4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
# File 'lib/aws-sdk-cloudformation/types.rb', line 4474

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

#versionString

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

Returns:

  • (String)


4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
# File 'lib/aws-sdk-cloudformation/types.rb', line 4474

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

#warningsTypes::Warnings

An object containing any warnings returned.

Returns:



4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
# File 'lib/aws-sdk-cloudformation/types.rb', line 4474

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