Class: Aws::AccessAnalyzer::Types::AccessPreview

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

Overview

Contains information about an access preview.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#analyzer_arn ⇒ String

The ARN of the analyzer used to generate the access preview.

Returns:

  • (String) 


83
84
85
86
87
88
89
90
91
92
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 83

class AccessPreview < Struct.new(
  :id,
  :analyzer_arn,
  :configurations,
  :created_at,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#configurations ⇒ Hash<String,Types::Configuration>

A map of resource ARNs for the proposed resource configuration.

Returns:



83
84
85
86
87
88
89
90
91
92
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 83

class AccessPreview < Struct.new(
  :id,
  :analyzer_arn,
  :configurations,
  :created_at,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The time at which the access preview was created.

Returns:

  • (Time) 


83
84
85
86
87
88
89
90
91
92
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 83

class AccessPreview < Struct.new(
  :id,
  :analyzer_arn,
  :configurations,
  :created_at,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique ID for the access preview.

Returns:

  • (String) 


83
84
85
86
87
88
89
90
91
92
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 83

class AccessPreview < Struct.new(
  :id,
  :analyzer_arn,
  :configurations,
  :created_at,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the access preview.

  • Creating - The access preview creation is in progress.

  • Completed - The access preview is complete. You can preview findings for external access to the resource.

  • Failed - The access preview creation has failed.

Returns:

  • (String) 


83
84
85
86
87
88
89
90
91
92
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 83

class AccessPreview < Struct.new(
  :id,
  :analyzer_arn,
  :configurations,
  :created_at,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ Types::AccessPreviewStatusReason

Provides more details about the current status of the access preview.

For example, if the creation of the access preview fails, a Failed status is returned. This failure can be due to an internal issue with the analysis or due to an invalid resource configuration.

Returns:



83
84
85
86
87
88
89
90
91
92
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 83

class AccessPreview < Struct.new(
  :id,
  :analyzer_arn,
  :configurations,
  :created_at,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end