Class: Aws::Resiliencehubv2::Types::Service

Inherits:

Struct

• Object
• Struct
• Aws::Resiliencehubv2::Types::Service

Includes:

Structure

Defined in:

lib/aws-sdk-resiliencehubv2/types.rb

Overview

Represents a service in Resilience Hub. A service is the primary unit of resilience assessment.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:tags]

Instance Attribute Summary

• #account_id ⇒ String

  The AWS account ID that owns the service.

• #achievability ⇒ Types::Achievability

  The achievability status of the service’s resilience targets.

• #assessment_status ⇒ String

  The current assessment status of the service.

• #associated_systems ⇒ Array<Types::AssociatedSystem>

  The systems associated with the service.

• #created_at ⇒ Time

  The timestamp when the service was created.

• #dependency_discovery ⇒ Types::DependencyDiscoveryConfig

  The dependency discovery configuration for the service.

• #description ⇒ String

  Resource description for services and policies.

• #effective_policy_values ⇒ Types::EffectivePolicyValues

  The effective policy values for the service.

• #estimated_assessment_cost ⇒ Types::AssessmentCost

  The estimated cost of running an assessment on the service.

• #kms_key_id ⇒ String

  KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.

• #name ⇒ String

  Resource name (used in ARN — no spaces allowed).

• #open_findings_count ⇒ Integer

  The number of open findings for the service.

• #organization_id ⇒ String

  The AWS Organizations identifier for the service.

• #ou_id ⇒ String

  The organizational unit (OU) identifier for the service.

• #permission_model ⇒ Types::PermissionModel

  The permission model for the service.

• #policy_arn ⇒ String

  ARN identifier.

• #regions ⇒ Array<String>

  The AWS Regions where the service operates.

• #report_configuration ⇒ Types::ServiceReportConfiguration

  Configuration for automatic report generation on a Service.

• #rerun_assessment ⇒ Boolean

  Indicates whether the assessment should be rerun.

• #resolved_findings_count ⇒ Integer

  The number of resolved findings for the service.

• #resource_discovery ⇒ Types::ResourceDiscoveryStatus

  The resource discovery status for the service.

• #service_arn ⇒ String

  ARN identifier.

• #tags ⇒ Hash<String,String>

  Resource tags.

• #updated_at ⇒ Time

  The timestamp when the service was last updated.

Instance Attribute Details

#account_id ⇒ String

The AWS account ID that owns the service.

Returns:

• (String)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#achievability ⇒ Types::Achievability

The achievability status of the service’s resilience targets.

Returns:

• (Types::Achievability)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#assessment_status ⇒ String

The current assessment status of the service.

Returns:

• (String)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#associated_systems ⇒ Array<Types::AssociatedSystem>

The systems associated with the service.

Returns:

• (Array<Types::AssociatedSystem>)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#created_at ⇒ Time

The timestamp when the service was created.

Returns:

• (Time)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#dependency_discovery ⇒ Types::DependencyDiscoveryConfig

The dependency discovery configuration for the service.

Returns:

• (Types::DependencyDiscoveryConfig)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#description ⇒ String

Resource description for services and policies.

Returns:

• (String)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#effective_policy_values ⇒ Types::EffectivePolicyValues

The effective policy values for the service.

Returns:

• (Types::EffectivePolicyValues)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#estimated_assessment_cost ⇒ Types::AssessmentCost

The estimated cost of running an assessment on the service.

Returns:

• (Types::AssessmentCost)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#kms_key_id ⇒ String

KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.

Returns:

• (String)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#name ⇒ String

Resource name (used in ARN — no spaces allowed).

Returns:

• (String)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#open_findings_count ⇒ Integer

The number of open findings for the service.

Returns:

• (Integer)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#organization_id ⇒ String

The AWS Organizations identifier for the service.

Returns:

• (String)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#ou_id ⇒ String

The organizational unit (OU) identifier for the service.

Returns:

• (String)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#permission_model ⇒ Types::PermissionModel

The permission model for the service.

Returns:

• (Types::PermissionModel)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#policy_arn ⇒ String

ARN identifier.

Returns:

• (String)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#regions ⇒ Array<String>

The AWS Regions where the service operates.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#report_configuration ⇒ Types::ServiceReportConfiguration

Configuration for automatic report generation on a Service.

Returns:

• (Types::ServiceReportConfiguration)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#rerun_assessment ⇒ Boolean

Indicates whether the assessment should be rerun.

Returns:

• (Boolean)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#resolved_findings_count ⇒ Integer

The number of resolved findings for the service.

Returns:

• (Integer)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#resource_discovery ⇒ Types::ResourceDiscoveryStatus

The resource discovery status for the service.

Returns:

• (Types::ResourceDiscoveryStatus)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#service_arn ⇒ String

ARN identifier.

Returns:

• (String)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Resource tags.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#updated_at ⇒ Time

The timestamp when the service was last updated.

Returns:

• (Time)

# File 'lib/aws-sdk-resiliencehubv2/types.rb', line 3090

class Service < Struct.new(
  :service_arn,
  :name,
  :description,
  :associated_systems,
  :policy_arn,
  :regions,
  :permission_model,
  :dependency_discovery,
  :effective_policy_values,
  :achievability,
  :report_configuration,
  :kms_key_id,
  :tags,
  :estimated_assessment_cost,
  :resource_discovery,
  :assessment_status,
  :rerun_assessment,
  :open_findings_count,
  :resolved_findings_count,
  :organization_id,
  :ou_id,
  :account_id,
  :created_at,
  :updated_at)
  SENSITIVE = [:tags]
  include Aws::Structure
end