Class: Aws::CloudFormation::Types::DescribeResourceScanOutput

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

The time that the resource scan was finished.

Returns:

  • (Time)


2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2837

class DescribeResourceScanOutput < Struct.new(
  :resource_scan_id,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_completed,
  :resource_types,
  :resources_scanned,
  :resources_read)
  SENSITIVE = []
  include Aws::Structure
end

#percentage_completedFloat

The percentage of the resource scan that has been completed.

Returns:

  • (Float)


2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2837

class DescribeResourceScanOutput < Struct.new(
  :resource_scan_id,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_completed,
  :resource_types,
  :resources_scanned,
  :resources_read)
  SENSITIVE = []
  include Aws::Structure
end

#resource_scan_idString

The Amazon Resource Name (ARN) of the resource scan. The format is arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:resourceScan/$\{Id\}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .

Returns:

  • (String)


2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2837

class DescribeResourceScanOutput < Struct.new(
  :resource_scan_id,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_completed,
  :resource_types,
  :resources_scanned,
  :resources_read)
  SENSITIVE = []
  include Aws::Structure
end

#resource_typesArray<String>

The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED.

Returns:

  • (Array<String>)


2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2837

class DescribeResourceScanOutput < Struct.new(
  :resource_scan_id,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_completed,
  :resource_types,
  :resources_scanned,
  :resources_read)
  SENSITIVE = []
  include Aws::Structure
end

#resources_readInteger

The number of resources that were read. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED.

This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.

Returns:

  • (Integer)


2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2837

class DescribeResourceScanOutput < Struct.new(
  :resource_scan_id,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_completed,
  :resource_types,
  :resources_scanned,
  :resources_read)
  SENSITIVE = []
  include Aws::Structure
end

#resources_scannedInteger

The number of resources that were listed. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED.

Returns:

  • (Integer)


2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2837

class DescribeResourceScanOutput < Struct.new(
  :resource_scan_id,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_completed,
  :resource_types,
  :resources_scanned,
  :resources_read)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

The time that the resource scan was started.

Returns:

  • (Time)


2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2837

class DescribeResourceScanOutput < Struct.new(
  :resource_scan_id,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_completed,
  :resource_types,
  :resources_scanned,
  :resources_read)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

Status of the resource scan.

INPROGRESS

The resource scan is still in progress.

COMPLETE

The resource scan is complete.

EXPIRED

The resource scan has expired.

FAILED

The resource scan has failed.

Returns:

  • (String)


2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2837

class DescribeResourceScanOutput < Struct.new(
  :resource_scan_id,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_completed,
  :resource_types,
  :resources_scanned,
  :resources_read)
  SENSITIVE = []
  include Aws::Structure
end

#status_reasonString

The reason for the resource scan status, providing more information if a failure happened.

Returns:

  • (String)


2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2837

class DescribeResourceScanOutput < Struct.new(
  :resource_scan_id,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_completed,
  :resource_types,
  :resources_scanned,
  :resources_read)
  SENSITIVE = []
  include Aws::Structure
end