class Amazonite::CloudFormation::DescribeResourceScanOutput

Defined in:

cloudformation/describe_resource_scan_output.cr

Constructors

Instance Method Summary

Constructor Detail

def self.from_xml(node : XML::Node) : self #

[View source]
def self.new(resource_scan_id : String | Nil = nil, status : ResourceScanStatus | Nil = nil, status_reason : String | Nil = nil, start_time : Time | Nil = nil, end_time : Time | Nil = nil, percentage_completed : Float64 | Nil = nil, resource_types : Array(String) | Nil = nil, resources_scanned : Int32 | Nil = nil, resources_read : Int32 | Nil = nil, scan_filters : Array(ScanFilter) | Nil = nil) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def end_time : Time | Nil #

The time that the resource scan was finished.


[View source]
def end_time=(end_time : Time | Nil) #

The time that the resource scan was finished.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def percentage_completed : Float64 | Nil #

The percentage of the resource scan that has been completed.


[View source]
def percentage_completed=(percentage_completed : Float64 | Nil) #

The percentage of the resource scan that has been completed.


[View source]
def resource_scan_id : String | Nil #

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


[View source]
def resource_scan_id=(resource_scan_id : String | Nil) #

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


[View source]
def resource_types : Array(String) | Nil #

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


[View source]
def resource_types=(resource_types : Array(String) | Nil) #

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


[View source]
def resources_read : Int32 | Nil #

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.


[View source]
def resources_read=(resources_read : Int32 | Nil) #

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.


[View source]
def resources_scanned : Int32 | Nil #

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


[View source]
def resources_scanned=(resources_scanned : Int32 | Nil) #

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


[View source]
def scan_filters : Array(ScanFilter) | Nil #

The scan filters that were used.


[View source]
def scan_filters=(scan_filters : Array(ScanFilter) | Nil) #

The scan filters that were used.


[View source]
def start_time : Time | Nil #

The time that the resource scan was started.


[View source]
def start_time=(start_time : Time | Nil) #

The time that the resource scan was started.


[View source]
def status : ResourceScanStatus | Nil #

Status of the resource scan.

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


[View source]
def status=(status : ResourceScanStatus | Nil) #

Status of the resource scan.

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


[View source]
def status_reason : String | Nil #

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


[View source]
def status_reason=(status_reason : String | Nil) #

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


[View source]
def to_query_params(prefix : String) : Array(Tuple(String, String)) #

[View source]
def validate! : Nil #

[View source]