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

Inherits:

Struct

• Object
• Struct
• Aws::CloudFormation::Types::DescribeResourceScanOutput

Includes:

Structure

Defined in:

lib/aws-sdk-cloudformation/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #end_time ⇒ Time

  The time that the resource scan was finished.

• #percentage_completed ⇒ Float

  The percentage of the resource scan that has been completed.

• #resource_scan_id ⇒ String

  The Amazon Resource Name (ARN) of the resource scan.

• #resource_types ⇒ Array<String>

  The list of resource types for the specified scan.

• #resources_read ⇒ Integer

  The number of resources that were read.

• #resources_scanned ⇒ Integer

  The number of resources that were listed.

• #start_time ⇒ Time

  The time that the resource scan was started.

• #status ⇒ String

  Status of the resource scan.

• #status_reason ⇒ String

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

Instance Attribute Details

#end_time ⇒ Time

The time that the resource scan was finished.

Returns:

• (Time)

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

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_completed ⇒ Float

The percentage of the resource scan that has been completed.

Returns:

• (Float)

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

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_id ⇒ String

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)

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

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_types ⇒ Array<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>)

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

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_read ⇒ Integer

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

<note markdown=“1”> This field may be 0 if the resource scan failed with a ‘ResourceScanLimitExceededException`.

</note>

Returns:

• (Integer)

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

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_scanned ⇒ Integer

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

Returns:

• (Integer)

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

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_time ⇒ Time

The time that the resource scan was started.

Returns:

• (Time)

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

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

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)

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

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_reason ⇒ String

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

Returns:

• (String)

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

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