Package software.amazon.awssdk.services.cloudformation.model

Interface DescribeResourceScanResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CloudFormationResponse.Builder, CopyableBuilder<DescribeResourceScanResponse.Builder,DescribeResourceScanResponse>, SdkBuilder<DescribeResourceScanResponse.Builder,DescribeResourceScanResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeResourceScanResponse
public static interface DescribeResourceScanResponse.Builder extends CloudFormationResponse.Builder, SdkPojo, CopyableBuilder<DescribeResourceScanResponse.Builder,DescribeResourceScanResponse>

  • Method Details

    • resourceScanId

      DescribeResourceScanResponse.Builder resourceScanId(String resourceScanId)

      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 .

      Parameters:
      resourceScanId - 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:
      Returns a reference to this object so that method calls can be chained together.

    • status

      DescribeResourceScanResponse.Builder status(String status)

      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.

      Parameters:
      status - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      DescribeResourceScanResponse.Builder status(ResourceScanStatus status)

      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.

      Parameters:
      status - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusReason

      DescribeResourceScanResponse.Builder statusReason(String statusReason)

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

      Parameters:
      statusReason - The reason for the resource scan status, providing more information if a failure happened.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTime

      DescribeResourceScanResponse.Builder startTime(Instant startTime)

      The time that the resource scan was started.

      Parameters:
      startTime - The time that the resource scan was started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      DescribeResourceScanResponse.Builder endTime(Instant endTime)

      The time that the resource scan was finished.

      Parameters:
      endTime - The time that the resource scan was finished.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • percentageCompleted

      DescribeResourceScanResponse.Builder percentageCompleted(Double percentageCompleted)

      The percentage of the resource scan that has been completed.

      Parameters:
      percentageCompleted - The percentage of the resource scan that has been completed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceTypes

      DescribeResourceScanResponse.Builder resourceTypes(Collection<String> resourceTypes)

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

      Parameters:
      resourceTypes - 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:
      Returns a reference to this object so that method calls can be chained together.

    • resourceTypes

      DescribeResourceScanResponse.Builder resourceTypes(String... resourceTypes)

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

      Parameters:
      resourceTypes - 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:
      Returns a reference to this object so that method calls can be chained together.

    • resourcesScanned

      DescribeResourceScanResponse.Builder resourcesScanned(Integer resourcesScanned)

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

      Parameters:
      resourcesScanned - The number of resources that were listed. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourcesRead

      DescribeResourceScanResponse.Builder resourcesRead(Integer resourcesRead)

      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.

      Parameters:
      resourcesRead - 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:
      Returns a reference to this object so that method calls can be chained together.