Class: Aws::CloudFormation::Types::DescribeGeneratedTemplateOutput

Inherits:

Struct

• Object
• Struct
• Aws::CloudFormation::Types::DescribeGeneratedTemplateOutput

Includes:

Structure

Defined in:

lib/aws-sdk-cloudformation/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_time ⇒ Time

  The time the generated template was created.

• #generated_template_id ⇒ String

  The Amazon Resource Name (ARN) of the generated template.

• #generated_template_name ⇒ String

  The name of the generated template.

• #last_updated_time ⇒ Time

  The time the generated template was last updated.

• #progress ⇒ Types::TemplateProgress

  An object describing the progress of the template generation.

• #resources ⇒ Array<Types::ResourceDetail>

  A list of objects describing the details of the resources in the template generation.

• #stack_id ⇒ String

  The stack ARN of the base stack if a base stack was provided when generating the template.

• #status ⇒ String

  The status of the template generation.

• #status_reason ⇒ String

  The reason for the current template generation status.

• #template_configuration ⇒ Types::TemplateConfiguration

  The configuration details of the generated template, including the ‘DeletionPolicy` and `UpdateReplacePolicy`.

• #total_warnings ⇒ Integer

  The number of warnings generated for this template.

Instance Attribute Details

#creation_time ⇒ Time

The time the generated template was created.

Returns:

• (Time)

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

class DescribeGeneratedTemplateOutput < Struct.new(
  :generated_template_id,
  :generated_template_name,
  :resources,
  :status,
  :status_reason,
  :creation_time,
  :last_updated_time,
  :progress,
  :stack_id,
  :template_configuration,
  :total_warnings)
  SENSITIVE = []
  include Aws::Structure
end

#generated_template_id ⇒ String

The Amazon Resource Name (ARN) of the generated template. The format is ‘arn:$Partition:cloudformation:$Region:$Account:generatedtemplate/$Id`. For example, `arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc `.

Returns:

• (String)

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

class DescribeGeneratedTemplateOutput < Struct.new(
  :generated_template_id,
  :generated_template_name,
  :resources,
  :status,
  :status_reason,
  :creation_time,
  :last_updated_time,
  :progress,
  :stack_id,
  :template_configuration,
  :total_warnings)
  SENSITIVE = []
  include Aws::Structure
end

#generated_template_name ⇒ String

The name of the generated template.

Returns:

• (String)

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

class DescribeGeneratedTemplateOutput < Struct.new(
  :generated_template_id,
  :generated_template_name,
  :resources,
  :status,
  :status_reason,
  :creation_time,
  :last_updated_time,
  :progress,
  :stack_id,
  :template_configuration,
  :total_warnings)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_time ⇒ Time

The time the generated template was last updated.

Returns:

• (Time)

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

class DescribeGeneratedTemplateOutput < Struct.new(
  :generated_template_id,
  :generated_template_name,
  :resources,
  :status,
  :status_reason,
  :creation_time,
  :last_updated_time,
  :progress,
  :stack_id,
  :template_configuration,
  :total_warnings)
  SENSITIVE = []
  include Aws::Structure
end

#progress ⇒ Types::TemplateProgress

An object describing the progress of the template generation.

Returns:

• (Types::TemplateProgress)

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

class DescribeGeneratedTemplateOutput < Struct.new(
  :generated_template_id,
  :generated_template_name,
  :resources,
  :status,
  :status_reason,
  :creation_time,
  :last_updated_time,
  :progress,
  :stack_id,
  :template_configuration,
  :total_warnings)
  SENSITIVE = []
  include Aws::Structure
end

#resources ⇒ Array<Types::ResourceDetail>

A list of objects describing the details of the resources in the template generation.

Returns:

• (Array<Types::ResourceDetail>)

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

class DescribeGeneratedTemplateOutput < Struct.new(
  :generated_template_id,
  :generated_template_name,
  :resources,
  :status,
  :status_reason,
  :creation_time,
  :last_updated_time,
  :progress,
  :stack_id,
  :template_configuration,
  :total_warnings)
  SENSITIVE = []
  include Aws::Structure
end

#stack_id ⇒ String

The stack ARN of the base stack if a base stack was provided when generating the template.

Returns:

• (String)

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

class DescribeGeneratedTemplateOutput < Struct.new(
  :generated_template_id,
  :generated_template_name,
  :resources,
  :status,
  :status_reason,
  :creation_time,
  :last_updated_time,
  :progress,
  :stack_id,
  :template_configuration,
  :total_warnings)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the template generation. Supported values are:

• ‘CreatePending` - the creation of the template is pending.

• ‘CreateInProgress` - the creation of the template is in progress.

• ‘DeletePending` - the deletion of the template is pending.

• ‘DeleteInProgress` - the deletion of the template is in progress.

• ‘UpdatePending` - the update of the template is pending.

• ‘UpdateInProgress` - the update of the template is in progress.

• ‘Failed` - the template operation failed.

• ‘Complete` - the template operation is complete.

Returns:

• (String)

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

class DescribeGeneratedTemplateOutput < Struct.new(
  :generated_template_id,
  :generated_template_name,
  :resources,
  :status,
  :status_reason,
  :creation_time,
  :last_updated_time,
  :progress,
  :stack_id,
  :template_configuration,
  :total_warnings)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

The reason for the current template generation status. This will provide more details if a failure happened.

Returns:

• (String)

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

class DescribeGeneratedTemplateOutput < Struct.new(
  :generated_template_id,
  :generated_template_name,
  :resources,
  :status,
  :status_reason,
  :creation_time,
  :last_updated_time,
  :progress,
  :stack_id,
  :template_configuration,
  :total_warnings)
  SENSITIVE = []
  include Aws::Structure
end

#template_configuration ⇒ Types::TemplateConfiguration

The configuration details of the generated template, including the ‘DeletionPolicy` and `UpdateReplacePolicy`.

Returns:

• (Types::TemplateConfiguration)

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

class DescribeGeneratedTemplateOutput < Struct.new(
  :generated_template_id,
  :generated_template_name,
  :resources,
  :status,
  :status_reason,
  :creation_time,
  :last_updated_time,
  :progress,
  :stack_id,
  :template_configuration,
  :total_warnings)
  SENSITIVE = []
  include Aws::Structure
end

#total_warnings ⇒ Integer

The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.

Returns:

• (Integer)

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

class DescribeGeneratedTemplateOutput < Struct.new(
  :generated_template_id,
  :generated_template_name,
  :resources,
  :status,
  :status_reason,
  :creation_time,
  :last_updated_time,
  :progress,
  :stack_id,
  :template_configuration,
  :total_warnings)
  SENSITIVE = []
  include Aws::Structure
end